Skip to content

Get Balance#

GET https://payments.apipro.io/v2/balance

This endpoint retrieves the current available balance for a specific project associated with the merchant's account.

Headers#

Header Value
Authorization {{authorization}}
Date {{date}}
Host {{host}}
Content-Type application/json

See Authentication & Signature for how to build the signed headers.

Responses#

Response Examples

Success for getting balance
{
  "error_code": 0,
  "error_reason": "",
  "balance": [
    {
      "amount": "3000,00",
      "current_balance": "3000,00",
      "available_balance": "3000,00",
      "overdraft_limit": "0,00",
      "overdraft_used": "0,00",
      "currency": "CLP",
      "billing_date": "2026-01-16T09:30:05.9100478Z"
    },
    {
      "amount": "0,00",
      "current_balance": "0,00",
      "available_balance": "5000,00",
      "overdraft_limit": "50000,00",
      "overdraft_used": "45000,00",
      "currency": "ARS",
      "billing_date": "2026-01-16T09:30:05.9131913Z"
    },
    {
      "amount": "0.00",
      "current_balance": "0.00",
      "available_balance": "2000.00",
      "overdraft_limit": "5000.00",
      "overdraft_used": "3000.00",
      "currency": "MXN",
      "billing_date": "2026-01-16T09:30:05.9132148Z"
    },
    {
      "amount": "0,00",
      "current_balance": "0,00",
      "available_balance": "495996,00",
      "overdraft_limit": "500000,00",
      "overdraft_used": "4003,96",
      "currency": "ZAR",
      "billing_date": "2026-01-16T09:30:05.9134976Z"
    },
    {
      "amount": "0,00",
      "current_balance": "0,00",
      "available_balance": "800,00",
      "overdraft_limit": "1000,00",
      "overdraft_used": "200,00",
      "currency": "USD",
      "billing_date": "2026-01-16T09:30:05.9135201Z"
    },
    {
      "amount": "0,00",
      "current_balance": "0,00",
      "available_balance": "49400,00",
      "overdraft_limit": "50000,00",
      "overdraft_used": "600,00",
      "currency": "AUD",
      "billing_date": "2026-01-16T09:30:05.9135322Z"
    },
    {
      "amount": "0,00",
      "current_balance": "0,00",
      "available_balance": "0,00",
      "overdraft_limit": "0,00",
      "overdraft_used": "0,00",
      "currency": "BOB",
      "billing_date": "2026-01-16T09:30:05.9135383Z"
    },
    {
      "amount": "169667,52",
      "current_balance": "169667,52",
      "available_balance": "669667,52",
      "overdraft_limit": "50000,00",
      "overdraft_used": "0,00",
      "currency": "NGN",
      "billing_date": "2026-01-16T09:30:05.9135455Z"
    }
  ]
}