Brex: Get card number
Brex team.teamGetCardNumber: arguments, response, policy and SDK examples.
← Team operations · Get started
Operation brex.team_getcardnumber
Provider route: GET /v2/cards/{id}/pan. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/brex with npm, or alter-sdk-brex with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { BrexIntegration } from "@alter-ai/brex";
async function execute(input: Parameters<BrexIntegration["team"]["teamGetCardNumber"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new BrexIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.team.teamGetCardNumber(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_brex import BrexIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = BrexIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.team.team_get_card_number(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.id | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get card number — response body |
Referenced models: Get card number — response body
Schemas
Section titled “Schemas”Get card number — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Card number, CVV, and expiration date of a card. |
cvv | string | Required within parent | |
expiration_date | Model | Required within parent | Expand Get card — response body — expiration date |
holder_name | string | Required within parent | |
id | string | Required within parent | |
number | string | Required within parent |
Referenced models: Get card — response body — expiration date
Get card — response body — expiration date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Card expiration year and month. Cards expire on the last day of the expiration month. The expiration date is in UTC for cards starting with 555671, 428803 and 485932. And the expiration date is in PST for cards starting with 511572. |
month | JSON | Required within parent | |
month (anyOf 1) | integer | Alternative | Format: int32 |
month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
year | JSON | Required within parent | |
year (anyOf 1) | integer | Alternative | Format: int32 |
year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: brex.team_getcardnumber. Catalog operation: team:getCardNumber. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["cards.pan"]