Skip to content
brex SDKbrex

PaymentsPaths

Defined in: src/payments/types.gen.ts:2

Properties

Section titled “Properties”

/v1/incoming_transfers

Section titled “/v1/incoming_transfers”

/v1/incoming_transfers: object

Defined in: src/payments/types.gen.ts:3

delete?

Section titled “delete?”

optional delete?: undefined

get?

Section titled “get?”

optional get?: undefined

Section titled “head?”

optional head?: undefined

options?

Section titled “options?”

optional options?: undefined

parameters

Section titled “parameters”

parameters: object

parameters.cookie?
Section titled “parameters.cookie?”

optional cookie?: undefined

parameters.header?
Section titled “parameters.header?”

optional header?: undefined

parameters.path?
Section titled “parameters.path?”

optional path?: undefined

parameters.query?
Section titled “parameters.query?”

optional query?: undefined

patch?

Section titled “patch?”

optional patch?: undefined

post

Section titled “post”

post: object

Create incoming transfer

Description
Section titled “Description”

This endpoint creates a new incoming transfer. You may use use any eligible bank account connection to fund (ACH Debit) any active Brex business account.

**Reminder**: You may not use the Brex API for any activity that requires a license or registration from any
governmental authority without Brex's prior review and approval. This includes but is not limited to any money services
business or money transmission activity.


Please review the <a href="https://www.brex.com/legal/developer-portal/">Brex Access Agreement</a> and contact us if
you have any questions.
post.parameters
Section titled “post.parameters”

parameters: object

post.parameters.cookie?
Section titled “post.parameters.cookie?”

optional cookie?: undefined

post.parameters.header
Section titled “post.parameters.header”

header: object

post.parameters.header.Idempotency-Key
Section titled “post.parameters.header.Idempotency-Key”

Idempotency-Key: string

post.parameters.path?
Section titled “post.parameters.path?”

optional path?: undefined

post.parameters.query?
Section titled “post.parameters.query?”

optional query?: undefined

post.requestBody
Section titled “post.requestBody”

requestBody: object

post.requestBody.content
Section titled “post.requestBody.content”

content: object

post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”

application/json: object

post.requestBody.content.application/json.amount
Section titled “post.requestBody.content.application/json.amount”

amount: object

post.requestBody.content.application/json.amount.amount
Section titled “post.requestBody.content.application/json.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”
700
post.requestBody.content.application/json.amount.currency
Section titled “post.requestBody.content.application/json.amount.currency”

currency: string | null

Description
Section titled “Description”

The type of currency, in ISO 4217 format.

Default
Section titled “Default”
USD
Example
Section titled “Example”
USD
post.requestBody.content.application/json.counterparty
Section titled “post.requestBody.content.application/json.counterparty”

counterparty: object & object

Type Declaration
Section titled “Type Declaration”
id
Section titled “id”

id: string

Description
Section titled “Description”

The financial account id: Can be found from the List linked accounts endpoint

type
Section titled “type”

type: "BANK"

Type Declaration
Section titled “Type Declaration”
type
Section titled “type”

type: "BANK"

Description
Section titled “Description”

discriminator enum property added by openapi-typescript

post.requestBody.content.application/json.description
Section titled “post.requestBody.content.application/json.description”

description: string

Description
Section titled “Description”

Description of the transfer for internal use. Not exposed externally.

post.requestBody.content.application/json.receiving_account
Section titled “post.requestBody.content.application/json.receiving_account”

receiving_account: object & object

Type Declaration
Section titled “Type Declaration”
id
Section titled “id”

id: string

Description
Section titled “Description”

ID of the Brex business account: Can be found from the List business accounts endpoint

type
Section titled “type”

type: "BREX_CASH"

Type Declaration
Section titled “Type Declaration”
type
Section titled “type”

type: "BREX_CASH"

Description
Section titled “Description”

discriminator enum property added by openapi-typescript

post.responses
Section titled “post.responses”

responses: object

post.responses.200
Section titled “post.responses.200”

200: object

Description
Section titled “Description”

createIncomingTransfer 200 response

post.responses.200.content
Section titled “post.responses.200.content”

content: object

post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”

application/json: object

post.responses.200.content.application/json.amount
Section titled “post.responses.200.content.application/json.amount”

amount: object

post.responses.200.content.application/json.amount.amount
Section titled “post.responses.200.content.application/json.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”
700
post.responses.200.content.application/json.amount.currency
Section titled “post.responses.200.content.application/json.amount.currency”

currency: string | null

Description
Section titled “Description”

The type of currency, in ISO 4217 format.

Default
Section titled “Default”
USD
Example
Section titled “Example”
USD
post.responses.200.content.application/json.cancellation_reason?
Section titled “post.responses.200.content.application/json.cancellation_reason?”

optional cancellation_reason?: "USER_CANCELLED" | "INSUFFICIENT_FUNDS" | "APPROVAL_DENIED" | "BLOCKED_BY_POSITIVE_PAY" | null

post.responses.200.content.application/json.counterparty?
Section titled “post.responses.200.content.application/json.counterparty?”

optional counterparty?: Omit<object & object, "type"> | null

post.responses.200.content.application/json.created_at?
Section titled “post.responses.200.content.application/json.created_at?”

optional created_at?: string | null

Format: date

Description
Section titled “Description”

Date of transfer creation

post.responses.200.content.application/json.creator_user_id?
Section titled “post.responses.200.content.application/json.creator_user_id?”

optional creator_user_id?: string | null

Description
Section titled “Description”

User ID of the transfer initiator

post.responses.200.content.application/json.description?
Section titled “post.responses.200.content.application/json.description?”

optional description?: string | null

Description
Section titled “Description”

Description of the transfer

post.responses.200.content.application/json.display_name?
Section titled “post.responses.200.content.application/json.display_name?”

optional display_name?: string | null

Description
Section titled “Description”

Human readable name for the transaction

post.responses.200.content.application/json.estimated_delivery_date?
Section titled “post.responses.200.content.application/json.estimated_delivery_date?”

optional estimated_delivery_date?: string | null

Format: date

Description
Section titled “Description”

Estimated delivery date for transfer

post.responses.200.content.application/json.external_memo?
Section titled “post.responses.200.content.application/json.external_memo?”

optional external_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

post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”

id: string

Description
Section titled “Description”

Unique ID associated with the transfer

post.responses.200.content.application/json.is_ppro_enabled?
Section titled “post.responses.200.content.application/json.is_ppro_enabled?”

optional is_ppro_enabled?: boolean | null

Description
Section titled “Description”

If Principal Protection (PPRO) is enabled

post.responses.200.content.application/json.originating_account
Section titled “post.responses.200.content.application/json.originating_account”

originating_account: object & object

Type Declaration
Section titled “Type Declaration”
id
Section titled “id”

id: string

Description
Section titled “Description”

ID of the Brex Business account.

type
Section titled “type”

type: "BREX_CASH"

Type Declaration
Section titled “Type Declaration”
type
Section titled “type”

type: "BREX_CASH"

Description
Section titled “Description”

discriminator enum property added by openapi-typescript

post.responses.200.content.application/json.payment_type
Section titled “post.responses.200.content.application/json.payment_type”

payment_type: "ACH" | "DOMESTIC_WIRE" | "CHEQUE" | "INTERNATIONAL_WIRE" | "BOOK_TRANSFER" | "STABLECOIN"

post.responses.200.content.application/json.process_date?
Section titled “post.responses.200.content.application/json.process_date?”

optional process_date?: string | null

Format: date

Description
Section titled “Description”

Transaction processing date

post.responses.200.content.application/json.status
Section titled “post.responses.200.content.application/json.status”

status: "PROCESSING" | "SCHEDULED" | "PENDING_APPROVAL" | "FAILED" | "PROCESSED"

post.responses.200.headers
Section titled “post.responses.200.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

put?

Section titled “put?”

optional put?: undefined

trace?

Section titled “trace?”

optional trace?: undefined

/v1/linked_accounts

Section titled “/v1/linked_accounts”

/v1/linked_accounts: object

Defined in: src/payments/types.gen.ts:31

delete?

Section titled “delete?”

optional delete?: undefined

get

Section titled “get”

get: object

Lists linked accounts

Description
Section titled “Description”

This endpoint lists all bank connections that are eligible to make ACH transfers to Brex business account

get.parameters
Section titled “get.parameters”

parameters: object

get.parameters.cookie?
Section titled “get.parameters.cookie?”

optional cookie?: undefined

get.parameters.header?
Section titled “get.parameters.header?”

optional header?: undefined

get.parameters.path?
Section titled “get.parameters.path?”

optional path?: undefined

get.parameters.query?
Section titled “get.parameters.query?”

optional query?: object

get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”

optional cursor?: string | null

get.parameters.query.limit?
Section titled “get.parameters.query.limit?”

optional limit?: number | null

get.requestBody?
Section titled “get.requestBody?”

optional requestBody?: undefined

get.responses
Section titled “get.responses”

responses: object

get.responses.200
Section titled “get.responses.200”

200: object

Description
Section titled “Description”

Returns a list of bank connections

get.responses.200.content
Section titled “get.responses.200.content”

content: object

get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”

application/json: object

get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”

items: object[]

get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”

optional next_cursor?: string | null

get.responses.200.headers
Section titled “get.responses.200.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.400
Section titled “get.responses.400”

400: object

Description
Section titled “Description”

Bad request

get.responses.400.content?
Section titled “get.responses.400.content?”

optional content?: undefined

get.responses.400.headers
Section titled “get.responses.400.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.401
Section titled “get.responses.401”

401: object

Description
Section titled “Description”

Unauthorized

get.responses.401.content?
Section titled “get.responses.401.content?”

optional content?: undefined

get.responses.401.headers
Section titled “get.responses.401.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.403
Section titled “get.responses.403”

403: object

Description
Section titled “Description”

Forbidden

get.responses.403.content?
Section titled “get.responses.403.content?”

optional content?: undefined

get.responses.403.headers
Section titled “get.responses.403.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

head?

Section titled “head?”

optional head?: undefined

options?

Section titled “options?”

optional options?: undefined

parameters

Section titled “parameters”

parameters: object

parameters.cookie?
Section titled “parameters.cookie?”

optional cookie?: undefined

parameters.header?
Section titled “parameters.header?”

optional header?: undefined

parameters.path?
Section titled “parameters.path?”

optional path?: undefined

parameters.query?
Section titled “parameters.query?”

optional query?: undefined

patch?

Section titled “patch?”

optional patch?: undefined

post?

Section titled “post?”

optional post?: undefined

put?

Section titled “put?”

optional put?: undefined

trace?

Section titled “trace?”

optional trace?: undefined

/v1/transfers

Section titled “/v1/transfers”

/v1/transfers: object

Defined in: src/payments/types.gen.ts:51

delete?

Section titled “delete?”

optional delete?: undefined

get

Section titled “get”

get: object

Lists transfers

Description
Section titled “Description”

This endpoint lists existing transfers for an account.

Currently, the API can only return transfers for the following payment rails:
- ACH
- DOMESTIC_WIRE
- CHEQUE
- INTERNATIONAL_WIRE
get.parameters
Section titled “get.parameters”

parameters: object

get.parameters.cookie?
Section titled “get.parameters.cookie?”

optional cookie?: undefined

get.parameters.header?
Section titled “get.parameters.header?”

optional header?: undefined

get.parameters.path?
Section titled “get.parameters.path?”

optional path?: undefined

get.parameters.query?
Section titled “get.parameters.query?”

optional query?: object

get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”

optional cursor?: string | null

get.parameters.query.limit?
Section titled “get.parameters.query.limit?”

optional limit?: number | null

get.requestBody?
Section titled “get.requestBody?”

optional requestBody?: undefined

get.responses
Section titled “get.responses”

responses: object

get.responses.200
Section titled “get.responses.200”

200: object

Description
Section titled “Description”

Returns a list of transfers.

get.responses.200.content
Section titled “get.responses.200.content”

content: object

get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”

application/json: object

get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”

items: object[]

get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”

optional next_cursor?: string | null

get.responses.200.headers
Section titled “get.responses.200.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.400
Section titled “get.responses.400”

400: object

Description
Section titled “Description”

Bad request

get.responses.400.content?
Section titled “get.responses.400.content?”

optional content?: undefined

get.responses.400.headers
Section titled “get.responses.400.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.401
Section titled “get.responses.401”

401: object

Description
Section titled “Description”

Unauthorized

get.responses.401.content?
Section titled “get.responses.401.content?”

optional content?: undefined

get.responses.401.headers
Section titled “get.responses.401.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.403
Section titled “get.responses.403”

403: object

Description
Section titled “Description”

Forbidden

get.responses.403.content?
Section titled “get.responses.403.content?”

optional content?: undefined

get.responses.403.headers
Section titled “get.responses.403.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.500
Section titled “get.responses.500”

500: object

Description
Section titled “Description”

Internal server error

get.responses.500.content?
Section titled “get.responses.500.content?”

optional content?: undefined

get.responses.500.headers
Section titled “get.responses.500.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

head?

Section titled “head?”

optional head?: undefined

options?

Section titled “options?”

optional options?: undefined

parameters

Section titled “parameters”

parameters: object

parameters.cookie?
Section titled “parameters.cookie?”

optional cookie?: undefined

parameters.header?
Section titled “parameters.header?”

optional header?: undefined

parameters.path?
Section titled “parameters.path?”

optional path?: undefined

parameters.query?
Section titled “parameters.query?”

optional query?: undefined

patch?

Section titled “patch?”

optional patch?: undefined

post

Section titled “post”

post: object

Create transfer

Description
Section titled “Description”

This endpoint creates a new transfer.

Currently, the API can only create transfers for the following payment rails:
- ACH
- DOMESTIC_WIRE
- CHEQUE
- INTERNATIONAL_WIRES


**Transaction Descriptions**
* For outgoing check payments, a successful transfer will return a response containing a description value with a format of `Check #<check number> to <recipient_name> - <external_memo>`.
* For book transfers (from one Brex Business account to another), the recipient value will have a format of `<customer_account.dba_name> - <external_memo>` and the sender will have a format of `<target customer account's dba name> - <external_memo>`.
* For other payment rails, the format will be `<counterparty_name> - <external_memo>`, where Counterparty name is `payment_instrument.beneficiary_name` or `contact.name`
For vendors created from the Payments API, the `counterparty_name` will be the `company_name` [field](/openapi/payments_api/#operation/createVendor!path=company_name&t=request).


**Reminder**: You may not use the Brex API for any activity that requires a license or registration from any
governmental authority without Brex's prior review and approval. This includes but is not limited to any money services
business or money transmission activity.


Please review the <a href="https://www.brex.com/legal/developer-portal/">Brex Access Agreement</a> and contact us if
you have any questions.
post.parameters
Section titled “post.parameters”

parameters: object

post.parameters.cookie?
Section titled “post.parameters.cookie?”

optional cookie?: undefined

post.parameters.header
Section titled “post.parameters.header”

header: object

post.parameters.header.Idempotency-Key
Section titled “post.parameters.header.Idempotency-Key”

Idempotency-Key: string

post.parameters.path?
Section titled “post.parameters.path?”

optional path?: undefined

post.parameters.query?
Section titled “post.parameters.query?”

optional query?: undefined

post.requestBody
Section titled “post.requestBody”

requestBody: object

post.requestBody.content
Section titled “post.requestBody.content”

content: object

post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”

application/json: object

post.requestBody.content.application/json.amount
Section titled “post.requestBody.content.application/json.amount”

amount: object

post.requestBody.content.application/json.amount.amount
Section titled “post.requestBody.content.application/json.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”
700
post.requestBody.content.application/json.amount.currency
Section titled “post.requestBody.content.application/json.amount.currency”

currency: string | null

Description
Section titled “Description”

The type of currency, in ISO 4217 format.

Default
Section titled “Default”
USD
Example
Section titled “Example”
USD
post.requestBody.content.application/json.approval_type?
Section titled “post.requestBody.content.application/json.approval_type?”

optional approval_type?: "MANUAL" | null

post.requestBody.content.application/json.counterparty
Section titled “post.requestBody.content.application/json.counterparty”

counterparty: object & object | object & object

post.requestBody.content.application/json.description
Section titled “post.requestBody.content.application/json.description”

description: string

Description
Section titled “Description”

Description of the transfer for internal use. Not exposed externally.

post.requestBody.content.application/json.external_memo
Section titled “post.requestBody.content.application/json.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

post.requestBody.content.application/json.is_ppro_enabled?
Section titled “post.requestBody.content.application/json.is_ppro_enabled?”

optional is_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.

post.requestBody.content.application/json.originating_account
Section titled “post.requestBody.content.application/json.originating_account”

originating_account: Omit<object & object, "type">

post.responses
Section titled “post.responses”

responses: object

post.responses.200
Section titled “post.responses.200”

200: object

Description
Section titled “Description”

createTransfer 200 response

post.responses.200.content
Section titled “post.responses.200.content”

content: object

post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”

application/json: object

post.responses.200.content.application/json.amount
Section titled “post.responses.200.content.application/json.amount”

amount: object

post.responses.200.content.application/json.amount.amount
Section titled “post.responses.200.content.application/json.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”
700
post.responses.200.content.application/json.amount.currency
Section titled “post.responses.200.content.application/json.amount.currency”

currency: string | null

Description
Section titled “Description”

The type of currency, in ISO 4217 format.

Default
Section titled “Default”
USD
Example
Section titled “Example”
USD
post.responses.200.content.application/json.cancellation_reason?
Section titled “post.responses.200.content.application/json.cancellation_reason?”

optional cancellation_reason?: "USER_CANCELLED" | "INSUFFICIENT_FUNDS" | "APPROVAL_DENIED" | "BLOCKED_BY_POSITIVE_PAY" | null

post.responses.200.content.application/json.counterparty?
Section titled “post.responses.200.content.application/json.counterparty?”

optional counterparty?: Omit<object & object, "type"> | null

post.responses.200.content.application/json.created_at?
Section titled “post.responses.200.content.application/json.created_at?”

optional created_at?: string | null

Format: date

Description
Section titled “Description”

Date of transfer creation

post.responses.200.content.application/json.creator_user_id?
Section titled “post.responses.200.content.application/json.creator_user_id?”

optional creator_user_id?: string | null

Description
Section titled “Description”

User ID of the transfer initiator

post.responses.200.content.application/json.description?
Section titled “post.responses.200.content.application/json.description?”

optional description?: string | null

Description
Section titled “Description”

Description of the transfer

post.responses.200.content.application/json.display_name?
Section titled “post.responses.200.content.application/json.display_name?”

optional display_name?: string | null

Description
Section titled “Description”

Human readable name for the transaction

post.responses.200.content.application/json.estimated_delivery_date?
Section titled “post.responses.200.content.application/json.estimated_delivery_date?”

optional estimated_delivery_date?: string | null

Format: date

Description
Section titled “Description”

Estimated delivery date for transfer

post.responses.200.content.application/json.external_memo?
Section titled “post.responses.200.content.application/json.external_memo?”

optional external_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

post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”

id: string

Description
Section titled “Description”

Unique ID associated with the transfer

post.responses.200.content.application/json.is_ppro_enabled?
Section titled “post.responses.200.content.application/json.is_ppro_enabled?”

optional is_ppro_enabled?: boolean | null

Description
Section titled “Description”

If Principal Protection (PPRO) is enabled

post.responses.200.content.application/json.originating_account
Section titled “post.responses.200.content.application/json.originating_account”

originating_account: object & object

Type Declaration
Section titled “Type Declaration”
id
Section titled “id”

id: string

Description
Section titled “Description”

ID of the Brex Business account.

type
Section titled “type”

type: "BREX_CASH"

Type Declaration
Section titled “Type Declaration”
type
Section titled “type”

type: "BREX_CASH"

Description
Section titled “Description”

discriminator enum property added by openapi-typescript

post.responses.200.content.application/json.payment_type
Section titled “post.responses.200.content.application/json.payment_type”

payment_type: "ACH" | "DOMESTIC_WIRE" | "CHEQUE" | "INTERNATIONAL_WIRE" | "BOOK_TRANSFER" | "STABLECOIN"

post.responses.200.content.application/json.process_date?
Section titled “post.responses.200.content.application/json.process_date?”

optional process_date?: string | null

Format: date

Description
Section titled “Description”

Transaction processing date

post.responses.200.content.application/json.status
Section titled “post.responses.200.content.application/json.status”

status: "PROCESSING" | "SCHEDULED" | "PENDING_APPROVAL" | "FAILED" | "PROCESSED"

post.responses.200.headers
Section titled “post.responses.200.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

put?

Section titled “put?”

optional put?: undefined

trace?

Section titled “trace?”

optional trace?: undefined

/v1/transfers/{id}

Section titled “/v1/transfers/{id}”

/v1/transfers/{id}: object

Defined in: src/payments/types.gen.ts:100

delete?

Section titled “delete?”

optional delete?: undefined

get

Section titled “get”

get: object

Get transfer

Description
Section titled “Description”

This endpoint gets a transfer by ID.

Currently, the API can only return transfers for the following payment rails:
- ACH
- DOMESTIC_WIRE
- CHEQUE
- INTERNATIONAL_WIRE
get.parameters
Section titled “get.parameters”

parameters: object

get.parameters.cookie?
Section titled “get.parameters.cookie?”

optional cookie?: undefined

get.parameters.header?
Section titled “get.parameters.header?”

optional header?: undefined

get.parameters.path
Section titled “get.parameters.path”

path: object

get.parameters.path.id
Section titled “get.parameters.path.id”

id: string

get.parameters.query?
Section titled “get.parameters.query?”

optional query?: undefined

get.requestBody?
Section titled “get.requestBody?”

optional requestBody?: undefined

get.responses
Section titled “get.responses”

responses: object

get.responses.200
Section titled “get.responses.200”

200: object

Description
Section titled “Description”

Returns a transfer.

get.responses.200.content
Section titled “get.responses.200.content”

content: object

get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”

application/json: object

get.responses.200.content.application/json.amount
Section titled “get.responses.200.content.application/json.amount”

amount: object

get.responses.200.content.application/json.amount.amount
Section titled “get.responses.200.content.application/json.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”
700
get.responses.200.content.application/json.amount.currency
Section titled “get.responses.200.content.application/json.amount.currency”

currency: string | null

Description
Section titled “Description”

The type of currency, in ISO 4217 format.

Default
Section titled “Default”
USD
Example
Section titled “Example”
USD
get.responses.200.content.application/json.cancellation_reason?
Section titled “get.responses.200.content.application/json.cancellation_reason?”

optional cancellation_reason?: "USER_CANCELLED" | "INSUFFICIENT_FUNDS" | "APPROVAL_DENIED" | "BLOCKED_BY_POSITIVE_PAY" | null

get.responses.200.content.application/json.counterparty?
Section titled “get.responses.200.content.application/json.counterparty?”

optional counterparty?: Omit<object & object, "type"> | null

get.responses.200.content.application/json.created_at?
Section titled “get.responses.200.content.application/json.created_at?”

optional created_at?: string | null

Format: date

Description
Section titled “Description”

Date of transfer creation

get.responses.200.content.application/json.creator_user_id?
Section titled “get.responses.200.content.application/json.creator_user_id?”

optional creator_user_id?: string | null

Description
Section titled “Description”

User ID of the transfer initiator

get.responses.200.content.application/json.description?
Section titled “get.responses.200.content.application/json.description?”

optional description?: string | null

Description
Section titled “Description”

Description of the transfer

get.responses.200.content.application/json.display_name?
Section titled “get.responses.200.content.application/json.display_name?”

optional display_name?: string | null

Description
Section titled “Description”

Human readable name for the transaction

get.responses.200.content.application/json.estimated_delivery_date?
Section titled “get.responses.200.content.application/json.estimated_delivery_date?”

optional estimated_delivery_date?: string | null

Format: date

Description
Section titled “Description”

Estimated delivery date for transfer

get.responses.200.content.application/json.external_memo?
Section titled “get.responses.200.content.application/json.external_memo?”

optional external_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

get.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”

id: string

Description
Section titled “Description”

Unique ID associated with the transfer

get.responses.200.content.application/json.is_ppro_enabled?
Section titled “get.responses.200.content.application/json.is_ppro_enabled?”

optional is_ppro_enabled?: boolean | null

Description
Section titled “Description”

If Principal Protection (PPRO) is enabled

get.responses.200.content.application/json.originating_account
Section titled “get.responses.200.content.application/json.originating_account”

originating_account: object & object

Type Declaration
Section titled “Type Declaration”
id
Section titled “id”

id: string

Description
Section titled “Description”

ID of the Brex Business account.

type
Section titled “type”

type: "BREX_CASH"

Type Declaration
Section titled “Type Declaration”
type
Section titled “type”

type: "BREX_CASH"

Description
Section titled “Description”

discriminator enum property added by openapi-typescript

get.responses.200.content.application/json.payment_type
Section titled “get.responses.200.content.application/json.payment_type”

payment_type: "ACH" | "DOMESTIC_WIRE" | "CHEQUE" | "INTERNATIONAL_WIRE" | "BOOK_TRANSFER" | "STABLECOIN"

get.responses.200.content.application/json.process_date?
Section titled “get.responses.200.content.application/json.process_date?”

optional process_date?: string | null

Format: date

Description
Section titled “Description”

Transaction processing date

get.responses.200.content.application/json.status
Section titled “get.responses.200.content.application/json.status”

status: "PROCESSING" | "SCHEDULED" | "PENDING_APPROVAL" | "FAILED" | "PROCESSED"

get.responses.200.headers
Section titled “get.responses.200.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.400
Section titled “get.responses.400”

400: object

Description
Section titled “Description”

Bad request

get.responses.400.content?
Section titled “get.responses.400.content?”

optional content?: undefined

get.responses.400.headers
Section titled “get.responses.400.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.401
Section titled “get.responses.401”

401: object

Description
Section titled “Description”

Unauthorized

get.responses.401.content?
Section titled “get.responses.401.content?”

optional content?: undefined

get.responses.401.headers
Section titled “get.responses.401.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.403
Section titled “get.responses.403”

403: object

Description
Section titled “Description”

Forbidden

get.responses.403.content?
Section titled “get.responses.403.content?”

optional content?: undefined

get.responses.403.headers
Section titled “get.responses.403.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.500
Section titled “get.responses.500”

500: object

Description
Section titled “Description”

Internal server error

get.responses.500.content?
Section titled “get.responses.500.content?”

optional content?: undefined

get.responses.500.headers
Section titled “get.responses.500.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

head?

Section titled “head?”

optional head?: undefined

options?

Section titled “options?”

optional options?: undefined

parameters

Section titled “parameters”

parameters: object

parameters.cookie?
Section titled “parameters.cookie?”

optional cookie?: undefined

parameters.header?
Section titled “parameters.header?”

optional header?: undefined

parameters.path?
Section titled “parameters.path?”

optional path?: undefined

parameters.query?
Section titled “parameters.query?”

optional query?: undefined

patch?

Section titled “patch?”

optional patch?: undefined

post?

Section titled “post?”

optional post?: undefined

put?

Section titled “put?”

optional put?: undefined

trace?

Section titled “trace?”

optional trace?: undefined

/v1/vendors

Section titled “/v1/vendors”

/v1/vendors: object

Defined in: src/payments/types.gen.ts:126

delete?

Section titled “delete?”

optional delete?: undefined

get

Section titled “get”

get: object

Lists vendors

Description
Section titled “Description”

This endpoint lists all existing vendors for an account. Takes an optional parameter to match by vendor name.

get.parameters
Section titled “get.parameters”

parameters: object

get.parameters.cookie?
Section titled “get.parameters.cookie?”

optional cookie?: undefined

get.parameters.header?
Section titled “get.parameters.header?”

optional header?: undefined

get.parameters.path?
Section titled “get.parameters.path?”

optional path?: undefined

get.parameters.query?
Section titled “get.parameters.query?”

optional query?: object

get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”

optional cursor?: string | null

get.parameters.query.limit?
Section titled “get.parameters.query.limit?”

optional limit?: number | null

get.parameters.query.name?
Section titled “get.parameters.query.name?”

optional name?: string | null

get.requestBody?
Section titled “get.requestBody?”

optional requestBody?: undefined

get.responses
Section titled “get.responses”

responses: object

get.responses.200
Section titled “get.responses.200”

200: object

Description
Section titled “Description”

Returns a list of vendor objects.

get.responses.200.content
Section titled “get.responses.200.content”

content: object

get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”

application/json: object

get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”

items: object[]

get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”

optional next_cursor?: string | null

get.responses.200.headers
Section titled “get.responses.200.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.400
Section titled “get.responses.400”

400: object

Description
Section titled “Description”

Bad request

get.responses.400.content?
Section titled “get.responses.400.content?”

optional content?: undefined

get.responses.400.headers
Section titled “get.responses.400.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.401
Section titled “get.responses.401”

401: object

Description
Section titled “Description”

Unauthorized

get.responses.401.content?
Section titled “get.responses.401.content?”

optional content?: undefined

get.responses.401.headers
Section titled “get.responses.401.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.403
Section titled “get.responses.403”

403: object

Description
Section titled “Description”

Forbidden

get.responses.403.content?
Section titled “get.responses.403.content?”

optional content?: undefined

get.responses.403.headers
Section titled “get.responses.403.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

head?

Section titled “head?”

optional head?: undefined

options?

Section titled “options?”

optional options?: undefined

parameters

Section titled “parameters”

parameters: object

parameters.cookie?
Section titled “parameters.cookie?”

optional cookie?: undefined

parameters.header?
Section titled “parameters.header?”

optional header?: undefined

parameters.path?
Section titled “parameters.path?”

optional path?: undefined

parameters.query?
Section titled “parameters.query?”

optional query?: undefined

patch?

Section titled “patch?”

optional patch?: undefined

post

Section titled “post”

post: object

Create vendor

Description
Section titled “Description”

This endpoint creates a new vendor.

post.parameters
Section titled “post.parameters”

parameters: object

post.parameters.cookie?
Section titled “post.parameters.cookie?”

optional cookie?: undefined

post.parameters.header
Section titled “post.parameters.header”

header: object

post.parameters.header.Idempotency-Key
Section titled “post.parameters.header.Idempotency-Key”

Idempotency-Key: string

post.parameters.path?
Section titled “post.parameters.path?”

optional path?: undefined

post.parameters.query?
Section titled “post.parameters.query?”

optional query?: undefined

post.requestBody
Section titled “post.requestBody”

requestBody: object

post.requestBody.content
Section titled “post.requestBody.content”

content: object

post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”

application/json: object

post.requestBody.content.application/json.company_name
Section titled “post.requestBody.content.application/json.company_name”

company_name: string

Description
Section titled “Description”

Name for vendor. The name must be unique.

post.requestBody.content.application/json.email?
Section titled “post.requestBody.content.application/json.email?”

optional email?: string | null

Format: email

Description
Section titled “Description”

Email for vendor.

post.requestBody.content.application/json.payment_accounts?
Section titled “post.requestBody.content.application/json.payment_accounts?”

optional payment_accounts?: object[] | null

Description
Section titled “Description”

Payment accounts associated with the vendor.

post.requestBody.content.application/json.phone?
Section titled “post.requestBody.content.application/json.phone?”

optional phone?: string | null

Description
Section titled “Description”

Phone number for vendor.

post.responses
Section titled “post.responses”

responses: object

post.responses.200
Section titled “post.responses.200”

200: object

Description
Section titled “Description”

createVendor 200 response

post.responses.200.content
Section titled “post.responses.200.content”

content: object

post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”

application/json: object

post.responses.200.content.application/json.company_name?
Section titled “post.responses.200.content.application/json.company_name?”

optional company_name?: string | null

post.responses.200.content.application/json.email?
Section titled “post.responses.200.content.application/json.email?”

optional email?: string | null

post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”

id: string

Description
Section titled “Description”

Vendor ID: Can be passed to /transfers endpoint to specify counterparty.

post.responses.200.content.application/json.payment_accounts?
Section titled “post.responses.200.content.application/json.payment_accounts?”

optional payment_accounts?: object[] | null

post.responses.200.content.application/json.phone?
Section titled “post.responses.200.content.application/json.phone?”

optional phone?: string | null

post.responses.200.headers
Section titled “post.responses.200.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

put?

Section titled “put?”

optional put?: undefined

trace?

Section titled “trace?”

optional trace?: undefined

/v1/vendors/{id}

Section titled “/v1/vendors/{id}”

/v1/vendors/{id}: object

Defined in: src/payments/types.gen.ts:151

delete

Section titled “delete”

delete: object

Delete vendor.

Description
Section titled “Description”

This endpoint deletes a vendor by ID.

delete.parameters
Section titled “delete.parameters”

parameters: object

delete.parameters.cookie?
Section titled “delete.parameters.cookie?”

optional cookie?: undefined

delete.parameters.header?
Section titled “delete.parameters.header?”

optional header?: undefined

delete.parameters.path
Section titled “delete.parameters.path”

path: object

delete.parameters.path.id
Section titled “delete.parameters.path.id”

id: string

delete.parameters.query?
Section titled “delete.parameters.query?”

optional query?: undefined

delete.requestBody?
Section titled “delete.requestBody?”

optional requestBody?: undefined

delete.responses
Section titled “delete.responses”

responses: object

delete.responses.200
Section titled “delete.responses.200”

200: object

Description
Section titled “Description”

deleteVendor 200 response

delete.responses.200.content?
Section titled “delete.responses.200.content?”

optional content?: undefined

delete.responses.200.headers
Section titled “delete.responses.200.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get

Section titled “get”

get: object

Get vendor

Description
Section titled “Description”

This endpoint gets a vendor by ID.

get.parameters
Section titled “get.parameters”

parameters: object

get.parameters.cookie?
Section titled “get.parameters.cookie?”

optional cookie?: undefined

get.parameters.header?
Section titled “get.parameters.header?”

optional header?: undefined

get.parameters.path
Section titled “get.parameters.path”

path: object

get.parameters.path.id
Section titled “get.parameters.path.id”

id: string

get.parameters.query?
Section titled “get.parameters.query?”

optional query?: undefined

get.requestBody?
Section titled “get.requestBody?”

optional requestBody?: undefined

get.responses
Section titled “get.responses”

responses: object

get.responses.200
Section titled “get.responses.200”

200: object

Description
Section titled “Description”

Returns a vendor object.

get.responses.200.content
Section titled “get.responses.200.content”

content: object

get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”

application/json: object

get.responses.200.content.application/json.company_name?
Section titled “get.responses.200.content.application/json.company_name?”

optional company_name?: string | null

get.responses.200.content.application/json.email?
Section titled “get.responses.200.content.application/json.email?”

optional email?: string | null

get.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”

id: string

Description
Section titled “Description”

Vendor ID: Can be passed to /transfers endpoint to specify counterparty.

get.responses.200.content.application/json.payment_accounts?
Section titled “get.responses.200.content.application/json.payment_accounts?”

optional payment_accounts?: object[] | null

get.responses.200.content.application/json.phone?
Section titled “get.responses.200.content.application/json.phone?”

optional phone?: string | null

get.responses.200.headers
Section titled “get.responses.200.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.400
Section titled “get.responses.400”

400: object

Description
Section titled “Description”

Bad request

get.responses.400.content?
Section titled “get.responses.400.content?”

optional content?: undefined

get.responses.400.headers
Section titled “get.responses.400.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.401
Section titled “get.responses.401”

401: object

Description
Section titled “Description”

Unauthorized

get.responses.401.content?
Section titled “get.responses.401.content?”

optional content?: undefined

get.responses.401.headers
Section titled “get.responses.401.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.403
Section titled “get.responses.403”

403: object

Description
Section titled “Description”

Forbidden

get.responses.403.content?
Section titled “get.responses.403.content?”

optional content?: undefined

get.responses.403.headers
Section titled “get.responses.403.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

get.responses.500
Section titled “get.responses.500”

500: object

Description
Section titled “Description”

Internal server error

get.responses.500.content?
Section titled “get.responses.500.content?”

optional content?: undefined

get.responses.500.headers
Section titled “get.responses.500.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

head?

Section titled “head?”

optional head?: undefined

options?

Section titled “options?”

optional options?: undefined

parameters

Section titled “parameters”

parameters: object

parameters.cookie?
Section titled “parameters.cookie?”

optional cookie?: undefined

parameters.header?
Section titled “parameters.header?”

optional header?: undefined

parameters.path?
Section titled “parameters.path?”

optional path?: undefined

parameters.query?
Section titled “parameters.query?”

optional query?: undefined

patch?

Section titled “patch?”

optional patch?: undefined

post?

Section titled “post?”

optional post?: undefined

put

Section titled “put”

put: object

Update vendor

Description
Section titled “Description”

Updates an existing vendor by ID.

put.parameters
Section titled “put.parameters”

parameters: object

put.parameters.cookie?
Section titled “put.parameters.cookie?”

optional cookie?: undefined

put.parameters.header?
Section titled “put.parameters.header?”

optional header?: object

put.parameters.header.Idempotency-Key?
Section titled “put.parameters.header.Idempotency-Key?”

optional Idempotency-Key?: string | null

put.parameters.path
Section titled “put.parameters.path”

path: object

put.parameters.path.id
Section titled “put.parameters.path.id”

id: string

put.parameters.query?
Section titled “put.parameters.query?”

optional query?: undefined

put.requestBody
Section titled “put.requestBody”

requestBody: object

put.requestBody.content
Section titled “put.requestBody.content”

content: object

put.requestBody.content.application/json
Section titled “put.requestBody.content.application/json”

application/json: object

put.requestBody.content.application/json.beneficiary_name?
Section titled “put.requestBody.content.application/json.beneficiary_name?”

optional beneficiary_name?: string | null

Description
Section titled “Description”

Name for the Beneficiary

put.requestBody.content.application/json.company_name?
Section titled “put.requestBody.content.application/json.company_name?”

optional company_name?: string | null

Description
Section titled “Description”

Name for vendor

put.requestBody.content.application/json.email?
Section titled “put.requestBody.content.application/json.email?”

optional email?: string | null

Format: email

Description
Section titled “Description”

Email for vendor

put.requestBody.content.application/json.payment_accounts?
Section titled “put.requestBody.content.application/json.payment_accounts?”

optional payment_accounts?: object[] | null

Description
Section titled “Description”

To update payment instruments, we require the entire payload for each payment instrument that is being updated.

put.requestBody.content.application/json.phone?
Section titled “put.requestBody.content.application/json.phone?”

optional phone?: string | null

Description
Section titled “Description”

Phone number for vendor

put.responses
Section titled “put.responses”

responses: object

put.responses.200
Section titled “put.responses.200”

200: object

Description
Section titled “Description”

updateVendor 200 response

put.responses.200.content
Section titled “put.responses.200.content”

content: object

put.responses.200.content.application/json
Section titled “put.responses.200.content.application/json”

application/json: object

put.responses.200.content.application/json.company_name?
Section titled “put.responses.200.content.application/json.company_name?”

optional company_name?: string | null

put.responses.200.content.application/json.email?
Section titled “put.responses.200.content.application/json.email?”

optional email?: string | null

put.responses.200.content.application/json.id
Section titled “put.responses.200.content.application/json.id”

id: string

Description
Section titled “Description”

Vendor ID: Can be passed to /transfers endpoint to specify counterparty.

put.responses.200.content.application/json.payment_accounts?
Section titled “put.responses.200.content.application/json.payment_accounts?”

optional payment_accounts?: object[] | null

put.responses.200.content.application/json.phone?
Section titled “put.responses.200.content.application/json.phone?”

optional phone?: string | null

put.responses.200.headers
Section titled “put.responses.200.headers”

headers: object

Index Signature
Section titled “Index Signature”

[name: string]: unknown

trace?

Section titled “trace?”

optional trace?: undefined