--- title: TransactionsComponents editUrl: false head: [] template: doc prev: false next: false sidebar: hidden: false attrs: {} pagefind: true draft: false --- Defined in: [src/transactions/types.gen.ts:166](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L166) ## Properties ### headers > **headers**: `never` Defined in: [src/transactions/types.gen.ts:333](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L333) *** ### parameters > **parameters**: `never` Defined in: [src/transactions/types.gen.ts:331](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L331) *** ### pathItems > **pathItems**: `never` Defined in: [src/transactions/types.gen.ts:334](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L334) *** ### requestBodies > **requestBodies**: `never` Defined in: [src/transactions/types.gen.ts:332](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L332) *** ### responses > **responses**: `never` Defined in: [src/transactions/types.gen.ts:330](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L330) *** ### schemas > **schemas**: `object` Defined in: [src/transactions/types.gen.ts:167](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/transactions/types.gen.ts#L167) #### CardAccount > **CardAccount**: `object` ##### CardAccount.account\_limit? > `optional` **account\_limit?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### 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 ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### CardAccount.available\_balance? > `optional` **available\_balance?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### 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 ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### CardAccount.current\_balance? > `optional` **current\_balance?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### 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 ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### CardAccount.current\_statement\_period > **current\_statement\_period**: `object` ##### CardAccount.current\_statement\_period.end\_date > **end\_date**: `string` Format: date ###### Description End date of the statement period at UTC 00:00:00 (exclusive) ##### CardAccount.current\_statement\_period.start\_date > **start\_date**: `string` Format: date ###### Description Start date of the statement period at UTC 00:00:00 (inclusive) ##### CardAccount.id > **id**: `string` ###### Description ID of the card account ##### CardAccount.status? > `optional` **status?**: `"ACTIVE"` \| `null` #### CardTransaction > **CardTransaction**: `object` ##### CardTransaction.amount > **amount**: `object` ##### CardTransaction.amount.amount > **amount**: `number` Format: int64 ###### 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 ```ts 700 ``` ##### CardTransaction.amount.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### CardTransaction.card\_id? > `optional` **card\_id?**: `string` \| `null` ###### Description ID of the card used for the transaction. Null when type is REWARDS_CREDIT or COLLECTION. ##### CardTransaction.card\_metadata? > `optional` **card\_metadata?**: \{\[`key`: `string`\]: `string`; \} \| `null` ###### 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? > `optional` **card\_transaction\_operation\_reference\_id?**: `string` \| `null` ###### Description The card transaction operation reference ID. Null when type is REWARDS_CREDIT, COLLECTION, or BNPL_FEE. ##### CardTransaction.description > **description**: `string` ###### Description Description of the transaction ##### CardTransaction.expense\_id? > `optional` **expense\_id?**: `string` \| `null` ###### Description The expense ID related to the card transaction. ##### CardTransaction.id > **id**: `string` ##### CardTransaction.initiated\_at\_date > **initiated\_at\_date**: `string` Format: date ###### Description ISO 8601 date string ##### CardTransaction.merchant? > `optional` **merchant?**: \{ `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; \} \| `null` ###### Union Members ###### Type Literal \{ `country`: `string`; `mcc`: `string`; `raw_descriptor`: `string`; \} ###### country > **country**: `string` ###### Description Merchant's country, in ISO 3166-1 alpha-3 format. ###### mcc > **mcc**: `string` ###### 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 > **raw\_descriptor**: `string` ###### Description Merchant descriptor, it can be the merchant name. *** `null` ##### CardTransaction.posted\_at\_date > **posted\_at\_date**: `string` Format: date ###### Description ISO 8601 date string ##### CardTransaction.type? > `optional` **type?**: `"PURCHASE"` \| `"REFUND"` \| `"CHARGEBACK"` \| `"REWARDS_CREDIT"` \| `"COLLECTION"` \| `"BNPL_FEE"` \| `null` #### CardTransactionType > **CardTransactionType**: `"PURCHASE"` \| `"REFUND"` \| `"CHARGEBACK"` \| `"REWARDS_CREDIT"` \| `"COLLECTION"` \| `"BNPL_FEE"` #### CashAccount > **CashAccount**: `object` ##### CashAccount.account\_number > **account\_number**: `string` ##### CashAccount.available\_balance > **available\_balance**: `object` ##### CashAccount.available\_balance.amount > **amount**: `number` Format: int64 ###### 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 ```ts 700 ``` ##### CashAccount.available\_balance.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### CashAccount.current\_balance > **current\_balance**: `object` ##### CashAccount.current\_balance.amount > **amount**: `number` Format: int64 ###### 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 ```ts 700 ``` ##### CashAccount.current\_balance.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### CashAccount.id > **id**: `string` ###### Description ID of the cash account ##### CashAccount.name > **name**: `string` ##### CashAccount.primary > **primary**: `boolean` ###### Description Whether or not this account is the primary account. There will always be only one primary account. ##### CashAccount.routing\_number > **routing\_number**: `string` ##### CashAccount.status? > `optional` **status?**: `"ACTIVE"` \| `null` #### CashTransaction > **CashTransaction**: `object` ##### CashTransaction.amount? > `optional` **amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### 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 ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### CashTransaction.description > **description**: `string` ###### Description Description of the transaction ##### CashTransaction.id > **id**: `string` ##### CashTransaction.initiated\_at\_date > **initiated\_at\_date**: `string` Format: date ###### Description ISO 8601 date of when the payment is initiated ##### CashTransaction.posted\_at\_date > **posted\_at\_date**: `string` Format: date ###### Description ISO 8601 date of when the payment is posted ##### CashTransaction.transfer\_id? > `optional` **transfer\_id?**: `string` \| `null` ###### Description Transfer ID to fetch additional metadata about the transaction using `https://developer.brex.com/openapi/payments_api/#operation/getTransfersById` ##### CashTransaction.type? > `optional` **type?**: `"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 > **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 > **Merchant**: `object` ##### Merchant.country > **country**: `string` ###### Description Merchant's country, in ISO 3166-1 alpha-3 format. ##### Merchant.mcc > **mcc**: `string` ###### 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 > **raw\_descriptor**: `string` ###### Description Merchant descriptor, it can be the merchant name. #### Money > **Money**: `object` ##### 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 > **amount**: `number` Format: int64 ###### 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 ```ts 700 ``` ##### Money.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` #### Page\_CardTransaction\_ > **Page\_CardTransaction\_**: `object` ##### Page\_CardTransaction\_.items > **items**: `object`[] ##### Page\_CardTransaction\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_CashAccount\_ > **Page\_CashAccount\_**: `object` ##### Page\_CashAccount\_.items > **items**: `object`[] ##### Page\_CashAccount\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_CashTransaction\_ > **Page\_CashTransaction\_**: `object` ##### Page\_CashTransaction\_.items > **items**: `object`[] ##### Page\_CashTransaction\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_Statement\_ > **Page\_Statement\_**: `object` ##### Page\_Statement\_.items > **items**: `object`[] ##### Page\_Statement\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Statement > **Statement**: `object` ##### Statement.end\_balance? > `optional` **end\_balance?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### 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 ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ##### Statement.id > **id**: `string` ##### Statement.period > **period**: `object` ##### Statement.period.end\_date > **end\_date**: `string` Format: date ###### Description End date of the statement period at UTC 00:00:00 (exclusive) ##### Statement.period.start\_date > **start\_date**: `string` Format: date ###### Description Start date of the statement period at UTC 00:00:00 (inclusive) ##### Statement.start\_balance? > `optional` **start\_balance?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### 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 ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` #### StatementPeriod > **StatementPeriod**: `object` ##### StatementPeriod.end\_date > **end\_date**: `string` Format: date ###### Description End date of the statement period at UTC 00:00:00 (exclusive) ##### StatementPeriod.start\_date > **start\_date**: `string` Format: date ###### Description Start date of the statement period at UTC 00:00:00 (inclusive) #### Status > **Status**: `"ACTIVE"`