List settlement

GET /settlements

List settlement

cURL

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

import requests

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

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

	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/settlements")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developersandbox-api.flutterwave.com/settlements")

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": "stm_JJo3vjtffW",
      "net_amount": 12.34,
      "gross_amount": 12.34,
      "currency": "NGN",
      "description": "<string>",
      "meta": {},
      "status": "completed",
      "due_datetime": "2025-02-07T12:00:00.022Z",
      "transaction_datetime": "2025-02-06T12:00:00.022Z",
      "settlement_account": "0690000031",
      "fees": [
        {
          "type": "stamp_duty",
          "amount": 1.4
        }
      ],
      "chargeback": "98.1",
      "refund": "98.1",
      "destination": "wallet",
      "charge_count": "2",
      "charges": [
        {
          "id": "chg_zam88NgLb7",
          "charged_amount": 100,
          "customer_id": "cus_X0yJv3ZMpL",
          "settlement_amount": 98.6,
          "payment_method_id": "pmd_wlVhaYmkl2",
          "currency": "NGN",
          "charge_date": "2024-06-26"
        }
      ],
      "created_datetime": "2025-02-07T12:00:00.022Z"
    }
  ]
}

{
  "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

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

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.

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