View as Markdown
Brex icon

Brex ACTION

Cancel Card

Cancels (terminates) a card permanently. This cannot be undone — use Freeze Card to block a card temporarily instead. See the documentation
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Brex account once, then configure and run Cancel Card from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "brex-cancel-card",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    brex: { authProvisionId: "apn_xxxxxxx" },
    cardId: "Card ID",
    reason: "Reason",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Cancel Card inputs
Property Type Description
cardId Card ID string
The unique ID of the card. Use List Cards to find a card ID by cardholder, name, or last four digits.
Required
reason Reason string
Why the card is being cancelled. Brex requires a reason and records it against the card.
Required
description Description string
An optional free-text note stored alongside the reason.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
brex-cancel-card
Version
0.0.1
App
Brex
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes