Collect API Status Codes

Status Codes

All API requests may return any of the following status codes;

Status Code	Name	Description
0	SUCCESS	This status code indicates that the request was processed successful.
1	IN_PROCESS	This indicates that the request has been received and is queued for processing. A webhook callback will be sent once processed or status query can be called to check on status
2	PARTIAL_PAYMENT	This status code is returned from the call-back notification to indicate that a payment request received a partial payment (if permitted by initiator).
-1	SYSTEM_ERROR	Returned whenever there is an error processing the current request
-2	REQUEST_EXPIRED	The payment request has been expired.
-3	REQUEST_CANCELLED	The payment request has been cancelled.

Payment Request Methods

The following payment request methods are currently supported;

S/N	Name	Description
1.	BANK_TRANSFER	Temporary NUBAN Account Number is generated on Paga for the payment request. Payment of the requested amount to this NUBAN with fulfil the payment request
2.	FUNDING_USSD	This allow's payer to pay with thier bank's USSD. Payer's bankID must be added to the payment request payload.

In addition, if the payer is a registered Paga account holder, the following payment options may be exposed;

S/N	Name	Description
1.	USSD	Payer can authorize the transaction and pay from their Paga wallet simply by dialling the returned USSD short code.
2.	MONEY_TRANSFER	Payer can authorize the transaction from their Paga wallet using either web or mobile app channels
3.	REQUEST_MONEY	Payer can authorize the transaction and pay from their Paga wallet for a using the paga payment link.

Payment Request States

A payment request may be in any one of the following states;

S/N	State	Description
1.	PENDING	Payment request has been received and is awaiting authorization/fulfilment from the payer.
2.	CHARGEABLE	Payment has been received and payment request can now be consumed.
3.	CONSUMED	Payment request charge completed.
4.	EXPIRED	Payment request has expired.
5.	FAILED	Payment request creation failed.
6.	CANCELLED	Payment request was cancelled

📘

When a payment request is fulfilled, it is set to CHARGEABLE which means that it is funded and can be processed (the funds are remitted to the payee’s account or bank account). When this “second-leg” processing occurs, then it set to CONSUMED. If something happens to cause the payment leg to fail, it can remain on CHARGEABLE until the payment leg completes

Collect API History Operations

Here are the different operations categories

S/N	Operation	Description
1	PAYMENT_REQUEST	This is for requesting payment
2	PERSISTENT_PAYMENT_ACCOUNT	This for creating persistent payment accounts

Collect API History Actions

Here are the different actions and the operations they are subcategories of:

Action	Operation	Description
CREATE_REQUEST	PAYMENT_REQUEST	This is when you create a new payment request by calling the /paymentRequest endpoint
PAYMENT	PAYMENT_REQUEST	This is whenever a payment comes in for a created Payment Request

Collect API History Action Statuses

Here are the different statuses

Status	Operation	Description
FAILED	CREATE_REQUEST, PAYMENT	Action failed
SUCCESSFUL	CREATE_REQUEST, PAYMENT	Action was successful
PAID_NOT_SETTLED	PAYMENT	Payment successful but settlement not done

Callback Events

Here are different callback events:

Events	Description
PAYMENT_COMPLETE	The payment made with respect to a particular payment request by a payer is the same as the amount in the request.
PARTIAL_PAYMENT	The payer carried out a part payment of the payment request amount
PAYMENT_REQUEST_EXPIRED	The payment request has expired.
PAYMENT_ERROR	An error occurred during the period of fulfilling the payment request. This means the payment was unsuccessful