PaymentsComponents
Defined in: src/payments/types.gen.ts:181
Properties
Section titled “Properties”headers
Section titled “headers”headers:
never
Defined in: src/payments/types.gen.ts:715
parameters
Section titled “parameters”parameters:
never
Defined in: src/payments/types.gen.ts:713
pathItems
Section titled “pathItems”pathItems:
never
Defined in: src/payments/types.gen.ts:716
requestBodies
Section titled “requestBodies”requestBodies:
never
Defined in: src/payments/types.gen.ts:714
responses
Section titled “responses”responses:
never
Defined in: src/payments/types.gen.ts:712
schemas
Section titled “schemas”schemas:
object
Defined in: src/payments/types.gen.ts:182
AccountClass
Section titled “AccountClass”AccountClass:
"BUSINESS"|"PERSONAL"
AccountType
Section titled “AccountType”AccountType:
"CHECKING"|"SAVING"
ACHDetailsRequest
Section titled “ACHDetailsRequest”ACHDetailsRequest:
object&object
Type Declaration
Section titled “Type Declaration”account_class
Section titled “account_class”account_class:
"BUSINESS"|"PERSONAL"
account_number
Section titled “account_number”account_number:
string
account_type
Section titled “account_type”account_type:
"CHECKING"|"SAVING"
beneficiary_name?
Section titled “beneficiary_name?”
optionalbeneficiary_name?:string|null
routing_number
Section titled “routing_number”routing_number:
string
Description
Section titled “Description”The routing number must follow proper format.
type:
"ACH"|"DOMESTIC_WIRE"|"CHEQUE"
Type Declaration
Section titled “Type Declaration”type:
"ACH"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
ACHDetailsResponse
Section titled “ACHDetailsResponse”ACHDetailsResponse:
object&object
Type Declaration
Section titled “Type Declaration”account_class?
Section titled “account_class?”
optionalaccount_class?:"BUSINESS"|"PERSONAL"|null
account_number
Section titled “account_number”account_number:
string
account_type?
Section titled “account_type?”
optionalaccount_type?:"CHECKING"|"SAVING"|null
payment_instrument_id
Section titled “payment_instrument_id”payment_instrument_id:
string
Description
Section titled “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
Section titled “routing_number”routing_number:
string
type:
"ACH"|"DOMESTIC_WIRE"|"CHEQUE"|"INTERNATIONAL_WIRE"
Type Declaration
Section titled “Type Declaration”type:
"ACH"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Address
Section titled “Address”Address:
object
Description
Section titled “Description”Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed).
Address.city?
Section titled “Address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
Address.country?
Section titled “Address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
Address.line1?
Section titled “Address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
Address.line2?
Section titled “Address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
Address.phone_number?
Section titled “Address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
Address.postal_code?
Section titled “Address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
Address.state?
Section titled “Address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
ApprovalType
Section titled “ApprovalType”ApprovalType:
"MANUAL"
Description
Section titled “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
Section titled “Balance”Balance:
object
Balance.amount
Section titled “Balance.amount”amount:
object
Balance.amount.amount
Section titled “Balance.amount.amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700Balance.amount.currency
Section titled “Balance.amount.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDBalance.as_of_date
Section titled “Balance.as_of_date”as_of_date:
string
Format: date
BankAccountDetailsResponse
Section titled “BankAccountDetailsResponse”BankAccountDetailsResponse:
Omit<object&object,"type"> &object&object&object
Type Declaration
Section titled “Type Declaration”account_number?
Section titled “account_number?”
optionalaccount_number?:string|null
Description
Section titled “Description”Account number of a bank account (or IBAN code for international transfer). For incoming cheques, this field might be null.
beneficiary_bank?
Section titled “beneficiary_bank?”
optionalbeneficiary_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?
Section titled “description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of the transfer.
external_memo?
Section titled “external_memo?”
optionalexternal_memo?:string|null
Description
Section titled “Description”External Memo populated by the sender
fed_reference_number?
Section titled “fed_reference_number?”
optionalfed_reference_number?:string|null
Description
Section titled “Description”Fed reference number for incoming wires
routing_number?
Section titled “routing_number?”
optionalrouting_number?:string|null
Description
Section titled “Description”Routing number of a bank account (or SWIFT/BIC code for international transfer). For incoming cheques, this field might be null.
type:
"VENDOR"|"BOOK_TRANSFER"|"BANK_ACCOUNT"
Type Declaration
Section titled “Type Declaration”type:
"BANK_ACCOUNT"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Type Declaration
Section titled “Type Declaration”type:
"BANK_ACCOUNT"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
BankConnection
Section titled “BankConnection”BankConnection:
object
BankConnection.available_balance?
Section titled “BankConnection.available_balance?”
optionalavailable_balance?: {amount: {amount:number;currency:string|null; };as_of_date:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: { amount: number; currency: string | null; }; as_of_date: string; }
amount
Section titled “amount”amount:
object
amount.amount
Section titled “amount.amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700amount.currency
Section titled “amount.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDas_of_date
Section titled “as_of_date”as_of_date:
string
Format: date
null
BankConnection.bank_details
Section titled “BankConnection.bank_details”bank_details:
object
BankConnection.bank_details.name
Section titled “BankConnection.bank_details.name”name:
string
Description
Section titled “Description”The name of the bank
BankConnection.bank_details.type
Section titled “BankConnection.bank_details.type”type:
"CHECKING"|"SAVING"
BankConnection.brex_account_id?
Section titled “BankConnection.brex_account_id?”
optionalbrex_account_id?:string|null
Description
Section titled “Description”Brex business account ID
BankConnection.current_balance?
Section titled “BankConnection.current_balance?”
optionalcurrent_balance?: {amount: {amount:number;currency:string|null; };as_of_date:string; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: { amount: number; currency: string | null; }; as_of_date: string; }
amount
Section titled “amount”amount:
object
amount.amount
Section titled “amount.amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700amount.currency
Section titled “amount.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDas_of_date
Section titled “as_of_date”as_of_date:
string
Format: date
null
BankConnection.id
Section titled “BankConnection.id”id:
string
BankConnection.last_four
Section titled “BankConnection.last_four”last_four:
string
BankDetails
Section titled “BankDetails”BankDetails:
object
BankDetails.name
Section titled “BankDetails.name”name:
string
Description
Section titled “Description”The name of the bank
BankDetails.type
Section titled “BankDetails.type”type:
"CHECKING"|"SAVING"
BankType
Section titled “BankType”BankType:
"CHECKING"|"SAVING"
BeneficiaryBank
Section titled “BeneficiaryBank”BeneficiaryBank:
object
BeneficiaryBank.address?
Section titled “BeneficiaryBank.address?”
optionaladdress?: {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
Section titled “Union Members”Type Literal
Section titled “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; }
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
country?
Section titled “country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
line1?
Section titled “line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
line2?
Section titled “line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
phone_number?
Section titled “phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
postal_code?
Section titled “postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
state?
Section titled “state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
null
BeneficiaryBank.name?
Section titled “BeneficiaryBank.name?”
optionalname?:string|null
BookTransferDetails
Section titled “BookTransferDetails”BookTransferDetails:
object&object
Type Declaration
Section titled “Type Declaration”recipient
Section titled “recipient”recipient:
object
recipient.id
Section titled “recipient.id”id:
string
recipient.type
Section titled “recipient.type”type:
"ACCOUNT_ID"|"PAYMENT_INSTRUMENT_ID"
type:
"VENDOR"|"BOOK_TRANSFER"
Type Declaration
Section titled “Type Declaration”type:
"BOOK_TRANSFER"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
BookTransferDetailsResponse
Section titled “BookTransferDetailsResponse”BookTransferDetailsResponse:
Omit<object&object,"type"> &object&object&object
Type Declaration
Section titled “Type Declaration”deposit_account_id
Section titled “deposit_account_id”deposit_account_id:
string
Description
Section titled “Description”This feature is currently limited to certain customers, please reach out if you are interested
type:
"VENDOR"|"BOOK_TRANSFER"|"BANK_ACCOUNT"
Type Declaration
Section titled “Type Declaration”type:
"BOOK_TRANSFER"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Type Declaration
Section titled “Type Declaration”type:
"BOOK_TRANSFER"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
BrexCashAccountDetails
Section titled “BrexCashAccountDetails”BrexCashAccountDetails:
object&object
Type Declaration
Section titled “Type Declaration”id:
string
Description
Section titled “Description”ID of the Brex Business account: Can be found from the /accounts endpoint
where instrument type is CASH.
type:
"BREX_CASH"
Type Declaration
Section titled “Type Declaration”type:
"BREX_CASH"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
BrexCashAccountDetailsResponse
Section titled “BrexCashAccountDetailsResponse”BrexCashAccountDetailsResponse:
object&object
Type Declaration
Section titled “Type Declaration”id:
string
Description
Section titled “Description”ID of the Brex Business account.
type:
"BREX_CASH"
Type Declaration
Section titled “Type Declaration”type:
"BREX_CASH"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
BrexCashDetails
Section titled “BrexCashDetails”BrexCashDetails:
object&object
Type Declaration
Section titled “Type Declaration”id:
string
Description
Section titled “Description”ID of the Brex business account: Can be found from the List business accounts endpoint
type:
"BREX_CASH"
Type Declaration
Section titled “Type Declaration”type:
"BREX_CASH"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
ChequeDetailsRequest
Section titled “ChequeDetailsRequest”ChequeDetailsRequest:
object&object
Type Declaration
Section titled “Type Declaration”beneficiary_name?
Section titled “beneficiary_name?”
optionalbeneficiary_name?:string|null
mailing_address
Section titled “mailing_address”mailing_address:
object
mailing_address.city?
Section titled “mailing_address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
mailing_address.country?
Section titled “mailing_address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
mailing_address.line1?
Section titled “mailing_address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
mailing_address.line2?
Section titled “mailing_address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
mailing_address.phone_number?
Section titled “mailing_address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
mailing_address.postal_code?
Section titled “mailing_address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
mailing_address.state?
Section titled “mailing_address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
recipient_name
Section titled “recipient_name”recipient_name:
string
type:
"ACH"|"DOMESTIC_WIRE"|"CHEQUE"
Type Declaration
Section titled “Type Declaration”type:
"CHEQUE"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
ChequeDetailsResponse
Section titled “ChequeDetailsResponse”ChequeDetailsResponse:
object&object
Type Declaration
Section titled “Type Declaration”mailing_address
Section titled “mailing_address”mailing_address:
object
mailing_address.city?
Section titled “mailing_address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
mailing_address.country?
Section titled “mailing_address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
mailing_address.line1?
Section titled “mailing_address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
mailing_address.line2?
Section titled “mailing_address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
mailing_address.phone_number?
Section titled “mailing_address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
mailing_address.postal_code?
Section titled “mailing_address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
mailing_address.state?
Section titled “mailing_address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
payment_instrument_id
Section titled “payment_instrument_id”payment_instrument_id:
string
Description
Section titled “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
Section titled “recipient_name”recipient_name:
string
type:
"ACH"|"DOMESTIC_WIRE"|"CHEQUE"|"INTERNATIONAL_WIRE"
Type Declaration
Section titled “Type Declaration”type:
"CHEQUE"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
CounterParty
Section titled “CounterParty”CounterParty:
object&object|object&object
Description
Section titled “Description”Counterparty Details for the transfer
CounterPartyBankDetails
Section titled “CounterPartyBankDetails”CounterPartyBankDetails:
object&object
Type Declaration
Section titled “Type Declaration”id:
string
Description
Section titled “Description”The financial account id: Can be found from the List linked accounts endpoint
type:
"BANK"
Type Declaration
Section titled “Type Declaration”type:
"BANK"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
CounterPartyIncomingTransfer
Section titled “CounterPartyIncomingTransfer”CounterPartyIncomingTransfer:
object&object
Type Declaration
Section titled “Type Declaration”id:
string
Description
Section titled “Description”The financial account id: Can be found from the List linked accounts endpoint
type:
"BANK"
Type Declaration
Section titled “Type Declaration”type:
"BANK"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Description
Section titled “Description”Counterparty Details for the transfer
CounterPartyIncomingTransferType
Section titled “CounterPartyIncomingTransferType”CounterPartyIncomingTransferType:
"BANK"
CounterPartyResponse
Section titled “CounterPartyResponse”CounterPartyResponse:
object&object
Type Declaration
Section titled “Type Declaration”account_number?
Section titled “account_number?”
optionalaccount_number?:string|null
Description
Section titled “Description”Account number of a bank account (or IBAN code for international transfer).
id:
string
Description
Section titled “Description”Vendor ID returned from /vendors endpoint
payment_instrument_id
Section titled “payment_instrument_id”payment_instrument_id:
string
routing_number?
Section titled “routing_number?”
optionalrouting_number?:string|null
Description
Section titled “Description”Routing number of a bank account (or SWIFT/BIC code for international transfer).
type:
"VENDOR"|"BOOK_TRANSFER"|"BANK_ACCOUNT"
Type Declaration
Section titled “Type Declaration”type:
"VENDOR"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Description
Section titled “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
Section titled “CounterPartyResponseType”CounterPartyResponseType:
"VENDOR"|"BOOK_TRANSFER"|"BANK_ACCOUNT"
CounterPartyType
Section titled “CounterPartyType”CounterPartyType:
"VENDOR"|"BOOK_TRANSFER"
CreateIncomingTransferRequest
Section titled “CreateIncomingTransferRequest”CreateIncomingTransferRequest:
object
CreateIncomingTransferRequest.amount
Section titled “CreateIncomingTransferRequest.amount”amount:
object
CreateIncomingTransferRequest.amount.amount
Section titled “CreateIncomingTransferRequest.amount.amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700CreateIncomingTransferRequest.amount.currency
Section titled “CreateIncomingTransferRequest.amount.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDCreateIncomingTransferRequest.counterparty
Section titled “CreateIncomingTransferRequest.counterparty”counterparty:
object&object
Type Declaration
Section titled “Type Declaration”id:
string
Description
Section titled “Description”The financial account id: Can be found from the List linked accounts endpoint
type:
"BANK"
Type Declaration
Section titled “Type Declaration”type:
"BANK"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
CreateIncomingTransferRequest.description
Section titled “CreateIncomingTransferRequest.description”description:
string
Description
Section titled “Description”Description of the transfer for internal use. Not exposed externally.
CreateIncomingTransferRequest.receiving_account
Section titled “CreateIncomingTransferRequest.receiving_account”receiving_account:
object&object
Type Declaration
Section titled “Type Declaration”id:
string
Description
Section titled “Description”ID of the Brex business account: Can be found from the List business accounts endpoint
type:
"BREX_CASH"
Type Declaration
Section titled “Type Declaration”type:
"BREX_CASH"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
CreateTransferRequest
Section titled “CreateTransferRequest”CreateTransferRequest:
object
CreateTransferRequest.amount
Section titled “CreateTransferRequest.amount”amount:
object
CreateTransferRequest.amount.amount
Section titled “CreateTransferRequest.amount.amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700CreateTransferRequest.amount.currency
Section titled “CreateTransferRequest.amount.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDCreateTransferRequest.approval_type?
Section titled “CreateTransferRequest.approval_type?”
optionalapproval_type?:"MANUAL"|null
CreateTransferRequest.counterparty
Section titled “CreateTransferRequest.counterparty”counterparty:
object&object|object&object
CreateTransferRequest.description
Section titled “CreateTransferRequest.description”description:
string
Description
Section titled “Description”Description of the transfer for internal use. Not exposed externally.
CreateTransferRequest.external_memo
Section titled “CreateTransferRequest.external_memo”external_memo:
string
Description
Section titled “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?
Section titled “CreateTransferRequest.is_ppro_enabled?”
optionalis_ppro_enabled?:boolean
Description
Section titled “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
Section titled “CreateTransferRequest.originating_account”originating_account:
Omit<object&object,"type">
CreateVendorRequest
Section titled “CreateVendorRequest”CreateVendorRequest:
object
CreateVendorRequest.company_name
Section titled “CreateVendorRequest.company_name”company_name:
string
Description
Section titled “Description”Name for vendor. The name must be unique.
CreateVendorRequest.email?
Section titled “CreateVendorRequest.email?”
optionalemail?:string|null
Format: email
Description
Section titled “Description”Email for vendor.
CreateVendorRequest.payment_accounts?
Section titled “CreateVendorRequest.payment_accounts?”
optionalpayment_accounts?:object[] |null
Description
Section titled “Description”Payment accounts associated with the vendor.
CreateVendorRequest.phone?
Section titled “CreateVendorRequest.phone?”
optionalphone?:string|null
Description
Section titled “Description”Phone number for vendor.
DomesticWireDetailsRequest
Section titled “DomesticWireDetailsRequest”DomesticWireDetailsRequest:
object&object
Type Declaration
Section titled “Type Declaration”account_number
Section titled “account_number”account_number:
string
address
Section titled “address”address:
object
address.city?
Section titled “address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
address.country?
Section titled “address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
address.line1?
Section titled “address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
address.line2?
Section titled “address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
address.phone_number?
Section titled “address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
address.postal_code?
Section titled “address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
address.state?
Section titled “address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
beneficiary_name?
Section titled “beneficiary_name?”
optionalbeneficiary_name?:string|null
routing_number
Section titled “routing_number”routing_number:
string
Description
Section titled “Description”The routing number must follow proper format.
type:
"ACH"|"DOMESTIC_WIRE"|"CHEQUE"
Type Declaration
Section titled “Type Declaration”type:
"DOMESTIC_WIRE"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
DomesticWireDetailsResponse
Section titled “DomesticWireDetailsResponse”DomesticWireDetailsResponse:
object&object
Type Declaration
Section titled “Type Declaration”account_number
Section titled “account_number”account_number:
string
address
Section titled “address”address:
object
address.city?
Section titled “address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
address.country?
Section titled “address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
address.line1?
Section titled “address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
address.line2?
Section titled “address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
address.phone_number?
Section titled “address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
address.postal_code?
Section titled “address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
address.state?
Section titled “address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
payment_instrument_id
Section titled “payment_instrument_id”payment_instrument_id:
string
Description
Section titled “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
Section titled “routing_number”routing_number:
string
type:
"ACH"|"DOMESTIC_WIRE"|"CHEQUE"|"INTERNATIONAL_WIRE"
Type Declaration
Section titled “Type Declaration”type:
"DOMESTIC_WIRE"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
InternationalWireDetailsResponse
Section titled “InternationalWireDetailsResponse”InternationalWireDetailsResponse:
object&object
Type Declaration
Section titled “Type Declaration”address
Section titled “address”address:
object
address.city?
Section titled “address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
address.country?
Section titled “address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
address.line1?
Section titled “address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
address.line2?
Section titled “address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
address.phone_number?
Section titled “address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
address.postal_code?
Section titled “address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
address.state?
Section titled “address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
beneficiary_bank_name?
Section titled “beneficiary_bank_name?”
optionalbeneficiary_bank_name?:string|null
Description
Section titled “Description”Name of counterparty’s bank
iban:
string
Description
Section titled “Description”Counterparty’s international bank account number
payment_instrument_id
Section titled “payment_instrument_id”payment_instrument_id:
string
Description
Section titled “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
Section titled “swift_code”swift_code:
string
Description
Section titled “Description”Counterparty’s SWIFT code
type:
"ACH"|"DOMESTIC_WIRE"|"CHEQUE"|"INTERNATIONAL_WIRE"
Type Declaration
Section titled “Type Declaration”type:
"INTERNATIONAL_WIRE"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Money:
object
Description
Section titled “Description”Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700.
Money.amount
Section titled “Money.amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700Money.currency
Section titled “Money.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDOriginatingAccount
Section titled “OriginatingAccount”OriginatingAccount:
object&object
Type Declaration
Section titled “Type Declaration”id:
string
Description
Section titled “Description”ID of the Brex Business account: Can be found from the /accounts endpoint
where instrument type is CASH.
type:
"BREX_CASH"
Type Declaration
Section titled “Type Declaration”type:
"BREX_CASH"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Description
Section titled “Description”Originating account details for the transfer
OriginatingAccountResponse
Section titled “OriginatingAccountResponse”OriginatingAccountResponse:
object&object
Type Declaration
Section titled “Type Declaration”id:
string
Description
Section titled “Description”ID of the Brex Business account.
type:
"BREX_CASH"
Type Declaration
Section titled “Type Declaration”type:
"BREX_CASH"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Description
Section titled “Description”Originating account details for the transfer
OriginatingAccountResponseType
Section titled “OriginatingAccountResponseType”OriginatingAccountResponseType:
"BREX_CASH"
OriginatingAccountType
Section titled “OriginatingAccountType”OriginatingAccountType:
"BREX_CASH"
Page_BankConnection_
Section titled “Page_BankConnection_”Page_BankConnection_:
object
Page_BankConnection_.items
Section titled “Page_BankConnection_.items”items:
object[]
Page_BankConnection_.next_cursor?
Section titled “Page_BankConnection_.next_cursor?”
optionalnext_cursor?:string|null
Page_Transfer_
Section titled “Page_Transfer_”Page_Transfer_:
object
Page_Transfer_.items
Section titled “Page_Transfer_.items”items:
object[]
Page_Transfer_.next_cursor?
Section titled “Page_Transfer_.next_cursor?”
optionalnext_cursor?:string|null
Page_VendorResponse_
Section titled “Page_VendorResponse_”Page_VendorResponse_:
object
Page_VendorResponse_.items
Section titled “Page_VendorResponse_.items”items:
object[]
Page_VendorResponse_.next_cursor?
Section titled “Page_VendorResponse_.next_cursor?”
optionalnext_cursor?:string|null
PaymentAccountDetails
Section titled “PaymentAccountDetails”PaymentAccountDetails:
object&object|object&object|object&object
Description
Section titled “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
Section titled “PaymentAccountDetailsResponse”PaymentAccountDetailsResponse:
object&object|object&object|object&object|object&object
PaymentAccountRequest
Section titled “PaymentAccountRequest”PaymentAccountRequest:
object
PaymentAccountRequest.details
Section titled “PaymentAccountRequest.details”details:
object&object|object&object|object&object
PaymentAccountResponse
Section titled “PaymentAccountResponse”PaymentAccountResponse:
object
PaymentAccountResponse.details
Section titled “PaymentAccountResponse.details”details:
object&object|object&object|object&object|object&object
PaymentDetailsTypeRequest
Section titled “PaymentDetailsTypeRequest”PaymentDetailsTypeRequest:
"ACH"|"DOMESTIC_WIRE"|"CHEQUE"
PaymentDetailsTypeResponse
Section titled “PaymentDetailsTypeResponse”PaymentDetailsTypeResponse:
"ACH"|"DOMESTIC_WIRE"|"CHEQUE"|"INTERNATIONAL_WIRE"
PaymentType
Section titled “PaymentType”PaymentType:
"ACH"|"DOMESTIC_WIRE"|"CHEQUE"|"INTERNATIONAL_WIRE"|"BOOK_TRANSFER"|"STABLECOIN"
ReceivingAccount
Section titled “ReceivingAccount”ReceivingAccount:
object&object
Type Declaration
Section titled “Type Declaration”id:
string
Description
Section titled “Description”ID of the Brex business account: Can be found from the List business accounts endpoint
type:
"BREX_CASH"
Type Declaration
Section titled “Type Declaration”type:
"BREX_CASH"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Description
Section titled “Description”Receiving account details for the transfer
ReceivingAccountType
Section titled “ReceivingAccountType”ReceivingAccountType:
"BREX_CASH"
Recipient
Section titled “Recipient”Recipient:
object
Recipient.id
Section titled “Recipient.id”id:
string
Recipient.type
Section titled “Recipient.type”type:
"ACCOUNT_ID"|"PAYMENT_INSTRUMENT_ID"
RecipientType
Section titled “RecipientType”RecipientType:
"ACCOUNT_ID"|"PAYMENT_INSTRUMENT_ID"
Description
Section titled “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
Section titled “Transfer”Transfer:
object
Transfer.amount
Section titled “Transfer.amount”amount:
object
Transfer.amount.amount
Section titled “Transfer.amount.amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700Transfer.amount.currency
Section titled “Transfer.amount.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDTransfer.cancellation_reason?
Section titled “Transfer.cancellation_reason?”
optionalcancellation_reason?:"USER_CANCELLED"|"INSUFFICIENT_FUNDS"|"APPROVAL_DENIED"|"BLOCKED_BY_POSITIVE_PAY"|null
Transfer.counterparty?
Section titled “Transfer.counterparty?”
optionalcounterparty?:Omit<object&object,"type"> |null
Transfer.created_at?
Section titled “Transfer.created_at?”
optionalcreated_at?:string|null
Format: date
Description
Section titled “Description”Date of transfer creation
Transfer.creator_user_id?
Section titled “Transfer.creator_user_id?”
optionalcreator_user_id?:string|null
Description
Section titled “Description”User ID of the transfer initiator
Transfer.description?
Section titled “Transfer.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of the transfer
Transfer.display_name?
Section titled “Transfer.display_name?”
optionaldisplay_name?:string|null
Description
Section titled “Description”Human readable name for the transaction
Transfer.estimated_delivery_date?
Section titled “Transfer.estimated_delivery_date?”
optionalestimated_delivery_date?:string|null
Format: date
Description
Section titled “Description”Estimated delivery date for transfer
Transfer.external_memo?
Section titled “Transfer.external_memo?”
optionalexternal_memo?:string|null
Description
Section titled “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
Section titled “Transfer.id”id:
string
Description
Section titled “Description”Unique ID associated with the transfer
Transfer.is_ppro_enabled?
Section titled “Transfer.is_ppro_enabled?”
optionalis_ppro_enabled?:boolean|null
Description
Section titled “Description”If Principal Protection (PPRO) is enabled
Transfer.originating_account
Section titled “Transfer.originating_account”originating_account:
object&object
Type Declaration
Section titled “Type Declaration”id:
string
Description
Section titled “Description”ID of the Brex Business account.
type:
"BREX_CASH"
Type Declaration
Section titled “Type Declaration”type:
"BREX_CASH"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
Transfer.payment_type
Section titled “Transfer.payment_type”payment_type:
"ACH"|"DOMESTIC_WIRE"|"CHEQUE"|"INTERNATIONAL_WIRE"|"BOOK_TRANSFER"|"STABLECOIN"
Transfer.process_date?
Section titled “Transfer.process_date?”
optionalprocess_date?:string|null
Format: date
Description
Section titled “Description”Transaction processing date
Transfer.status
Section titled “Transfer.status”status:
"PROCESSING"|"SCHEDULED"|"PENDING_APPROVAL"|"FAILED"|"PROCESSED"
TransferCancellationReason
Section titled “TransferCancellationReason”TransferCancellationReason:
"USER_CANCELLED"|"INSUFFICIENT_FUNDS"|"APPROVAL_DENIED"|"BLOCKED_BY_POSITIVE_PAY"
Description
Section titled “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
Section titled “TransferStatus”TransferStatus:
"PROCESSING"|"SCHEDULED"|"PENDING_APPROVAL"|"FAILED"|"PROCESSED"
Description
Section titled “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
Section titled “UpdateVendorRequest”UpdateVendorRequest:
object
UpdateVendorRequest.beneficiary_name?
Section titled “UpdateVendorRequest.beneficiary_name?”
optionalbeneficiary_name?:string|null
Description
Section titled “Description”Name for the Beneficiary
UpdateVendorRequest.company_name?
Section titled “UpdateVendorRequest.company_name?”
optionalcompany_name?:string|null
Description
Section titled “Description”Name for vendor
UpdateVendorRequest.email?
Section titled “UpdateVendorRequest.email?”
optionalemail?:string|null
Format: email
Description
Section titled “Description”Email for vendor
UpdateVendorRequest.payment_accounts?
Section titled “UpdateVendorRequest.payment_accounts?”
optionalpayment_accounts?:object[] |null
Description
Section titled “Description”To update payment instruments, we require the entire payload for each payment instrument that is being updated.
UpdateVendorRequest.phone?
Section titled “UpdateVendorRequest.phone?”
optionalphone?:string|null
Description
Section titled “Description”Phone number for vendor
VendorDetails
Section titled “VendorDetails”VendorDetails:
object&object
Type Declaration
Section titled “Type Declaration”payment_instrument_id
Section titled “payment_instrument_id”payment_instrument_id:
string
Description
Section titled “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:
"VENDOR"|"BOOK_TRANSFER"
Type Declaration
Section titled “Type Declaration”type:
"VENDOR"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
VendorDetailsResponse
Section titled “VendorDetailsResponse”VendorDetailsResponse:
object&object
Type Declaration
Section titled “Type Declaration”account_number?
Section titled “account_number?”
optionalaccount_number?:string|null
Description
Section titled “Description”Account number of a bank account (or IBAN code for international transfer).
id:
string
Description
Section titled “Description”Vendor ID returned from /vendors endpoint
payment_instrument_id
Section titled “payment_instrument_id”payment_instrument_id:
string
routing_number?
Section titled “routing_number?”
optionalrouting_number?:string|null
Description
Section titled “Description”Routing number of a bank account (or SWIFT/BIC code for international transfer).
type:
"VENDOR"|"BOOK_TRANSFER"|"BANK_ACCOUNT"
Type Declaration
Section titled “Type Declaration”type:
"VENDOR"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
VendorResponse
Section titled “VendorResponse”VendorResponse:
object
VendorResponse.company_name?
Section titled “VendorResponse.company_name?”
optionalcompany_name?:string|null
VendorResponse.email?
Section titled “VendorResponse.email?”
optionalemail?:string|null
VendorResponse.id
Section titled “VendorResponse.id”id:
string
Description
Section titled “Description”Vendor ID: Can be passed to /transfers endpoint to specify counterparty.
VendorResponse.payment_accounts?
Section titled “VendorResponse.payment_accounts?”
optionalpayment_accounts?:object[] |null
VendorResponse.phone?
Section titled “VendorResponse.phone?”
optionalphone?:string|null