support
Back to documentation
Search
Categories
Tags
main parametersexpand all
uuid
required
general transaction options
comment
Try me
Documentation

Web service Transaction/Cancel

L'appel aux Web Services requiert une authentification HTTP Basic Authentication. Plus d'infos : "Phase d'authentification".

POSThttps://api.lyra.com/api-payment/V4/Transaction/Cancel

The REST Web Service Transaction/Cancel allows you to cancel a transaction.

  • Required statuses:
    • AUTHORISED_TO_VALIDATE(To be validated)
    • WAITING_AUTHORISATION_TO_VALIDATE(To be validated and authorized)
    • WAITING_AUTHORISATION(Waiting for authorization)
    • AUTHORISED(Waiting for capture)

You can find out the status of a transaction using the Web Service, Transaction/Get , (parameter detailedStatus,).

  • Partial cancellation: use the Transaction/Update Web Service to edit the transaction amount.

  • Total cancellation: use the Transaction/Cancel Web Service to cancel a transaction.

Input parameters

uuid

Unique transaction ID generated by the payment gateway.

Format

comment

Public comment.

Format

Response reference

The web service returns the following object:

Response Context
Transaction Object containing transaction details.

See response reference for more information.