Skip to main content
POST
/
v1
/
checkout
/
order
Create an online checkout order
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": "[email protected]",
    "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"
}
'
import requests

url = "https://api.nomba.com/v1/checkout/order"

payload = {
    "order": {
        "callbackUrl": "https://ip:port/merchant.com/callback",
        "customerEmail": "[email protected]",
        "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"
}
headers = {
    "accountId": "<accountid>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    accountId: '<accountid>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    order: {
      callbackUrl: 'https://ip:port/merchant.com/callback',
      customerEmail: '[email protected]',
      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'
  })
};

fetch('https://api.nomba.com/v1/checkout/order', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nomba.com/v1/checkout/order",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'order' => [
        'callbackUrl' => 'https://ip:port/merchant.com/callback',
        'customerEmail' => '[email protected]',
        '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "accountId: <accountid>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nomba.com/v1/checkout/order"

	payload := strings.NewReader("{\n  \"order\": {\n    \"callbackUrl\": \"https://ip:port/merchant.com/callback\",\n    \"customerEmail\": \"[email protected]\",\n    \"amount\": \"10000.00\",\n    \"currency\": \"NGN\",\n    \"orderReference\": \"90e81e8a-bc14-4ebf-89c0-57da752cca58\",\n    \"customerId\": \"762878332454\",\n    \"accountId\": \"01a10aeb-d989-460a-bbde-9842f2b4320f\",\n    \"allowedPaymentMethods\": [\n      \"Card\",\n      \"Transfer\"\n    ],\n    \"splitRequest\": {\n      \"splitList\": [\n        {\n          \"accountId\": \"01a10aeb-d989-460a-bbde-9842f2b4320f\",\n          \"value\": \"65.45\"\n        }\n      ]\n    },\n    \"orderMetaData\": {\n      \"productName\": \"Premium Plan\",\n      \"internalRef\": \"INV-2026-001\",\n      \"region\": \"CD\"\n    }\n  },\n  \"tokenizeCard\": \"true\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("accountId", "<accountid>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.nomba.com/v1/checkout/order")
  .header("accountId", "<accountid>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"order\": {\n    \"callbackUrl\": \"https://ip:port/merchant.com/callback\",\n    \"customerEmail\": \"[email protected]\",\n    \"amount\": \"10000.00\",\n    \"currency\": \"NGN\",\n    \"orderReference\": \"90e81e8a-bc14-4ebf-89c0-57da752cca58\",\n    \"customerId\": \"762878332454\",\n    \"accountId\": \"01a10aeb-d989-460a-bbde-9842f2b4320f\",\n    \"allowedPaymentMethods\": [\n      \"Card\",\n      \"Transfer\"\n    ],\n    \"splitRequest\": {\n      \"splitList\": [\n        {\n          \"accountId\": \"01a10aeb-d989-460a-bbde-9842f2b4320f\",\n          \"value\": \"65.45\"\n        }\n      ]\n    },\n    \"orderMetaData\": {\n      \"productName\": \"Premium Plan\",\n      \"internalRef\": \"INV-2026-001\",\n      \"region\": \"CD\"\n    }\n  },\n  \"tokenizeCard\": \"true\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.nomba.com/v1/checkout/order")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accountId"] = '<accountid>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"order\": {\n    \"callbackUrl\": \"https://ip:port/merchant.com/callback\",\n    \"customerEmail\": \"[email protected]\",\n    \"amount\": \"10000.00\",\n    \"currency\": \"NGN\",\n    \"orderReference\": \"90e81e8a-bc14-4ebf-89c0-57da752cca58\",\n    \"customerId\": \"762878332454\",\n    \"accountId\": \"01a10aeb-d989-460a-bbde-9842f2b4320f\",\n    \"allowedPaymentMethods\": [\n      \"Card\",\n      \"Transfer\"\n    ],\n    \"splitRequest\": {\n      \"splitList\": [\n        {\n          \"accountId\": \"01a10aeb-d989-460a-bbde-9842f2b4320f\",\n          \"value\": \"65.45\"\n        }\n      ]\n    },\n    \"orderMetaData\": {\n      \"productName\": \"Premium Plan\",\n      \"internalRef\": \"INV-2026-001\",\n      \"region\": \"CD\"\n    }\n  },\n  \"tokenizeCard\": \"true\"\n}"

response = http.request(request)
puts response.read_body
{
  "code": "00",
  "description": "Success",
  "data": {
    "checkoutLink": "https://ip:port/checkout/78388899938",
    "orderReference": "90e81e8a-bc14-4ebf-89c0-57da752cca58"
  }
}
{
  "code": "400",
  "description": "Request failed."
}
{
  "code": "401",
  "description": "Unauthorized"
}
{
  "code": "403",
  "description": "Forbidden"
}
{
  "code": "404",
  "description": "Record not found"
}
{
  "code": "429",
  "description": "Too many requests"
}
{
  "code": "500",
  "description": "Server error"
}

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
​
tokenizeCard
boolean

Determines if the card used for payment is to be tokenized

Example:

"true"

Response

OK - your request was successful.

​
code
string
required

Response Code

Example:

"00"

​
description
string
required

checkout order created successful

Example:

"Success"

​
data
object
required