Balance

Overview

Balance API provides a way to view the current amount that a beneficiary has in an account.

Get balance of a beneficiary (View API reference)

Get the current amount for a given beneficiary account.

curl --location --request GET 'https://sandbox.api.caliza.co/core-api/v1/beneficiaries/{beneficiaryId}/balances' \
--header 'Authorization: Bearer {YOUR_BEARER_TOKEN}' \
--header 'Content-Type: application/json' \

The response will look like:

{
  "total": "60",
  "currencyCode": "BRL",
  "currencyName": "Brazilian Real"
}