GHS Payout (new encryption)

Summary

These APIs are used to initiate a GHS 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/GHS

Headers

200: OK

{
    "message": "success",
    "error": null,
    "data": [
        {
            "id": 752.0,
            "code": "10550214",
            "name": "The Hongkong and Shanghai Banking Corporation Limited"
        },
        {
            "id": 753.0,
            "code": "11088200",
            "name": "Giro Elszamolasforgalmi Zrt."
        },
        {
            "id": 754.0,
            "code": "11276282",
            "name": "First National Bank Ghana Limited"
        },
        {
            "id": 755.0,
            "code": "11299458",
            "name": "OMNIBANK GHANA LIMITED"
        }
    ]
}

Get Bank Codes

Make a GET call to the Branch Code API

GET {{env_url}}/wallet/merchant/bank/transfer/request/branch-code/{bankid}

200: OK

{
    "message": "success",
    "error": null,
    "data": [
        {
            "id": 2391.0,
            "branch_code": "1812051EPC",
            "branch_name": "1st Natl Bank Ghana Ltd",
            "swift_code": null,
            "bic": null,
            "bank_id": 754.0
        }
    ]
}

Get Mobile Money Lists

Make a GET call to the Mobile Money List API

GET {{env_url}}/wallet/merchant/bank/transfer/request/banks/GHS?type=mobile-money

Headers

Response Body

200: OK

{
    "message": "success",
    "error": null,
    "data": [
        {
            "code": "MTN",
            "name": "MTN Mobile Money"
        },
        {
            "code": "VODAFONE",
            "name": "Vodafone Mobile Money"
        },
        {
            "code": "AIRTELTIGO",
            "name": "Airtel-Tigo Mobile Money"
        }
    ]
}

Merchant Bank Account 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.

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*	String	GH
bankCode*	String	10550214
branchCode*	String	1812062RXQ
amount*		1000
accountName*	String	John Jane Doe
requestId*	String	kbtr-3857-011-133-166993253334816
description*	String	Payout
currency*	String	GHS
bankName*	String	The Hongkong and Shanghai Banking Corporation Limited
accountNumber*	String	10101010101

200: OK

{
    "id": 1205,
    "amount": 100.00,
    "payoutStatus": "PENDING",
    "requestId": "tranf-55b59c78-0093-4c6a-8370-5778c1bde9e3",
    "narration": "GIFT_AND_DONATION",
    "country": "GH",
    "fee": 15.00,
    "bankCode": "10550214",
    "bankName": "The Hongkong and Shanghai Banking Corporation Limited",
    "accountNumber": "10010101011",
    "accountName": "John Jane Doe"
}

400: Bad Request

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

Merchant Bank Account Payout request

Make a POST call to the Merchant payout request API

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

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*	String	GH
serviceCode*	String	MTN
amount*		1000
accountName*	String	John Jane Doe
requestId*	String	kbtr-3857-011-133-166993253334816
description*	String	Payout
currency*	String	GHS
bankName*	String	MTN Mobile Money
accountNumber*	String	233540105690

200: OK

{
    "id": 1206,
    "amount": 100.00,
    "payoutStatus": "PENDING",
    "requestId": "tranf-7956670a-2912-4e74-a54d-ca89c89c7609",
    "narration": "MEDICAL_TREATMENT",
    "country": "GH",
    "fee": 2.50,
    "bankCode": "VODAFONE",
    "bankName": "Vodafone Mobile Money",
    "accountNumber": "233540105690",
    "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.