GET
/
receivers
/
{receiverId}
/
bank-accounts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

receiverId
string
required

Response

200 - application/json
id
string
required

The ID of the bank account.

name
string
required

Display name for the bank account.

type
enum<string>
required

Type of bank account.

Available options:
ach,
wire,
pix
accountClass
enum<string>

Classification of the account holder.

Available options:
individual,
business
accountNumber
string

Bank account number.

accountType
enum<string>

Type of bank account (checking or savings).

Available options:
checking,
saving
addressLine1
string

Primary street address.

addressLine2
string

Secondary address information (apt, suite, etc).

beneficiaryName
string

Name of the account holder or business entity.

city
string

City name.

country
enum<string>

Two-letter country code.

Available options:
BR,
US,
MX,
CO,
AR
pixKey
string

Pix code identifier

postalCode
string

ZIP or postal code.

routingNumber
string

Bank routing number for ACH transfers.

stateProvinceRegion
string

State, province, or region name.