Skip to content

Brex: Transactions schemas

10 Brex schemas with complete fields and constraints.

← Transactions operations · All schemas

Get cash account by ID — response body

FieldTypePresenceDescription and constraints
$objectRoot
account_numberstringRequired within parent
available_balanceModelRequired within parentExpand Get transfer — response body — amount
current_balanceModelRequired within parentExpand Get transfer — response body — amount
idstringRequired within parentID of the cash account
namestringRequired within parent
primarybooleanRequired within parentWhether or not this account is the primary account. There will always be only one primary account.
routing_numberstringRequired within parent
statusJSONOptional
status (anyOf 1)JSONAlternative
status (anyOf 1) (allOf 1)stringAll variants applyKnown values: ACTIVE
status (anyOf 2)nullAlternative

Referenced models: Get transfer — response body — amount

List card accounts — response body — item

FieldTypePresenceDescription and constraints
$objectRoot
account_limitJSONOptional
account_limit (anyOf 1)JSONAlternative
account_limit (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
account_limit (anyOf 2)nullAlternative
available_balanceJSONOptional
available_balance (anyOf 1)JSONAlternative
available_balance (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
available_balance (anyOf 2)nullAlternative
current_balanceJSONOptional
current_balance (anyOf 1)JSONAlternative
current_balance (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
current_balance (anyOf 2)nullAlternative
current_statement_periodModelRequired within parentExpand List card accounts — response body — item current statement period
idstringRequired within parentID of the card account
statusJSONOptional
status (anyOf 1)JSONAlternative
status (anyOf 1) (allOf 1)stringAll variants applyKnown values: ACTIVE
status (anyOf 2)nullAlternative

Referenced models: Get transfer — response body — amount, List card accounts — response body — item current statement period

List card accounts — response body — item current statement period

FieldTypePresenceDescription and constraints
$objectRoot
end_datestringRequired within parentEnd date of the statement period at UTC 00:00:00 (exclusive)
Format: date
start_datestringRequired within parentStart date of the statement period at UTC 00:00:00 (inclusive)
Format: date

List cash account statements — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand List cash account statements — response body — items item
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: List cash account statements — response body — items item

List cash account statements — response body — items item

FieldTypePresenceDescription and constraints
$objectRoot
end_balanceJSONOptional
end_balance (anyOf 1)JSONAlternative
end_balance (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
end_balance (anyOf 2)nullAlternative
idstringRequired within parent
periodModelRequired within parentExpand List card accounts — response body — item current statement period
start_balanceJSONOptional
start_balance (anyOf 1)JSONAlternative
start_balance (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
start_balance (anyOf 2)nullAlternative

Referenced models: Get transfer — response body — amount, List card accounts — response body — item current statement period

List cash accounts — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get cash account by ID — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get cash account by ID — 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

List transactions for the selected cash account — response body

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

Referenced models: List transactions for the selected cash account — response body — items item

List transactions for the selected cash account — response body — items item

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONOptional
amount (anyOf 1)JSONAlternative
amount (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
amount (anyOf 2)nullAlternative
descriptionstringRequired within parentDescription of the transaction
idstringRequired within parent
initiated_at_datestringRequired within parentISO 8601 date of when the payment is initiated
Format: date
posted_at_datestringRequired within parentISO 8601 date of when the payment is posted
Format: date
transfer_idJSONOptional
transfer_id (anyOf 1)stringAlternativeTransfer ID to fetch additional metadata about the transaction using `https://developer.brex.com/openapi/payments_api/#operation/getTransfersById`
transfer_id (anyOf 2)nullAlternative
typeJSONOptional
type (anyOf 1)JSONAlternative
type (anyOf 1) (allOf 1)stringAll variants applyKnown values: PAYMENT, DIVIDEND, FEE, ADJUSTMENT, INTEREST, CARD_COLLECTION, REWARDS_REDEMPTION, RECEIVABLES_OFFERS_ADVANCE, FBO_TRANSFER, RECEIVABLES_OFFERS_REPAYMENT, RECEIVABLES_OFFERS_COLLECTION, BREX_OPERATIONAL_TRANSFER, INTRA_CUSTOMER_ACCOUNT_BOOK_TRANSFER, BOOK_TRANSFER, CRYPTO_BRIDGE, STABLECOIN, TRANSACTION_FEES_COLLECTION, PAYBACK
type (anyOf 2)nullAlternative

Referenced models: Get transfer — response body — amount

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.