POST
/
collect
curl --request POST \
  --url http://sandbox.mintlify.com/collect \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "amount": 123,
  "phoneNumber": "<string>"
}'
{
  "amount": 123,
  "createdAt": "<string>",
  "currency": "<string>",
  "description": "<string>",
  "fee": 123,
  "id": "<string>",
  "merchantId": 123,
  "paymentType": "collection",
  "phoneNumber": "<string>",
  "status": "pending",
  "telecomOperator": "mtn",
  "updatedAt": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
amount
integer
required
​
phoneNumber
string
required

Response

201
application/json
Collection request created and pending
​
amount
integer
​
createdAt
string
​
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

Was this page helpful?