v1

latestOpenAPI 3.1.02026-07-26290731.0 KB

Card Payment API

post/api/v3/purchases

Headers

Authorizationstring

Set value to "Bearer ACCESS_TOKEN"

Content-Typestring

Set value to "application/json"

Request body

customerIdstring required

Unique identifier for the customer

amountstring required

The amount being paid. This is usually in the smallest currency unit (e.g Naira)

transactionRefstring required

Unique transaction reference per transaction.

currencystring required

Currency being used.

authDatastring required

Combination of the sensitive data of the payment (PAN, PIN, Expiry Date, and CVV2)

deviceInformationstring json

It is compulsory to collect device information from the user's browser and include it in the payment request.

Response

200

transactionRefstring

paymentIdstring

messagestring

amountstring

responseCodestring

plainTextSupportMessagestring

Example response

{
  "transactionRef": "12n345mmm0km655",
  "paymentId": "3530471",
  "message": "Kindly enter the OTP sent to 234805***1111",
  "amount": "20000.00",
  "responseCode": "T0",
  "plainTextSupportMessage": "Didn't get the OTP? Dial *723*0# on your phone (MTN,Etisalat,Airtel) Glo,use *805*0#."
}