Retrieve merchant balance summary.

Production

https://api.paypaga.com

GET

/v2/balances

Real-time access to the financial balances of a merchant's account. This can be used for reporting and as a precursor to Pay Out - Payment Processing to determine if there is sufficient balance.

Error codes for Get Merchant Balance

HTTP status	Error code	Description
400	VALIDATION_ERROR	Request validation failed
401	UNAUTHORIZED	Missing or invalid authorization token
403	FORBIDDEN	You do not have permission to access this resource
500	INTERNAL_ERROR	Unexpected server error

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://api.paypaga.com/oauth2/token

Query Params

Responses

🟢200

application/json

Balance summary.

Bodyapplication/json

🟠400ValidationError

🟠401Unauthorized

🟠403Forbidden

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.paypaga.com/v2/balances?country=undefined'

Response Example

200 - Example 1

{
    "as_of": "2024-08-06T21:10:41Z",
    "reporting_currency": "USD",
    "total": {
        "currency_code": "USD",
        "amount": 325000
    },
    "countries": [
        {
            "country": "BR",
            "currency": "BRL",
            "amount": 210000,
            "available_for_payout": 82000
        },
        {
            "country": "MX",
            "currency": "MXN",
            "amount": 115000,
            "available_for_payout": 68000
        },
        {
            "country": "CO",
            "currency": "COP",
            "amount": 0,
            "available_for_payout": 0
        }
    ]
}

Modified at 2026-06-09 15:16:31

Create a hosted PayURL checkout

List supported countries

Retrieve merchant balance summary.

Error codes for Get Merchant Balance#

Request

Responses

Error codes for Get Merchant Balance