NGN Payout (new encryption)

Summary

These APIs are used to initiate a NGN payout

Before you begin!

• Find your keys on the Klasha Dashboard → Settings → Generate API Keys (here)

Integration steps

Authentication

Encryption algorithm here

Get Bank Lists

Make a GET call to the Bank List API

GET {{env_url}}/wallet/merchant/bank/transfer/request/banks/NGN

Headers

200: OK

{
    "message": "success",
    "error": null,
    "data": [
        {
            "code": "90527",
            "name": " OJOKORO MICROFINANCE BANK"
        },
        {
            "code": "110072",
            "name": "78 FINANCE COMPANY LIMITED"
        },
        {
            "code": "090629",
            "name": "9jaPay Microfinance Bank"
        },
        {
            "code": "120001",
            "name": "9PAYMENT SERVICE BANK"
        }
    ]
}

Resolve Bank Account

Make a POST call to the resolve account API

POST {{env_url}}/wallet/merchant/bank/transfer/request/resolve/account

Headers

Key	Value
Context-Type	application/json
Authorization	Bearer <token here>

Request Body

Name	Type	Description
bankCode*		100004
countryCode*		NG
accountNumber*		9067285661

200: OK

{
    "status": "success",
    "message": "Account details fetched",
    "data": {
        "account_number": "9067777000",
        "account_name": "John Jane Doe"
    }
}

400: Bad Request

This error occurs when the account number cannot be verified
{
    "status": "error",
    "message": "Account could not be resolved"
}

400: Bad Request

This error occurs when the right "countryCode" is not passed in
{
    "message": "Operation not allowed.",
    "error": "Operation not allowed",
    "data": null
}

Merchant Payout request

Make a POST call to the Merchant payout request API

POST {{env_url}}/wallet/merchant/{businessId}/bank/transfer/v2/request

You would need to pass, as a header the x-auth-token. This can be obtained from your merchant dashboard → Settings → Generate API keys → Merchant public key.

Headers

Key	Value
Content-Type	application/json
x-auth-token	Your merchant public key
Authorization	Bearer <token here>

Request body (encrypted):

{ 
  "message": "encrypted-request-body"
}

Request body (plain)

Request Body

Name	Type	Description
country*		NG
bankCode*		10004
amount*		1000
accountName*		John Jane Doe
requestId*	String	kbtr-3857-011-133-166993253334816
description*	String	Payout
currency*	String	NGN
bankName*	String	Opay Limited
accountNumber*	String	9067285661

200: OK

{
    "id": 3,
    "amount": 1000,
    "payoutStatus": "PENDING",
    "requestId": "kbtr-3857-011-133-166993253334816",
    "narration": "certification",
    "country": "NG",
    "fee": 54,
    "bankCode": "10004",
    "bankName": "Opay Limited",
    "accountNumber": "9067285661",
    "accountName": "John Jane Doe"
}

400: Bad Request

{
    "message": "A human readable error message",
    "error": "Bad Request",
    "data": null
}

Query payout status

Make a call to fetch status of initiated payouts.