List orders

GET /orders

List orders

cURL

curl --request GET \
  --url https://developersandbox-api.flutterwave.com/orders \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://developersandbox-api.flutterwave.com/orders"

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

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

print(response.text)

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

fetch('https://developersandbox-api.flutterwave.com/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://developersandbox-api.flutterwave.com/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://developersandbox-api.flutterwave.com/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://developersandbox-api.flutterwave.com/orders")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developersandbox-api.flutterwave.com/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

200

{
  "message": "<string>",
  "meta": {
    "page_info": {
      "total": 123,
      "current_page": 123,
      "total_pages": 123
    }
  },
  "data": [
    {
      "id": "ord_WRq7L4TM8p",
      "amount": 12.34,
      "fees": [
        {
          "type": "vat",
          "amount": 12.3
        }
      ],
      "billing_details": {
        "email": "[e-mail]",
        "name": {
          "first": "King",
          "middle": "Leo",
          "last": "LeBron"
        },
        "phone": {
          "country_code": "234",
          "number": "08012345678"
        }
      },
      "currency": "NGN",
      "customer_id": "cus_3XarBILKQS",
      "description": "Payment for a Suit Skirt",
      "meta": {},
      "next_action": {
        "type": "redirect_url",
        "redirect_url": {
          "url": "https://developer-sandbox-ui-sit.flutterwave.cloud/redirects?opay&token=eyJhbGciOiJIUzI1NiJ9.eyJjbGllbnRJZCI6ImNiYThhMTkwLTE2OGUtNGNmZS05NmY5LTE2NDZhYjFhOWNkYiIsImNoYXJnZUlkIjoiY2hnX25PTmdlQUdZOTciLCJzdWIiOiJjYmE4YTE5MC0xNjhlLTRjZmUtOTZmOS0xNjQ2YWIxYTljZGIiLCJpYXQiOjE3MzgzMTc3MTAsImV4cCI6MTczODMxODAxMH0.QgLoZYfNhHJOJJvOsLA9eLoxOjGF0qnuehPMgMP4zD4"
        }
      },
      "payment_method_details": {
        "id": "pmd_WRq7L4TM8p",
        "type": "card",
        "card": {
          "expiry_month": "09",
          "expiry_year": "32",
          "first6": "123412",
          "last4": "1234",
          "network": "MASTERCARD",
          "billing_address": {
            "city": "New York",
            "country": "US",
            "line1": "123 Main Street",
            "postal_code": "10001",
            "state": "New York",
            "line2": "Apt 4B"
          },
          "cof": {
            "enabled": true,
            "agreement_id": "Agreement00w02W1",
            "recurring_amount_variability": "VARIABLE",
            "agreement_type": "UNSCHEDULED",
            "trace_id": "123456789"
          },
          "card_holder_name": "Alex James"
        },
        "customer_id": "cus_3XarBILKQS",
        "meta": {},
        "device_fingerprint": "62wd23423rq324323qew1",
        "client_ip": "154.123.220.1",
        "created_datetime": "2024-12-03T13:54:21.546559974Z"
      },
      "redirect_url": "https://flutterwave.com",
      "reference": "<string>",
      "created_datetime": "2025-03-27T10:00:00Z"
    }
  ]
}

{
  "status": "failed",
  "error": {
    "type": "REQUEST_NOT_VALID",
    "code": "10400",
    "message": "Request is not valid",
    "validation_errors": [
      {
        "field_name": "amount",
        "message": "must not be null"
      }
    ]
  }
}

{
  "status": "failed",
  "message": "UNAUTHORIZED",
  "error": {
    "type": "UNAUTHORIZED",
    "code": "10401",
    "message": "unauthorized"
  }
}

{
  "status": "failed",
  "message": "<string>",
  "error": {
    "type": "FORBIDDEN",
    "code": "10403",
    "message": "Forbidden"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Trace-Id · string

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

Required string length: 12 - 255

Query Parameters

status · enum<string>

The status of the order.

Available options: completed, pending, authorized, partially-completed, voided, failed

to · string<date-time>

The end date and time for a period. This parameter is used in conjunction with the 'from' parameter to define a time range. The value should be in ISO 8601 format.

from · string<date-time>

The start date and time for a period. This parameter is used in conjunction with the 'to' parameter to define a time range. The value should be in ISO 8601 format.

customer_id · string

The customer ID

payment_method_id · string

ID of the payment method.

page · integer · default: 1

The page of the data to retrieve. The most recent data entry is on page 1.

Required range: x >= 1

size · integer · default: 10

Length of data returned. Defaults to 10.

Required range: 10 <= x <= 50

Response

200

application/json

OK

status · enum<string>

Available options: success, failed

message · string

meta · object

Show child attributes

data · object[]

Maximum array length: 10

Show child attributes