Cancel Payments

In this guide, you will find step-by-step instructions on canceling a previously created payment on Yuno.

Which payments can you cancel?

Only payments with PENDING status can be canceled. Check the Payment status page for further details regarding the possible payment status.

Requirements

To cancel a payment, you need to:

Access your API credentials on the Yuno Dashboard, which consist of:
- public-api-key
- private-secrete-key
Have the payment identification data received after creating the payment using the Create Payment endpoint:
- id: The unique identifier of the payment, obtained from the parameter id after creating the payment.
- transaction_id: The unique identifier of the transaction obtained from the parameter transaction.id after creating the payment.

Explore Yuno Postman Collections

Yuno provides Postman Collections that you can use to replicate the use cases locally.

Cancel a Payment

You can cancel a payment only if it has the PENDING status. Use the Cancel Payment endpoint to cancel the payment. To identify the payment to be canceled, you need to provide its id and the transaction_id.

To confirm you have successfully canceled the payment, check if the parameters from the Cancel Payment endpoint response contain the following values:

type = CANCEL
status = SUCCEEDED
payment.status = CANCELED
payment.sub_status = CANCELED

If the response contains the above values, the cancellation was successful.

Check the payment status

If, for some reason, you need to confirm the payment cancelation:

Use the Retrieve Payment by ID or Retrieve Payment by merchant_order_id to get detailed information about the payment.
Alternatively, set up webhooks to receive notifications for each event. Refer to the Webhooks guide to learn how to configure webhooks in Yuno.