Brex: Transactions schemas
10 Brex schemas with complete fields and constraints.
← Transactions operations · All schemas
Get cash account by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_number | string | Required within parent | |
available_balance | Model | Required within parent | Expand Get transfer — response body — amount |
current_balance | Model | Required within parent | Expand Get transfer — response body — amount |
id | string | Required within parent | ID of the cash account |
name | string | Required within parent | |
primary | boolean | Required within parent | Whether or not this account is the primary account. There will always be only one primary account. |
routing_number | string | Required within parent | |
status | JSON | Optional | |
status (anyOf 1) | JSON | Alternative | |
status (anyOf 1) (allOf 1) | string | All variants apply | Known values: ACTIVE |
status (anyOf 2) | null | Alternative |
Referenced models: Get transfer — response body — amount
List card accounts — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_limit | JSON | Optional | |
account_limit (anyOf 1) | JSON | Alternative | |
account_limit (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
account_limit (anyOf 2) | null | Alternative | |
available_balance | JSON | Optional | |
available_balance (anyOf 1) | JSON | Alternative | |
available_balance (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
available_balance (anyOf 2) | null | Alternative | |
current_balance | JSON | Optional | |
current_balance (anyOf 1) | JSON | Alternative | |
current_balance (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
current_balance (anyOf 2) | null | Alternative | |
current_statement_period | Model | Required within parent | Expand List card accounts — response body — item current statement period |
id | string | Required within parent | ID of the card account |
status | JSON | Optional | |
status (anyOf 1) | JSON | Alternative | |
status (anyOf 1) (allOf 1) | string | All variants apply | Known values: ACTIVE |
status (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_date | string | Required within parent | End date of the statement period at UTC 00:00:00 (exclusive) Format: date |
start_date | string | Required within parent | Start date of the statement period at UTC 00:00:00 (inclusive) Format: date |
List cash account statements — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand List cash account statements — response body — items item |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: List cash account statements — response body — items item
List cash account statements — response body — items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_balance | JSON | Optional | |
end_balance (anyOf 1) | JSON | Alternative | |
end_balance (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
end_balance (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
period | Model | Required within parent | Expand List card accounts — response body — item current statement period |
start_balance | JSON | Optional | |
start_balance (anyOf 1) | JSON | Alternative | |
start_balance (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
start_balance (anyOf 2) | null | Alternative |
Referenced models: Get transfer — response body — amount, List card accounts — response body — item current statement period
List cash accounts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get cash account by ID — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get cash account by ID — response body
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
List transactions for the selected cash account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand List transactions for the selected cash account — 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 the selected cash account — response body — items item
List transactions for the selected cash account — response body — items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Optional | |
amount (anyOf 1) | JSON | Alternative | |
amount (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
amount (anyOf 2) | null | Alternative | |
description | string | Required within parent | Description of the transaction |
id | string | Required within parent | |
initiated_at_date | string | Required within parent | ISO 8601 date of when the payment is initiated Format: date |
posted_at_date | string | Required within parent | ISO 8601 date of when the payment is posted Format: date |
transfer_id | JSON | Optional | |
transfer_id (anyOf 1) | string | Alternative | Transfer ID to fetch additional metadata about the transaction using `https://developer.brex.com/openapi/payments_api/#operation/getTransfersById` |
transfer_id (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | JSON | Alternative | |
type (anyOf 1) (allOf 1) | string | All variants apply | Known 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) | null | Alternative |
Referenced models: Get transfer — response body — amount