--- title: PaymentsComponents editUrl: false head: [] template: doc prev: false next: false sidebar: hidden: false attrs: {} pagefind: true draft: false --- Defined in: [src/payments/types.gen.ts:181](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L181) ## Properties ### headers > **headers**: `never` Defined in: [src/payments/types.gen.ts:715](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L715) *** ### parameters > **parameters**: `never` Defined in: [src/payments/types.gen.ts:713](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L713) *** ### pathItems > **pathItems**: `never` Defined in: [src/payments/types.gen.ts:716](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L716) *** ### requestBodies > **requestBodies**: `never` Defined in: [src/payments/types.gen.ts:714](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L714) *** ### responses > **responses**: `never` Defined in: [src/payments/types.gen.ts:712](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L712) *** ### schemas > **schemas**: `object` Defined in: [src/payments/types.gen.ts:182](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/payments/types.gen.ts#L182) #### AccountClass > **AccountClass**: `"BUSINESS"` \| `"PERSONAL"` #### AccountType > **AccountType**: `"CHECKING"` \| `"SAVING"` #### ACHDetailsRequest > **ACHDetailsRequest**: `object` & `object` ##### Type Declaration ###### account\_class > **account\_class**: `"BUSINESS"` \| `"PERSONAL"` ###### account\_number > **account\_number**: `string` ###### account\_type > **account\_type**: `"CHECKING"` \| `"SAVING"` ###### beneficiary\_name? > `optional` **beneficiary\_name?**: `string` \| `null` ###### routing\_number > **routing\_number**: `string` ###### Description The routing number must follow proper format. ###### type > **type**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` ##### Type Declaration ###### type > **type**: `"ACH"` ###### Description discriminator enum property added by openapi-typescript #### ACHDetailsResponse > **ACHDetailsResponse**: `object` & `object` ##### Type Declaration ###### account\_class? > `optional` **account\_class?**: `"BUSINESS"` \| `"PERSONAL"` \| `null` ###### account\_number > **account\_number**: `string` ###### account\_type? > `optional` **account\_type?**: `"CHECKING"` \| `"SAVING"` \| `null` ###### payment\_instrument\_id > **payment\_instrument\_id**: `string` ###### Description Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. ###### routing\_number > **routing\_number**: `string` ###### type > **type**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` \| `"INTERNATIONAL_WIRE"` ##### Type Declaration ###### type > **type**: `"ACH"` ###### Description discriminator enum property added by openapi-typescript #### Address > **Address**: `object` ##### Description Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed). ##### Address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ##### Address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ##### Address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ##### Address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ##### Address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ##### Address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ##### Address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. #### ApprovalType > **ApprovalType**: `"MANUAL"` ##### Description Specifies the approval type for the transaction. `MANUAL` requires a cash admin to approve the transaction before disbursing funds. When not set, the default policy will apply. #### Balance > **Balance**: `object` ##### Balance.amount > **amount**: `object` ##### Balance.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 ``` ##### Balance.amount.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### Balance.as\_of\_date > **as\_of\_date**: `string` Format: date #### BankAccountDetailsResponse > **BankAccountDetailsResponse**: `Omit`\<`object` & `object`, `"type"`\> & `object` & `object` & `object` ##### Type Declaration ###### account\_number? > `optional` **account\_number?**: `string` \| `null` ###### Description Account number of a bank account (or IBAN code for international transfer). For incoming cheques, this field might be null. ###### beneficiary\_bank? > `optional` **beneficiary\_bank?**: \{ `address?`: \{ `city?`: `string` \| `null`; `country?`: `string` \| `null`; `line1?`: `string` \| `null`; `line2?`: `string` \| `null`; `phone_number?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `state?`: `string` \| `null`; \} \| `null`; `name?`: `string` \| `null`; \} \| `null` ###### description? > `optional` **description?**: `string` \| `null` ###### Description Description of the transfer. ###### external\_memo? > `optional` **external\_memo?**: `string` \| `null` ###### Description External Memo populated by the sender ###### fed\_reference\_number? > `optional` **fed\_reference\_number?**: `string` \| `null` ###### Description Fed reference number for incoming wires ###### routing\_number? > `optional` **routing\_number?**: `string` \| `null` ###### Description Routing number of a bank account (or SWIFT/BIC code for international transfer). For incoming cheques, this field might be null. ###### type > **type**: `"VENDOR"` \| `"BOOK_TRANSFER"` \| `"BANK_ACCOUNT"` ##### Type Declaration ###### type > **type**: `"BANK_ACCOUNT"` ###### Description discriminator enum property added by openapi-typescript ##### Type Declaration ###### type > **type**: `"BANK_ACCOUNT"` ###### Description discriminator enum property added by openapi-typescript #### BankConnection > **BankConnection**: `object` ##### BankConnection.available\_balance? > `optional` **available\_balance?**: \{ `amount`: \{ `amount`: `number`; `currency`: `string` \| `null`; \}; `as_of_date`: `string`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: \{ `amount`: `number`; `currency`: `string` \| `null`; \}; `as_of_date`: `string`; \} ###### amount > **amount**: `object` ###### 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 ``` ###### amount.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ###### as\_of\_date > **as\_of\_date**: `string` Format: date *** `null` ##### BankConnection.bank\_details > **bank\_details**: `object` ##### BankConnection.bank\_details.name > **name**: `string` ###### Description The name of the bank ##### BankConnection.bank\_details.type > **type**: `"CHECKING"` \| `"SAVING"` ##### BankConnection.brex\_account\_id? > `optional` **brex\_account\_id?**: `string` \| `null` ###### Description Brex business account ID ##### BankConnection.current\_balance? > `optional` **current\_balance?**: \{ `amount`: \{ `amount`: `number`; `currency`: `string` \| `null`; \}; `as_of_date`: `string`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: \{ `amount`: `number`; `currency`: `string` \| `null`; \}; `as_of_date`: `string`; \} ###### amount > **amount**: `object` ###### 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 ``` ###### amount.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ###### as\_of\_date > **as\_of\_date**: `string` Format: date *** `null` ##### BankConnection.id > **id**: `string` ##### BankConnection.last\_four > **last\_four**: `string` #### BankDetails > **BankDetails**: `object` ##### BankDetails.name > **name**: `string` ###### Description The name of the bank ##### BankDetails.type > **type**: `"CHECKING"` \| `"SAVING"` #### BankType > **BankType**: `"CHECKING"` \| `"SAVING"` #### BeneficiaryBank > **BeneficiaryBank**: `object` ##### BeneficiaryBank.address? > `optional` **address?**: \{ `city?`: `string` \| `null`; `country?`: `string` \| `null`; `line1?`: `string` \| `null`; `line2?`: `string` \| `null`; `phone_number?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `state?`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `city?`: `string` \| `null`; `country?`: `string` \| `null`; `line1?`: `string` \| `null`; `line2?`: `string` \| `null`; `phone_number?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `state?`: `string` \| `null`; \} ###### city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### BeneficiaryBank.name? > `optional` **name?**: `string` \| `null` #### BookTransferDetails > **BookTransferDetails**: `object` & `object` ##### Type Declaration ###### recipient > **recipient**: `object` ###### recipient.id > **id**: `string` ###### recipient.type > **type**: `"ACCOUNT_ID"` \| `"PAYMENT_INSTRUMENT_ID"` ###### type > **type**: `"VENDOR"` \| `"BOOK_TRANSFER"` ##### Type Declaration ###### type > **type**: `"BOOK_TRANSFER"` ###### Description discriminator enum property added by openapi-typescript #### BookTransferDetailsResponse > **BookTransferDetailsResponse**: `Omit`\<`object` & `object`, `"type"`\> & `object` & `object` & `object` ##### Type Declaration ###### deposit\_account\_id > **deposit\_account\_id**: `string` ###### Description This feature is currently limited to certain customers, please reach out if you are interested ###### type > **type**: `"VENDOR"` \| `"BOOK_TRANSFER"` \| `"BANK_ACCOUNT"` ##### Type Declaration ###### type > **type**: `"BOOK_TRANSFER"` ###### Description discriminator enum property added by openapi-typescript ##### Type Declaration ###### type > **type**: `"BOOK_TRANSFER"` ###### Description discriminator enum property added by openapi-typescript #### BrexCashAccountDetails > **BrexCashAccountDetails**: `object` & `object` ##### Type Declaration ###### id > **id**: `string` ###### Description ID of the Brex Business account: Can be found from the `/accounts` endpoint where instrument type is `CASH`. ###### type > **type**: `"BREX_CASH"` ##### Type Declaration ###### type > **type**: `"BREX_CASH"` ###### Description discriminator enum property added by openapi-typescript #### BrexCashAccountDetailsResponse > **BrexCashAccountDetailsResponse**: `object` & `object` ##### Type Declaration ###### id > **id**: `string` ###### Description ID of the Brex Business account. ###### type > **type**: `"BREX_CASH"` ##### Type Declaration ###### type > **type**: `"BREX_CASH"` ###### Description discriminator enum property added by openapi-typescript #### BrexCashDetails > **BrexCashDetails**: `object` & `object` ##### Type Declaration ###### id > **id**: `string` ###### Description ID of the Brex business account: Can be found from the [List business accounts](/openapi/transactions_api/#operation/listAccounts) endpoint ###### type > **type**: `"BREX_CASH"` ##### Type Declaration ###### type > **type**: `"BREX_CASH"` ###### Description discriminator enum property added by openapi-typescript #### ChequeDetailsRequest > **ChequeDetailsRequest**: `object` & `object` ##### Type Declaration ###### beneficiary\_name? > `optional` **beneficiary\_name?**: `string` \| `null` ###### mailing\_address > **mailing\_address**: `object` ###### mailing\_address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### mailing\_address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### mailing\_address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### mailing\_address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### mailing\_address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### mailing\_address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### mailing\_address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### recipient\_name > **recipient\_name**: `string` ###### type > **type**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` ##### Type Declaration ###### type > **type**: `"CHEQUE"` ###### Description discriminator enum property added by openapi-typescript #### ChequeDetailsResponse > **ChequeDetailsResponse**: `object` & `object` ##### Type Declaration ###### mailing\_address > **mailing\_address**: `object` ###### mailing\_address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### mailing\_address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### mailing\_address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### mailing\_address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### mailing\_address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### mailing\_address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### mailing\_address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### payment\_instrument\_id > **payment\_instrument\_id**: `string` ###### Description Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. ###### recipient\_name > **recipient\_name**: `string` ###### type > **type**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` \| `"INTERNATIONAL_WIRE"` ##### Type Declaration ###### type > **type**: `"CHEQUE"` ###### Description discriminator enum property added by openapi-typescript #### CounterParty > **CounterParty**: `object` & `object` \| `object` & `object` ##### Description Counterparty Details for the transfer #### CounterPartyBankDetails > **CounterPartyBankDetails**: `object` & `object` ##### Type Declaration ###### id > **id**: `string` ###### Description The financial account id: Can be found from the [List linked accounts](/openapi/payments_api/#operation/listLinkedAccounts) endpoint ###### type > **type**: `"BANK"` ##### Type Declaration ###### type > **type**: `"BANK"` ###### Description discriminator enum property added by openapi-typescript #### CounterPartyIncomingTransfer > **CounterPartyIncomingTransfer**: `object` & `object` ##### Type Declaration ###### id > **id**: `string` ###### Description The financial account id: Can be found from the [List linked accounts](/openapi/payments_api/#operation/listLinkedAccounts) endpoint ###### type > **type**: `"BANK"` ##### Type Declaration ###### type > **type**: `"BANK"` ###### Description discriminator enum property added by openapi-typescript ##### Description Counterparty Details for the transfer #### CounterPartyIncomingTransferType > **CounterPartyIncomingTransferType**: `"BANK"` #### CounterPartyResponse > **CounterPartyResponse**: `object` & `object` ##### Type Declaration ###### account\_number? > `optional` **account\_number?**: `string` \| `null` ###### Description Account number of a bank account (or IBAN code for international transfer). ###### id > **id**: `string` ###### Description Vendor ID returned from `/vendors` endpoint ###### payment\_instrument\_id > **payment\_instrument\_id**: `string` ###### routing\_number? > `optional` **routing\_number?**: `string` \| `null` ###### Description Routing number of a bank account (or SWIFT/BIC code for international transfer). ###### type > **type**: `"VENDOR"` \| `"BOOK_TRANSFER"` \| `"BANK_ACCOUNT"` ##### Type Declaration ###### type > **type**: `"VENDOR"` ###### Description discriminator enum property added by openapi-typescript ##### Description Counterparty Details for the transfer - Currently only supports vendors that are returned in the response from the /vendors endpoint BOOK_TRANSFER is a limited feature. Please reach out if you are interested. #### CounterPartyResponseType > **CounterPartyResponseType**: `"VENDOR"` \| `"BOOK_TRANSFER"` \| `"BANK_ACCOUNT"` #### CounterPartyType > **CounterPartyType**: `"VENDOR"` \| `"BOOK_TRANSFER"` #### CreateIncomingTransferRequest > **CreateIncomingTransferRequest**: `object` ##### CreateIncomingTransferRequest.amount > **amount**: `object` ##### CreateIncomingTransferRequest.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 ``` ##### CreateIncomingTransferRequest.amount.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### CreateIncomingTransferRequest.counterparty > **counterparty**: `object` & `object` ###### Type Declaration ###### id > **id**: `string` ###### Description The financial account id: Can be found from the [List linked accounts](/openapi/payments_api/#operation/listLinkedAccounts) endpoint ###### type > **type**: `"BANK"` ###### Type Declaration ###### type > **type**: `"BANK"` ###### Description discriminator enum property added by openapi-typescript ##### CreateIncomingTransferRequest.description > **description**: `string` ###### Description Description of the transfer for internal use. Not exposed externally. ##### CreateIncomingTransferRequest.receiving\_account > **receiving\_account**: `object` & `object` ###### Type Declaration ###### id > **id**: `string` ###### Description ID of the Brex business account: Can be found from the [List business accounts](/openapi/transactions_api/#operation/listAccounts) endpoint ###### type > **type**: `"BREX_CASH"` ###### Type Declaration ###### type > **type**: `"BREX_CASH"` ###### Description discriminator enum property added by openapi-typescript #### CreateTransferRequest > **CreateTransferRequest**: `object` ##### CreateTransferRequest.amount > **amount**: `object` ##### CreateTransferRequest.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 ``` ##### CreateTransferRequest.amount.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### CreateTransferRequest.approval\_type? > `optional` **approval\_type?**: `"MANUAL"` \| `null` ##### CreateTransferRequest.counterparty > **counterparty**: `object` & `object` \| `object` & `object` ##### CreateTransferRequest.description > **description**: `string` ###### Description Description of the transfer for internal use. Not exposed externally. ##### CreateTransferRequest.external\_memo > **external\_memo**: `string` ###### Description External memo for the transfer. `Payment Instructions` for Wires and the `Entry Description` for ACH payments. Must be at most 90 characters for `ACH` and `WIRE` transactions and at most 40 characters for `CHEQUES` ##### CreateTransferRequest.is\_ppro\_enabled? > `optional` **is\_ppro\_enabled?**: `boolean` ###### Description When set to true, add Principal Protection (PPRO) to the transaction. PPRO means Brex will cover any fees charged by intemediary or receiving banks. PPRO charges will be billed separately in a monthly statement. PPRO is only available for international wire transactions. ##### CreateTransferRequest.originating\_account > **originating\_account**: `Omit`\<`object` & `object`, `"type"`\> #### CreateVendorRequest > **CreateVendorRequest**: `object` ##### CreateVendorRequest.company\_name > **company\_name**: `string` ###### Description Name for vendor. The name must be unique. ##### CreateVendorRequest.email? > `optional` **email?**: `string` \| `null` Format: email ###### Description Email for vendor. ##### CreateVendorRequest.payment\_accounts? > `optional` **payment\_accounts?**: `object`[] \| `null` ###### Description Payment accounts associated with the vendor. ##### CreateVendorRequest.phone? > `optional` **phone?**: `string` \| `null` ###### Description Phone number for vendor. #### DomesticWireDetailsRequest > **DomesticWireDetailsRequest**: `object` & `object` ##### Type Declaration ###### account\_number > **account\_number**: `string` ###### address > **address**: `object` ###### address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### beneficiary\_name? > `optional` **beneficiary\_name?**: `string` \| `null` ###### routing\_number > **routing\_number**: `string` ###### Description The routing number must follow proper format. ###### type > **type**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` ##### Type Declaration ###### type > **type**: `"DOMESTIC_WIRE"` ###### Description discriminator enum property added by openapi-typescript #### DomesticWireDetailsResponse > **DomesticWireDetailsResponse**: `object` & `object` ##### Type Declaration ###### account\_number > **account\_number**: `string` ###### address > **address**: `object` ###### address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### payment\_instrument\_id > **payment\_instrument\_id**: `string` ###### Description Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. ###### routing\_number > **routing\_number**: `string` ###### type > **type**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` \| `"INTERNATIONAL_WIRE"` ##### Type Declaration ###### type > **type**: `"DOMESTIC_WIRE"` ###### Description discriminator enum property added by openapi-typescript #### InternationalWireDetailsResponse > **InternationalWireDetailsResponse**: `object` & `object` ##### Type Declaration ###### address > **address**: `object` ###### address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. ###### beneficiary\_bank\_name? > `optional` **beneficiary\_bank\_name?**: `string` \| `null` ###### Description Name of counterparty's bank ###### iban > **iban**: `string` ###### Description Counterparty's international bank account number ###### payment\_instrument\_id > **payment\_instrument\_id**: `string` ###### Description Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. ###### swift\_code > **swift\_code**: `string` ###### Description Counterparty's `SWIFT` code ###### type > **type**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` \| `"INTERNATIONAL_WIRE"` ##### Type Declaration ###### type > **type**: `"INTERNATIONAL_WIRE"` ###### Description discriminator enum property added by openapi-typescript #### 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 ``` #### OriginatingAccount > **OriginatingAccount**: `object` & `object` ##### Type Declaration ###### id > **id**: `string` ###### Description ID of the Brex Business account: Can be found from the `/accounts` endpoint where instrument type is `CASH`. ###### type > **type**: `"BREX_CASH"` ##### Type Declaration ###### type > **type**: `"BREX_CASH"` ###### Description discriminator enum property added by openapi-typescript ##### Description Originating account details for the transfer #### OriginatingAccountResponse > **OriginatingAccountResponse**: `object` & `object` ##### Type Declaration ###### id > **id**: `string` ###### Description ID of the Brex Business account. ###### type > **type**: `"BREX_CASH"` ##### Type Declaration ###### type > **type**: `"BREX_CASH"` ###### Description discriminator enum property added by openapi-typescript ##### Description Originating account details for the transfer #### OriginatingAccountResponseType > **OriginatingAccountResponseType**: `"BREX_CASH"` #### OriginatingAccountType > **OriginatingAccountType**: `"BREX_CASH"` #### Page\_BankConnection\_ > **Page\_BankConnection\_**: `object` ##### Page\_BankConnection\_.items > **items**: `object`[] ##### Page\_BankConnection\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_Transfer\_ > **Page\_Transfer\_**: `object` ##### Page\_Transfer\_.items > **items**: `object`[] ##### Page\_Transfer\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_VendorResponse\_ > **Page\_VendorResponse\_**: `object` ##### Page\_VendorResponse\_.items > **items**: `object`[] ##### Page\_VendorResponse\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### PaymentAccountDetails > **PaymentAccountDetails**: `object` & `object` \| `object` & `object` \| `object` & `object` ##### Description Payment Instruments associated with the vendor. Each vendor can only have one payment account per payment instrument type. For instance, a vendor may have associated details for each of ACH, DOMESTIC_WIRE, and CHEQUE, but they cannot have 2 entries for ACH. If you modify a vendor's existing payment instrument type with new details, it will overwrite any previous data. #### PaymentAccountDetailsResponse > **PaymentAccountDetailsResponse**: `object` & `object` \| `object` & `object` \| `object` & `object` \| `object` & `object` #### PaymentAccountRequest > **PaymentAccountRequest**: `object` ##### PaymentAccountRequest.details > **details**: `object` & `object` \| `object` & `object` \| `object` & `object` #### PaymentAccountResponse > **PaymentAccountResponse**: `object` ##### PaymentAccountResponse.details > **details**: `object` & `object` \| `object` & `object` \| `object` & `object` \| `object` & `object` #### PaymentDetailsTypeRequest > **PaymentDetailsTypeRequest**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` #### PaymentDetailsTypeResponse > **PaymentDetailsTypeResponse**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` \| `"INTERNATIONAL_WIRE"` #### PaymentType > **PaymentType**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` \| `"INTERNATIONAL_WIRE"` \| `"BOOK_TRANSFER"` \| `"STABLECOIN"` #### ReceivingAccount > **ReceivingAccount**: `object` & `object` ##### Type Declaration ###### id > **id**: `string` ###### Description ID of the Brex business account: Can be found from the [List business accounts](/openapi/transactions_api/#operation/listAccounts) endpoint ###### type > **type**: `"BREX_CASH"` ##### Type Declaration ###### type > **type**: `"BREX_CASH"` ###### Description discriminator enum property added by openapi-typescript ##### Description Receiving account details for the transfer #### ReceivingAccountType > **ReceivingAccountType**: `"BREX_CASH"` #### Recipient > **Recipient**: `object` ##### Recipient.id > **id**: `string` ##### Recipient.type > **type**: `"ACCOUNT_ID"` \| `"PAYMENT_INSTRUMENT_ID"` #### RecipientType > **RecipientType**: `"ACCOUNT_ID"` \| `"PAYMENT_INSTRUMENT_ID"` ##### Description Specifies the type of the recipient. `ACCOUNT_ID` is the ID of a Brex Business account. `PAYMENT_INSTRUMENT_ID` is the ID of Payment Instrument of the receiving Brex account. #### Transfer > **Transfer**: `object` ##### Transfer.amount > **amount**: `object` ##### Transfer.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 ``` ##### Transfer.amount.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` ##### Transfer.cancellation\_reason? > `optional` **cancellation\_reason?**: `"USER_CANCELLED"` \| `"INSUFFICIENT_FUNDS"` \| `"APPROVAL_DENIED"` \| `"BLOCKED_BY_POSITIVE_PAY"` \| `null` ##### Transfer.counterparty? > `optional` **counterparty?**: `Omit`\<`object` & `object`, `"type"`\> \| `null` ##### Transfer.created\_at? > `optional` **created\_at?**: `string` \| `null` Format: date ###### Description Date of transfer creation ##### Transfer.creator\_user\_id? > `optional` **creator\_user\_id?**: `string` \| `null` ###### Description User ID of the transfer initiator ##### Transfer.description? > `optional` **description?**: `string` \| `null` ###### Description Description of the transfer ##### Transfer.display\_name? > `optional` **display\_name?**: `string` \| `null` ###### Description Human readable name for the transaction ##### Transfer.estimated\_delivery\_date? > `optional` **estimated\_delivery\_date?**: `string` \| `null` Format: date ###### Description Estimated delivery date for transfer ##### Transfer.external\_memo? > `optional` **external\_memo?**: `string` \| `null` ###### Description External memo for the transfer. `Payment Instructions` for Wires and the `Entry Description` for ACH payments. Must be at most 90 characters for `ACH` and `WIRE` transactions and at most 40 characters for `CHEQUES` ##### Transfer.id > **id**: `string` ###### Description Unique ID associated with the transfer ##### Transfer.is\_ppro\_enabled? > `optional` **is\_ppro\_enabled?**: `boolean` \| `null` ###### Description If Principal Protection (PPRO) is enabled ##### Transfer.originating\_account > **originating\_account**: `object` & `object` ###### Type Declaration ###### id > **id**: `string` ###### Description ID of the Brex Business account. ###### type > **type**: `"BREX_CASH"` ###### Type Declaration ###### type > **type**: `"BREX_CASH"` ###### Description discriminator enum property added by openapi-typescript ##### Transfer.payment\_type > **payment\_type**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` \| `"INTERNATIONAL_WIRE"` \| `"BOOK_TRANSFER"` \| `"STABLECOIN"` ##### Transfer.process\_date? > `optional` **process\_date?**: `string` \| `null` Format: date ###### Description Transaction processing date ##### Transfer.status > **status**: `"PROCESSING"` \| `"SCHEDULED"` \| `"PENDING_APPROVAL"` \| `"FAILED"` \| `"PROCESSED"` #### TransferCancellationReason > **TransferCancellationReason**: `"USER_CANCELLED"` \| `"INSUFFICIENT_FUNDS"` \| `"APPROVAL_DENIED"` \| `"BLOCKED_BY_POSITIVE_PAY"` ##### Description `USER_CANCELLED`: The transfer was canceled. `INSUFFICIENT_FUNDS`: The transfer could not be sent due to insufficient funds. `APPROVAL_DENIED`: The transfer was not sent because it was denied. `BLOCKED_BY_POSITIVE_PAY`: The transfer was blocked because of the ACH debit settings. #### TransferStatus > **TransferStatus**: `"PROCESSING"` \| `"SCHEDULED"` \| `"PENDING_APPROVAL"` \| `"FAILED"` \| `"PROCESSED"` ##### Description `PROCESSING`: We have started to process the sending or receiving of this transaction. `SCHEDULED`: The transaction is scheduled to enter the `PROCESSING` status. `PENDING_APPROVAL`: The transaction requires approval before it can enter the `SCHEDULED` or `PROCESSING` status. `FAILED`: A grouping of multiple terminal states that prevented the transaction from completing. This includes a a user-cancellation, approval being denied, insufficient funds, failed verifications, etc. `PROCESSED`: The money movement has been fully completed, which could mean money sent has arrived. #### UpdateVendorRequest > **UpdateVendorRequest**: `object` ##### UpdateVendorRequest.beneficiary\_name? > `optional` **beneficiary\_name?**: `string` \| `null` ###### Description Name for the Beneficiary ##### UpdateVendorRequest.company\_name? > `optional` **company\_name?**: `string` \| `null` ###### Description Name for vendor ##### UpdateVendorRequest.email? > `optional` **email?**: `string` \| `null` Format: email ###### Description Email for vendor ##### UpdateVendorRequest.payment\_accounts? > `optional` **payment\_accounts?**: `object`[] \| `null` ###### Description To update payment instruments, we require the entire payload for each payment instrument that is being updated. ##### UpdateVendorRequest.phone? > `optional` **phone?**: `string` \| `null` ###### Description Phone number for vendor #### VendorDetails > **VendorDetails**: `object` & `object` ##### Type Declaration ###### payment\_instrument\_id > **payment\_instrument\_id**: `string` ###### Description ID of the vendor's payment instrument: this will dictate the payment method and the counterparty of the transaction. The payment instrument ID is returned from the /vendors response and the type of the instrument will dictate the payment method. eg. Passing an instrument ID of type ACH will trigger an ACH payment to the associated vendor. Since a payment instrument can be updated while retaining the same payment_instrument_id, please make sure to double check the details. ###### type > **type**: `"VENDOR"` \| `"BOOK_TRANSFER"` ##### Type Declaration ###### type > **type**: `"VENDOR"` ###### Description discriminator enum property added by openapi-typescript #### VendorDetailsResponse > **VendorDetailsResponse**: `object` & `object` ##### Type Declaration ###### account\_number? > `optional` **account\_number?**: `string` \| `null` ###### Description Account number of a bank account (or IBAN code for international transfer). ###### id > **id**: `string` ###### Description Vendor ID returned from `/vendors` endpoint ###### payment\_instrument\_id > **payment\_instrument\_id**: `string` ###### routing\_number? > `optional` **routing\_number?**: `string` \| `null` ###### Description Routing number of a bank account (or SWIFT/BIC code for international transfer). ###### type > **type**: `"VENDOR"` \| `"BOOK_TRANSFER"` \| `"BANK_ACCOUNT"` ##### Type Declaration ###### type > **type**: `"VENDOR"` ###### Description discriminator enum property added by openapi-typescript #### VendorResponse > **VendorResponse**: `object` ##### VendorResponse.company\_name? > `optional` **company\_name?**: `string` \| `null` ##### VendorResponse.email? > `optional` **email?**: `string` \| `null` ##### VendorResponse.id > **id**: `string` ###### Description Vendor ID: Can be passed to /transfers endpoint to specify counterparty. ##### VendorResponse.payment\_accounts? > `optional` **payment\_accounts?**: `object`[] \| `null` ##### VendorResponse.phone? > `optional` **phone?**: `string` \| `null`