Sign in
latestOpenAPI 3.0.02026-08-1071532.8 KB

cfd1b00f674f

PAYOUTS

post/payout/send-funds

Headers

public-keystring required
x-api-versionnumber required
Accept-Language'en' | 'fr' | 'sw' required
secret-keystring required

Request body

merchant_referencestring required

The unique reference for this request. It must be at least 8 characters long.

transaction_method'BANK' | 'MOBILE_MONEY' required

The transaction method to be used.

currencystring required

The 3-character ISO currency code for the request currency.

amountnumber required

The amount being requested

provider_codestring required

The provider code as obtained from the payment options

account_numberstring required

The bank account or mobile money number of the recipient.

customer_namestring required

The name of the customer.

descriptionstring required

The description/narration for the transaction. Between 10-30 characters

Example request

{
  "merchant_reference": "MCTREF123456",
  "transaction_method": "MOBILE_MONEY",
  "currency": "ZMW",
  "amount": 5000,
  "provider_code": "mtn_zm",
  "account_number": "17100000034",
  "customer_name": "John Doe"
}

Response

Payout initiated successfully.

codenumber required

HTTP Status code

status'success' | 'accepted' | 'error' required

The status of the response

messagestring required

The message of the response

dataobject required

Response data

Example response

{
  "code": 202,
  "status": "accepted",
  "message": "Request Accepted",
  "data": {
    "internal_reference": "DUSUPAYRMGRXNNYBWATKJ",
    "merchant_reference": "MCTREFT2WMNWZ23SBN6Y"
  }
}