Create BRL bank-account beneficiary

curl --request POST \ --url https://api.example.com/v2/account/beneficiaries/bank-accounts/brl/ \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "alias": "<string>", "description": "<string>", "pixKey": "<string>", "taxId": "<string>", "userName": "<string>", "bankCode": "<string>", "branchCode": "<string>", "accountNumber": "<string>" } '

Authorizations

Authorization

string

header

required

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

Query Parameters

subAccountId

string<uuid>

Operate against a sub-account of the authenticated main account.

Body

application/json

Passthrough body to the platform service CreateBeneficiaryBrlBankAccountInput. V2 forwards the body verbatim; clients must use upstream field names.

alias

string

required

description

string

pixKey

string

taxId

string

userName

string

bankCode

string

branchCode

string

accountNumber

string

accountType

enum<string>

Available options:

CHECKING,

SAVINGS,

PAYMENT

Response

string<uuid>