Skip to content
PGSwift Docs
Documentation/Check Balance

Check Balance

This api can be used to check available balance.

GET /api/balance

Request

No payload needed

Response

Name Description
status Operation status indicator. true indicates success, false indicates failure.
data Account balance details and information.
data.balance Client's total settled account balance.
data.reserved_funds Client's total reserved balance.
data.outstanding_funds Client's total unsettled balance.
message Error message information (if applicable). 
{
    "status": true,
    "data": {
        "balance": 528534207.52,
        "reserved_funds": 210000,
        "outstanding_funds": 0
    }
}

Settlement Schedule