Settlements

This section details all necessary APIs needed for managing your settlements.

Get all Settlements

This section describes how to query all settlements made to an account.

get https://api.flutterwave.com/v3/settlements

Query Params

Show optional parameters

Headers

Authorization string

Pass your secret key as a bearer token in the request header to authorize this call

var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{BASE_API_URL}}/settlements',
  'headers': {
    'Authorization': 'Bearer FLWSECK_TEST-SANDBOXDEMOKEY-X'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "{{BASE_API_URL}}/settlements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer FLWSECK_TEST-SANDBOXDEMOKEY-X"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
require "uri"
require "net/http"

url = URI("{{BASE_API_URL}}/settlements")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer FLWSECK_TEST-SANDBOXDEMOKEY-X"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "Settlements fetched",
  "meta": {
    "page_info": {
      "total": 6,
      "current_page": 1,
      "total_pages": 1,
      "page_size": 20
    }
  },
  "data": [
    {
      "id": 41748,
      "account_id": 73362,
      "merchant_name": "Earth Gang",
      "merchant_email": "selma.m0ckaham@flutterwavego.com",
      "settlement_account": "0031318432",
      "bank_code": "063",
      "transaction_date": "2020-01-01T04:00:00.000Z",
      "due_date": "2020-01-01T04:00:00.000Z",
      "processed_date": null,
      "status": "completed",
      "is_local": true,
      "currency": "NGN",
      "gross_amount": 122000,
      "app_fee": 2108,
      "merchant_fee": 0,
      "chargeback": 0,
      "refund": 0,
      "stampduty_charge": 0,
      "net_amount": 119892,
      "transaction_count": 8,
      "processor_ref": null,
      "disburse_ref": "INSTANT_SETTLEMENT",
      "disburse_message": null,
      "channel": "web",
      "destination": "autowallet",
      "fx_data": null,
      "flag_message": null,
      "meta": [
        908260,
        908790,
        908232,
        908274,
        909038,
        908246,
        908290,
        908216
      ],
      "refund_meta": null,
      "chargeback_meta": null,
      "source_bankcode": null,
      "created_at": "2020-01-02T01:30:00.000Z"
    },
    {
      "id": 41642,
      "account_id": 73362,
      "merchant_name": "Earth Gang",
      "merchant_email": "selma.m0ckaham@flutterwavego.com",
      "settlement_account": "0031318432",
      "bank_code": "063",
      "transaction_date": "2019-12-31T04:00:00.000Z",
      "due_date": "2019-12-31T04:00:00.000Z",
      "processed_date": null,
      "status": "completed",
      "is_local": true,
      "currency": "NGN",
      "gross_amount": 24000,
      "app_fee": 936,
      "merchant_fee": 0,
      "chargeback": 0,
      "refund": 0,
      "stampduty_charge": 0,
      "net_amount": 23064,
      "transaction_count": 12,
      "processor_ref": null,
      "disburse_ref": "INSTANT_SETTLEMENT",
      "disburse_message": null,
      "channel": "web",
      "destination": "autowallet",
      "fx_data": null,
      "flag_message": null,
      "meta": [
        908041,
        908197,
        908082,
        908015,
        908111,
        908053,
        908087,
        908034,
        908174,
        908067,
        907967,
        908103
      ],
      "refund_meta": null,
      "chargeback_meta": null,
      "source_bankcode": null,
      "created_at": "2020-01-01T01:30:00.000Z"
    },
    {
      "id": 41497,
      "account_id": 73362,
      "merchant_name": "Earth Gang",
      "merchant_email": "selma.m0ckaham@flutterwavego.com",
      "settlement_account": "0031318432",
      "bank_code": "063",
      "transaction_date": "2019-12-30T04:00:00.000Z",
      "due_date": "2019-12-30T04:00:00.000Z",
      "processed_date": null,
      "status": "completed",
      "is_local": true,
      "currency": "NGN",
      "gross_amount": 50800,
      "app_fee": 950,
      "merchant_fee": 0,
      "chargeback": 0,
      "refund": 0,
      "stampduty_charge": 0,
      "net_amount": 49850,
      "transaction_count": 5,
      "processor_ref": null,
      "disburse_ref": "RV3E18675549F6A0",
      "disburse_message": null,
      "channel": "web",
      "destination": "autowallet",
      "fx_data": null,
      "flag_message": null,
      "meta": [
        906256,
        906358,
        906301,
        906362,
        906319
      ],
      "refund_meta": null,
      "chargeback_meta": null,
      "source_bankcode": null,
      "created_at": "2019-12-31T01:30:00.000Z"
    },
    {
      "id": 41440,
      "account_id": 73362,
      "merchant_name": "Earth Gang",
      "merchant_email": "selma.m0ckaham@flutterwavego.com",
      "settlement_account": "0031318432",
      "bank_code": "063",
      "transaction_date": "2019-12-30T01:00:00.000Z",
      "due_date": "2019-12-31T00:00:00.000Z",
      "processed_date": null,
      "status": "pending",
      "is_local": true,
      "currency": "NGN",
      "gross_amount": 30620,
      "app_fee": 620,
      "merchant_fee": 0,
      "chargeback": 0,
      "refund": 20114,
      "stampduty_charge": 0,
      "net_amount": 9886,
      "transaction_count": 3,
      "processor_ref": null,
      "disburse_ref": null,
      "disburse_message": null,
      "channel": "web",
      "destination": "account",
      "fx_data": null,
      "flag_message": null,
      "meta": [
        906262,
        906336,
        906339
      ],
      "refund_meta": [
        4169,
        4848,
        4852,
        4855,
        4868,
        4869,
        4870,
        4989
      ],
      "chargeback_meta": [],
      "source_bankcode": null,
      "created_at": "2019-12-31T01:00:01.000Z"
    },
    {
      "id": 40018,
      "account_id": 73362,
      "merchant_name": "Earth Gang",
      "merchant_email": "selma.m0ckaham@flutterwavego.com",
      "settlement_account": "0031318432",
      "bank_code": "063",
      "transaction_date": "2019-11-28T00:00:00.000Z",
      "due_date": "2019-11-29T00:00:00.000Z",
      "processed_date": null,
      "status": "pending",
      "is_local": true,
      "currency": "NGN",
      "gross_amount": 9000,
      "app_fee": 176,
      "merchant_fee": 0,
      "chargeback": 0,
      "refund": 0,
      "stampduty_charge": 0,
      "net_amount": 8824,
      "transaction_count": 1,
      "processor_ref": null,
      "disburse_ref": null,
      "disburse_message": null,
      "channel": "web",
      "destination": "account",
      "fx_data": null,
      "flag_message": null,
      "meta": [
        854542
      ],
      "refund_meta": [],
      "chargeback_meta": [],
      "source_bankcode": null,
      "created_at": "2019-11-29T11:50:38.000Z"
    },
    {
      "id": 38813,
      "account_id": 73362,
      "merchant_name": "Earth Gang",
      "merchant_email": "selma.m0ckaham@flutterwavego.com",
      "settlement_account": "0031318432",
      "bank_code": "063",
      "transaction_date": "2019-10-10T01:00:00.000Z",
      "due_date": "2019-10-11T19:12:49.000Z",
      "processed_date": null,
      "status": "pending",
      "is_local": true,
      "currency": "NGN",
      "gross_amount": 2826.96,
      "app_fee": 2508.96,
      "merchant_fee": 0,
      "chargeback": 0,
      "refund": 0,
      "stampduty_charge": 0,
      "net_amount": 318,
      "transaction_count": 2,
      "processor_ref": null,
      "disburse_ref": null,
      "disburse_message": null,
      "channel": null,
      "destination": "account",
      "fx_data": null,
      "flag_message": null,
      "meta": null,
      "refund_meta": [],
      "chargeback_meta": null,
      "source_bankcode": null,
      "created_at": "2019-10-11T01:00:01.000Z"
    }
  ]
}
{}
Banks for Mobile Money (MoMo) Transfers

When making Mobile money transfers, you can use the following values for the account_bank parameter in your payload:

GH: AIRTEL, VODAFONE, TIGO, MTN

KE, UG, ZM, RW: MPS

Get a Settlement

This section describes how to get details on a particular settlement specified by its ID.

get https://api.flutterwave.com/v3/settlements/:id

Path Params

id int32

This is a unique identifier for the particular settlement you want to fetch. It is returned in the call to list all settlements as data.id.

Query Params

Show optional parameters

Headers

Authorization string

Pass your secret key as a bearer token in the request header to authorize this call

var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{BASE_API_URL}}/settlements/41497',
  'headers': {
    'Authorization': 'Bearer FLWSECK_TEST-SANDBOXDEMOKEY-X'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "{{BASE_API_URL}}/settlements/41497",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer FLWSECK_TEST-SANDBOXDEMOKEY-X"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
require "uri"
require "net/http"

url = URI("{{BASE_API_URL}}/settlements/41497")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer FLWSECK_TEST-SANDBOXDEMOKEY-X"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "Settlement fetched",
  "data": {
    "id": 41497,
    "account_id": 73362,
    "merchant_name": "Earth Gang",
    "merchant_email": "selma.m0ckaham@flutterwavego.com",
    "settlement_account": "0031318432",
    "bank_code": "063",
    "transaction_date": "2019-12-30T04:00:00.000Z",
    "due_date": "2019-12-30T04:00:00.000Z",
    "processed_date": null,
    "status": "completed",
    "is_local": 1,
    "currency": "NGN",
    "gross_amount": 50800,
    "app_fee": 950,
    "merchant_fee": 0,
    "chargeback": 0,
    "refund": 0,
    "stampduty_charge": 0,
    "net_amount": 49850,
    "transaction_count": 5,
    "processor_ref": null,
    "disburse_ref": "RV3E18675549F6A0",
    "disburse_message": null,
    "channel": "web",
    "destination": "autowallet",
    "fx_data": null,
    "flag_message": null,
    "meta": "[906256,906358,906301,906362,906319]",
    "refund_meta": null,
    "chargeback_meta": null,
    "source_bankcode": null,
    "created_at": "2019-12-31T01:30:00.000Z",
    "transactions": [
      {
        "customer_email": "h0vkard@flw.ext",
        "flw_ref": "FLW-MOCK-RECURR-42b3daee9f470127dacd19560533f3a6",
        "tx_ref": "Rave-Pages017117571060",
        "id": 984411,
        "charged_amount": 10140,
        "app_fee": 190,
        "merchant_fee": 0,
        "stampduty_charge": 0,
        "settlement_amount": 9950,
        "status": "successful",
        "payment_entity": "card",
        "transaction_date": "2019-12-30",
        "currency": "NGN",
        "card_locale": "LOCAL",
        "rrn": "N/A",
        "subaccount_settlement": 0
      },
      {
        "customer_email": "h0vkard@flw.ext",
        "flw_ref": "FLW-MOCK-RECURR-c536481525f02f76409892f517a16300",
        "tx_ref": "Rave-Pages017117571060",
        "id": 984456,
        "charged_amount": 10140,
        "app_fee": 190,
        "merchant_fee": 0,
        "stampduty_charge": 0,
        "settlement_amount": 9950,
        "status": "successful",
        "payment_entity": "card",
        "transaction_date": "2019-12-30",
        "currency": "NGN",
        "card_locale": "LOCAL",
        "rrn": "N/A",
        "subaccount_settlement": 0
      },
      {
        "customer_email": "h0vkard@flw.ext",
        "flw_ref": "FLW-MOCK-RECURR-d22d0ec0955047e9648bec46da40c987",
        "tx_ref": "Rave-Pages017117571060",
        "id": 984474,
        "charged_amount": 10190,
        "app_fee": 190,
        "merchant_fee": 0,
        "stampduty_charge": 0,
        "settlement_amount": 10000,
        "status": "successful",
        "payment_entity": "card",
        "transaction_date": "2019-12-30",
        "currency": "NGN",
        "card_locale": "LOCAL",
        "rrn": "N/A",
        "subaccount_settlement": 0
      },
      {
        "customer_email": "h0vkard@flw.ext",
        "flw_ref": "FLW-MOCK-RECURR-e55f863f14a95816e0939e7c4625ee43",
        "tx_ref": "Rave-Pages017117571060",
        "id": 984513,
        "charged_amount": 10190,
        "app_fee": 190,
        "merchant_fee": 0,
        "stampduty_charge": 0,
        "settlement_amount": 10000,
        "status": "successful",
        "payment_entity": "card",
        "transaction_date": "2019-12-30",
        "currency": "NGN",
        "card_locale": "LOCAL",
        "rrn": "N/A",
        "subaccount_settlement": 0
      },
      {
        "customer_email": "h0vkard@flw.ext",
        "flw_ref": "FLW-MOCK-RECURR-6100e5300876cef2270b2e31bc9cc16e",
        "tx_ref": "Rave-Pages017117571060",
        "id": 984517,
        "charged_amount": 10140,
        "app_fee": 190,
        "merchant_fee": 0,
        "stampduty_charge": 0,
        "settlement_amount": 9950,
        "status": "successful",
        "payment_entity": "card",
        "transaction_date": "2019-12-30",
        "currency": "NGN",
        "card_locale": "LOCAL",
        "rrn": "N/A",
        "subaccount_settlement": 0
      }
    ]
  }
}
{}
Loading...