Overview
In addition to being passively informed about ongoing payment status by Merchant Callback and Webhook Notification, merchant can query payment status using direct API call to GetPaymentStatus
Request
curl --location --request GET 'https://api.sandbox.volumepay.io/api/payments/{payment-id}}/status' \
--header 'x-application-id: {application-id}'| argument | kind | type | description |
|---|---|---|---|
| payment-id | path variable | UUID | id of the payment to get status for |
| application-id | header | UUID | id of the merchant application |
Response
{
"paymentId": "dd91e433-f77a-4155-bef6-1452bdf2a1d6",
"merchantPaymentId": "fecd123b8b123a4ef09c9a123eb41cb5",
"paymentStatus": "COMPLETED",
"paymentAmount": 52.06,
"institutionId": "natwest",
"shopperId": "5204d458-1234-4714-2f44-4a6f9fc99e67",
"errorDescription": null,
"tracingId": "6177857480076664131"
}| field | type | description |
|---|---|---|
| paymentId | UUID | payment id |
| merchantPaymentId | string [optional] | merchant payment id if specified when payment was initialized |
| paymentStatus | string | current payment status: AWAITING_AUTHORIZATION, AUTHORIZED, PENDING, COMPLETED, FAILED |
| errorDescription | string [optional] | error details when paymentStatus is FAILED |
| tracingId | string | call tracingId |