Brex: Payments schemas
40 Brex schemas with complete fields and constraints.
← Payments operations · All schemas
Create incoming transfer — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand Create transfer — request body — body amount |
counterparty | Model | Required within parent | Expand Create incoming transfer — request body — body counterparty |
description | string | Required within parent | Description of the transfer for internal use. Not exposed externally. |
receiving_account | Model | Required within parent | Expand Create incoming transfer — request body — body receiving account |
Referenced models: Create transfer — request body — body amount, Create incoming transfer — request body — body counterparty, Create incoming transfer — request body — body receiving account
Create incoming transfer — request body — body / counterparty / type: BANK
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | Counterparty Details for the transfer |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).id | string | Required within parent | The financial account id: Can be found from the [List linked accounts](/openapi/payments_api/#operation/listLinkedAccounts) endpoint |
$ (allOf 2).type | string | Required within parent | One of: BANK |
Create incoming transfer — request body — body / receiving_account / type: BREX CASH
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | Receiving account details for the transfer |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).id | string | Required within parent | ID of the Brex business account: Can be found from the [List business accounts](/openapi/transactions_api/#operation/listAccounts) endpoint |
$ (allOf 2).type | string | Required within parent | One of: BREX_CASH |
Create incoming transfer — request body — body counterparty
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Counterparty Details for the transfer discriminator: {"mapping": {"BANK": "#/components/schemas/payments__CounterPartyBankDetails"}, "propertyName": "type"} |
$ (oneOf 1) | Model | Alternative | Expand Create incoming transfer — request body — body / counterparty / type: BANK |
Referenced models: Create incoming transfer — request body — body / counterparty / type: BANK
Create incoming transfer — request body — body receiving account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Receiving account details for the transfer discriminator: {"mapping": {"BREX_CASH": "#/components/schemas/payments__BrexCashDetails"}, "propertyName": "type"} |
$ (oneOf 1) | Model | Alternative | Expand Create incoming transfer — request body — body / receiving_account / type: BREX CASH |
Referenced models: Create incoming transfer — request body — body / receiving_account / type: BREX CASH
Create transfer — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand Create transfer — request body — body amount |
approval_type | JSON | Optional | |
approval_type (anyOf 1) | JSON | Alternative | |
approval_type (anyOf 1) (allOf 1) | string | All variants apply | 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. One of: MANUAL |
approval_type (anyOf 2) | null | Alternative | |
counterparty | Model | Required within parent | Expand Create transfer — request body — body counterparty |
description | string | Required within parent | Description of the transfer for internal use. Not exposed externally. |
external_memo | string | Required within parent | 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` Maximum length: 90 |
is_ppro_enabled | boolean | Optional | 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. |
originating_account | JSON | Required within parent | |
originating_account (allOf 1) | Model | All variants apply | Expand Create transfer — request body — body originating account Originating account details for the transfer |
originating_account (allOf 2) | JSON | All variants apply | Brex originating account details. Account IDs are returned by the /accounts endpoint. This endpoint currently only supports accounts with instrument type `CASH` (Brex business accounts) Currently only USD transfers are supported and amount should be positive |
Referenced models: Create transfer — request body — body amount, Create transfer — request body — body counterparty, Create transfer — request body — body originating account Originating account details for the transfer
Create transfer — request body — body / counterparty / type: VENDOR, BOOK TRANSFER type: VENDOR, BOOK TRANSFER recipient
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
type | string | Required within parent | 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. One of: ACCOUNT_ID, PAYMENT_INSTRUMENT_ID |
Create transfer — request body — body / counterparty / type: VENDOR, BOOK TRANSFER — payments__Book Transfer Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | Counterparty Details for the transfer |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).recipient | Model | Required within parent | Expand Create transfer — request body — body / counterparty / type: VENDOR, BOOK TRANSFER type: VENDOR, BOOK TRANSFER recipient |
$ (allOf 2).type | string | Required within parent | One of: VENDOR, BOOK_TRANSFER |
Referenced models: Create transfer — request body — body / counterparty / type: VENDOR, BOOK TRANSFER type: VENDOR, BOOK TRANSFER recipient
Create transfer — request body — body / counterparty / type: VENDOR, BOOK TRANSFER — payments__Vendor Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | Counterparty Details for the transfer |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).payment_instrument_id | string | Required within parent | 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. |
$ (allOf 2).type | string | Required within parent | One of: VENDOR, BOOK_TRANSFER |
Create transfer — request body — body / originating_account / Originating account details for the transfer / type: BREX CASH
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | Originating account details for the transfer |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).id | string | Required within parent | ID of the Brex Business account: Can be found from the `/accounts` endpoint where instrument type is `CASH`. |
$ (allOf 2).type | string | Required within parent | One of: BREX_CASH |
Create transfer — request body — body amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
amount | integer | Required within parent | The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. Format: int64 |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | The type of currency, in ISO 4217 format. Default: USD |
currency (anyOf 2) | null | Alternative |
Create transfer — request body — body counterparty
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Counterparty Details for the transfer discriminator: {"mapping": {"BOOK_TRANSFER": "#/components/schemas/payments__BookTransferDetails", "VENDOR": "#/components/schemas/payments__VendorDetails"}, "propertyName": "type"} |
$ (oneOf 1) | Model | Alternative | Expand Create transfer — request body — body / counterparty / type: VENDOR, BOOK TRANSFER — payments__Vendor Details |
$ (oneOf 2) | Model | Alternative | Expand Create transfer — request body — body / counterparty / type: VENDOR, BOOK TRANSFER — payments__Book Transfer Details |
Referenced models: Create transfer — request body — body / counterparty / type: VENDOR, BOOK TRANSFER — payments__Book Transfer Details, Create transfer — request body — body / counterparty / type: VENDOR, BOOK TRANSFER — payments__Vendor Details
Create transfer — request body — body originating account Originating account details for the transfer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Originating account details for the transfer discriminator: {"mapping": {"BREX_CASH": "#/components/schemas/payments__BrexCashAccountDetails"}, "propertyName": "type"} |
$ (oneOf 1) | Model | Alternative | Expand Create transfer — request body — body / originating_account / Originating account details for the transfer / type: BREX CASH |
Referenced models: Create transfer — request body — body / originating_account / Originating account details for the transfer / type: BREX CASH
Create vendor — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
company_name | string | Required within parent | Name for vendor. The name must be unique. |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Email for vendor. Format: email |
email (anyOf 2) | null | Alternative | |
payment_accounts | JSON | Optional | |
payment_accounts (anyOf 1) | array | Alternative | Payment accounts associated with the vendor. |
payment_accounts (anyOf 1)[] | Model | Each item | Expand Update vendor — request body — body payment accounts array item |
payment_accounts (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Phone number for vendor. |
phone (anyOf 2) | null | Alternative |
Referenced models: Update vendor — request body — body payment accounts array item
Get transfer — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand Get transfer — response body — amount |
cancellation_reason | JSON | Optional | |
cancellation_reason (anyOf 1) | JSON | Alternative | |
cancellation_reason (anyOf 1) (allOf 1) | string | All variants apply | `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. Known values: USER_CANCELLED, INSUFFICIENT_FUNDS, APPROVAL_DENIED, BLOCKED_BY_POSITIVE_PAY |
cancellation_reason (anyOf 2) | null | Alternative | |
counterparty | JSON | Optional | |
counterparty (anyOf 1) | JSON | Alternative | |
counterparty (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — counterparty object object |
counterparty (anyOf 2) | null | Alternative | |
created_at | JSON | Optional | |
created_at (anyOf 1) | string | Alternative | Date of transfer creation Format: date |
created_at (anyOf 2) | null | Alternative | |
creator_user_id | JSON | Optional | |
creator_user_id (anyOf 1) | string | Alternative | User ID of the transfer initiator |
creator_user_id (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the transfer |
description (anyOf 2) | null | Alternative | |
display_name | JSON | Optional | |
display_name (anyOf 1) | string | Alternative | Human readable name for the transaction |
display_name (anyOf 2) | null | Alternative | |
estimated_delivery_date | JSON | Optional | |
estimated_delivery_date (anyOf 1) | string | Alternative | Estimated delivery date for transfer Format: date |
estimated_delivery_date (anyOf 2) | null | Alternative | |
external_memo | JSON | Optional | |
external_memo (anyOf 1) | string | Alternative | 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` Maximum length: 90 |
external_memo (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique ID associated with the transfer |
imad | JSON | Optional | |
imad (anyOf 1) | string | Alternative | IMAD (Input Message Accountability Data) of the wire |
imad (anyOf 2) | null | Alternative | |
is_ppro_enabled | JSON | Optional | |
is_ppro_enabled (anyOf 1) | boolean | Alternative | If Principal Protection (PPRO) is enabled |
is_ppro_enabled (anyOf 2) | null | Alternative | |
omad | JSON | Optional | |
omad (anyOf 1) | string | Alternative | OMAD (Output Message Accountability Data) of the wire |
omad (anyOf 2) | null | Alternative | |
originating_account | Model | Required within parent | Expand Get transfer — response body — originating account |
payment_type | string | Required within parent | Known values: ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE, BOOK_TRANSFER, STABLECOIN |
process_date | JSON | Optional | |
process_date (anyOf 1) | string | Alternative | Transaction processing date Format: date |
process_date (anyOf 2) | null | Alternative | |
status | Model | Required within parent | Expand Get transfer — response body — status |
Referenced models: Get transfer — response body — amount, Get transfer — response body — counterparty object object, Get transfer — response body — originating account, Get transfer — response body — status
Get transfer — response body — amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. Format: int64 |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | The type of currency, in ISO 4217 format. Default: USD |
currency (anyOf 2) | null | Alternative |
Get transfer — response body — counterparty / object / object / type: VENDOR, BOOK TRANSFER, BANK ACCOUNT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | 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. |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).account_number | JSON | Optional | |
$ (allOf 2).account_number (anyOf 1) | string | Alternative | Account number of a bank account (or IBAN code for international transfer). |
$ (allOf 2).account_number (anyOf 2) | null | Alternative | |
$ (allOf 2).id | string | Required within parent | Vendor ID returned from `/vendors` endpoint |
$ (allOf 2).payment_instrument_id | string | Required within parent | |
$ (allOf 2).routing_number | JSON | Optional | |
$ (allOf 2).routing_number (anyOf 1) | string | Alternative | Routing number of a bank account (or SWIFT/BIC code for international transfer). |
$ (allOf 2).routing_number (anyOf 2) | null | Alternative | |
$ (allOf 2).type | string | Required within parent | Known values: VENDOR, BOOK_TRANSFER, BANK_ACCOUNT |
Get transfer — response body — counterparty object object
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. discriminator: {"mapping": {"BANK_ACCOUNT": "#/components/schemas/payments__BankAccountDetailsResponse", "BOOK_TRANSFER": "#/components/schemas/payments__BookTransferDetailsResponse", "VENDOR": "#/components/schemas/payments__VendorDetailsResponse"}, "propertyName": "type"} |
$ (anyOf 1) | Model | Alternative | Expand Get transfer — response body — counterparty / object / object / type: VENDOR, BOOK TRANSFER, BANK ACCOUNT |
Referenced models: Get transfer — response body — counterparty / object / object / type: VENDOR, BOOK TRANSFER, BANK ACCOUNT
Get transfer — response body — originating account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Originating account details for the transfer discriminator: {"mapping": {"BREX_CASH": "#/components/schemas/payments__BrexCashAccountDetailsResponse"}, "propertyName": "type"} |
$ (anyOf 1) | Model | Alternative | Expand Get transfer — response body — originating_account / type: BREX CASH |
Referenced models: Get transfer — response body — originating_account / type: BREX CASH
Get transfer — response body — originating_account / type: BREX CASH
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | Originating account details for the transfer |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).id | string | Required within parent | ID of the Brex Business account. |
$ (allOf 2).type | string | Required within parent | Known values: BREX_CASH |
Get transfer — response body — status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | `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. Known values: PROCESSING, SCHEDULED, PENDING_APPROVAL, FAILED, PROCESSED |
Get vendor — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
company_name | JSON | Optional | |
company_name (anyOf 1) | string | Alternative | |
company_name (anyOf 2) | null | Alternative | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | |
email (anyOf 2) | null | Alternative | |
id | string | Required within parent | Vendor ID: Can be passed to /transfers endpoint to specify counterparty. |
payment_accounts | JSON | Optional | |
payment_accounts (anyOf 1) | array | Alternative | |
payment_accounts (anyOf 1)[] | Model | Each item | Expand Get vendor — response body — payment accounts array item |
payment_accounts (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | |
phone (anyOf 2) | null | Alternative |
Referenced models: Get vendor — response body — payment accounts array item
Get vendor — response body — payment accounts array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
details | Model | Required within parent | Expand Get vendor — response body — payment accounts array item details |
Referenced models: Get vendor — response body — payment accounts array item details
Get vendor — response body — payment accounts array item details
Referenced models: Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__ACHDetails Response, Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__Cheque Details Response, Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__Domestic Wire Details Response, Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__International Wire Details Response
Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__ACHDetails Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).account_class | JSON | Optional | |
$ (allOf 2).account_class (anyOf 1) | JSON | Alternative | |
$ (allOf 2).account_class (anyOf 1) (allOf 1) | string | All variants apply | Known values: BUSINESS, PERSONAL |
$ (allOf 2).account_class (anyOf 2) | null | Alternative | |
$ (allOf 2).account_number | string | Required within parent | |
$ (allOf 2).account_type | JSON | Optional | |
$ (allOf 2).account_type (anyOf 1) | JSON | Alternative | |
$ (allOf 2).account_type (anyOf 1) (allOf 1) | string | All variants apply | Known values: CHECKING, SAVING |
$ (allOf 2).account_type (anyOf 2) | null | Alternative | |
$ (allOf 2).payment_instrument_id | string | Required within parent | Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. |
$ (allOf 2).routing_number | string | Required within parent | |
$ (allOf 2).type | string | Required within parent | Known values: ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE |
Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__Cheque Details Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).mailing_address | Model | Required within parent | Expand Get card — response body — billing address |
$ (allOf 2).payment_instrument_id | string | Required within parent | Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. |
$ (allOf 2).recipient_name | string | Required within parent | |
$ (allOf 2).type | string | Required within parent | Known values: ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE |
Referenced models: Get card — response body — billing address
Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__Domestic Wire Details Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).account_number | string | Required within parent | |
$ (allOf 2).address | Model | Required within parent | Expand Get card — response body — billing address |
$ (allOf 2).payment_instrument_id | string | Required within parent | Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. |
$ (allOf 2).routing_number | string | Required within parent | |
$ (allOf 2).type | string | Required within parent | Known values: ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE |
Referenced models: Get card — response body — billing address
Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__International Wire Details Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).address | Model | Required within parent | Expand Get card — response body — billing address |
$ (allOf 2).beneficiary_bank_name | JSON | Optional | |
$ (allOf 2).beneficiary_bank_name (anyOf 1) | string | Alternative | Name of counterparty's bank |
$ (allOf 2).beneficiary_bank_name (anyOf 2) | null | Alternative | |
$ (allOf 2).iban | string | Required within parent | Counterparty's international bank account number |
$ (allOf 2).payment_instrument_id | string | Required within parent | Payment Instrument ID that can be passed to the /transfers endpoint to trigger a transfer. The type of the payment instrument dictates the method. |
$ (allOf 2).swift_code | string | Required within parent | Counterparty's `SWIFT` code |
$ (allOf 2).type | string | Required within parent | Known values: ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE |
Referenced models: Get card — response body — billing address
Lists linked accounts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Lists linked accounts — response body — items item |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Lists linked accounts — response body — items item
Lists linked accounts — response body — items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
available_balance | JSON | Optional | |
available_balance (anyOf 1) | JSON | Alternative | |
available_balance (anyOf 1) (allOf 1) | Model | All variants apply | Expand Lists linked accounts — response body — items item current balance amount, as of date amount, as of date |
available_balance (anyOf 2) | null | Alternative | |
bank_details | JSON | Required within parent | |
bank_details (allOf 1) | Model | All variants apply | Expand Lists linked accounts — response body — items item bank details name, type |
bank_details (allOf 2) | JSON | All variants apply | Details of the bank - Name, Type |
brex_account_id | JSON | Optional | |
brex_account_id (anyOf 1) | string | Alternative | Brex business account ID |
brex_account_id (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 Lists linked accounts — response body — items item current balance amount, as of date amount, as of date |
current_balance (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
last_four | string | Required within parent |
Referenced models: Lists linked accounts — response body — items item current balance amount, as of date amount, as of date, Lists linked accounts — response body — items item bank details name, type
Lists linked accounts — response body — items item bank details name, type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | The name of the bank |
type | JSON | Required within parent | |
type (allOf 1) | string | All variants apply | Known values: CHECKING, SAVING |
type (allOf 2) | JSON | All variants apply | The type of bank account connected. For example, CHECKING or SAVING |
Lists linked accounts — response body — items item current balance amount, as of date amount, as of date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand Get transfer — response body — amount |
as_of_date | string | Required within parent | Format: date |
Referenced models: Get transfer — response body — amount
Lists transfers — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get transfer — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get transfer — response body
Lists vendors — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get vendor — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get vendor — response body
Update vendor — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
beneficiary_name | JSON | Optional | |
beneficiary_name (anyOf 1) | string | Alternative | Name for the Beneficiary |
beneficiary_name (anyOf 2) | null | Alternative | |
company_name | JSON | Optional | |
company_name (anyOf 1) | string | Alternative | Name for vendor |
company_name (anyOf 2) | null | Alternative | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Email for vendor Format: email |
email (anyOf 2) | null | Alternative | |
payment_accounts | JSON | Optional | |
payment_accounts (anyOf 1) | array | Alternative | To update payment instruments, we require the entire payload for each payment instrument that is being updated. |
payment_accounts (anyOf 1)[] | Model | Each item | Expand Update vendor — request body — body payment accounts array item |
payment_accounts (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Phone number for vendor |
phone (anyOf 2) | null | Alternative |
Referenced models: Update vendor — request body — body payment accounts array item
Update vendor — request body — body / payment_accounts / array / item / details / account_class: BUSINESS, PERSONAL, account type: CHECKING, SAVING, type: ACH, DOMESTIC WIRE, CHEQUE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | 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. |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).account_class | string | Required within parent | One of: BUSINESS, PERSONAL |
$ (allOf 2).account_number | string | Required within parent | |
$ (allOf 2).account_type | string | Required within parent | One of: CHECKING, SAVING |
$ (allOf 2).beneficiary_name | JSON | Optional | |
$ (allOf 2).beneficiary_name (anyOf 1) | string | Alternative | |
$ (allOf 2).beneficiary_name (anyOf 2) | null | Alternative | |
$ (allOf 2).routing_number | string | Required within parent | The routing number must follow proper format. |
$ (allOf 2).type | string | Required within parent | One of: ACH, DOMESTIC_WIRE, CHEQUE |
Update vendor — request body — body / payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE — payments__Cheque Details Request
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | 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. |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).beneficiary_name | JSON | Optional | |
$ (allOf 2).beneficiary_name (anyOf 1) | string | Alternative | |
$ (allOf 2).beneficiary_name (anyOf 2) | null | Alternative | |
$ (allOf 2).mailing_address | Model | Required within parent | Expand Get card — response body — billing address |
$ (allOf 2).recipient_name | string | Required within parent | Maximum length: 40 |
$ (allOf 2).type | string | Required within parent | One of: ACH, DOMESTIC_WIRE, CHEQUE |
Referenced models: Get card — response body — billing address
Update vendor — request body — body / payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE — payments__Domestic Wire Details Request
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | 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. |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).account_number | string | Required within parent | |
$ (allOf 2).address | Model | Required within parent | Expand Get card — response body — billing address |
$ (allOf 2).beneficiary_name | JSON | Optional | |
$ (allOf 2).beneficiary_name (anyOf 1) | string | Alternative | |
$ (allOf 2).beneficiary_name (anyOf 2) | null | Alternative | |
$ (allOf 2).routing_number | string | Required within parent | The routing number must follow proper format. |
$ (allOf 2).type | string | Required within parent | One of: ACH, DOMESTIC_WIRE, CHEQUE |
Referenced models: Get card — response body — billing address
Update vendor — request body — body payment accounts array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
details | Model | Required within parent | Expand Update vendor — request body — body payment accounts array item details |
Referenced models: Update vendor — request body — body payment accounts array item details
Update vendor — request body — body payment accounts array item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. discriminator: {"mapping": {"ACH": "#/components/schemas/payments__ACHDetailsRequest", "CHEQUE": "#/components/schemas/payments__ChequeDetailsRequest", "DOMESTIC_WIRE": "#/components/schemas/payments__DomesticWireDetailsRequest"}, "propertyName": "type"} |
$ (oneOf 1) | Model | Alternative | Expand Update vendor — request body — body / payment_accounts / array / item / details / account_class: BUSINESS, PERSONAL, account type: CHECKING, SAVING, type: ACH, DOMESTIC WIRE, CHEQUE |
$ (oneOf 2) | Model | Alternative | Expand Update vendor — request body — body / payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE — payments__Domestic Wire Details Request |
$ (oneOf 3) | Model | Alternative | Expand Update vendor — request body — body / payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE — payments__Cheque Details Request |
Referenced models: Update vendor — request body — body / payment_accounts / array / item / details / account_class: BUSINESS, PERSONAL, account type: CHECKING, SAVING, type: ACH, DOMESTIC WIRE, CHEQUE, Update vendor — request body — body / payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE — payments__Cheque Details Request, Update vendor — request body — body / payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE — payments__Domestic Wire Details Request