Get account balance

GET

/order/v2/account/balance

Sandbox

Retrieve the BRL balance of the authenticated company’s administrative account: the available balance and the provisioned amount (paid but not yet compensated).

Authorizations

Bearer

Responses

200

The resource was returned successfully

object

balance

required

Available BRL balance of the account. Null when it could not be retrieved; provisioned is still returned.

object

currency

required

Balance currency.

string

Example

BRL

value

required

Available balance.

string

Example

1500.00

Example

{
  "currency": "BRL",
  "value": "1500.00"
}

provisioned

required

BRL amount already paid but not yet compensated, net of fees. It becomes available balance on compensation. May lag by a few seconds. Null when it could not be computed; balance is still returned.

object

currency

required

Balance currency.

string

Example

BRL

value

required

Available balance.

string

Example

1500.00

Example

{
  "currency": "BRL",
  "value": "320.50"
}

401

Unauthorized Request

object

error

string

Example

UNAUTHORIZED

message

string

Example

Unauthorized Request

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

403

object

error

string

Example

FORBIDDEN_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

404

Resource not found

object

error

string

Example

NOT_FOUND

message

string

Example

Resource not found

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

500

object

error

string

Example

INTERNAL_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]