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": {
    "orderReference": "fd3002af-d48b-40a0-adba-0b1c93635bd2",
    "customerId": "762878332454",
    "callbackUrl": "https://ip:port/merchant.com/callback",
    "customerEmail": "[email protected]",
    "amount": "10000.00",
    "currency": "NGN"
  },
  "tokenizeCard": "true"
}'
{
  "code": "00",
  "description": "Success",
  "data": {
    "checkoutLink": "https://ip:port/checkout/78388899938",
    "orderReference": "fd3002af-d48b-40a0-adba-0b1c93635bd2"
  }
}

Create a checkout order

Create an online checkout order to accept payments from your customers

POST /v1/checkout/order

Kindly be aware that the optional boolean value tokenizedCard should be included or set to true only if you intend to tokenize your customer’s card for the purpose of attempting other card payments at a later time.

Please pass the accountId inside the order request object if you wish to generate a checkout link for a subaccount.

Request body

order
object
required

Account reference

orderReference
string

Reference of the online checkout order to be created

customerId
string

ID of the customer that would be paying for the checkout order

callbackUrl
string
required

Merchant callback url for redirect after payment

customerEmail
string
required

Customer email

amount
number
required

The amount to be paid by the customer

currency
string
required

The currency of the money to be paid by the customer

accountId
string

Pass the accountId if you are generating this for a subaccount.

tokenizedCard
boolean

Determines if the card used for payment is to be tokenized

Response body

code
string
required

Response code

description
string
required

Response description

data
object
checkoutLink
string
required

Payment checkout link.

orderReference
string
required

Account ID.

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": {
    "orderReference": "fd3002af-d48b-40a0-adba-0b1c93635bd2",
    "customerId": "762878332454",
    "callbackUrl": "https://ip:port/merchant.com/callback",
    "customerEmail": "[email protected]",
    "amount": "10000.00",
    "currency": "NGN"
  },
  "tokenizeCard": "true"
}'
{
  "code": "00",
  "description": "Success",
  "data": {
    "checkoutLink": "https://ip:port/checkout/78388899938",
    "orderReference": "fd3002af-d48b-40a0-adba-0b1c93635bd2"
  }
}