Settlements Module

This wrapper class facilitates synchronous integration with Paystack Settlements API. The Settlements API allows you to gain insights into payouts made by Paystack to your bank account.

class SettlementClientAPI(secret_key: str = None)

Paystack Settlement API Reference: Settlements

list_settlement_transactions(settlement_id: int, per_page: int | None = 50, page: int | None = 1, from_date: date | None = None, to_date: date | None = None)→ PayStackResponse

Get the transactions that make up a particular settlement

Parameters:

  • settlement_id (int) – ID of the settlement

  • per_page (int, optional) – The number of plans per page. (default: 50)

  • page (int, optional) – The page number. (default: 1)

  • from_date

  • to_date

Returns:

The response from the API

Return type:

PayStackResponse object

list_settlements(per_page: int | None = 50, page: int | None = 1, status: str | None = None, subaccount: str | None = None, from_date: date | None = None, to_date: date | None = None)→ PayStackResponse

List all settlements made to your settlement accounts

Parameters:

  • per_page (int, optional) – The number of plans per page. (default: 50)

  • page (int, optional) – The page number. (default: 1)

  • status – Values can be any of the following: success, processing, pending or failed.

  • from_date

  • to_date

Returns:

The response from the API

Return type:

PayStackResponse object