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

Create an online checkout order

cURL

curl --request POST \
  --url https://api.nomba.com/v1/checkout/order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'accountId: <accountid>' \
  --data '
{
  "order": {
    "callbackUrl": "https://ip:port/merchant.com/callback",
    "customerEmail": "[e-mail]",
    "amount": "10000.00",
    "currency": "NGN",
    "orderReference": "90e81e8a-bc14-4ebf-89c0-57da752cca58",
    "customerId": "762878332454",
    "accountId": "01a10aeb-d989-460a-bbde-9842f2b4320f",
    "allowedPaymentMethods": [
      "Card",
      "Transfer"
    ],
    "splitRequest": {
      "splitList": [
        {
          "accountId": "01a10aeb-d989-460a-bbde-9842f2b4320f",
          "value": "65.45"
        }
      ]
    },
    "orderMetaData": {
      "productName": "Premium Plan",
      "internalRef": "INV-2026-001",
      "region": "CD"
    }
  },
  "tokenizeCard": "true"
}
'

200

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

For a complete guide on response codes and transaction statuses, see Response Codes.

Authorizations

Authorization · string · header · required

Nomba authenticates API calls with OAuth2 HTTP bearer tokens. There are two methods of authentication; Client-Credentials method and PKCE (Proof Key for Code Exchange) method. In each of the methods, You will get an ACCESS_TOKEN. You need to use an "Authorization" HTTP header to provide your ACCESS_TOKEN. For example: Authorization: {ACCESS_TOKEN}.

Headers

accountId · string<uuid> · required

The parent accountId of the business.

Example:

"890022ce-bae0-45c1-9b9d-ee7872e6ca27"

Body

application/json

The request payload required to create a checkout order.

The Checkout request object

order · object · required

Show child attributes

tokenizeCard · boolean

Determines if the card used for payment is to be tokenized

Example:

"true"

Response

200

application/json

OK - your request was successful.

code · string · required

Response Code

Example:

"00"

description · string · required

checkout order created successful

Example:

"Success"

data · object · required

Show child attributes