Documentation Index
Fetch the complete documentation index at: https://docs.peere.network/llms.txt
Use this file to discover all available pages before exploring further.
Billing & Payment Schemas
API endpoints for processing payments and establishing billing agreements.
Endpoints
| Method | Endpoint | Description |
|---|
| POST | /v1/billing/intent | Send billing intent to establish agreement |
| POST | /v1/customer/bill | Bill customer using agreement phrase |
POST /v1/billing/intent
Send billing intent to customers via their banks to establish billing agreements.
Request Body
{
"lookupPhrases": ["string"],
"currency": "string",
"description": "string"
}
Request Schema
| Field | Type | Required | Description |
|---|
lookupPhrases | string[] | Yes | Customer lookup phrases |
currency | string | Yes | Currency code (e.g., “NGN”) |
description | string | Yes | Description of billing agreement |
Response Schema
[
{
"statusCode": 200,
"success": true,
"message": "Billing intent sent successfully",
"lookupPhrase": "string",
"entityId": "string"
}
]
Response Fields
| Field | Type | Description |
|---|
lookupPhrase | string | Customer lookup phrase used |
entityId | string | Merchant entity identifier |
POST /v1/customer/bill
Bill customers using established agreement phrases.
Request Body
{
"agreementPhrases": ["string"],
"amount": 1500,
"currency": "string",
"description": "string"
}
Request Schema
| Field | Type | Required | Description |
|---|
agreementPhrases | string[] | Yes | Customer agreement phrases |
amount | number | Yes | Amount to bill |
currency | string | Yes | Currency code |
description | string | Yes | Payment description |
Response Schema
[
{
"statusCode": 201,
"success": true,
"message": "Customer billed successfully",
"reference": "string",
"phrase": "string",
"entityId": "string"
}
]
Response Fields
| Field | Type | Description |
|---|
reference | string | Transaction reference |
phrase | string | Agreement Phrase used |
entityId | string | Merchant entity identifier |
Error Responses
400 Bad Request
{
"statusCode": 400,
"success": false,
"message": "Invalid request parameters"
}
403 Forbidden
{
"statusCode": 403,
"success": false,
"message": "Customer has not approved billing"
}
