Payments
Cancel Payment
Payments
Cancel Payment
POST
/
api
/
payment-request
/
cancel
/
{paymentRequestId}
curl --request POST \
--url https://api.atoa.me/api/payment-request/cancel/{paymentRequestId} \
--header 'Authorization: Bearer <token>'{
"message": "Your payment has been cancelled successfully."
}
The Cancel Payment API facilitates the quick cancellation of a payment request. Simply pass the paymentRequestId obtained during payment generation.
The payment can be cancelled if the status of the payment request is in PAYMENT_NOT_INITIATED or AWAITING_AUTHORIZATION.
Authorization
Bearer <token>
Request Body Schema
paymentRequestId
string
requiredThe paymentRequestId of the initiated payment which you’ll receive from process-payment API
Response
message
string
Your payment has been cancelled successfully.
curl --request POST \
--url https://api.atoa.me/api/payment-request/cancel/{paymentRequestId} \
--header 'Authorization: Bearer <token>'{
"message": "Your payment has been cancelled successfully."
}