The Open Banking Nigeria Developer Hub

Welcome to the Open Banking Nigeria developer hub. You'll find comprehensive guides and documentation to help you start working with Open Banking Nigeria as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started
 

What is Open Banking Nigeria?

Open Banking Nigeria is an open source financial API standard for open banking and connectivity designed specifically for the Nigerian financial industry.

Open Banking API Standard is brought to you by the Open Technology Foundation, an NGO backed by a group of industry experts across banking, fintech, risk management, etc.

Read more about our Open Banking Nigeria in our help center or visit homepage to jump in right now.

API Reference

The reference to all our provided endpoints is here: https://doc.openbanking.ng/reference

Main points about Open Banking Nigeria API

  • API is built on HTTP and it is RESTful.
  • There is no need to learn yet another 3rd party library to use the API.
  • You can use your favorite HTTP/REST library available for your programming language to make HTTP calls.
  • All code examples will be using cURL and our official PHP SDK.
  • We try to keep our documentation clear and simple as possible so your feedback about it is always welcome.
 

Base URL

https://api.openbanking.ng/api/v2/

Acceptable Content Types

We accept these values of Content-Type header when using POST or PUT methods:
application/json (this one is used as default and it is recommended)
multipart/form-data application/x-www-form-urlencoded

HTTP Methods

Verb
Description

GET

Obtain information. Query path parameters are allowed.

POST

Add new information. Body is allowed.

PUT

Modify existing information. Body is allowed.

DELETE

Remove information.

 

API response is JSON formatted and it has Content-Type: application/json header.

HTTP Status Codes

Open Banking Nigeria API uses standard HTTP response codes.

HTTP code
Description

200

OK

The request was successful.

201

Created

The request has been fulfilled and resulted in a new resource being created.

204

No Content

The server has fulfilled the request but does not need to return an entity-body, i.e. when resource is deleted.

400

Bad Request

The request could not be understood by the server due to malformed syntax.

401

Unauthorized

The request requires user authentication.

404

Not Found

The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.

500

Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

Response with error

Every error has the structure described below.

Parameter
Type
Description

error

Object

Object that contains data about error.

error.code

Integer

Optional. Code of error.

error.message

String

Readable message about the error occured.

{
  "error": {
    "code": 123,
    "message": "Group not found"
  }
}

API error codes

Error code
Message
Description

1

Unauthorized

API key is required and is not provided

2

Endpoint not found

The endpoint you are trying to use is non-existing

302

API-Key Unauthorized

You are trying to use an API key to authorize which is invalid

Suggest Edits

Authentication

 

How to authenticate

Every request to an Open Banking Nigeria API endpoint should have HTTP header containing a valid API key that we use to authenticate the account:

Authorization: The access_token from the /oauth/token call

Credentials can be obtained from your bank's Open Banking portal or from Open Banking Nigeria sandbox

Authenticate request on sandbox

curl -v https://api.openbanking.ng/api/v1/endpoint \
-H "Authorization: Bearer {replace-it-with-your-access-token}"
-H "Content-Type: application/json"

Authentication errors

You might get errors described below when authentication fails. You can read more about response and errors on Response.

{
  "status": "ERROR",
  "message": "Access Denied",
  "code": "UNAUTHORIZED"
}
Suggest Edits

Introduction

The fastest way to kick start!

 

The Sandbox allows you to test out all the functionalities that can be implemented using the open banking specification. The server simulates the interaction of a real bank.

It is available at https://api.openbanking.ng

1. First Step

To start, you need to make a call to the sandbox to obtain access_token that would be used for all the requests.

curl "https://api.openbanking.ng/oauth/token" \
-X POST \
--user 'gigy:secret' \ 
-d 'grant_type=password&username=demo&password=password'
Suggest Edits

Get Account

 
gethttps://api.openbanking.ng/account/accountNumber
curl https://api.openbanking.ng/account/0022728151
A binary file was returned

You couldn't be authenticated

{
  "status": "SUCCESSFUL",
  "message": "SUCCESSFUL",
  "data": {
    "accountNumber": "0123456789",
    "customerId": null,
    "bvn": "",
    "fullName": "Sodiq Fagbola",
    "shortName": "Sodiq",
    "currency": "NAIRA",
    "accountOpeningDate": null,
    "lastTransactionDate": null,
    "status": "Successful",
    "bankSortCode": "012",
    "accountBalance": "0123456789",
    "phoneNumber": "090000000",
    "accountType": "CURRENT",
    "accountManagerName": "Anaedu Anthony",
    "accountManagerPhone": "08000000000"
  }
}

Path Params

accountNumber
string
required
 

Response Parameters

For a successful call, the data parameter has all the parameters for the response. These parameters are described below

Parameter
Description
Example

accountNumber

The NUBAN account number of the customer as sent in the request

0123456789

customerId

The unique identifier of a customer on the bank's core banking application

RXXXXXXXXX
CCXXXXXXXX
120093993999

bvn

The customer's BVN. This usually 11 digits

46466566464

fullName

The customer's full name. This includes the last name, first name and any other name

Sodiq Damilola Fagbola

shortName

The customer's short name. This is usually the first name or any other alias the customer can be referred to

Sodiq

currency

The operating currency of the account.

NAIRA

accountOpeningDate

The date the account was created at the bank

2013-04-09 05:19:44

lastTransactionDate

The last date a transaction (CR/DR) was carried out on the account

2015-05-01 14:22:00

status

Account status.

Active

bankSortCode

Sort code of the branch the account domiciles

030093

accountBalance

The amount available in the account

4,000,900.50

phoneNumber

The customer's phone number

0803XXXXXXXX

accountType

The type of account.

Savings

accountManagerName

The name of the account manager of the account at the bank

Mr. Wasiu Okeke

accountManagerPhone

The phone number of the Account Manager

0803XXXXXXXX

Suggest Edits

Get Account Balance

 
gethttps://api.openbanking.ng/account/balance/accountNumber
curl https://api.openbanking.ng/account/getAccountBalance/0022728151
-X GET
A binary file was returned

You couldn't be authenticated

{
  "status": "SUCCESSFUL",
  "message": "SUCCESSFUL",
  "data": {
    "accountNumber": "0123456789",
    "accountName": "Adamu Alliu",
    "availableBalance": 1000000,
    "clearedBalance": 1000000,
    "unClearedBalance": 1000000,
    "lienBalance": 1000000,
    "date": 1523101676899
  }
}

Path Params

accountNumber
string
required

Query Params

date
string
 
Parameter
Description
Example

accountNumber

The NUBAN account number of the customer

0123456789

accountName

The name of the account holder

Sodiq Damilola Fagbola

availableBalance

The amount available in the account

4,000,900.50

clearedBalance

Amount cleared

2,000,600.50

unClearedBalance

Amount uncleared

1,000,200.50

lienBalance

date

current datetime

2013-04-09 05:19:44

Suggest Edits

Get Account By Customer BVN

 
gethttps://api.openbanking.ng/account/bvn/bvn
curl --request GET \
  --url https://api.openbanking.ng/account/getAccountByCustomerBvn/00011122233
A binary file was returned

You couldn't be authenticated

{
  "status": true,
  "message": "Account number resolved",
  "data": {
    "account_number": "0022728151",
    "account_name": "WES GIBBONS"
  }
}

Path Params

bvn
string
required
 
Parameter
Description
Example

account_number

The NUBAN account number of the customer retrieved

0123456789

account_name

The Name of the customer retrieved

Sodiq Damilola Fagbola

Suggest Edits

Get Account By Email

 
gethttps://api.openbanking.ng/account/getAccountByEmail/email
curl --request GET \
  --url https://api.openbanking.ng/account/getAccountByEmail/jon%40snow.com
A binary file was returned

You couldn't be authenticated

[
  {
    "accountBalance": "string",
    "accountManagerName": "string",
    "accountManagerPhone": "string",
    "accountNumber": "string",
    "accountOpeningDate": "2018-02-19T18:29:31.927Z",
    "accountType": "string",
    "bankSortCode": "string",
    "bvn": "string",
    "currency": "NAIRA",
    "customerId": "string",
    "fullName": "string",
    "lastTransactionDate": "2018-02-19T18:29:31.927Z",
    "phoneNumber": "string",
    "shortName": "string",
    "status": "string"
  }
]

Path Params

email
string
required
 
Parameter
Description
Example

accountBalance

The amount available in the account

4,000,900.50

accountManagerName

The name of the account manager of the account at the bank

Mr. Wasiu Okeke

accountManagerPhone

The phone number of the Account Manager

0803XXXXXXXX

accountNumber

The NUBAN account number of the customer

0123456789

accountOpeningDate

The date the account was created at the bank

2013-04-09 05:19:44

accountType

The type of account.

Savings

bankSortCode

Sort code of the branch the account domiciles

030093

bvn

The customer's BVN. This usually 11 digits

46466566464

currency

The operating currency of the account.

NAIRA

customerId

The unique identifier of a customer on the bank's core banking application

RXXXXXXXXX
CCXXXXXXXX
120093993999

fullName

The customer's full name. This includes the last name, first name and any other name

Sodiq Damilola Fagbola

lastTransactionDate

The last date a transaction (CR/DR) was carried out on the account

2015-05-01 14:22:00

phoneNumber

The customer's phone number

0803XXXXXXXX

shortName

The customer's short name. This is usually the first name or any other alias the customer can be referred to

Sodiq

status

Account status.

Active

Suggest Edits

Get Account By Phone

 
gethttps://api.openbanking.ng/account/getAccountByPhone/phone
curl --request GET \
  --url https://api.openbanking.ng/account/getAccountByPhone/0801112223334
A binary file was returned

You couldn't be authenticated

{
  "status": true,
  "message": "Account number resolved",
  "data": {
    "account_number": "0022728151",
    "account_name": "WES GIBBONS"
  }
}

Path Params

phone
string
required
 

Response Parameters

For a successful call, the data parameter has all the parameters for the response. These parameters are described below

Parameter
Description
Example

account_number

The NUBAN account number of the customer

0123456789

account_name

The name of the account holder

Sodiq Damilola Fagbola

Suggest Edits

Get Account Type

 
gethttps://api.openbanking.ng/account/getAccountType
curl --request GET \
  --url https://api.openbanking.ng/account/getAccountType
A binary file was returned

You couldn't be authenticated

[
  {
    "accountTypeId": "string",
    "accountTypeName": "string",
    "cardProduct": "string",
    "currency": "NAIRA",
    "digitalProduct": "string",
    "documentation": "string",
    "kycLevel": "string",
    "maximumBalance": "string",
    "maximumInFlow": "string",
    "maximumTransactionLimit": "string",
    "minimumBalance": "string"
  }
]
 
Suggest Edits

Get Account By Customer Id

 
gethttps://api.openbanking.ng/account/customer/customerId
curl --request GET \
  --url https://api.openbanking.ng/account/getAccountByCustomerId/241
A binary file was returned

You couldn't be authenticated

[
  {
    "accountBalance": "string",
    "accountManagerName": "string",
    "accountManagerPhone": "string",
    "accountNumber": "string",
    "accountOpeningDate": "2018-02-19T18:38:28.458Z",
    "accountType": "string",
    "bankSortCode": "string",
    "bvn": "string",
    "currency": "NAIRA",
    "customerId": "string",
    "fullName": "string",
    "lastTransactionDate": "2018-02-19T18:38:28.458Z",
    "phoneNumber": "string",
    "shortName": "string",
    "status": "string"
  }
]

Path Params

customerId
string
required
 
Suggest Edits

Open Account

 
posthttps://api.openbanking.ng/account/open
curl --request POST \
  --url https://api.openbanking.ng/account/openAccount \
  --header 'content-type: application/json' \
  --data '{
  "accountName": "string",
  "accountTypeId": "string",
  "address": "string",
  "bvn": "string",
  "city": "string",
  "country": "string",
  "customerId": "string",
  "dateOfBirth": "2018-02-19T18:15:21.115Z",
  "email": "string",
  "firstName": "string",
  "localGovernment": "string",
  "nationality": "string",
  "nextOfKinAddress": "string",
  "nextOfKinEmail": "string",
  "nextOfKinName": "string",
  "nextOfKinPhone": "string",
  "nextOfKinRelationship": "string",
  "otherName": "string",
  "phone": "string",
  "surName": "string"
}'
A binary file was returned

You couldn't be authenticated

[
  {
    "accountNumber": "string",
    "customerId": "string"
  }
]

Body Params

accountName
string
accountTypeId
string
address
string
bvn
string
city
string
country
string
customerId
string
dateOfBirth
string
email
string
firstName
string
localGovernment
string
nationality
string
nextOfKin
string
nextOfKinEmail
string
nextOfKinName
string
nextOfKinPhone
string
nextOfKinRelationship
string
otherName
string
phone
string
surname
string

Headers

content-type
string
 
Suggest Edits

Update Account

 
posthttps://api.openbanking.ng/account/accountNumber
curl https://api.openbanking.ng/account/updateAccount/0022728151
-X POST
A binary file was returned

You couldn't be authenticated

"SUCCESSFUL"

Path Params

accountNumber
string
required
 
Suggest Edits

Block Account

 
posthttps://api.openbanking.ng/account/block
curl --request POST \
  --url https://api.openbanking.ng/account/blockAccount \
  --header 'content-type: application/json' \
  --data '{
  "accountNumber": "string",
  "blockMessage": "string",
  "blockType": "PND"
}
  '
A binary file was returned

You couldn't be authenticated

SUCCESSFUL

Body Params

accountNumber
string
blockMessage
string
blockType
string

Headers

content-type
string
 
Suggest Edits

Get Agencies

 
gethttps://api.openbanking.ng/agencies/
curl --request GET \
  --url https://api.openbanking.ng/agencies/
A binary file was returned

You couldn't be authenticated

{
  "status": "SUCCESSFUL",
  "message": "SUCCESSFUL",
  "data": [ 
    {
      "agencyID": 2344,
      "agencyName": "Akorede and Sons",
      "agencyType": "FULL_AGENCY",
      "street": "Adegbola Street",
      "city": "Ikoyi",
      "latitude": 35,
      "longitude": 76,
      "phoneNumber": "090000000",
      "agencyServices": null,
      "state": "Lagos"
    }
  ]
}
 
Suggest Edits

Get Agency By Code

Finds an Agency by Agency Code

 
gethttps://api.openbanking.ng/agencies/agencyId
curl --request GET \
  --url https://api.openbanking.ng/agencies/29
  --header 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

{
  "status": "SUCCESSFUL",
  "message": "SUCCESSFUL",
  "data": {
      "agencyID": 2344,
      "agencyName": "Akorede and Sons",
      "agencyType": "FULL_AGENCY",
      "street": "Adegbola Street",
      "city": "Ikoyi",
      "latitude": 35,
      "longitude": 76,
      "phoneNumber": "090000000",
      "agencyServices": null,
      "state": "Lagos"
    }
}
Invalid Agency Code supplied
Agency not Found

Path Params

agencyId
string
required

Headers

content-type
string
 
Suggest Edits

Get Agencies At A Location

 
gethttps://api.openbanking.ng/agencies/latitude/latitude/longitude/longitude
No code samples available
A binary file was returned

You couldn't be authenticated

{
  "status": "SUCCESSFUL",
  "message": "SUCCESSFUL",
  "data": [
    {
      "agencyID": 2344,
      "agencyName": "Akorede and Sons",
      "agencyType": "FULL_AGENCY",
      "street": "Adegbola Street",
      "city": "Ikoyi",
      "latitude": 35,
      "longitude": 76,
      "phoneNumber": "090000000",
      "agencyServices": null,
      "state": "Lagos"
    }
  ]
}
Unauthorized
Forbidden
Agency not Found

Body Params

latitude
double
longitude
double
 
 
gethttps://api.openbanking.ng/atm/getATM/atmTerminalId
curl --request GET \
  --url https://api.openbanking.ng/atm/getATM/485
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

{
  "atmId": "string",
  "atmName": "string",
  "baseCurrency": "NAIRA",
  "latitude": 0,
  "longitude": 0,
  "terminalId": "string"
}
Invalid Terminal ID supplied
Unauthorized
Forbidden
Not Found

Path Params

atmTerminalId
string
required
 
 
gethttps://api.openbanking.ng/atm/getATMs
curl --request GET \
  --url https://api.openbanking.ng/atm/getATMs
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "atmId": "string",
    "atmName": "string",
    "baseCurrency": "NAIRA",
    "latitude": 0,
    "longitude": 0,
    "terminalId": "string"
  },
  ...
]
Invalid Terminal ID supplied
Unauthorized
Forbidden
ATM not found

Headers

content-type
string
 
Suggest Edits

Get ATMs By Branch

 
gethttps://api.openbanking.ng/atm/getATMsByBranch/branchCode
curl --request GET \
  --url https://api.openbanking.ng/atm/getATMsByBranch/672
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "atmId": "string",
    "atmName": "string",
    "baseCurrency": "NAIRA",
    "latitude": 0,
    "longitude": 0,
    "terminalId": "string"
  },
  ...
]
Unauthorized
Forbidden
Not Found

Path Params

branchCode
string
required

Headers

content-type
string
 
Suggest Edits

Get ATMs Near Location

 
gethttps://api.openbanking.ng/atm/getATMsNearLocation/latitude?longitude=longitude
curl --request GET \
  --url https://api.openbanking.ng/atm/getATMsNearLocation/3.744?longitude=6.7892
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "atmId": "string",
    "atmName": "string",
    "baseCurrency": "NAIRA",
    "latitude": 0,
    "longitude": 0,
    "terminalId": "string"
  },
  ...
]
Unauthorized
Forbidden
Not Found

Path Params

latitude
string
required

Query Params

longitude
string

Headers

content-type
string
 
Suggest Edits

GetBillPaymentItem

 
gethttps://api.openbanking.ng/billpayment/getBillPaymentItem
curl --request GET \
  --url https://api.openbanking.ng/billpayment/getBillPaymentItem?billerId=324
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "billPaymentProductId": "string",
    "billPaymentProductName": "string",
    "billerId": "string",
    "billingSystemId": "string",
    "categoryId": "string",
    "fixedOrVariableAmount": "string"
  }
]

Query Params

billerId
string
 
Suggest Edits

GetBillerCategories

 
gethttps://api.openbanking.ng/billpayment/getBillerCategories
curl --request GET \
  --url https://api.openbanking.ng/billpayment/getBillerCategories?billingSystemId=424
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "billingSystemId": "string",
    "categoryDescription": "string",
    "categoryName": "string"
  }
]

Query Params

billingSystemId
string
 
Suggest Edits

GetBillers

 
gethttps://api.openbanking.ng/billpayment/getBillers
curl --request GET \
  --url https://api.openbanking.ng/billpayment/getBillers?categoryId=12
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "billerCategory": "string",
    "billerId": "string",
    "categoryDescription": "string",
    "categoryId": "string",
    "currency": "NAIRA",
    "customerId": "string",
    "nameOfBiller": "string"
  }
]

Query Params

categoryId
string
 
Suggest Edits

GetBillingSystem

 
gethttps://api.openbanking.ng/billpayment/getBillingSystem
No code samples available
A binary file was returned

You couldn't be authenticated

[
  {
    "billingSystemId": "string"
  }
]
 
Suggest Edits

Get Card Limit

 
gethttps://api.openbanking.ng/card/getCardLimit
No code samples available
A binary file was returned

You couldn't be authenticated

[
  {
    "cardToken": "string",
    "channel": "string",
    "maxAmountPerTransaction": "string",
    "maxCumulativeAmount": "string",
    "maximumTransaction": 0,
    "outstandingCumulativeAmount": "string",
    "outstandingTranscation": "string",
    "periodtype": "string",
    "transactiontype": "string"
  }
]
 
Suggest Edits

Get Card Product By Bank

 
gethttps://api.openbanking.ng/card/getCardProductByBank
No code samples available
A binary file was returned

You couldn't be authenticated

[
  {
    "cardBrand": "AMEX",
    "cardType": "CREDIT",
    "currency": "NAIRA",
    "productId": "string",
    "productName": "string",
    "purchasePrice": "string",
    "validityPeriod": 0
  }
]
 
Suggest Edits

Get Cards

 
gethttps://api.openbanking.ng/card/getCards/accountNumber
No code samples available
A binary file was returned

You couldn't be authenticated

[
  {
    "accountNumber": "string",
    "cardName": "string",
    "cardType": "CREDIT",
    "expiry": "2018-02-16T02:12:57.972Z",
    "issuerNumber": "string",
    "maskedPan": "string",
    "token": "string"
  }
]

Path Params

accountNumber
string
required

The Account Number tied to Card

 
Suggest Edits

Request Card

 
gethttps://api.openbanking.ng/card/requestCard/cardToken
No code samples available
A binary file was returned

You couldn't be authenticated

[
  {
    "accountNumber": "string",
    "branchId": "string",
    "cardPickupType": "HOME_DELIVERY",
    "deliveryAddress": "string",
    "productId": "string"
  }
]

Path Params

cardToken
string
required

The Account Number tied to Card

 
Suggest Edits

Set Card Limit

 
posthttps://api.openbanking.ng/card/getCardLimit
curl --request POST \
  --url https://api.openbanking.ng/card/getCardLimit \
  --header 'content-type: application/json' \
  --data '{
  "channel": "string",
  "channelType": "string",
  "periodType": "NAIRA",
  "transactionType": "string"
  }
A binary file was returned

You couldn't be authenticated

"SUCCESSFUL"

Body Params

channel
string
channelType
array of strings
periodType
string
transactionType
string

Headers

content-type
string
 
posthttps://api.openbanking.ng/customer/block?customerId=customerId
curl --request POST \
  --url https://api.openbanking.ng/customer/block?customerId=2352
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

"SUCCESSFUL"

Query Params

customerId
string

Customer Id

Headers

content-type
string
 
Suggest Edits

Get By BVN

 
gethttps://api.openbanking.ng/customer/getByBVN/bvn
curl --request GET \
  --url https://api.openbanking.ng/customer/getByBVN/00011122233
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "address": "string",
    "bvn": "string",
    "customerID": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "numberOfAccounts": 0,
    "otherNames": "string",
    "startDateOfRelationship": "2018-02-16T01:23:21.166Z",
    "status": "ACTIVE",
    "type": "RETAIL"
  }
]

Path Params

bvn
string
required

The Customer’s Bank Verification Number

 
Suggest Edits

Get By CustomerId

FInds a customer by cusyomer Id

 
gethttps://api.openbanking.ng/customer/getByCustomerId/customerId
No code samples available
A binary file was returned

You couldn't be authenticated

{
  "address": "string",
  "bvn": "string",
  "customerID": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "numberOfAccounts": 0,
  "otherNames": "string",
  "startDateOfRelationship": "2018-02-16T01:28:06.682Z",
  "status": "ACTIVE",
  "type": "RETAIL"
}
Customer not found
Invalid Customer ID supplied

Path Params

customerId
string
required

The Customer’s unique identifier

 
Suggest Edits

Get By Email

FInds a customer by cusyomer Id

 
gethttps://api.openbanking.ng/customer/getByEmail/email
No code samples available
A binary file was returned

You couldn't be authenticated

{
  "address": "string",
  "bvn": "string",
  "customerID": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "numberOfAccounts": 0,
  "otherNames": "string",
  "startDateOfRelationship": "2018-02-16T01:28:06.682Z",
  "status": "ACTIVE",
  "type": "RETAIL"
}
Customer not found
Invalid Customer ID supplied

Path Params

email
string
required

The Customer’s Email AddressThe Customer’s unique identifier

 
Suggest Edits

Get By Phone Number

FInds a customer by cusyomer Id

 
gethttps://api.openbanking.ng/customer/getByPhoneNumber/phoneNumber
No code samples available
A binary file was returned

You couldn't be authenticated

{
  "address": "string",
  "bvn": "string",
  "customerID": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "numberOfAccounts": 0,
  "otherNames": "string",
  "startDateOfRelationship": "2018-02-16T01:28:06.682Z",
  "status": "ACTIVE",
  "type": "RETAIL"
}
Customer not found

Path Params

phoneNumber
string
required

The Customer’s Phone Number

 
Suggest Edits

Update Customer Information

 
posthttps://api.openbanking.ng/customer/update
curl --request POST \
  --url https://api.openbanking.ng/customer/update \
  --header 'content-type: application/json' \
  --data '{
  "address": "string",
  "customerId": "string",
  "customerName": "string",
  "email": "string",
  "phoneNumber": "string"
}'
A binary file was returned

You couldn't be authenticated

"SUCCESSFUL"
Customer not found
Invalid Customer ID supplied

Body Params

address
string

Customer's Address

customerId
string
customerName
string
email
string
phoneNumber
string

Headers

content-type
string
 
Suggest Edits

Cancel Direct Debit

 
gethttps://api.openbanking.ng/direct_debit/cancelDirectDebit/referenceId?cancelationReason=cancelationReason
curl --request GET \
  --url https://api.openbanking.ng/direct_debit/cancelDirectDebit/6748?cancelationReason=Reversal
A binary file was returned

You couldn't be authenticated

"SUCCESSFUL"
Unauthorized
Forbidden
Not Found

Path Params

referenceId
string
required

Query Params

cancelationReason
string
 
Suggest Edits

Get Direct Debit

 
gethttps://api.openbanking.ng/direct_debit/getDirectDebit/referenceNumber?accountNumber=accountNumber
curl --request GET \
  --url https://api.openbanking.ng/direct_debit/getDirectDebit/6748?accountNumber=0027522334
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "amount": "string",
    "channel": "string",
    "currency": "NAIRA",
    "destinationBankCode": "string",
    "endDate": "2018-02-20T01:05:19.837Z",
    "latitude": 0,
    "longitude": 0,
    "maximumAmount": "string",
    "merchantAccount": "string",
    "merchantAccountName": "string",
    "merchantBvn": "string",
    "merchantEmail": "string",
    "merchantId": "string",
    "merchantPhone": "string",
    "minimumAmount": "string",
    "numberOfTransactions": 0,
    "productName": "string",
    "recurringDate": "2018-02-20T01:05:19.837Z",
    "recurringPeriod": "string",
    "referenceId": "string",
    "sourceAccount": "string",
    "sourceAccountName": "string",
    "sourceAmount": "string",
    "sourceBvn": "string",
    "sourceCurrency": "NAIRA",
    "sourceEmail": "string",
    "sourceNarration": "string",
    "sourceNation": "string",
    "sourcePhone": "string",
    "startDate": "2018-02-20T01:05:19.837Z",
    "status": "string",
    "transactionFee": "string"
  }
]
Unauthorized
Forbidden
Not Found

Path Params

referenceNumber
string
required

Query Params

accountNumber
string
 
Suggest Edits

Setup Direct Debit

 
posthttps://api.openbanking.ng/direct_debit/setupDirectDebit
curl --request POST \
  --url https://api.openbanking.ng/direct_debit/setupDirectDebit \
  --header 'content-type: application/json' \
  --data '{
  "amount": "string",
  "channel": "string",
  "currency": "NAIRA",
  "destinationBankCode": "string",
  "endDate": "2018-02-20T01:10:02.162Z",
  "latitude": 0,
  "longitude": 0,
  "maximumAmount": "string",
  "merchantAccount": "string",
  "merchantAccountName": "string",
  "merchantBvn": "string",
  "merchantEmail": "string",
  "merchantId": "string",
  "merchantPhone": "string",
  "minimumAmount": "string",
  "numberOfTransactions": 0,
  "productName": "string",
  "recurringDate": "2018-02-20T01:10:02.162Z",
  "recurringPeriod": "string",
  "referenceId": "string",
  "sourceAccount": "string",
  "sourceAccountName": "string",
  "sourceAmount": "string",
  "sourceBvn": "string",
  "sourceCurrency": "NAIRA",
  "sourceEmail": "string",
  "sourceNarration": "string",
  "sourceNation": "string",
  "sourcePhone": "string",
  "startDate": "2018-02-20T01:10:02.162Z",
  "transactionFee": "string"
}'
A binary file was returned

You couldn't be authenticated

[
  {
    "message": "string",
    "responseCode": "SUCCESSFUL",
    "transactionReferenceId": "string"
  }
]
Created
Unauthorized
Forbidden
Not Found

Body Params

amount
string
channel
string
currency
string
destinationBankCode
string
endDate
string
latitude
double
longitude
double
maximumAmount
string
merchantAccount
string
merchantAccountName
string
merchantBvn
string
merchantEmail
string
merchantId
string
merchantPhone
string
minimumAmount
string
numberOfTransactions
string
productName
string
recurringDate
string
recurringPeriod
string
referenceId
string
sourceAccount
string
sourceAccountName
string
sourceAmount
string
sourceBvn
string
sourceCurrency
string
sourceEmail
string
sourceNarration
string
sourceNation
string
sourcePhone
string
startDate
string
transactionFee
string

Headers

content-type
string
 
Suggest Edits

Book Investment

 
posthttps://api.openbanking.ng/investment/bookInvestment
curl --request POST \
  --url https://api.openbanking.ng/investment/bookInvestment \
  --header 'content-type: application/json' \
  --data '{
  "accountNumber": "0022728151",
  "amount": "12,000",
  "currency": "NAIRA",
  "dateBooked": "2018-02-15T19:19:04.610Z",
  "maturityDate": "2018-02-15T19:19:04.610Z",
  "productId": "251d67"
}'
A binary file was returned

You couldn't be authenticated

SUCCESSFUL

Body Params

accountNumber
string
amount
string
currency
string
dateBooked
string
maturityDate
string
productId
string

Headers

content-type
string
 
Suggest Edits

Get Investment

 
gethttps://api.openbanking.ng/investment/getInvestment/accountNumberOrCustomerId
curl --request GET \
  --url https://api.openbanking.ng/investment/getInvestment/236253
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "accountNumber": "string",
    "amount": "string",
    "bookingType": "DISCOUNTED",
    "currency": "NAIRA",
    "dateBooked": "2018-02-20T00:35:24.023Z",
    "interestDiscountRate": "string",
    "investmentId": "string",
    "maturityDate": "2018-02-20T00:35:24.023Z",
    "productId": "string"
  }
]
Unauthorized
Forbidden
Not Found

Path Params

accountNumberOrCustomerId
string
required

Headers

content-type
string
 
Suggest Edits

Get Investment Product

 
gethttps://api.openbanking.ng/investment/getInvestmentProduct
curl --request GET \
  --url https://api.openbanking.ng/investment/getInvestment/236253
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "bookingType": "DISCOUNTED",
    "interestDiscountRate": "string",
    "productId": "string",
    "productName": "string",
    "productType": "string"
  },
  ...
]
Unauthorized
Forbidden
Not Found
 
Suggest Edits

Get Bank Meta

 
gethttps://api.openbanking.ng/general/getBankMeta
curl --request GET \
  --url https://api.openbanking.ng/general/getBankMeta
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "bankCategory": "COMMERCIAL",
    "bankName": "string",
    "cbnBankCode": "string",
    "customerSupportEmail": "string",
    "customerSupportPhone": "string",
    "headOfficeAddress": "string",
    "incorporationDate": "string",
    "nibssCode": "string",
    "numberOfBranches": "string",
    "numberOfCountryCode": "string",
    "rc": "string",
    "socialMediaTypeAndAddress": "string",
    "swiftCode": "string",
    "website": "string"
  }
]
Unauthorized
Forbidden
Not Found
 
Suggest Edits

Get Charges

 
gethttps://api.openbanking.ng/general/getCharges
curl --request GET \
  --url https://api.openbanking.ng/general/getCharges
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "currency": "NAIRA",
    "maximumCharge": "string",
    "maximumChargeType": "string",
    "minimumCharge": "string",
    "minimumChargeType": "string",
    "productId": "string",
    "productName": "string",
    "standardChargeType": "string",
    "standardType": "string",
    "taxRate": "string",
    "transactionType": "INTRA_BANK"
  }
]
Unauthorized
Forbidden
Not Found
 
Suggest Edits

Get Interface Version

 
gethttps://api.openbanking.ng/general/getInterfaceVersion
curl --request GET \
  --url https://api.openbanking.ng/general/getInterfaceVersion
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "versionService": [
      "string"
    ],
    "versionSupported": "string"
  }
]
Unauthorized
Forbidden
Not Found
 
Suggest Edits

Get Products

 
gethttps://api.openbanking.ng/general/getProducts
curl --request GET \
  --url https://api.openbanking.ng/general/getProducts
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "currency": "NAIRA",
    "description": "string",
    "eligibility": "string",
    "name": "string",
    "productId": "string"
  }
]
Unauthorized
Forbidden
Not Found
 
 
gethttps://api.openbanking.ng/transaction/getHold/accountNumber?holdReferenceId=holdReferenceId
curl https://api.openbanking.ng/transaction/getHold/0022728151?holdReferenceId=236
-X GET
A binary file was returned

You couldn't be authenticated

[
  {
    "accountNumber": "string",
    "amount": "string",
    "enddate": "2018-02-16T00:32:23.847Z",
    "holdReferenceId": "string",
    "reason": "string",
    "respondeDescription": "string",
    "responseCode": "SUCCESSFUL",
    "startdate": "2018-02-16T00:32:23.847Z"
  }
]

Path Params

accountNumber
string
required

Query Params

holdReferenceId
string

holdReferenceId

 
Suggest Edits

GetStatement

 
gethttps://api.openbanking.ng/transaction/getStatement
{
  "accountNumber": "string",
  "startDateAndendDate_Or_lastNumberOfRecords": "string"
}
A binary file was returned

You couldn't be authenticated

[
  {
    "accountNumber": "string",
    "amount": "string",
    "bookDate": "2018-02-16T00:47:24.094Z",
    "channel": "string",
    "currency": "NAIRA",
    "debitOrCredit": "string",
    "narration": "string",
    "referenceId": "string",
    "transactionTime": {
      "date": 0,
      "day": 0,
      "hours": 0,
      "minutes": 0,
      "month": 0,
      "seconds": 0,
      "time": 0,
      "timezoneOffset": 0,
      "year": 0
    },
    "transactionType": "string",
    "valueDate": "2018-02-16T00:47:24.094Z"
  }
]

Body Params

getStatement
string

getStatement

 
Suggest Edits

MultipleTransferOtherBank

 
posthttps://api.openbanking.ng/transaction/multipleTransferOtherBank
{
  "batchId": "string",
  "channel": "string",
  "courceNarration": "string",
  "currency": "NAIRA",
  "destinationAccount": "string",
  "destinationAccountName": "string",
  "destinationAmount": "string",
  "destinationNarration": "string",
  "endDate": "2018-02-16T00:57:06.574Z",
  "interval": "DAY",
  "latitude": 0,
  "longitude": 0,
  "numberOfTime": 0,
  "numberOfTransaction": "string",
  "referenceId": "string",
  "sourceAccount": "string",
  "sourceAccountName": "string",
  "sourceAmount": "string",
  "sourcecurrency": "NAIRA",
  "startDate": "2018-02-16T00:57:06.574Z",
  "transactionDate": "2018-02-16T00:57:06.574Z",
  "transactionFee": "string"
}
A binary file was returned

You couldn't be authenticated

[
  {
    "batchId": "string",
    "numberOfTransaction": "string",
    "responseCode": "SUCCESSFUL",
    "responseMessage": "string",
    "transactionId": "string"
  }
]

Body Params

multipleTransferBank
string

multipleTransferBank

 
Suggest Edits

MultipleTransferToEmail

 
posthttps://api.openbanking.ng/transaction/multipleTransferToEmail
{
  "batchId": "string",
  "channel": "string",
  "courceNarration": "string",
  "currency": "NAIRA",
  "destinationAccount": "string",
  "destinationAccountName": "string",
  "destinationAmount": "string",
  "destinationNarration": "string",
  "latitude": 0,
  "longitude": 0,
  "numberOfTransaction": "string",
  "referenceId": "string",
  "sourceAccount": "string",
  "sourceAccountName": "string",
  "sourceAmount": "string",
  "sourcecurrency": "NAIRA",
  "transactionDate": "2018-02-16T01:01:24.700Z",
  "transactionFee": "string"
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

multipleTransfer
string

multipleTransfer

 
Suggest Edits

MultipleTransferToPhone

 
posthttps://api.openbanking.ng/transaction/multipleTransferToPhone
{
  "batchId": "string",
  "channel": "string",
  "courceNarration": "string",
  "currency": "NAIRA",
  "destinationAccount": "string",
  "destinationAccountName": "string",
  "destinationAmount": "string",
  "destinationNarration": "string",
  "latitude": 0,
  "longitude": 0,
  "numberOfTransaction": "string",
  "referenceId": "string",
  "sourceAccount": "string",
  "sourceAccountName": "string",
  "sourceAmount": "string",
  "sourcecurrency": "NAIRA",
  "transactionDate": "2018-02-16T01:03:13.196Z",
  "transactionFee": "string"
}
A binary file was returned

You couldn't be authenticated

[
  {
    "batchId": "string",
    "numberOfTransaction": "string",
    "responseCode": "SUCCESSFUL",
    "responseMessage": "string",
    "transactionId": "string"
  }
]

Body Params

multipleTransfer
string

multipleTransfer

 
Suggest Edits

MultipleTransferWithinBank

 
posthttps://api.openbanking.ng/transaction/multipleTransferWithinBank
{
  "batchId": "string",
  "channel": "string",
  "courceNarration": "string",
  "currency": "NAIRA",
  "destinationAccount": "string",
  "destinationAccountName": "string",
  "destinationAmount": "string",
  "destinationNarration": "string",
  "endDate": "2018-02-16T01:10:00.966Z",
  "interval": "DAY",
  "latitude": 0,
  "longitude": 0,
  "numberOfTime": 0,
  "numberOfTransaction": "string",
  "referenceId": "string",
  "sourceAccount": "string",
  "sourceAccountName": "string",
  "sourceAmount": "string",
  "sourcecurrency": "NAIRA",
  "startDate": "2018-02-16T01:10:00.967Z",
  "transactionDate": "2018-02-16T01:10:00.967Z",
  "transactionFee": "string"
}
A binary file was returned

You couldn't be authenticated

[
  {
    "batchId": "string",
    "numberOfTransaction": "string",
    "responseCode": "SUCCESSFUL",
    "responseMessage": "string",
    "transactionId": "string"
  }
]

Body Params

multipleTransferBank
string

multipleTransferBank

 
Suggest Edits

PlaceHold

 
posthttps://api.openbanking.ng/transaction/placeHold
{
  "accountNumber": "string",
  "amount": "string",
  "enddate": "2018-02-16T01:12:50.400Z",
  "holdReferenceId": "string",
  "reason": "string",
  "startdate": "2018-02-16T01:12:50.400Z"
}
A binary file was returned

You couldn't be authenticated

[
  {
    "holdReferenceId": "string",
    "responseCode": "string",
    "responseDescription": "string"
  }
]

Body Params

accountNumber
string

placeHold

amount
string
enddate
string
holdReferenceId
string
reason
string
startdate
string

Headers

content-type
string
 
 
posthttps://api.openbanking.ng/transaction/placePnd
{
  "accountNumber": "string",
  "pndReferenceId": "string",
  "amount": "string",
  "reason": "string"
}
A binary file was returned

You couldn't be authenticated

[
  {
    "pndReferenceId": "string",
    "responseCode": "SUCCESSFUL",
    "responseMessage": "string"
  }
]

Body Params

accountNumber
string

Account Number, Reference ID, Amount and Reason

pndReferenceId
string

pndReferenceId

amount
string

amount

reason
string

reason

Headers

content-type
string
 
Suggest Edits

Remove Hold

 
posthttps://api.openbanking.ng/transaction/removeHold
{
  "accountNumber": "string",
  "holdReferenceId": "string"
}
A binary file was returned

You couldn't be authenticated

[
  {
    "repsonseMessage": "string",
    "responseCode": "SUCCESSFUL"
  }
]

Body Params

accountNumber
string

Account Number and Reference ID

holdReferenceId
string

holdReferenceId

Headers

content-type
string
 
Suggest Edits

SingleTransferOtherBank

 
posthttps://api.openbanking.ng/transaction/singleTransferOtherBank
{
  "channel": "string",
  "courceNarration": "string",
  "currency": "NAIRA",
  "destinationAccount": "string",
  "destinationAccountName": "string",
  "destinationAmount": "string",
  "destinationNarration": "string",
  "endDate": "2018-02-16T01:26:00.255Z",
  "interval": "DAY",
  "latitude": 0,
  "longitude": 0,
  "numberOfTime": 0,
  "referenceId": "string",
  "sourceAccount": "string",
  "sourceAccountName": "string",
  "sourceAmount": "string",
  "sourcecurrency": "NAIRA",
  "startDate": "2018-02-16T01:26:00.255Z",
  "transactionFee": "string",
  "transationDate": "2018-02-16T01:26:00.255Z"
}
A binary file was returned

You couldn't be authenticated

[
  {
    "responseCode": "SUCCESSFUL",
    "responseMessage": "string",
    "transactionReferenceId": "string"
  }
]

Body Params

singleTransferBank
string

singleTransferBank

 
Suggest Edits

SingleTransferToEmail

 
posthttps://api.openbanking.ng/transaction/singleTransferToEmail
{
  "channel": "string",
  "courceNarration": "string",
  "currency": "NAIRA",
  "destinationAccount": "string",
  "destinationAccountName": "string",
  "destinationAmount": "string",
  "destinationNarration": "string",
  "latitude": 0,
  "longitude": 0,
  "referenceId": "string",
  "sourceAccount": "string",
  "sourceAccountName": "string",
  "sourceAmount": "string",
  "sourcecurrency": "NAIRA",
  "transactionFee": "string",
  "transationDate": "2018-02-16T01:29:14.924Z"
}
A binary file was returned

You couldn't be authenticated

[
  {
    "responseCode": "SUCCESSFUL",
    "responseMessage": "string",
    "transactionReferenceId": "string"
  }
]

Body Params

singleTransfer
string

singleTransfer

 
Suggest Edits

SingleTransferToPhone

 
posthttps://api.openbanking.ng/transaction/singleTransferToPhone
{
  "channel": "string",
  "courceNarration": "string",
  "currency": "NAIRA",
  "destinationAccount": "string",
  "destinationAccountName": "string",
  "destinationAmount": "string",
  "destinationNarration": "string",
  "latitude": 0,
  "longitude": 0,
  "referenceId": "string",
  "sourceAccount": "string",
  "sourceAccountName": "string",
  "sourceAmount": "string",
  "sourcecurrency": "NAIRA",
  "transactionFee": "string",
  "transationDate": "2018-02-16T01:31:35.856Z"
}
A binary file was returned

You couldn't be authenticated

[
  {
    "responseCode": "SUCCESSFUL",
    "responseMessage": "string",
    "transactionReferenceId": "string"
  }
]

Body Params

singleTransfer
string

singleTransfer

 
Suggest Edits

SingleTransferWithinBank

 
posthttps://api.openbanking.ng/transaction/singleTransferWithinBank
{
  "channel": "string",
  "courceNarration": "string",
  "currency": "NAIRA",
  "destinationAccount": "string",
  "destinationAccountName": "string",
  "destinationAmount": "string",
  "destinationNarration": "string",
  "endDate": "2018-02-16T01:34:07.983Z",
  "interval": "DAY",
  "latitude": 0,
  "longitude": 0,
  "numberOfTime": 0,
  "referenceId": "string",
  "sourceAccount": "string",
  "sourceAccountName": "string",
  "sourceAmount": "string",
  "sourcecurrency": "NAIRA",
  "startDate": "2018-02-16T01:34:07.983Z",
  "transactionFee": "string",
  "transationDate": "2018-02-16T01:34:07.983Z"
}
A binary file was returned

You couldn't be authenticated

[
  {
    "responseCode": "SUCCESSFUL",
    "responseMessage": "string",
    "transactionReferenceId": "string"
  }
]

Body Params

singleTransferBank
string

singleTransferBank

 
Suggest Edits

GetPosByMerchantIdOrBranchIdOrEmail

 
gethttps://api.openbanking.ng/pos/getPosByMerchantIdOrBranchIdOrEmail
curl --request GET \
  --url https://api.openbanking.ng/pos/getPosByMerchantIdOrBranchIdOrEmail/?branchId=54
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "currency": "NAIRA",
    "dateDeployed": "2018-02-16T01:37:56.777Z",
    "email": "string",
    "latitude": 0,
    "longitude": 0,
    "merchantId": "string",
    "merchantName": "string",
    "phone": "string",
    "ptsa": "string",
    "ptsp": "string",
    "status": "string",
    "terminalId": "string",
    "terminalType": "string"
  }
]

Query Params

branchId
string

branchId

email
string

email

Body Params

merchantId
string

merchantId

 

Response Parameters

For a successful call, the data parameter has all the parameters for the response. These parameters are described below

Parameter
Description
Example

currency

The operating currency of the account.

NAIRA

dateDeployed

The date it was deployed to the branch or merchant

2015-05-01 14:22:00

email

The email address of the merchant or branch where it is deployed

latitude

The latitude value of the merchant or branch

longitude

The longitude value of the merchant or branch

merchantId

The unique identifier of a merchant on the bank's core banking application

RXXXXXXXXX
CCXXXXXXXX
120093993999

merchantName

The name of the merchant

Sodiq

phone

The phone number of the branch manager

0803XXXXXXXX

ptsa

ptsp

status

Merchant status

Active

terminalId

The terminal Id

terminalType

The branchType

Suggest Edits

Finds a POS by Terminal ID

 
gethttps://api.openbanking.ng/pos/getPosByTerminalId
curl --request GET \
  --url https://api.openbanking.ng/pos/getPosByTerminalId?terminalId=56
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

{
  "currency": "NAIRA",
  "dateDeployed": "2018-02-16T01:46:39.557Z",
  "email": "string",
  "latitude": 0,
  "longitude": 0,
  "merchantId": "string",
  "merchantName": "string",
  "phone": "string",
  "ptsa": "string",
  "ptsp": "string",
  "status": "string",
  "terminalId": "string",
  "terminalType": "string"
}

Query Params

terminalId
string
 

Response Parameters

For a successful call, the data parameter has all the parameters for the response. These parameters are described below

Paraneter
Deascription
Example

currency

The operating currency of the account

NAIRA

dateDeployed

The date it was deployed to the branch or merchant

2015-05-01 14:22:00

email

The email address of the merchant or branch where it is deployed

latitude

The latitude value of the branch

longitude

The longitude value of the branch

merchantId

The unique identifier of a merchant on the bank's core banking application

RXXXXXXXXX
CCXXXXXXXX
120093993999

merchantName

The name of the merchant

Sodiq

phone

The phone number of the merchant branch manager

0803XXXXXXX

ptsa

ptsp

status

Merchant status

Active

terminalId

The terminal Id

terminalType

The terminal type

Suggest Edits

GetPosNearLocation

 
gethttps://api.openbanking.ng/pos/getPosNearLocation
curl --request GET \
  --url https://api.openbanking.ng/pos/getPosNearLocation?latitude=0&longitude=0
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "currency": "NAIRA",
    "dateDeployed": "2018-02-16T01:52:49.682Z",
    "email": "string",
    "latitude": 0,
    "longitude": 0,
    "merchantId": "string",
    "merchantName": "string",
    "phone": "string",
    "ptsa": "string",
    "ptsp": "string",
    "status": "string",
    "terminalId": "string",
    "terminalType": "string"
  }
]

Query Params

longitude
int32

longitude

latitude
int32

latitude

 

Response Parameters

For a successful call, the data parameter has all the parameters for the response. These parameters are described below

Parameter
Description
Example

currency

The operating currency of the account.

NAIRA

dateDeployed

The date it was deployed to the branch or merchant

2015-05-01 14:22:00

email

The email address of the merchant or branch where it is deployed

latitude

The latitude value of the merchant or branch

longitude

The longitude value of the merchant or branch

merchantId

The unique identifier of a merchant on the bank's core banking application

RXXXXXXXXX
CCXXXXXXXX
120093993999

merchantName

The name of the merchant

Sodiq

phone

The phone number of the merchant or branch manager

0803XXXXXXX

ptsa

ptsp

status

terminalId

The terminal Id

terminalType

The terminal Type

Suggest Edits

Get Customer Transaction Limit

 
gethttps://api.openbanking.ng/limit/getCustomerTransactionLimit/accountNumber
curl --request GET \
  --url https://api.openbanking.ng/limit/getCustomerTransactionLimit/0027583293
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "channel": "string",
    "maxAmountPerTransaction": "string",
    "maxCumulativeAmount": "string",
    "maxTransaction": 0,
    "outstandingCumulativeAmount": "string",
    "outstandingTransaction": "string",
    "periodType": "DAY",
    "transactionType": "INTRA_BANK"
  }
]
Unauthorized
Forbidden
Not Found

Path Params

accountNumber
string
required

Customer's account number

 
Suggest Edits

Get Global Transaction Limit

 
gethttps://api.openbanking.ng/limit/getGlobalTransactionLimit
curl --request GET \
  --url https://api.openbanking.ng/limit/getGlobalTransactionLimit \
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "maxAmountPerTransaction": "string",
    "maxCumulativeAmount": "string",
    "maxTransaction": 0,
    "periodType": "DAY",
    "transactionType": "INTRA_BANK"
  }
]
Unauthorized
Forbidden
Not Found
 
Suggest Edits

Get Branch

Finds a branch by branch code

 
gethttps://api.openbanking.ng/branch/getBranch/branchId
curl --request GET \
  --url https://api.openbanking.ng/branch/getBranch/3293
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

{
  "branchId": "string",
  "branchName": "string",
  "branchtype": "FULL_BRANCH",
  "city": "string",
  "latitude": 0,
  "longitude": 0,
  "numberOfATMs": 0,
  "phoneNumber": "string",
  "state": "string",
  "street": "string"
}
Invalid Branch Code supplied

Path Params

branchId
string
required

The Branch’s unique identifier

 

Response Parameters

For a successful call, the data parameter has all the parameters for the response. These parameters are described below

Parameter
Description
Example

branchId

The unique id of the branch as sent in the request

RXXXXXXXXX
CCXXXXXXXX
120093993999

branchName

The name of the branch

Ikoyi Branch

branchType

The branch Type

city

The city where the branch is loacated

Lagos

latitude

The latitude value of the branch

longitude

The longitude value of the branch

numberOfATMs

The number of available ATMs at the branch

4

phoneNumber

The phone number of the branch manager

0803XXXXXXXX

state

The state where the branch is located

Lagos

street

The street where the branch is Located

Adeola Odeku street.

Suggest Edits

Get Branches

 
gethttps://api.openbanking.ng/branch/getBranches
curl --request GET \
  --url https://api.openbanking.ng/branch/getBranches
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "branchId": "string",
    "branchName": "string",
    "branchtype": "FULL_BRANCH",
    "city": "string",
    "latitude": 0,
    "longitude": 0,
    "numberOfATMs": 0,
    "phoneNumber": "string",
    "state": "string",
    "street": "string"
  }
]
 
Suggest Edits

Get Branches At Location

 
gethttps://api.openbanking.ng/branch/getBranchesAtLocation/latitude?longitude=longitude
curl --request GET \
  --url https://api.openbanking.ng/branch/getBranchesAtLocation/3.24?longitude=5.232
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "branchId": "string",
    "branchName": "string",
    "branchtype": "FULL_BRANCH",
    "city": "string",
    "latitude": 0,
    "longitude": 0,
    "numberOfATMs": 0,
    "phoneNumber": "string",
    "state": "string",
    "street": "string"
  }
]

Path Params

latitude
string
required

Query Params

longitude
string
 
Suggest Edits

Get Authorization Token

 
gethttps://api.openbanking.ng/access/getAuthorizationToken/clientId?clientSecret=clientSecret&grantType=grantType
curl --request GET \
  --url https://api.openbanking.ng/access/getAuthorizationToken/:345?clientSecret=SECRET&grantType=PERMANENT
  --headers 'content-type: application/json'
A binary file was returned

You couldn't be authenticated

[
  {
    "accessToken": "string",
    "expirationTime": {},
    "tokenType": "string"
  }
]

Path Params

clientId
string
required

Query Params

clientSecret
string
grantType
string