Query payment status
GET {{baseUrl}}/api/payments/:paymentId
Query status of a payment.
Body
PARAM
Key | Datatype | Required | Description |
HEADERS
Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
{
"payment": {
"id": "b95d6888-591b-4538-b508-6102cf1259c9",
"payment": {
"linkId": "G56F5_ll",
"amount": 123.45,
"status": "completed",
"currency": "ZAR",
"merchantInvoiceId": "INV-902",
"entityId": "8ac7a4ca77a64c9c0177af52972c13bd",
"notes": "Please pay this at earliest convenience",
"expiryTime": "2021-10-27T12:45:27Z"
},
"source": "API",
"createdAt": "2021-10-27T12:35:27Z",
"updatedAt": "2021-10-27T12:45:43Z",
"customer": {
"givenName": "Grace",
"surname": "Nkosi",
"email": "grace.nkosi@example.com",
"mobile": "+27123456789",
"whatsApp": "+27123456789",
"billing": {
"street1": "123 Example Street",
"city": "Cape Town",
"state": "Western Cape",
"postalCode": "7700",
"country": "ZA"
}
},
"options": {
"sendEmail": false,
"sendSms": false,
"sendWhatsapp": false,
"emailCc": "joe.smith@example.com",
"emailBcc": "moe.smith@example.com",
"notificationUrl": "https://webhook.example.com"
},
"checkout": {
"defaultPaymentMethod": "CARD",
"tokeniseCard": false
}
},
"audit": [
{
"oldStatus": "initiated",
"newStatus": "processing",
"timestamp": "2021-10-27T12:45:43Z"
},
{
"oldStatus": "initiated",
"newStatus": "processing",
"timestamp": "2021-10-27T12:45:43Z"
}
]
} |
ENDPOINTS