POST
/
disburse
cURL
curl --request POST \
  --url https://api.pay.staging.mynkwa.com/disburse \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "amount": 1000,
  "phoneNumber": "237650000000"
}'
{
  "amount": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "description": "<string>",
  "fee": 123,
  "id": "<string>",
  "merchantId": 123,
  "paymentType": "collection",
  "phoneNumber": "<string>",
  "status": "pending",
  "telecomOperator": "mtn",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key
string
header
required

Body

application/json
amount
integer
required
Example:

1000

phoneNumber
string
required
Example:

"237650000000"

Response

Disbursement request created and pending

amount
integer
createdAt
string<date-time>
currency
string
description
string
fee
integer
id
string
merchantId
integer
paymentType
enum<string>
Available options:
collection,
disbursement
phoneNumber
string
status
enum<string>
Available options:
pending,
success,
failed,
canceled
telecomOperator
enum<string>
Available options:
mtn,
orange
updatedAt
string<date-time>