Get merchant balance

Production Environment

https://api.lopay.com

GET

/api/1/partner/merchant/{id}/balance

Retrieves the given merchant's balance, as well as the balance breakdown.

Request

Authorization

Path Params

Header Params

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

🟢200OK

application/json

OK response

Body

Examples

Merchant with available balanceMerchant with pending balanceMerchant with a reserved balance

{
    "balance": 1000,
    "currencyCode": "GBP",
    "breakdown": {
        "available": 1000,
        "pending": 0,
        "reserved": 0
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found

🔴500Internal Server Error

Modified at 2025-10-30 11:30:45