Miscellaneous Module

This wrapper class facilitates synchronous integration with Paystack Miscellaneous API. The Miscellaneous API are supporting APIs that can be used to provide more details to other APIs.

You can use the tool kit in the helpers module as reference: PayStackEase Helpers Package

class MiscellaneousClientAPI(secret_key: str = None)

Paystack Miscellaneous API Reference: Miscellaneous

list_banks(country: str | None = None, use_cursor: bool | None = False, per_page: int | None = 50, pay_with_bank_transfer: bool | None = False, pay_with_bank: bool | None = False, enabled_for_verification: bool | None = False, next_cursor: str | None = None, previous_cursor: str | None = None, gateway: str | None = None, channel_type: str | None = None, currency: str | None = None)→ PayStackResponse

Get a list of all supported banks and their properties

Parameters:

  • country (str, optional) – The country to obtain the list of supported banks.

  • use_cursor (bool, optional) – Use cursor to paginate through the list of supported banks. (default: False)

  • per_page (int, optional) – Number of banks to return per page. (default: 50)

  • pay_with_bank_transfer (bool, optional) – filter for available banks a customer can make a transfer to complete a payment. (default: False)

  • pay_with_bank (bool, optional) – filter for banks a customer can pay directly from. (default: False)

  • enabled_for_verification (bool, optional) – filter the banks that are supported for account verification. (default: False)

  • next_cursor (str, optional) – The cursor for the next page.

  • previous_cursor (str, optional) – The cursor for the previous page.

  • gateway (str, optional) – filter for banks that support the specified gateway.

  • channel_type (str, optional) – filter for banks that support the specified channel type.

  • currency (str, optional) – filter for banks that support the specified currency.

Returns:

The response from the API.

Return type:

PayStackResponse object

list_countries()→ PayStackResponse

Get a list of all supported countries and their properties

Returns:

The response from the API.

Return type:

PayStackResponse object

list_states(country: str)→ PayStackResponse

Get a list of all supported states and their properties

Parameters:

country (str) – The country to obtain the list of supported states.

Returns:

The response from the API.

Return type:

PayStackResponse object

Note

enable_for_verification is supported only for South Africa and combine with currency or country filter. If you set country as Ghana, please use either mobile_money for mobile money channels OR ghipps for bank channels type.

See documentation to get the string values for gateway, channel_type and currency enum classes: Tool kit module