Collection

This endpoint processes collection payment from a user's payment details.

Header Parameters
apiToken string — REQUIRED Secret key for the project

Request Body — REQUIRED
reference string Unique reference for the payment. Can be left empty if the server generates one.
description string — REQUIRED Description of the payment.
amount integer — REQUIRED Amount of the payment in smallest currency unit (e.g., cents).
phoneNumber string — REQUIRED The phone number associated with the payment.

Responses
201 payment created successfully Schema — OPTIONAL customer object _id string — OPTIONAL Unique identifier for the customer. phoneNumber string — OPTIONAL Phone number of the customer. firstname string — OPTIONAL First name of the customer. lastname string — OPTIONAL Last name of the customer. mno string — OPTIONAL Mobile Network Operator name. merchantAccountId string Name of the merchant account. mode string Mode of payment processing. reference string Reference number for the payment. amount integer Amount being charged. currency string Currency code for the transaction. link string — OPTIONAL Link to the payment gateway or receipt. status string Current status of the payment.
400 Bad request, such as invalid input Schema — OPTIONAL code int32 Error code representing the type of error. message string Error message detailing what went wrong.
401 Unauthorized access Schema — OPTIONAL code int32 Error code representing the type of error. message string Error message detailing what went wrong.
500 Internal Server Error Schema — OPTIONAL code int32 Error code representing the type of error. message string Error message detailing what went wrong.