Read all bank accounts

GET

receivers

{receiverId}

bank-accounts

Authorizations

Authorization

string

headerrequired

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

Path Parameters

receiverId

string

required

Response

200 - application/json

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

pixKey

string

Pix code identifier

beneficiaryName

string

Name of the account holder or business entity.

routingNumber

string

Bank routing number for ACH transfers.

accountNumber

string

Bank account number.

accountType

enum<string>

Type of bank account (checking or savings).

Available options:

checking,

saving

accountClass

enum<string>

Classification of the account holder.

Available options:

individual,

business

country

enum<string>

Two-letter country code.

Available options:

BR,

US,

MX,

CO,

AR

city

string

City name.

stateProvinceRegion

string

State, province, or region name.

addressLine1

string

Primary street address.

addressLine2

string

Secondary address information (apt, suite, etc).

postalCode

string

ZIP or postal code.

Was this page helpful?

Extensions

Payments

Authorizations

Path Parameters

Response