Sign in

v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB
Online Checkout

Create an online checkout order

You can use this endpoint to create an online checkout order. Load the URL returned in 'checkoutLink' property in a browser to allow your customer initiate payment.

post/v1/checkout/order

Headers

accountIdstring uuid required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Request body

tokenizeCardboolean

Determines if the card used for payment is to be tokenized

Example request

{
  "order": {
    "orderReference": "90e81e8a-bc14-4ebf-89c0-57da752cca58",
    "customerId": "762878332454",
    "callbackUrl": "https://ip:port/merchant.com/callback",
    "customerEmail": "abcde@gmail.com",
    "currency": "NGN",
    "accountId": "01a10aeb-d989-460a-bbde-9842f2b4320f",
    "allowedPaymentMethods": [
      "Card",
      "Transfer"
    ],
    "splitRequest": {
      "splitList": [
        {
          "accountId": "01a10aeb-d989-460a-bbde-9842f2b4320f"
        }
      ]
    },
    "orderMetaData": {
      "productName": "Premium Plan",
      "internalRef": "INV-2026-001",
      "region": "CD"
    }
  }
}

Response

OK - your request was successful.

codestring required

Response Code

descriptionstring required

checkout order created successful

Example response

{
  "code": "00",
  "description": "Success",
  "data": {
    "checkoutLink": "https://ip:port/checkout/78388899938",
    "orderReference": "90e81e8a-bc14-4ebf-89c0-57da752cca58"
  }
}