Miscellaneous

Overview

The Miscellaneous class provides utility methods for accessing reference data like supported banks, countries, and states. This information is essential for building forms and validating user input.

Methods

listBanks

Get a list of all supported banks and their details. Use this to populate bank selection dropdowns and get bank codes for verification.

const result = await paystack.miscellaneous.listBanks({
  country: "nigeria",
  perPage: 50,
  use_cursor: false
});

if (result.data) {
  result.data.data.forEach(bank => {
    console.log(`${bank.name} - ${bank.code}`);
  });
}

const result = await paystack.miscellaneous.listBanks({
  country: "nigeria",
  perPage: 50,
  use_cursor: false
});

if (result.data) {
  result.data.data.forEach(bank => {
    console.log(`${bank.name} - ${bank.code}`);
  });
}

Parameters

enum

required

The country to get banks for. Options: nigeria, ghana, kenya, south africa

number

default:"50"

Number of results per page (max: 100)

boolean

default:"false"

Use cursor-based pagination

boolean

Filter for banks that support pay with bank transfer

boolean

Filter for banks that support pay with bank

boolean

Filter for banks that are enabled for account verification

string

Cursor for the next page (when using cursor pagination)

string

Cursor for the previous page (when using cursor pagination)

enum

Filter by gateway type. Options: emandate, digitalBankMandate

string

Filter by bank type

enum

Filter by currency. Options: NGN, USD, GHS, ZAR, KES, XOF

boolean

Include NIP sort code in the response

Response

boolean

Indicates whether the request was successful

string

A message describing the result

array

Array of bank objects

Show Bank object properties

string

The bank’s name

string

The bank’s slug identifier

string

The bank code used for verification and transfers

string

The bank’s long code

unknown

Gateway information

boolean

Whether this bank supports pay with bank

boolean

Whether the bank is currently active

boolean

Whether the bank has been deleted

string

The country where the bank operates

enum

The bank’s currency. Options: NGN, USD, GHS, ZAR, KES, XOF

string

The type of bank

number

The bank’s unique ID

string | null

ISO 8601 timestamp of when the bank was created

string | null

ISO 8601 timestamp of when the bank was last updated

listCountries

Get a list of all supported countries and their configuration details.

const result = await paystack.miscellaneous.listCountries();

if (result.data) {
  result.data.data.forEach(country => {
    console.log(`${country.name} (${country.iso_code})`);
    console.log(`Default currency: ${country.default_currency_code}`);
  });
}

const result = await paystack.miscellaneous.listCountries();

if (result.data) {
  result.data.data.forEach(country => {
    console.log(`${country.name} (${country.iso_code})`);
    console.log(`Default currency: ${country.default_currency_code}`);
  });
}

Parameters

This method takes no parameters.

Response

boolean

Indicates whether the request was successful

string

A message describing the result

array

Array of country objects

Show Country object properties

number

The country’s unique ID

string

The country’s name

string

The country’s ISO code (e.g., “NG”, “GH”)

string

The default currency code for the country

object

Default integration settings for the country

object

Relationships to other entities

Show Relationship properties

object

Currency relationships

Show Currency properties

string

The relationship type

array

Array of currency codes

object

Integration feature relationships

object

Integration type relationships

object

Payment method relationships

listStates

Get a list of all states in a specific country. Useful for address verification and form population.

const result = await paystack.miscellaneous.listStates({
  country: "NG"
});

if (result.data) {
  result.data.data.forEach(state => {
    console.log(`${state.name} (${state.abbreviation})`);
  });
}

const result = await paystack.miscellaneous.listStates({
  country: "NG"
});

if (result.data) {
  result.data.data.forEach(state => {
    console.log(`${state.name} (${state.abbreviation})`);
  });
}

Parameters

string

required

The country code (e.g., “NG” for Nigeria)

Response

boolean

Indicates whether the request was successful

string

A message describing the result

array

Array of state objects

Show State object properties

string

The full name of the state

string

The state’s slug identifier

string

The state’s abbreviation

Common Use Cases

Building a Bank Selection Form

// Get all Nigerian banks
const { data } = await paystack.miscellaneous.listBanks({
  country: "nigeria",
  enabled_for_verification: true
});

if (data) {
  const bankOptions = data.data.map(bank => ({
    label: bank.name,
    value: bank.code
  }));
  // Use bankOptions in your form
}

Address Verification

// Get all states in Nigeria for address validation
const { data } = await paystack.miscellaneous.listStates({
  country: "NG"
});

if (data) {
  const stateOptions = data.data.map(state => ({
    label: state.name,
    value: state.slug
  }));
  // Use stateOptions in your address form
}

Error Handling

All methods return a result object with data and error properties:

const result = await paystack.miscellaneous.listBanks({
  country: "nigeria"
});

if (result.error) {
  console.error('Failed to fetch banks:', result.error.flatten());
} else if (result.data) {
  console.log(`Found ${result.data.data.length} banks`);
}

Verification

Use bank codes for account verification

Paystack Miscellaneous API

Official Paystack Miscellaneous API documentation

Core

Modules

Overview

Methods

listBanks

Parameters

Response

listCountries

Parameters

Response

listStates

Parameters

Response

Common Use Cases

Building a Bank Selection Form

Address Verification

Error Handling

Verification

Paystack Miscellaneous API

​Overview

​Methods

​listBanks

​Parameters

​Response

​listCountries

​Parameters

​Response

​listStates

​Parameters

​Response

​Common Use Cases

​Building a Bank Selection Form

​Address Verification

​Error Handling

​Related Resources

Verification

Paystack Miscellaneous API

Overview

Methods

listBanks

Parameters

Response

listCountries

Parameters

Response

listStates

Parameters

Response

Common Use Cases

Building a Bank Selection Form

Address Verification

Error Handling

Related Resources