POST /api/payments/confirmConfirms a payment transaction that was previously initiated. You must supply the transactionId from the Initiate Payment response. An optional confirmationCode (e.g., OTP) may be required depending on the product.
Request Body Transaction ID obtained from the Initiate Payment response. Example: TXN-20240616143022-A7F9E2Merchant reference number associated with the transaction. Example: MER-20240616-001
OTP or additional verification code required by some payment products.
Additional confirmation data serialised as a JSON string. Example: "{}"
Response 200 — Payment Confirmed Optional informational message.
Show PaymentConfirmResponse
Merchant reference number.
Final payment status after confirmation. Common values: CONFIRMED, SUCCESSFUL, FAILED
Payment amount as a decimal value (e.g., 150.00).
Transaction reference returned by the downstream payment provider.
UTC timestamp of when the confirmation was processed. Example: 2024-06-16T14:35:10Z
Error detail populated if confirmation resulted in a FAILED status.
Additional confirmation response data, serialised as a JSON string.
400 — Bad Request Validation failed or the transaction cannot be confirmed (e.g., already confirmed or expired).
500 — Internal Server Error Examples Request
200 Response
400 Response
500 Response
{ "transactionId" : "TXN-20240616143022-A7F9E2" , "referenceNo" : "MER-20240616-001" , "confirmationCode" : "123456" , "extraProperties" : "{}" }