POST
/
receivers
/
{receiverId}
/
bank-accounts
curl --request POST \
  --url https://extensions-sandbox.lumx.io/payments/receivers/{receiverId}/bank-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Default Account",
  "type": "pix",
  "pixKey": "14947677768",
  "beneficiaryName": "Individual full name or business name",
  "routingNumber": "012345678",
  "accountNumber": "1001001234",
  "accountType": "checking",
  "accountClass": "individual",
  "addressLine1": "Address line 1",
  "addressLine2": "Address line 2",
  "city": "City",
  "stateProvinceRegion": "State/Province/Region",
  "country": "BR",
  "postalCode": "Postal code"
}'
{
  "id": "ba_000000000000"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
receiverId
string
required

Body

application/json
​
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 key 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
​
addressLine1
string

Primary street address.

​
addressLine2
string

Secondary address information (apt, suite, etc).

​
city
string

City name.

​
stateProvinceRegion
string

State, province, or region name.

​
country
enum<string>

Two-letter country code.

Available options:
BR,
US,
MX,
CO,
AR
​
postalCode
string

ZIP or postal code.

Response

201 - application/json
​
id
string
required

The ID of the bank account.

Read all bank accountsRead a bank account