Skip to content

Brex: Payments schemas

40 Brex schemas with complete fields and constraints.

← Payments operations · All schemas

Create incoming transfer — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand Create transfer — request body — body amount
counterpartyModelRequired within parentExpand Create incoming transfer — request body — body counterparty
descriptionstringRequired within parent
Description of the transfer for internal use. Not exposed externally.
receiving_accountModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants applyCounterparty Details for the transfer
$ (allOf 2)JSONAll variants apply
$ (allOf 2).idstringRequired within parent
The financial account id: Can be found from the [List linked accounts](/openapi/payments_api/#operation/listLinkedAccounts) endpoint
$ (allOf 2).typestringRequired within parentOne of: BANK

Create incoming transfer — request body — body / receiving_account / type: BREX CASH

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants applyReceiving account details for the transfer
$ (allOf 2)JSONAll variants apply
$ (allOf 2).idstringRequired within parent
ID of the Brex business account: Can be found from the [List business accounts](/openapi/transactions_api/#operation/listAccounts) endpoint
$ (allOf 2).typestringRequired within parentOne of: BREX_CASH

Create incoming transfer — request body — body counterparty

FieldTypePresenceDescription and constraints
$objectRootCounterparty Details for the transfer
discriminator: {"mapping": {"BANK": "#/components/schemas/payments__CounterPartyBankDetails"}, "propertyName": "type"}
$ (oneOf 1)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootReceiving account details for the transfer
discriminator: {"mapping": {"BREX_CASH": "#/components/schemas/payments__BrexCashDetails"}, "propertyName": "type"}
$ (oneOf 1)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand Create transfer — request body — body amount
approval_typeJSONOptional
approval_type (anyOf 1)JSONAlternative
approval_type (anyOf 1) (allOf 1)stringAll variants applySpecifies 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)nullAlternative
counterpartyModelRequired within parentExpand Create transfer — request body — body counterparty
descriptionstringRequired within parentDescription of the transfer for internal use. Not exposed externally.
external_memostringRequired within parentExternal 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_enabledbooleanOptionalWhen 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_accountJSONRequired within parent
originating_account (allOf 1)ModelAll variants applyExpand Create transfer — request body — body originating account Originating account details for the transfer
originating_account (allOf 2)JSONAll variants applyBrex 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
typestringRequired within parentSpecifies 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

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants applyCounterparty Details for the transfer
$ (allOf 2)JSONAll variants apply
$ (allOf 2).recipientModelRequired within parentExpand Create transfer — request body — body / counterparty / type: VENDOR, BOOK TRANSFER type: VENDOR, BOOK TRANSFER recipient
$ (allOf 2).typestringRequired within parentOne 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

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants applyCounterparty Details for the transfer
$ (allOf 2)JSONAll variants apply
$ (allOf 2).payment_instrument_idstringRequired within parentID 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).typestringRequired within parentOne of: VENDOR, BOOK_TRANSFER

Create transfer — request body — body / originating_account / Originating account details for the transfer / type: BREX CASH

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants applyOriginating account details for the transfer
$ (allOf 2)JSONAll variants apply
$ (allOf 2).idstringRequired within parent
ID of the Brex Business account: Can be found from the `/accounts` endpoint
where instrument type is `CASH`.
$ (allOf 2).typestringRequired within parentOne of: BREX_CASH

Create transfer — request body — body amount

FieldTypePresenceDescription and constraints
$objectRoot
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.
amountintegerRequired within parentThe 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
currencyJSONOptional
currency (anyOf 1)stringAlternativeThe type of currency, in ISO 4217 format.
Default: USD
currency (anyOf 2)nullAlternative

Create transfer — request body — body counterparty

FieldTypePresenceDescription and constraints
$objectRootCounterparty Details for the transfer
discriminator: {"mapping": {"BOOK_TRANSFER": "#/components/schemas/payments__BookTransferDetails", "VENDOR": "#/components/schemas/payments__VendorDetails"}, "propertyName": "type"}
$ (oneOf 1)ModelAlternativeExpand Create transfer — request body — body / counterparty / type: VENDOR, BOOK TRANSFER — payments__Vendor Details
$ (oneOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootOriginating account details for the transfer
discriminator: {"mapping": {"BREX_CASH": "#/components/schemas/payments__BrexCashAccountDetails"}, "propertyName": "type"}
$ (oneOf 1)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
company_namestringRequired within parentName for vendor. The name must be unique.
emailJSONOptional
email (anyOf 1)stringAlternativeEmail for vendor.
Format: email
email (anyOf 2)nullAlternative
payment_accountsJSONOptional
payment_accounts (anyOf 1)arrayAlternativePayment accounts associated with the vendor.
payment_accounts (anyOf 1)[]ModelEach itemExpand Update vendor — request body — body payment accounts array item
payment_accounts (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternativePhone number for vendor.
phone (anyOf 2)nullAlternative

Referenced models: Update vendor — request body — body payment accounts array item

Get transfer — response body

FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand Get transfer — response body — amount
cancellation_reasonJSONOptional
cancellation_reason (anyOf 1)JSONAlternative
cancellation_reason (anyOf 1) (allOf 1)stringAll 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)nullAlternative
counterpartyJSONOptional
counterparty (anyOf 1)JSONAlternative
counterparty (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — counterparty object object
counterparty (anyOf 2)nullAlternative
created_atJSONOptional
created_at (anyOf 1)stringAlternativeDate of transfer creation
Format: date
created_at (anyOf 2)nullAlternative
creator_user_idJSONOptional
creator_user_id (anyOf 1)stringAlternativeUser ID of the transfer initiator
creator_user_id (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the transfer
description (anyOf 2)nullAlternative
display_nameJSONOptional
display_name (anyOf 1)stringAlternativeHuman readable name for the transaction
display_name (anyOf 2)nullAlternative
estimated_delivery_dateJSONOptional
estimated_delivery_date (anyOf 1)stringAlternativeEstimated delivery date for transfer
Format: date
estimated_delivery_date (anyOf 2)nullAlternative
external_memoJSONOptional
external_memo (anyOf 1)stringAlternativeExternal 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)nullAlternative
idstringRequired within parentUnique ID associated with the transfer
imadJSONOptional
imad (anyOf 1)stringAlternativeIMAD (Input Message Accountability Data) of the wire
imad (anyOf 2)nullAlternative
is_ppro_enabledJSONOptional
is_ppro_enabled (anyOf 1)booleanAlternativeIf Principal Protection (PPRO) is enabled
is_ppro_enabled (anyOf 2)nullAlternative
omadJSONOptional
omad (anyOf 1)stringAlternativeOMAD (Output Message Accountability Data) of the wire
omad (anyOf 2)nullAlternative
originating_accountModelRequired within parentExpand Get transfer — response body — originating account
payment_typestringRequired within parentKnown values: ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE, BOOK_TRANSFER, STABLECOIN
process_dateJSONOptional
process_date (anyOf 1)stringAlternativeTransaction processing date
Format: date
process_date (anyOf 2)nullAlternative
statusModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
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.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeThe 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencyJSONOptional
currency (anyOf 1)stringAlternativeThe type of currency, in ISO 4217 format.
Default: USD
currency (anyOf 2)nullAlternative

Get transfer — response body — counterparty / object / object / type: VENDOR, BOOK TRANSFER, BANK ACCOUNT

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants applyCounterparty 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)JSONAll variants apply
$ (allOf 2).account_numberJSONOptional
$ (allOf 2).account_number (anyOf 1)stringAlternativeAccount number of a bank account (or IBAN code for international transfer).
$ (allOf 2).account_number (anyOf 2)nullAlternative
$ (allOf 2).idstringRequired within parentVendor ID returned from `/vendors` endpoint
$ (allOf 2).payment_instrument_idstringRequired within parent
$ (allOf 2).routing_numberJSONOptional
$ (allOf 2).routing_number (anyOf 1)stringAlternativeRouting number of a bank account (or SWIFT/BIC code for international transfer).
$ (allOf 2).routing_number (anyOf 2)nullAlternative
$ (allOf 2).typestringRequired within parentKnown values: VENDOR, BOOK_TRANSFER, BANK_ACCOUNT

Get transfer — response body — counterparty object object

FieldTypePresenceDescription and constraints
$objectRootCounterparty 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)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootOriginating account details for the transfer
discriminator: {"mapping": {"BREX_CASH": "#/components/schemas/payments__BrexCashAccountDetailsResponse"}, "propertyName": "type"}
$ (anyOf 1)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants applyOriginating account details for the transfer
$ (allOf 2)JSONAll variants apply
$ (allOf 2).idstringRequired within parent
ID of the Brex Business account.
$ (allOf 2).typestringRequired within parentKnown values: BREX_CASH

Get transfer — response body — status

FieldTypePresenceDescription and constraints
$stringRoot`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

FieldTypePresenceDescription and constraints
$objectRoot
company_nameJSONOptional
company_name (anyOf 1)stringAlternative
company_name (anyOf 2)nullAlternative
emailJSONOptional
email (anyOf 1)stringAlternative
email (anyOf 2)nullAlternative
idstringRequired within parentVendor ID: Can be passed to /transfers endpoint to specify counterparty.
payment_accountsJSONOptional
payment_accounts (anyOf 1)arrayAlternative
payment_accounts (anyOf 1)[]ModelEach itemExpand Get vendor — response body — payment accounts array item
payment_accounts (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternative
phone (anyOf 2)nullAlternative

Referenced models: Get vendor — response body — payment accounts array item

Get vendor — response body — payment accounts array item

FieldTypePresenceDescription and constraints
$objectRoot
detailsModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootdiscriminator: {"mapping": {"ACH": "#/components/schemas/payments__ACHDetailsResponse", "CHEQUE": "#/components/schemas/payments__ChequeDetailsResponse", "DOMESTIC_WIRE": "#/components/schemas/payments__DomesticWireDetailsResponse", "INTERNATIONAL_WIRE": "#/components/schemas/payments__InternationalWireDetailsResponse"}, "propertyName": "type"}
$ (anyOf 1)ModelAlternativeExpand Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__ACHDetails Response
$ (anyOf 2)ModelAlternativeExpand Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__Domestic Wire Details Response
$ (anyOf 3)ModelAlternativeExpand Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__Cheque Details Response
$ (anyOf 4)ModelAlternativeExpand Get vendor — response body — payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE, INTERNATIONAL WIRE — payments__International Wire Details Response

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

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants apply
$ (allOf 2)JSONAll variants apply
$ (allOf 2).account_classJSONOptional
$ (allOf 2).account_class (anyOf 1)JSONAlternative
$ (allOf 2).account_class (anyOf 1) (allOf 1)stringAll variants applyKnown values: BUSINESS, PERSONAL
$ (allOf 2).account_class (anyOf 2)nullAlternative
$ (allOf 2).account_numberstringRequired within parent
$ (allOf 2).account_typeJSONOptional
$ (allOf 2).account_type (anyOf 1)JSONAlternative
$ (allOf 2).account_type (anyOf 1) (allOf 1)stringAll variants applyKnown values: CHECKING, SAVING
$ (allOf 2).account_type (anyOf 2)nullAlternative
$ (allOf 2).payment_instrument_idstringRequired within parentPayment 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_numberstringRequired within parent
$ (allOf 2).typestringRequired within parentKnown 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

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants apply
$ (allOf 2)JSONAll variants apply
$ (allOf 2).mailing_addressModelRequired within parentExpand Get card — response body — billing address
$ (allOf 2).payment_instrument_idstringRequired within parentPayment 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_namestringRequired within parent
$ (allOf 2).typestringRequired within parentKnown 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

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants apply
$ (allOf 2)JSONAll variants apply
$ (allOf 2).account_numberstringRequired within parent
$ (allOf 2).addressModelRequired within parentExpand Get card — response body — billing address
$ (allOf 2).payment_instrument_idstringRequired within parentPayment 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_numberstringRequired within parent
$ (allOf 2).typestringRequired within parentKnown 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

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants apply
$ (allOf 2)JSONAll variants apply
$ (allOf 2).addressModelRequired within parentExpand Get card — response body — billing address
$ (allOf 2).beneficiary_bank_nameJSONOptional
$ (allOf 2).beneficiary_bank_name (anyOf 1)stringAlternativeName of counterparty's bank
$ (allOf 2).beneficiary_bank_name (anyOf 2)nullAlternative
$ (allOf 2).ibanstringRequired within parentCounterparty's international bank account number
$ (allOf 2).payment_instrument_idstringRequired within parentPayment 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_codestringRequired within parentCounterparty's `SWIFT` code
$ (allOf 2).typestringRequired within parentKnown values: ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE

Referenced models: Get card — response body — billing address

Lists linked accounts — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Lists linked accounts — response body — items item
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Lists linked accounts — response body — items item

Lists linked accounts — response body — items item

FieldTypePresenceDescription and constraints
$objectRoot
available_balanceJSONOptional
available_balance (anyOf 1)JSONAlternative
available_balance (anyOf 1) (allOf 1)ModelAll variants applyExpand Lists linked accounts — response body — items item current balance amount, as of date amount, as of date
available_balance (anyOf 2)nullAlternative
bank_detailsJSONRequired within parent
bank_details (allOf 1)ModelAll variants applyExpand Lists linked accounts — response body — items item bank details name, type
bank_details (allOf 2)JSONAll variants apply
Details of the bank - Name, Type
brex_account_idJSONOptional
brex_account_id (anyOf 1)stringAlternative
Brex business account ID
brex_account_id (anyOf 2)nullAlternative
current_balanceJSONOptional
current_balance (anyOf 1)JSONAlternative
current_balance (anyOf 1) (allOf 1)ModelAll variants applyExpand Lists linked accounts — response body — items item current balance amount, as of date amount, as of date
current_balance (anyOf 2)nullAlternative
idstringRequired within parent
last_fourstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parent
The name of the bank
typeJSONRequired within parent
type (allOf 1)stringAll variants applyKnown values: CHECKING, SAVING
type (allOf 2)JSONAll 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

FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand Get transfer — response body — amount
as_of_datestringRequired within parentFormat: date

Referenced models: Get transfer — response body — amount

Lists transfers — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get transfer — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get transfer — response body

Lists vendors — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get vendor — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get vendor — response body

Update vendor — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
beneficiary_nameJSONOptional
beneficiary_name (anyOf 1)stringAlternativeName for the Beneficiary
beneficiary_name (anyOf 2)nullAlternative
company_nameJSONOptional
company_name (anyOf 1)stringAlternativeName for vendor
company_name (anyOf 2)nullAlternative
emailJSONOptional
email (anyOf 1)stringAlternativeEmail for vendor
Format: email
email (anyOf 2)nullAlternative
payment_accountsJSONOptional
payment_accounts (anyOf 1)arrayAlternativeTo update payment instruments, we require the entire payload for each payment instrument that is being updated.
payment_accounts (anyOf 1)[]ModelEach itemExpand Update vendor — request body — body payment accounts array item
payment_accounts (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternativePhone number for vendor
phone (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants applyPayment 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)JSONAll variants apply
$ (allOf 2).account_classstringRequired within parentOne of: BUSINESS, PERSONAL
$ (allOf 2).account_numberstringRequired within parent
$ (allOf 2).account_typestringRequired within parentOne of: CHECKING, SAVING
$ (allOf 2).beneficiary_nameJSONOptional
$ (allOf 2).beneficiary_name (anyOf 1)stringAlternative
$ (allOf 2).beneficiary_name (anyOf 2)nullAlternative
$ (allOf 2).routing_numberstringRequired within parentThe routing number must follow proper format.
$ (allOf 2).typestringRequired within parentOne of: ACH, DOMESTIC_WIRE, CHEQUE

Update vendor — request body — body / payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE — payments__Cheque Details Request

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants applyPayment 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)JSONAll variants apply
$ (allOf 2).beneficiary_nameJSONOptional
$ (allOf 2).beneficiary_name (anyOf 1)stringAlternative
$ (allOf 2).beneficiary_name (anyOf 2)nullAlternative
$ (allOf 2).mailing_addressModelRequired within parentExpand Get card — response body — billing address
$ (allOf 2).recipient_namestringRequired within parentMaximum length: 40
$ (allOf 2).typestringRequired within parentOne 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

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants applyPayment 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)JSONAll variants apply
$ (allOf 2).account_numberstringRequired within parent
$ (allOf 2).addressModelRequired within parentExpand Get card — response body — billing address
$ (allOf 2).beneficiary_nameJSONOptional
$ (allOf 2).beneficiary_name (anyOf 1)stringAlternative
$ (allOf 2).beneficiary_name (anyOf 2)nullAlternative
$ (allOf 2).routing_numberstringRequired within parentThe routing number must follow proper format.
$ (allOf 2).typestringRequired within parentOne of: ACH, DOMESTIC_WIRE, CHEQUE

Referenced models: Get card — response body — billing address

Update vendor — request body — body payment accounts array item

FieldTypePresenceDescription and constraints
$objectRoot
detailsModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootPayment 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)ModelAlternativeExpand 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)ModelAlternativeExpand Update vendor — request body — body / payment_accounts / array / item / details / type: ACH, DOMESTIC WIRE, CHEQUE — payments__Domestic Wire Details Request
$ (oneOf 3)ModelAlternativeExpand 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.