Skip to main content

Balance

Your current receivable position. Requires inbound:read.

You do not prefund, so this is not a spendable balance — it is what you owe SmartPay for value already issued to subscribers on your behalf.

Request
cURL
curl https://api.smartpay.sl/api/v1/inbound/balance \
  -H "X-API-Key-ID: $SMARTPAY_API_KEY_ID" \
  -H "X-Timestamp: $TS" \
  -H "X-Nonce: $NONCE" \
  -H "X-Signature: $SIG"
Response
200 Uncapped
{
  "success": true,
  "code": "OK",
  "data": {
    "partner_id": "PTR_9XQ2M4KP7RTW",
    "partner_code": "UBA_SL",
    "currency": "SLE",
    "outstanding": 1250000,
    "total_received": 8400000,
    "total_settled": 7150000,
    "exposure_limit": 0,
    "available_exposure": null,
    "as_of": "2026-08-19T14:22:01Z"
  }
}
200 With a ceiling
{
  "success": true,
  "code": "OK",
  "data": {
    "partner_id": "PTR_9XQ2M4KP7RTW",
    "partner_code": "UBA_SL",
    "currency": "SLE",
    "outstanding": 1250000,
    "total_received": 8400000,
    "total_settled": 7150000,
    "exposure_limit": 2000000,
    "available_exposure": 750000,
    "as_of": "2026-08-19T14:22:01Z"
  }
}
outstandinginteger

What you owe SmartPay right now: everything credited to subscribers on your behalf, less everything you have settled. This is the figure you settle against.

total_receivedinteger

Lifetime value you have pushed into SmartPay, net of reversals. Settlement never reduces it, so it is your volume figure rather than your balance.

available_exposureinteger | null

How much more you may push before hitting your ceiling. null means no ceiling is configured for your account.

Tip

If you have a ceiling, poll this and alert your operations team before available_exposure reaches zero. Discovering it through a wall of 402s mid-morning is avoidable.

Note

A negative outstanding means you have settled more than you owe — you are paid ahead, and that credit is applied against future inbound.