Miscellaneous
A collection of endpoints that provides utility functions
Copy link Resolve Card BIN
Get the details of a card BIN
Path Parameters
The card bank identification number
Response
200Verification Resolve Card B I N response
9 object properties
GET
/decision/bin/{bin}curl https://api.paystack.co/decision/bin/539983 \
-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.miscellaneous.resolveCardBin("539983");
console.log(response.data);require "paystack"
paystack = Paystack::Client.new(ENV.fetch("PAYSTACK_SECRET_KEY"))
response = paystack.miscellaneous.resolve_card_bin("539983")
puts response.dataResponse
{
"status": true,
"message": "Bin resolved",
"data": {
"bin": "539983",
"brand": "Mastercard",
"sub_brand": "",
"country_code": "NG",
"country_name": "Nigeria",
"card_type": "DEBIT",
"bank": "Guaranty Trust Bank",
"linked_bank_id": 9
}
}{
"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 List Countries
List all supported countries on Paystack
Response
200Miscellaneous List Countries response
GET
/countrycurl https://api.paystack.co/country \
-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.miscellaneous.listCountries();
console.log(response.data);require "paystack"
paystack = Paystack::Client.new(ENV.fetch("PAYSTACK_SECRET_KEY"))
response = paystack.miscellaneous.list_countries()
puts response.dataResponse
{
"status": true,
"message": "Countries retrieved",
"data": [
{
"id": 1,
"name": "Nigeria",
"iso_code": "NG",
"default_currency_code": "NGN",
"integration_defaults": {},
"relationships": {
"currency": {
"type": "currency",
"data": [
"NGN",
"USD"
]
},
"integration_feature": {
"type": "integration_feature",
"data": []
},
"integration_type": {
"type": "integration_type",
"data": [
"ITYPE_001",
"ITYPE_002",
"ITYPE_003"
]
},
"payment_method": {
"type": "payment_method",
"data": [
"PAYM_001",
"PAYM_002",
"PAYM_003",
"PAYM_004"
]
}
}
},
{
"id": 2,
"name": "Ghana",
"iso_code": "GH",
"default_currency_code": "GHS",
"integration_defaults": {},
"relationships": {
"currency": {
"type": "currency",
"data": [
"GHS",
"USD"
]
},
"integration_feature": {
"type": "integration_feature",
"data": []
},
"integration_type": {
"type": "integration_type",
"data": [
"ITYPE_004",
"ITYPE_005"
]
},
"payment_method": {
"type": "payment_method",
"data": [
"PAYM_001"
]
}
}
}
]
}{
"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 List States (AVS)
Get a list of states for a country for address verification
Query Parameters
The country code of the states to list. It is gotten after the charge request
Response
200Miscellaneous List States response
GET
/address_verification/statescurl https://api.paystack.co/address_verification/states \
-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.miscellaneous.avs({
country: "CA"
});
console.log(response.data);require "paystack"
paystack = Paystack::Client.new(ENV.fetch("PAYSTACK_SECRET_KEY"))
response = paystack.miscellaneous.avs({
country: "CA"
})
puts response.dataResponse
{
"status": true,
"message": "States retrieved",
"data": [
{
"name": "Alberta",
"slug": "alberta",
"abbreviation": "AB"
},
{
"name": "British Columbia",
"slug": "british-columbia",
"abbreviation": "BC"
}
]
}{
"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
}