Brex: List transactions for all card accounts
Brex transactions.transactionsListPrimaryCardTransactions: arguments, response, policy and SDK examples.
← Transactions operations · Get started
Operation brex.transactions_listprimarycardtransactions
Provider route: GET /v2/transactions/card/primary. 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["transactions"]["transactionsListPrimaryCardTransactions"]>[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.transactions.transactionsListPrimaryCardTransactions(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.transactions.transactions_list_primary_card_transactions(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.cursor | JSON | Optional | |
query.cursor (anyOf 1) | string | Alternative | |
query.cursor (anyOf 2) | null | Alternative | |
query.limit | JSON | Optional | |
query.limit (anyOf 1) | integer | Alternative | Format: int32 |
query.limit (anyOf 2) | null | Alternative | |
query.user_ids | JSON | Optional | |
query.user_ids (anyOf 1) | array | Alternative | |
query.user_ids (anyOf 1)[] | string | Each item | |
query.user_ids (anyOf 2) | null | Alternative | |
query.posted_at_start | JSON | Optional | |
query.posted_at_start (anyOf 1) | string | Alternative | Format: date-time |
query.posted_at_start (anyOf 2) | null | Alternative | |
query.expand[] | JSON | Optional | |
query.expand[] (anyOf 1) | array | Alternative | `expense_id` can be passed to `expand[]` query parameter to get expanded, e.g., `?expand[]=expense_id`. |
query.expand[] (anyOf 1)[] | string | Each item | |
query.expand[] (anyOf 2) | null | Alternative |
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 List transactions for all card accounts — response body |
Referenced models: List transactions for all card accounts — response body
Schemas
Section titled “Schemas”List transactions for all card accounts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand List transactions for all card accounts — response body — items item |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: List transactions for all card accounts — response body — items item
List transactions for all card accounts — response body — items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand Get transfer — response body — amount |
card_id | JSON | Optional | |
card_id (anyOf 1) | string | Alternative | ID of the card used for the transaction. Null when type is REWARDS_CREDIT or COLLECTION. |
card_id (anyOf 2) | null | Alternative | |
card_metadata | JSON | Optional | |
card_metadata (anyOf 1) | object | Alternative | Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. Additional keys: see wildcard field |
card_metadata (anyOf 1).* | string | Additional keys | |
card_metadata (anyOf 2) | null | Alternative | |
card_transaction_operation_reference_id | JSON | Optional | |
card_transaction_operation_reference_id (anyOf 1) | string | Alternative | The card transaction operation reference ID. Null when type is REWARDS_CREDIT, COLLECTION, or BNPL_FEE. |
card_transaction_operation_reference_id (anyOf 2) | null | Alternative | |
description | string | Required within parent | Description of the transaction |
expense_id | JSON | Optional | |
expense_id (anyOf 1) | string | Alternative | The expense ID related to the card transaction. |
expense_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
initiated_at_date | string | Required within parent | ISO 8601 date string Format: date |
merchant | JSON | Optional | |
merchant (anyOf 1) | JSON | Alternative | |
merchant (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get an expense — response body — merchant country, mcc, raw descriptor country, mcc, raw descriptor |
merchant (anyOf 2) | null | Alternative | |
posted_at_date | string | Required within parent | ISO 8601 date string Format: date |
type | JSON | Optional | |
type (anyOf 1) | JSON | Alternative | |
type (anyOf 1) (allOf 1) | string | All variants apply | Known values: PURCHASE, REFUND, CHARGEBACK, REWARDS_CREDIT, COLLECTION, BNPL_FEE |
type (anyOf 2) | null | Alternative |
Referenced models: Get transfer — response body — amount, Get an expense — response body — merchant country, mcc, raw descriptor country, mcc, raw descriptor
Get transfer — response body — amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700. |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. Format: int64 |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | The type of currency, in ISO 4217 format. Default: USD |
currency (anyOf 2) | null | Alternative |
Get an expense — response body — merchant country, mcc, raw descriptor country, mcc, raw descriptor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | string | Required within parent | Merchant's country, in ISO 3166-1 alpha-3 format. |
mcc | string | Required within parent | A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to https://en.wikipedia.org/wiki/Merchant_category_code for more details. |
raw_descriptor | string | Required within parent | Merchant descriptor, it can be the merchant name. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: brex.transactions_listprimarycardtransactions. Catalog operation: transactions:listPrimaryCardTransactions. 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: ["transactions.card.readonly"]