Cancel an order

POST

orders

{id}

cancel

Cancel an order

curl --request POST \
  --url https://api.example.com/v1/orders/{id}/cancel \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/orders/{id}/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.example.com/v1/orders/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/v1/orders/{id}/cancel"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/orders/{id}/cancel")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "beneficiaryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "fromAmount": "1006.5000",
  "fromCurrency": "USDT",
  "fundingDeadlineAt": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rate": "0.00067100",
  "status": "created",
  "toAmount": "1500000.0000",
  "toCurrency": "NGN",
  "updatedAt": "<string>",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientRef": "<string>",
  "completedAt": "<string>",
  "executionDeadlineAt": "<string>",
  "failureReason": "execution_failed",
  "fundedAt": "<string>",
  "purpose": "<string>",
  "settlement": {
    "currency": "XOF",
    "expiresAt": "<string>",
    "instructions": {},
    "method": "virtual_account",
    "reference": "SETTLE-4F7A2C91B0",
    "requiredAmount": "1006.5000",
    "requirements": {
      "proofOfPayment": true
    },
    "settlementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "open"
  },
  "uetr": "<string>"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Authorizations

Authorization

string

header

required

Enter Auth0 JWT token

Path Parameters

string<uuid>

required

Order id

Response

beneficiaryId

string<uuid>

required

Beneficiary id

createdAt

string

required

Creation time (ISO 8601)

fromAmount

string

required

Total source debit, in fromCurrency (decimal string)

Example:

"1006.5000"

fromCurrency

string

required

Funded (source) currency

Example:

"USDT"

fundingDeadlineAt

string

required

Deadline for funds to be attributed to the order before it expires (ISO 8601)

string<uuid>

required

Order id

quoteId

string<uuid>

required

Consumed quote id

rate

string

required

All-in rate: fromCurrency per 1 toCurrency

Example:

"0.00067100"

status

enum<string>

required

Order lifecycle status

Available options:

created,

awaiting_funds,

funds_received,

executing,

completed,

failed,

expired,

cancelled

toAmount

string

required

Amount delivered, in toCurrency (decimal string)

Example:

"1500000.0000"

toCurrency

string

required

Delivered (target) currency

Example:

"NGN"

updatedAt

string

required

Last update time (ISO 8601)

accountId

string<uuid>

Owning sub-account; present when the order was created in a sub-account context (Zuba-Account-Id header). Absent = the order belongs to your master account.

clientRef

string

Client-supplied reference

completedAt

string

When the order completed (ISO 8601)

executionDeadlineAt

string

Desk execution deadline, set when funds are received (ISO 8601)

failureReason

enum<string>

Fixed failure code; present only when status is failed

Available options:

execution_failed,

review_expired

fundedAt

string

When funds were received (ISO 8601)

purpose

string

Free-text purpose

settlement

object

Funding instructions; present when the order is (or was) settlement-funded rather than balance-funded

Show child attributes

uetr

string

Outbound wire reference (UETR); present once the order completes over a wire rail

Cancel an order

curl --request POST \
  --url https://api.example.com/v1/orders/{id}/cancel \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/orders/{id}/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.example.com/v1/orders/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/v1/orders/{id}/cancel"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/orders/{id}/cancel")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "beneficiaryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "fromAmount": "1006.5000",
  "fromCurrency": "USDT",
  "fundingDeadlineAt": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rate": "0.00067100",
  "status": "created",
  "toAmount": "1500000.0000",
  "toCurrency": "NGN",
  "updatedAt": "<string>",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientRef": "<string>",
  "completedAt": "<string>",
  "executionDeadlineAt": "<string>",
  "failureReason": "execution_failed",
  "fundedAt": "<string>",
  "purpose": "<string>",
  "settlement": {
    "currency": "XOF",
    "expiresAt": "<string>",
    "instructions": {},
    "method": "virtual_account",
    "reference": "SETTLE-4F7A2C91B0",
    "requiredAmount": "1006.5000",
    "requirements": {
      "proofOfPayment": true
    },
    "settlementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "open"
  },
  "uetr": "<string>"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}