API Reference · Wallets & accounts
Wallets
Proposed embedded NGN wallets for your customers. Not built.
The wallet object
Represents a wallet entity in the rafiqPay system.
| Field | Type & Flags | Description |
|---|---|---|
| id | string | Wallet ID (wal_...). |
| customerId | string | Owner customer ID. |
| availableBalance | string | Derived ledger balance in Naira. |
Example wallet JSON
wallet example payload
{
"id": "wal_amina_01",
"customerId": "cus_amina_01",
"availableBalance": "142500.00",
"currency": "NGN"
}Endpoints & Operations
POST/v1/walletsProposed
Create a wallet
Proposed. Not built: rafiqPay does not open wallets for your customers.
Request Example
POST /v1/wallets
cURL · v1
curl -X POST "https://api.rafiqpay.net/v1/wallets" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a" \
-H "Idempotency-Key: idem_create-wallet_01" \
-H "Content-Type: application/json" \
-d '{
"customerId": "cus_amina_01",
"tier": "TIER_2"
}'Response (200 OK)
Response payload
{
"id": "wal_amina_01",
"availableBalance": "0.00"
}GET/v1/wallets/:idProposed
Retrieve a wallet
Retrieves a wallet.
Request Example
GET /v1/wallets/:id
cURL · v1
curl -X GET "https://api.rafiqpay.net/v1/wallets/:id" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a"Response (200 OK)
Response payload
{
"id": "wal_amina_01",
"availableBalance": "142500.00"
}GET/v1/walletsProposed
List wallets
Lists wallets.
Request Example
GET /v1/wallets
cURL · v1
curl -X GET "https://api.rafiqpay.net/v1/wallets" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a"Response (200 OK)
Response payload
{
"object": "list",
"data": [],
"hasMore": false,
"nextCursor": null
}GET/v1/wallets/:id/transactionsProposed
List wallet transactions
Lists ledger entries for a wallet.
Request Example
GET /v1/wallets/:id/transactions
cURL · v1
curl -X GET "https://api.rafiqpay.net/v1/wallets/:id/transactions" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a"Response (200 OK)
Response payload
{
"object": "list",
"data": [],
"hasMore": false,
"nextCursor": null
}Related Webhook Events
These events are dispatched to your webhook endpoints when actions occur on this resource: