Skip to content

Payments API (1.0)

The payments API allows you to initiate and manage payments and vendors from your Brex business accounts.

Download OpenAPI description
Languages
Servers
Production
https://api.brex.com
Staging (Note: This is not a sandbox. It will not work with customer tokens.)
https://api-staging.brex.com

Endpoints to manage vendors

Operations

Endpoints to initiate transfers and view transfer statuses. Note that for all transfer endpoints, the 'money' field is positive or unsigned for outgoing transfers (debits), and negative for incoming transfers (credits).

Operations

Endpoint to view connected linked accounts

Operations

Request

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

Security
OAuth2(Required scopes:
linked_accounts.readonly
)
Query
cursorstring or null
limitinteger or null(int32)
curl -i -X GET \
  https://api.brex.com/v1/linked_accounts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns a list of bank connections

Bodyapplication/json
next_cursorstring or null
itemsArray of objects(BankConnection)required
items[].​idstringrequired
items[].​bank_detailsobjectrequired

Details of the bank - Name, Type

items[].​bank_details.​namestringrequired

The name of the bank

items[].​bank_details.​typestringrequired

The type of bank account connected. For example, CHECKING or SAVING

Enum"CHECKING""SAVING"
items[].​brex_account_idstring or null

Brex business account ID

items[].​last_fourstringrequired
items[].​available_balanceobject or null
items[].​current_balanceobject or null
Response
application/json
{ "next_cursor": "string", "items": [ {} ] }