v1

latestOpenAPI 3.1.02026-07-26540161.7 KB

Authorize a charge

This API lets you authorize a charge on a card or mobile money payment

post/checkout/charges/{id}/authorize

Path parameters

idstring required

Headers

x-business-idstring

Your business ID

Request body

pinstring

Transaction pin of the card to charge if the auth_model is PIN

otpstring

one time password to be used to complete the request if the auth_model is OTP

avsstring

Object containing AVS details. This should be present if the auth_model is AVS

statestring

The state registered with the card. Required if auth_mode is AVS

citystring

The city registered with the card. Required if auth_mode is AVS

countrystring

The country registered with the card. Required if auth_mode is AVS

addressstring

The address registered with the card. Required if auth_mode is AVS

zip_codestring

The zip code registered with the card. Required if auth_mode is AVS

Response

200

statusboolean

messagestring

Example response

{
  "status": true,
  "message": "Kindly enter the One-time PIN (OTP) sent to your phone number",
  "data": {
    "id": 280,
    "authorization": {
      "mode": "OTP"
    },
    "auth_model": "OTP",
    "amount": 150000,
    "currency": "NGN",
    "message": "Kindly enter the One-time PIN (OTP) sent to your phone number",
    "status": "processing",
    "reference": "KPHHHHSS"
  }
}