Billing & Payment Operations
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/billing/intent | Send billing intent to establish agreement |
| POST | /v1/customer/bill | Bill customer using payment id |
{
"lookupIDs": ["string"],
"currency": "string",
"description": "string"
}
| Field | Type | Required | Description |
|---|---|---|---|
lookupIDs | string[] | Yes | Customer lookup IDs |
currency | string | Yes | Currency code (e.g., “NGN”) |
description | string | Yes | Description of billing agreement |
[
{
"statusCode": 200,
"success": true,
"message": "Billing intent sent successfully",
"lookupID": "string",
"entityId": "string"
}
]
| Field | Type | Description |
|---|---|---|
lookupID | string | Customer lookup ID used |
entityId | string | Merchant entity identifier |
{
"paymentIDs": ["string"],
"amount": 1500,
"currency": "string",
"description": "string"
}
| Field | Type | Required | Description |
|---|---|---|---|
paymentIDs | string[] | Yes | Customer payment ids |
amount | number | Yes | Amount to bill |
currency | string | Yes | Currency code |
description | string | Yes | Payment description |
[
{
"statusCode": 201,
"success": true,
"message": "Customer billed successfully",
"reference": "string",
"phrase": "string",
"entityId": "string"
}
]
| Field | Type | Description |
|---|---|---|
reference | string | Transaction reference |
phrase | string | Payment ID used |
entityId | string | Merchant entity identifier |
{
"statusCode": 400,
"success": false,
"message": "Invalid request parameters"
}
{
"statusCode": 403,
"success": false,
"message": "Customer has not approved billing"
}