TZS Payout(new encryption)

Summary

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

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 - TZ
serviceCode*		Allowed Payout types: Bank: TZ-BANK-B2C Mobile Money: TZ-TIGO-B2C or TZ-Airtime-B2C
amount*		Amount - 1000
accountName*		Receiver's Name - John Doe
requestId*	String	Unique request's reference - TZS-payout-3
description*	String	Merchant's description - Payout
currency*	String	Currency of payout - TZS
accountNumber*	String	Receiver's account number - 255713998877

Plain Request

{
    "country": "TZ",
    "serviceCode": "TZ-TIGO-B2C",
    "amount": 1000,
    "accountName": "John Doe",
    "accountNumber": "255713998877",
    "currency": "TZS",
    "requestId": "TZS-payout-3",
    "description": "Payout",
}

Second Tab

200: OK

{
    "id": 694,
    "amount": 1000.00,
    "payoutStatus": "PENDING",
    "requestId": "TZS-payout-3",
    "narration": "Payout",
    "country": "TZ",
    "fee": 826.00,
    "bankCode": "TZ-TIGO-B2C",
    "bankName": "TZ-TIGO-B2C",
    "accountNumber": "255713998877",
    "accountName": "John 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.