Skip to main content
POST
/
v1
/
checkout
/
order
/
cancel
Cancel Checkout Order
curl --request POST \
  --url https://api.nomba.com/v1/checkout/order/cancel \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderReference": "OD-69923-2e102708-ee34-4a29-b713-a826ca928a12"
}
'
import requests

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

payload = { "orderReference": "OD-69923-2e102708-ee34-4a29-b713-a826ca928a12" }
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({orderReference: 'OD-69923-2e102708-ee34-4a29-b713-a826ca928a12'})
};

fetch('https://api.nomba.com/v1/checkout/order/cancel', 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/cancel",
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([
'orderReference' => 'OD-69923-2e102708-ee34-4a29-b713-a826ca928a12'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$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/cancel"

payload := strings.NewReader("{\n \"orderReference\": \"OD-69923-2e102708-ee34-4a29-b713-a826ca928a12\"\n}")

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

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/cancel")
.header("Content-Type", "application/json")
.body("{\n \"orderReference\": \"OD-69923-2e102708-ee34-4a29-b713-a826ca928a12\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderReference\": \"OD-69923-2e102708-ee34-4a29-b713-a826ca928a12\"\n}"

response = http.request(request)
puts response.read_body
{
  "code": "00",
  "description": "success",
  "data": {
    "success": true,
    "message": "Order cancelled successfully"
  }
}
{
"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"
}

Body

application/json

The request payload required to cancel a checkout order.

The request payload to cancel a checkout order

orderReference
string
required

The unique reference of the checkout order to cancel

Example:

"OD-69923-2e102708-ee34-4a29-b713-a826ca928a12"

Response

OK - your request was successful.

code
string
required

Response Code

Example:

"00"

description
string
required

Response description

Example:

"success"

data
object
required

The response object for a cancel order operation