Skip to main content
GET
/
v1
/
orders
/
{id}
Get an order by id
curl --request GET \
  --url https://api.example.com/v1/orders/{id} \
  --header 'Authorization: Bearer <token>'
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/orders/{id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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}"

	req, _ := http.NewRequest("GET", 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))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/v1/orders/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.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": "funds_received",
  "toAmount": "1500000.0000",
  "toCurrency": "NGN",
  "updatedAt": "<string>",
  "clientRef": "<string>",
  "completedAt": "<string>",
  "executionDeadlineAt": "<string>",
  "fundedAt": "<string>",
  "purpose": "<string>",
  "uetr": "<string>",
  "settlement": {
    "settlementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "requiredAmount": "1006.5000",
    "currency": "XOF",
    "reference": "SETTLE-4F7A2C91B0",
    "instructions": {},
    "expiresAt": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Enter Auth0 JWT token

Path Parameters

​
id
string<uuid>
required

Order id

Response

The order

​
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)

​
id
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. Orders are executed manually by the trade desk: funds_received means the order is queued for execution, executing means execution is approved and in flight, completed means delivered.

Available options:
created,
awaiting_funds,
funds_received,
executing,
completed,
failed,
expired,
cancelled
Example:

"funds_received"

​
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)

​
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

​
uetr
string

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

​
settlement
object

Funding instructions for an order created without sufficient balance; present while the order awaits funds and after matching