Skip to main content
GET
/
v1
/
orders
List orders
curl --request GET \
  --url https://api.example.com/v1/orders \
  --header 'Authorization: Bearer <token>'
import requests

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

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', 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",
  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"

	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")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

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

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
{
  "data": [
    {
      "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>"
      }
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "object": "order.list"
}

Authorizations

​
Authorization
string
header
required

Enter Auth0 JWT token

Query Parameters

​
status
enum<string>

Filter by status

Available options:
created,
awaiting_funds,
funds_received,
executing,
completed,
failed,
expired,
cancelled
​
from
string

ISO-8601 lower bound on createdAt (inclusive)

​
to
string

ISO-8601 upper bound on createdAt (exclusive)

​
limit
number
default:20

Page size (1-100, default 20)

Required range: 1 <= x <= 100
​
cursor
string

Opaque pagination cursor

Response

Orders page

​
data
object[]
required
​
hasMore
boolean
required

Whether more items exist after this page

Example:

true

​
nextCursor
string | null
required

Opaque cursor for the next page, or null when there are no more items

​
object
enum<string>
required

Stable collection discriminator

Available options:
order.list
Example:

"order.list"