This endpoint is provided as a proxy for clients who will like to collect payments from a user using their payment token. The API will send a request for a debit of a specified amount through IPG.

Request Message description

Field #	Field name	Data type	Max length	Required	Description
1	customerId	String	50	true	The Email or Mobile Number of the User.
2	token	String	20	true	The Payment Token of the user generated by Vault.
3	amount	Long		true	The Amount to be debited from the user’s payment card. (This is in lower denomination KOBO)
4	providerCode	String	50	true	The Code of the Provider/Client from which the request is coming from.
5	currencyCode	Numeric String	3	true	The Code of the currency of the Amount to be debited. E.g 566
6	transactionId	String	50	true	The unique transaction identifier
7	loanId	String	20	false	Existing loan Id.

Endpoint

POST /payments

Sample request

{
"customerId": "2348123456789",
"token": "5123450558220138603",
"amount": 500000, // Five thousand naira only
"providerCode": "FEDERAL",
"transactionId" : "1234567",
"currencyCode": "566"
}

Response Message  field description

Field#	Field name	Data Type	Max Length	Required	Description
1	responseCode	Numeric String	5	true	The code representing the status of the processing of this request
2	responseMessage	String	255	true	The description of the responseCode.
3	transactionRef	String	50	true	The Quickteller Transaction Reference for the transfer request.
4	accountBalance	Long		true	The customer’s balance will be returned when he/she does not have sufficient funds to pay back the loan

Sample Response (success) 

{
"responseCode": "00",
"responseDescription": "Successful",
"transactionRef": "UBN|WEB|ILS|20170501120945|0198849"
}

Sample Response (failure)

{
"responseCode": "51",
"responseMessage": "Insufficient funds",
"accountBalance": 40509000,
}