GET
/
payments
/
{id}
curl --request GET \
  --url http://sandbox.mintlify.com/payments/{id} \
  --header 'X-API-Key: <api-key>'
{
  "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

Path Parameters

​
id
string
required

ID of payment to fetch

Response

200
application/json
Payment
​
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?