Get balance

GET

/account/v1/holder/company/balance

• Production
• Sandbox

Return holder accounts balance from company authenticated token.

NOTE: Please, to authenticate use the scope: “api://app-account-prd”

Authorizations

• Bearer

Parameters

Query Parameters

accountType

required

string

Allowed values: ADMINISTRATIVE RESERVE ADMINISTRATIVE_OUT PAYMENT

Represents the account type

Responses

200

The resource was returned successfully

object

id

required

Holder Id

string

Example

e77c5311-bd63-4080-a965-5d8b7ce82094

fullName

required

Full name

string

Example

John Doe

document

required

Document

object

type

required

Document type

----------------------------
Brasil
----------------------------
CPF
CNPJ
OTHERS

----------------------------
Mexico
----------------------------
CURP
RFC

string

Example

CPF

number

required

Document number

string

Example

12345678911

country

required

Country

string

Example

BRA

createdAt

required

Created At

string

Example

2021-01-01T00:00:00.000Z

accounts

required

Accounts balance

Array<object>

object

id

required

Account id

string

Example

123e4567-e89b-12d3-a456-426614174000

type

required

Account type

string

Allowed values: ADMINISTRATIVE COMMON RESERVE FEE ADMINISTRATIVE_OUT FEE_OUT PAYMENT PAYMENT_FEE

Example

ADMINISTRATIVE

balance

required

Account balance

Array<object>

object

currency

required

Currency

string

Allowed values: BRL USD USDT BUSD MXN

Example

BRL

value

required

The amount of the transaction, in minor units. Minor Units Format ------------------ All amount values must be formatted in that currency’s smallest unit. Two-decimal currency (for example Real): R$ 10,95 BRL, amount will be “10.95”. Two-decimal currency (for example US Dollars): $10.95 USD, amount will be “10.95”. Zero-decimal currency (for example Japanese Yen): ¥1095 JPY, amount will be “1095”. Click here to download the latest official ISO 4217 Currency Table, with Minor Units (number of decimal places) per currency

string

Example

10.95

400

The request is not valid

Array<string>

403

Array<string>

500

An unexpected error occurred inside the server

Array<string>