ZMW Momo Payout(new encryption)

Summary

These APIs are used to initiate a ZMW Momo payout

Before you begin!

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

Integration steps

Token Generation

Encryption algorithm here

Merchant Payout request

Make a POST call to the Merchant payout request API

POST {{env_url}}/wallet/merchant/bank/transfer/request/v3?encryption=NEW

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*		Country of payout - ZM
serviceCode*		Allowed Payout types: Mobile Money: AIRTEL_OAPI-ZMB
amount*		Amount - 100
accountName*		Receiver's Name - John Doe
requestId*	String	Unique request's reference
description*	String	Merchant's description - Payout
currency*	String	Currency of payout - ZMW
accountNumber*	String	Receiver's phone number - 260973456789
type	String	Allowed value: mobile_money
walletId	Integer	Business wallet ID
payoutType	String	Allowed value: USD_MOMO
debitAmount	String

Plain Request

{
  "country": "ZM",
  "amount": "100",
  "accountName": "test sample",
  "serviceCode": "AIRTEL_OAPI-ZMB",
  "requestId": "tranf-36ac6398-fa2c-407d-84c5-c40c91091a98",
  "description": "none for now",
  "currency": "ZMW",
  "accountNumber": "260973456789",
  "type": "mobile_money",
  "debitAmount": "10",
  "walletId": 12,
  "payoutType": "USD_MOMO"
}

200: OK

{
    "id": 10,
    "amount": 100.00,
    "payoutStatus": "PENDING",
    "requestId": "tranf-36ac6398-fa2c-407d-84c5-c40c91091a98",
    "narration": "none for now",
    "country": "ZM",
    "fee": 2.00,
    "bankCode": "AIRTEL_OAPI-ZMB",
    "bankName": "AIRTEL_OAPI-ZMB",
    "accountNumber": "260973456789",
    "accountName": "test sample"
}

400: Bad Request

{
    "status": "error",
    "message": "Unable process payout. Contact support"
}

Query payout status

Make a call to fetch status of initiated payouts.