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 payment id

POST /v1/billing/intent

Send billing intent to customers via their banks to establish billing agreements.

Request Body

{
  "lookupIDs": ["string"],
  "currency": "string",
  "description": "string"
}

Request Schema

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

Response Schema

[
  {
    "statusCode": 200,
    "success": true,
    "message": "Billing intent sent successfully",
    "lookupID": "string",
    "entityId": "string"
  }
]

Response Fields

Field	Type	Description
`lookupID`	string	Customer lookup ID used
`entityId`	string	Merchant entity identifier

POST /v1/customer/bill

Bill customers using established payment ids.

Request Body

{
  "paymentIDs": ["string"],
  "amount": 1500,
  "currency": "string",
  "description": "string"
}

Request Schema

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

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	Payment ID 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"
}

Account Operations

Find Customer

Billing & Payment Operations

Recurring Billing

Customer Decisions

Refund Management

Transaction Management

Balance & Financial Operations

Shared Operations

schemas

Billing & Payment Schemas

Endpoints

POST /v1/billing/intent

Request Body

Request Schema

Response Schema

Response Fields

POST /v1/customer/bill

Request Body

Request Schema

Response Schema

Response Fields

Error Responses

400 Bad Request

403 Forbidden

​Billing & Payment Schemas

​Endpoints

​POST /v1/billing/intent

​Request Body

​Request Schema

​Response Schema

​Response Fields

​POST /v1/customer/bill

​Request Body

​Request Schema

​Response Schema

​Response Fields

​Error Responses

​400 Bad Request

​403 Forbidden

Billing & Payment Schemas

Endpoints

POST /v1/billing/intent

Request Body

Request Schema

Response Schema

Response Fields

POST /v1/customer/bill

Request Body

Request Schema

Response Schema

Response Fields

Error Responses

400 Bad Request

403 Forbidden