Skip to main content
POST
/
collect
cURL
curl --request POST \
  --url https://api.pay.staging.mynkwa.com/collect \
  --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,
  "phoneNumber": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mynkwa.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
amount
integer
required
Example:

1000

​
phoneNumber
string
required
Example:

"237650000000"

Response

Collection 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>