API Reference · Platform
Balance & Ledger Entries
Your available balance, and the double-entry journal lines behind it.
The balance object
Represents a balance entity in the rafiqPay system.
| Field | Type & Flags | Description |
|---|---|---|
| availableBalance | string | Available NGN balance, formatted for display. |
| pendingSettlement | string | Always ₦0.00: settlement timing is not tracked yet. |
| issuingBalance | string | Balance set aside for cards. |
Example balance JSON
balance example payload
{
"availableBalance": "₦14,280,500.00",
"pendingSettlement": "₦0.00",
"issuingBalance": "₦0.00",
"currency": "NGN",
"mode": "live"
}Endpoints & Operations
GET/v1/balances/summaryIn plan 035
Retrieve your balance
Returns your available balance from the ledger, for the key’s mode.
Request Example
GET /v1/balances/summary
cURL · v1
curl -X GET "https://api.rafiqpay.net/v1/balances/summary" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a"Response (200 OK)
Response payload
{
"availableBalance": "₦14,280,500.00",
"pendingSettlement": "₦0.00",
"issuingBalance": "₦0.00",
"currency": "NGN",
"mode": "live"
}GET/v1/ledger/entriesProposed
List ledger entries
Lists append-only journal postings.
Request Example
GET /v1/ledger/entries
cURL · v1
curl -X GET "https://api.rafiqpay.net/v1/ledger/entries" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a"Response (200 OK)
Response payload
{
"object": "list",
"data": [],
"hasMore": false,
"nextCursor": null
}GET/v1/ledger/entries/:idProposed
Retrieve a ledger entry
Retrieves a single journal entry.
Request Example
GET /v1/ledger/entries/:id
cURL · v1
curl -X GET "https://api.rafiqpay.net/v1/ledger/entries/:id" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a"Response (200 OK)
Response payload
{
"id": "led_01",
"direction": "CREDIT",
"amount": "35000.00"
}