Bank

A collection of endpoints for managing bank details

Copy link List Banks

List banks supported on Paystack

Query Parameters

countrystring
The country from which to obtain the list of supported banks
Enumghanakenyanigeriasouth africa
currencystring
The country from which to obtain the list of supported banks
EnumGHSKESNGNZAR
use_cursorboolean
A flag to indicate if cursor based pagination should be used
perPageinteger
The number of records to fetch per request
pageinteger
The offset to retrieve data from
nextstring
An alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
previousstring
An alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
pay_with_bank_transferboolean
A flag to filter for available banks a customer can make a transfer to complete a payment
pay_with_bankboolean
A flag to filter for banks a customer can pay directly from
enabled_for_verificationboolean
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.
gatewaystring
The type of gateway for a Nigerian bank
Enumemandatedigitalbankmandate
typestring
Type of financial channel
Enumghippsmobile_moneynubankepssbasa
include_nip_sort_codeboolean
A flag that returns Nigerian banks with their NIP institution code. The returned value can be used in identifying institutions on NIP.

Response

200Miscellaneous List Banks response
statusrequiredboolean
messagerequiredstring
datarequiredarray[object]
GET/bank
curl https://api.paystack.co/bank \
  -H "Authorization: Bearer YOUR_SECRET_KEY"
import { Paystack } from "@paystack/paystack-sdk";

const paystack = new Paystack({ secretKey: process.env.PAYSTACK_SECRET_KEY! });

const response = await paystack.bank.list({
  country: "nigeria",
  currency: "NGN"
});
console.log(response.data);
require "paystack"

paystack = Paystack::Client.new(ENV.fetch("PAYSTACK_SECRET_KEY"))

response = paystack.bank.list({
  country: "nigeria",
  currency: "NGN"
})
puts response.data
Response
{
  "status": true,
  "message": "Banks retrieved",
  "data": [
    {
      "name": "Abbey Mortgage Bank",
      "slug": "abbey-mortgage-bank",
      "code": "801",
      "longcode": "",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "is_deleted": false,
      "country": "Nigeria",
      "currency": "NGN",
      "type": "nuban",
      "id": 174,
      "createdAt": "2020-12-07T16:19:09.000Z",
      "updatedAt": "2020-12-07T16:19:19.000Z"
    },
    {
      "name": "Coronation Merchant Bank",
      "slug": "coronation-merchant-bank",
      "code": "559",
      "longcode": "",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "is_deleted": false,
      "country": "Nigeria",
      "currency": "NGN",
      "type": "nuban",
      "id": 173,
      "createdAt": "2020-11-24T10:25:07.000Z",
      "updatedAt": "2020-11-24T10:25:07.000Z"
    },
    {
      "name": "Infinity MFB",
      "slug": "infinity-mfb",
      "code": "50457",
      "longcode": "",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "is_deleted": false,
      "country": "Nigeria",
      "currency": "NGN",
      "type": "nuban",
      "id": 172,
      "createdAt": "2020-11-24T10:23:37.000Z",
      "updatedAt": "2020-11-24T10:23:37.000Z"
    },
    {
      "name": "Paycom",
      "slug": "paycom",
      "code": "999992",
      "longcode": "",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "is_deleted": false,
      "country": "Nigeria",
      "currency": "NGN",
      "type": "nuban",
      "id": 171,
      "createdAt": "2020-11-24T10:20:45.000Z",
      "updatedAt": "2020-11-24T10:20:54.000Z"
    },
    {
      "name": "Petra Mircofinance Bank Plc",
      "slug": "petra-microfinance-bank-plc",
      "code": "50746",
      "longcode": "",
      "gateway": null,
      "pay_with_bank": false,
      "active": true,
      "is_deleted": false,
      "country": "Nigeria",
      "currency": "NGN",
      "type": "nuban",
      "id": 170,
      "createdAt": "2020-11-24T10:03:06.000Z",
      "updatedAt": "2020-11-24T10:03:06.000Z"
    }
  ],
  "meta": {
    "next": "YmFuazoxNjk=",
    "previous": null,
    "perPage": 5
  }
}
{
  "status": false,
  "message": "An error occurred",
  "meta": {
    "nextStep": "string"
  },
  "type": "string",
  "code": "validation_error",
  "errorCodeMappingNotFound": true
}
{
  "status": false,
  "message": "An error occurred",
  "meta": {
    "nextStep": "string"
  },
  "type": "string",
  "code": "validation_error",
  "errorCodeMappingNotFound": true
}

Copy link Resolve Account Number

Resolve an account number to confirm the name associated with it

Query Parameters

account_numberinteger
The account number of interest
bank_codeinteger
The bank code associated with the account number

Response

200Verification Resolve Account Number response
statusrequiredboolean
messagerequiredstring
datarequiredobject
3 object properties
account_numberrequiredstring
account_namerequiredstring
bank_idrequiredinteger
GET/bank/resolve
curl https://api.paystack.co/bank/resolve \
  -H "Authorization: Bearer YOUR_SECRET_KEY"
import { Paystack } from "@paystack/paystack-sdk";

const paystack = new Paystack({ secretKey: process.env.PAYSTACK_SECRET_KEY! });

const response = await paystack.bank.resolveAccountNumber({
  account_number: 22728151,
  bank_code: 63
});
console.log(response.data);
require "paystack"

paystack = Paystack::Client.new(ENV.fetch("PAYSTACK_SECRET_KEY"))

response = paystack.bank.resolve_account_number({
  account_number: 22728151,
  bank_code: 63
})
puts response.data
Response
{
  "status": true,
  "message": "Account number resolved",
  "data": {
    "account_number": "0022728151",
    "account_name": "WES GIBBONS"
  }
}
{
  "status": false,
  "message": "An error occurred",
  "meta": {
    "nextStep": "string"
  },
  "type": "string",
  "code": "validation_error",
  "errorCodeMappingNotFound": true
}
{
  "status": false,
  "message": "An error occurred",
  "meta": {
    "nextStep": "string"
  },
  "type": "string",
  "code": "validation_error",
  "errorCodeMappingNotFound": true
}

Copy link Validate Bank Account

Confirm the authenticity of a customer's account number before sending money

Request Body

account_namerequiredstring
Customer's first and last name registered with their bank
account_numberrequiredstring
Customer's account number
account_typerequiredstring
The type of the customer's account number
Enumpersonalbusiness
bank_coderequiredstring
The bank code of the customer’s bank. You can fetch the bank codes by using our List Banks endpoint
country_coderequiredstring
The two digit ISO code of the customer’s bank
document_typerequiredstring
Customer’s mode of identity
EnumidentityNumberpassportNumberbusinessRegistrationNumber
document_numberstring
Customer’s mode of identity number

Response

200Verification Validate Account response
statusrequiredboolean
messagerequiredstring
datarequiredobject
7 object properties
verifiedrequiredboolean
verificationMessagerequiredstring
accountAcceptsDebitsrequiredboolean
accountAcceptsCreditsrequiredboolean
accountOpenForMoreThanThreeMonthsrequiredboolean
accountHolderMatchrequiredboolean
accountOpenrequiredboolean
POST/bank/validate
curl https://api.paystack.co/bank/validate \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "account_name": "Ann Bron",
    "account_number": "0123456789",
    "account_type": "personal",
    "bank_code": "632005",
    "country_code": "ZA",
    "document_type": "identityNumber"
  }' \
  -X POST
import { Paystack } from "@paystack/paystack-sdk";

const paystack = new Paystack({ secretKey: process.env.PAYSTACK_SECRET_KEY! });

const response = await paystack.bank.validateAccountNumber({
  account_name: "Ann Bron",
  account_number: "0123456789",
  account_type: "personal",
  bank_code: "632005",
  country_code: "ZA",
  document_type: "identityNumber"
});
console.log(response.data);
require "paystack"

paystack = Paystack::Client.new(ENV.fetch("PAYSTACK_SECRET_KEY"))

response = paystack.bank.validate_account_number({
  account_name: "Ann Bron",
  account_number: "0123456789",
  account_type: "personal",
  bank_code: "632005",
  country_code: "ZA",
  document_type: "identityNumber"
})
puts response.data
Response
{
  "status": true,
  "message": "Personal Account Verification attempted",
  "data": {
    "accountAcceptsDebits": true,
    "accountAcceptsCredits": true,
    "accountHolderMatch": true,
    "accountOpenForMoreThanThreeMonths": true,
    "accountOpen": true,
    "verified": true,
    "verificationMessage": "Account is verified successfully"
  }
}
{
  "status": false,
  "message": "An error occurred",
  "meta": {
    "nextStep": "string"
  },
  "type": "string",
  "code": "validation_error",
  "errorCodeMappingNotFound": true
}