TransactionsComponents
Defined in: src/transactions/types.gen.ts:166
Properties
Section titled “Properties”headers
Section titled “headers”headers:
never
Defined in: src/transactions/types.gen.ts:333
parameters
Section titled “parameters”parameters:
never
Defined in: src/transactions/types.gen.ts:331
pathItems
Section titled “pathItems”pathItems:
never
Defined in: src/transactions/types.gen.ts:334
requestBodies
Section titled “requestBodies”requestBodies:
never
Defined in: src/transactions/types.gen.ts:332
responses
Section titled “responses”responses:
never
Defined in: src/transactions/types.gen.ts:330
schemas
Section titled “schemas”schemas:
object
Defined in: src/transactions/types.gen.ts:167
CardAccount
Section titled “CardAccount”CardAccount:
object
CardAccount.account_limit?
Section titled “CardAccount.account_limit?”
optionalaccount_limit?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
CardAccount.available_balance?
Section titled “CardAccount.available_balance?”
optionalavailable_balance?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
CardAccount.current_balance?
Section titled “CardAccount.current_balance?”
optionalcurrent_balance?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
CardAccount.current_statement_period
Section titled “CardAccount.current_statement_period”current_statement_period:
object
CardAccount.current_statement_period.end_date
Section titled “CardAccount.current_statement_period.end_date”end_date:
string
Format: date
Description
Section titled “Description”End date of the statement period at UTC 00:00:00 (exclusive)
CardAccount.current_statement_period.start_date
Section titled “CardAccount.current_statement_period.start_date”start_date:
string
Format: date
Description
Section titled “Description”Start date of the statement period at UTC 00:00:00 (inclusive)
CardAccount.id
Section titled “CardAccount.id”id:
string
Description
Section titled “Description”ID of the card account
CardAccount.status?
Section titled “CardAccount.status?”
optionalstatus?:"ACTIVE"|null
CardTransaction
Section titled “CardTransaction”CardTransaction:
object
CardTransaction.amount
Section titled “CardTransaction.amount”amount:
object
CardTransaction.amount.amount
Section titled “CardTransaction.amount.amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700CardTransaction.amount.currency
Section titled “CardTransaction.amount.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDCardTransaction.card_id?
Section titled “CardTransaction.card_id?”
optionalcard_id?:string|null
Description
Section titled “Description”ID of the card used for the transaction. Null when type is REWARDS_CREDIT or COLLECTION.
CardTransaction.card_metadata?
Section titled “CardTransaction.card_metadata?”
optionalcard_metadata?: {[key:string]:string; } |null
Description
Section titled “Description”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.
CardTransaction.card_transaction_operation_reference_id?
Section titled “CardTransaction.card_transaction_operation_reference_id?”
optionalcard_transaction_operation_reference_id?:string|null
Description
Section titled “Description”The card transaction operation reference ID. Null when type is REWARDS_CREDIT, COLLECTION, or BNPL_FEE.
CardTransaction.description
Section titled “CardTransaction.description”description:
string
Description
Section titled “Description”Description of the transaction
CardTransaction.expense_id?
Section titled “CardTransaction.expense_id?”
optionalexpense_id?:string|null
Description
Section titled “Description”The expense ID related to the card transaction.
CardTransaction.id
Section titled “CardTransaction.id”id:
string
CardTransaction.initiated_at_date
Section titled “CardTransaction.initiated_at_date”initiated_at_date:
string
Format: date
Description
Section titled “Description”ISO 8601 date string
CardTransaction.merchant?
Section titled “CardTransaction.merchant?”
optionalmerchant?: {country:string;mcc:string;raw_descriptor:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ country: string; mcc: string; raw_descriptor: string; }
country
Section titled “country”country:
string
Description
Section titled “Description”Merchant’s country, in ISO 3166-1 alpha-3 format.
mcc:
string
Description
Section titled “Description”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
Section titled “raw_descriptor”raw_descriptor:
string
Description
Section titled “Description”Merchant descriptor, it can be the merchant name.
null
CardTransaction.posted_at_date
Section titled “CardTransaction.posted_at_date”posted_at_date:
string
Format: date
Description
Section titled “Description”ISO 8601 date string
CardTransaction.type?
Section titled “CardTransaction.type?”
optionaltype?:"PURCHASE"|"REFUND"|"CHARGEBACK"|"REWARDS_CREDIT"|"COLLECTION"|"BNPL_FEE"|null
CardTransactionType
Section titled “CardTransactionType”CardTransactionType:
"PURCHASE"|"REFUND"|"CHARGEBACK"|"REWARDS_CREDIT"|"COLLECTION"|"BNPL_FEE"
CashAccount
Section titled “CashAccount”CashAccount:
object
CashAccount.account_number
Section titled “CashAccount.account_number”account_number:
string
CashAccount.available_balance
Section titled “CashAccount.available_balance”available_balance:
object
CashAccount.available_balance.amount
Section titled “CashAccount.available_balance.amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700CashAccount.available_balance.currency
Section titled “CashAccount.available_balance.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDCashAccount.current_balance
Section titled “CashAccount.current_balance”current_balance:
object
CashAccount.current_balance.amount
Section titled “CashAccount.current_balance.amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700CashAccount.current_balance.currency
Section titled “CashAccount.current_balance.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDCashAccount.id
Section titled “CashAccount.id”id:
string
Description
Section titled “Description”ID of the cash account
CashAccount.name
Section titled “CashAccount.name”name:
string
CashAccount.primary
Section titled “CashAccount.primary”primary:
boolean
Description
Section titled “Description”Whether or not this account is the primary account. There will always be only one primary account.
CashAccount.routing_number
Section titled “CashAccount.routing_number”routing_number:
string
CashAccount.status?
Section titled “CashAccount.status?”
optionalstatus?:"ACTIVE"|null
CashTransaction
Section titled “CashTransaction”CashTransaction:
object
CashTransaction.amount?
Section titled “CashTransaction.amount?”
optionalamount?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
CashTransaction.description
Section titled “CashTransaction.description”description:
string
Description
Section titled “Description”Description of the transaction
CashTransaction.id
Section titled “CashTransaction.id”id:
string
CashTransaction.initiated_at_date
Section titled “CashTransaction.initiated_at_date”initiated_at_date:
string
Format: date
Description
Section titled “Description”ISO 8601 date of when the payment is initiated
CashTransaction.posted_at_date
Section titled “CashTransaction.posted_at_date”posted_at_date:
string
Format: date
Description
Section titled “Description”ISO 8601 date of when the payment is posted
CashTransaction.transfer_id?
Section titled “CashTransaction.transfer_id?”
optionaltransfer_id?:string|null
Description
Section titled “Description”Transfer ID to fetch additional metadata about the transaction using https://developer.brex.com/openapi/payments_api/#operation/getTransfersById
CashTransaction.type?
Section titled “CashTransaction.type?”
optionaltype?:"BOOK_TRANSFER"|"STABLECOIN"|"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"|"CRYPTO_BRIDGE"|"TRANSACTION_FEES_COLLECTION"|"PAYBACK"|null
CashTransactionType
Section titled “CashTransactionType”CashTransactionType:
"BOOK_TRANSFER"|"STABLECOIN"|"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"|"CRYPTO_BRIDGE"|"TRANSACTION_FEES_COLLECTION"|"PAYBACK"
Merchant
Section titled “Merchant”Merchant:
object
Merchant.country
Section titled “Merchant.country”country:
string
Description
Section titled “Description”Merchant’s country, in ISO 3166-1 alpha-3 format.
Merchant.mcc
Section titled “Merchant.mcc”mcc:
string
Description
Section titled “Description”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.
Merchant.raw_descriptor
Section titled “Merchant.raw_descriptor”raw_descriptor:
string
Description
Section titled “Description”Merchant descriptor, it can be the merchant name.
Money:
object
Description
Section titled “Description”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.
Money.amount
Section titled “Money.amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700Money.currency
Section titled “Money.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDPage_CardTransaction_
Section titled “Page_CardTransaction_”Page_CardTransaction_:
object
Page_CardTransaction_.items
Section titled “Page_CardTransaction_.items”items:
object[]
Page_CardTransaction_.next_cursor?
Section titled “Page_CardTransaction_.next_cursor?”
optionalnext_cursor?:string|null
Page_CashAccount_
Section titled “Page_CashAccount_”Page_CashAccount_:
object
Page_CashAccount_.items
Section titled “Page_CashAccount_.items”items:
object[]
Page_CashAccount_.next_cursor?
Section titled “Page_CashAccount_.next_cursor?”
optionalnext_cursor?:string|null
Page_CashTransaction_
Section titled “Page_CashTransaction_”Page_CashTransaction_:
object
Page_CashTransaction_.items
Section titled “Page_CashTransaction_.items”items:
object[]
Page_CashTransaction_.next_cursor?
Section titled “Page_CashTransaction_.next_cursor?”
optionalnext_cursor?:string|null
Page_Statement_
Section titled “Page_Statement_”Page_Statement_:
object
Page_Statement_.items
Section titled “Page_Statement_.items”items:
object[]
Page_Statement_.next_cursor?
Section titled “Page_Statement_.next_cursor?”
optionalnext_cursor?:string|null
Statement
Section titled “Statement”Statement:
object
Statement.end_balance?
Section titled “Statement.end_balance?”
optionalend_balance?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
Statement.id
Section titled “Statement.id”id:
string
Statement.period
Section titled “Statement.period”period:
object
Statement.period.end_date
Section titled “Statement.period.end_date”end_date:
string
Format: date
Description
Section titled “Description”End date of the statement period at UTC 00:00:00 (exclusive)
Statement.period.start_date
Section titled “Statement.period.start_date”start_date:
string
Format: date
Description
Section titled “Description”Start date of the statement period at UTC 00:00:00 (inclusive)
Statement.start_balance?
Section titled “Statement.start_balance?”
optionalstart_balance?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
StatementPeriod
Section titled “StatementPeriod”StatementPeriod:
object
StatementPeriod.end_date
Section titled “StatementPeriod.end_date”end_date:
string
Format: date
Description
Section titled “Description”End date of the statement period at UTC 00:00:00 (exclusive)
StatementPeriod.start_date
Section titled “StatementPeriod.start_date”start_date:
string
Format: date
Description
Section titled “Description”Start date of the statement period at UTC 00:00:00 (inclusive)
Status
Section titled “Status”Status:
"ACTIVE"