Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.cursorJSONOptional
query.cursor (anyOf 1)stringAlternative
query.cursor (anyOf 2)nullAlternative
query.limitJSONOptional
query.limit (anyOf 1)integerAlternativeFormat: int32
query.limit (anyOf 2)nullAlternative
query.user_idsJSONOptional
query.user_ids (anyOf 1)arrayAlternative
query.user_ids (anyOf 1)[]stringEach item
query.user_ids (anyOf 2)nullAlternative
query.posted_at_startJSONOptional
query.posted_at_start (anyOf 1)stringAlternativeFormat: date-time
query.posted_at_start (anyOf 2)nullAlternative
query.expand[]JSONOptional
query.expand[] (anyOf 1)arrayAlternative`expense_id` can be passed to `expand[]` query parameter to get expanded, e.g., `?expand[]=expense_id`.
query.expand[] (anyOf 1)[]stringEach item
query.expand[] (anyOf 2)nullAlternative

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List transactions for all card accounts — response body

Referenced models: List transactions for all card accounts — response body

List transactions for all card accounts — response body
FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand List transactions for all card accounts — response body — items item
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: List transactions for all card accounts — response body — items item

List transactions for all card accounts — response body — items item
FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand Get transfer — response body — amount
card_idJSONOptional
card_id (anyOf 1)stringAlternativeID of the card used for the transaction. Null when type is REWARDS_CREDIT or COLLECTION.
card_id (anyOf 2)nullAlternative
card_metadataJSONOptional
card_metadata (anyOf 1)objectAlternative
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).*stringAdditional keys
card_metadata (anyOf 2)nullAlternative
card_transaction_operation_reference_idJSONOptional
card_transaction_operation_reference_id (anyOf 1)stringAlternativeThe card transaction operation reference ID. Null when type is REWARDS_CREDIT, COLLECTION, or BNPL_FEE.
card_transaction_operation_reference_id (anyOf 2)nullAlternative
descriptionstringRequired within parentDescription of the transaction
expense_idJSONOptional
expense_id (anyOf 1)stringAlternativeThe expense ID related to the card transaction.
expense_id (anyOf 2)nullAlternative
idstringRequired within parent
initiated_at_datestringRequired within parentISO 8601 date string
Format: date
merchantJSONOptional
merchant (anyOf 1)JSONAlternative
merchant (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an expense — response body — merchant country, mcc, raw descriptor country, mcc, raw descriptor
merchant (anyOf 2)nullAlternative
posted_at_datestringRequired within parentISO 8601 date string
Format: date
typeJSONOptional
type (anyOf 1)JSONAlternative
type (anyOf 1) (allOf 1)stringAll variants applyKnown values: PURCHASE, REFUND, CHARGEBACK, REWARDS_CREDIT, COLLECTION, BNPL_FEE
type (anyOf 2)nullAlternative

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
FieldTypePresenceDescription and constraints
$objectRoot
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.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeThe 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencyJSONOptional
currency (anyOf 1)stringAlternativeThe type of currency, in ISO 4217 format.
Default: USD
currency (anyOf 2)nullAlternative
Get an expense — response body — merchant country, mcc, raw descriptor country, mcc, raw descriptor
FieldTypePresenceDescription and constraints
$objectRoot
countrystringRequired within parentMerchant's country, in ISO 3166-1 alpha-3 format.
mccstringRequired within parentA 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_descriptorstringRequired within parentMerchant descriptor, it can be the merchant name.

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"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.