Hosted Payments

Here we have the API to enable you carry out hosted payment.

The Process for carrying out this payment will include the following:

1. A payment request will be initiated by you, with a callback URL as part of the request payload.

2. We would respond with a URL where the user will be redirected to make the payment.

3. Upon success of the process by the user, we would call the URL you provided to us at stage one, with query parameters added to it.

Initiate Payment

This is used to initiate the request for hosted payment.

URL

{baseUrl}/developer/hostedpayment

REQUEST BODY SAMPLE

{
  "amount": 0,
  "currency": "string",
  "reference": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "callBackURL": "string",
  "allowPaymentMethods": [
    "string"
  ]
}

Note: allowPaymentMethods is optional and can be any of the following:
      card, 
      applepay, 
      googlepay

REQUEST

curl --location --request POST 
'{baseUrl}/developer/hostedpayment' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer_token' \
--data-raw '{
  "amount": 7,
  "currency": "USD",
  "reference": "TESTHOSTED8",
  "firstName": "Shola",
  "lastName": "Gabriel",
  "email": "[email protected]",
  "callBackURL": "https://www.example.com/callback",  
  "allowPaymentMethods": [
    "applepay"
  ]
}'

SUCCESS RESPONSE

{
   "ResponseCode":"00",
   "ResponseMessage":"Successful",
   "Data":{
      "TxRef":"SSP6384911743989070122E7C",
      "Amount":13.0,
      "URL":"https://pay.sandbox.checkout.com/page/hpp_ORFWb8Y_C-Va"
   }
}

FAILED RESPONSE

{
    "ResponseCode": "03",
    "ResponseMessage": "Unable to save transaction",
    "Data": null
}

Callback

The endpoint you provided at initiation will be called here with a query parameter to notify you of the transaction status.

URL

{your_call_back_url_provide}?paymentId=SSP6384911743989070122E7C&merchantPaymentId=TESTHOSTED8&status=COMPLETED&amount=13.0&currency=USD&cko-payment-id=pay_xnaixvt5ufwupdn5nju5prnqky&cko-session-id=sid_sxtv2xesmqsufdzc6zhfwsmirq

REQUEST

https://www.example.com/callback?paymentId=SSP6384911743989070122E7C&merchantPaymentId=TESTHOSTED8&status=COMPLETED&amount=13.0&currency=USD&cko-payment-id=pay_xnaixvt5ufwupdn5nju5prnqky&cko-session-id=sid_sxtv2xesmqsufdzc6zhfwsmirq