Skip to main content
GET
/
v2
/
account
/
beneficiaries
/
bank-accounts
/
brl
Get Beneficiary BRL Bank Accounts
curl --request GET \
  --url https://api.avenia.io:8443/v2/v2/account/beneficiaries/bank-accounts/brl \
  --header 'Authorization: Bearer <token>'
{
  "bankAccounts": [
    {
      "id": "<string>",
      "alias": "<string>",
      "description": "<string>",
      "pixKey": "<string>",
      "taxId": "<string>",
      "userName": "<string>",
      "bankCode": "<string>",
      "branchCode": "<string>",
      "accountNumber": "<string>",
      "accountType": "<string>",
      "createdAt": "<string>"
    }
  ],
  "cursor": "<string>"
}

Get Beneficiary BRL Bank Accounts

GET request to /v2/account/beneficiaries/bank-accounts/brl

Authorizations

Authorization
string
header
required

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

Query Parameters

subAccountId
string

Sub-account ID

createdAfter
integer

Filter accounts created after timestamp

createdBefore
integer

Filter accounts created before timestamp

cursor
string

Cursor for pagination

alias
string

Filter by alias

Response

200 - application/json

OK

bankAccounts
object[]
required
cursor
string
required