Accounts

Get primary cash account

This endpoint returns the primary cash account with its status. There will always be only one primary account.

get/v2/accounts/cash/primary

Request

Base URL
https://api.brex.com
Auth
OAuth 2
Authorization codehttps://accounts-api.brex.com/oauth2/default/v1/authorize
Token URLhttps://accounts-api.brex.com/oauth2/default/v1/token
Scopesaccounts.cash.readonly
TypeScript
https://skmtc.dev/brex-com/apis/transactions-api/docs/v2/accounts/cash/primary/get.ts
A function with typed inputs. Its response is checked against the schema.

Returns the primary cash account.

idstring required

ID of the cash account

namestring required

status'ACTIVE'

account_numberstring required

routing_numberstring required

primaryboolean required

Whether or not this account is the primary account. There will always be only one primary account.

{
  "current_balance": {
    "amount": 700,
    "currency": "USD"
  },
  "available_balance": {
    "amount": 700,
    "currency": "USD"
  }
}

No recorded changes to this operation across all 1 revision of this API.