flutterwave-settlements

name	flutterwave-settlements
description	Fetch and reconcile settlement reports across currencies and subaccounts.

flutterwave-settlements

Purpose

Fetch and reconcile settlement reports across currencies and subaccounts.

Implementation Pattern (TypeScript)

const FLW_V3_BASE_URL = process.env.FLW_V3_BASE_URL ?? "https://api.flutterwave.com/v3";
const FLW_V4_BASE_URL = process.env.FLW_V4_BASE_URL ?? "https://developersandbox-api.flutterwave.com";
const FLW_SECRET_KEY = process.env.FLW_SECRET_KEY;

type FlwResponse<T> = {
  status: "success" | "error";
  message: string;
  data: T;
};

class FlutterwaveApiError extends Error {
  constructor(
    message: string,
    public readonly statusCode: number,
    public readonly payload?: unknown,
  ) {
    super(message);
    this.name = "FlutterwaveApiError";
  }
}

function getBaseUrl(version: "v3" | "v4") {
  return version === "v3" ? FLW_V3_BASE_URL : FLW_V4_BASE_URL;
}

async function flwRequest<T>(
  version: "v3" | "v4",
  path: string,
  init: RequestInit = {},
): Promise<FlwResponse<T>> {
  if (!FLW_SECRET_KEY) {
    throw new Error("Missing FLW_SECRET_KEY");
  }

  const response = await fetch(`${getBaseUrl(version)}${path}`, {
    ...init,
    headers: {
      "Content-Type": "application/json",
      Authorization: `Bearer ${FLW_SECRET_KEY}`,
      ...(init.headers ?? {}),
    },
  });

  const body = (await response.json()) as FlwResponse<T>;

  if (!response.ok || body.status === "error") {
    throw new FlutterwaveApiError(
      body.message || "Flutterwave API request failed",
      response.status,
      body,
    );
  }

  return body;
}

Endpoint Operations and References

Version	Method	Route / Operation	Use Case	Reference
v3	GET	/settlements	List settlements	https://developer.flutterwave.com/docs/settlements
v4	GET	/settlement	List settlements	https://developer.flutterwave.com/reference/settlement_list
v4	GET	/settlement/{id}	Retrieve settlement	https://developer.flutterwave.com/reference/settlement_get
v4	GET	/fees	Join fee records for net settlement	https://developer.flutterwave.com/reference/fees_get

Country / Rail Matrix

Market	Rail	Integration Notes
All	Daily settlement cut	Schedule nightly reconciliation.
All	Subaccount split settlement	Join split metadata at transaction level.
All	Multi-currency settlement	Report by currency and converted base view.

Usage Example

export async function runSettlementsExample() {
  return flwRequest<unknown>("v4", "/settlement", {
    method: "GET",
  });
}

Reliability Checklist

• Re-verify successful payment state server-side before fulfillment.
• Store provider ids, internal ids, tx_ref, and event ids for reconciliation.
• Keep webhook consumers idempotent and return HTTP 200 quickly.
• Separate version-specific request/response types to avoid schema mixups.

v4 Delta Note

v4 is resource-centric in the public reference. Keep route maps and payload types versioned in code so agent-generated integrations remain accurate.