list_banks
Retrieve supported banks and their properties for a specific country, with filters for currency, type, and other payment options.
Instructions
Get a list of all banks supported by Paystack and their properties
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | No | A cursor that indicates your place in the list. It can be used to fetch the next page of the list | |
| type | No | Type of financial channel. For Ghanaian channels, please use either mobile_money for mobile money channels OR ghipps for bank channels | |
| country | Yes | The country from which to obtain the list of supported banks. Accepted values are: ghana, kenya, nigeria, south africa | |
| gateway | No | The gateway type of the bank. It can be one of these: [emandate, digitalbankmandate] | |
| perPage | Yes | The number of objects to return per page. Defaults to 50, and limited to 100 records per page. | |
| currency | No | One of the supported currency | |
| previous | No | A cursor that indicates your place in the list. It should be used to fetch the previous page of the list after an intial next request | |
| use_cursor | Yes | Flag to enable cursor pagination on the endpoint | |
| pay_with_bank | No | A flag to filter for banks a customer can pay directly from | |
| include_nip_sort_code | No | A flag that returns Nigerian banks with their nip institution code. The returned value can be used in identifying institutions on NIP. | |
| pay_with_bank_transfer | No | A flag to filter for available banks a customer can make a transfer to complete a payment | |
| enabled_for_verification | No | A flag to filter the banks that are supported for account verification in South Africa. You need to combine this with either the currency or country filter. |