support
Back to documentation
Search
Categories
Tags
main parametersexpand all
subscriptionId
required
paymentMethodToken
required
terminationDate
Try me
Documentation

Subscription/Cancel Web Service

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

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

The Subscription/Cancel REST web service allows you to cancel a subscription.

The Subscription/Cancel web service does not cancel transactions that have already been created and are being processed.

Use the Web ServiceOrder/Getpour savoir si les paiements sont en cours de traitement (statut: RUNNING) (Transaction lifecycle).
Pour les annuler, utilisez le Web ServiceTransaction/Cancel.

Input parameters

paymentMethodToken

Token associated with a payment method.

Format

subscriptionId

Recurring payment identifier.

Format

terminationDate

Recurring payment termination date.

Format

Response reference

The web service returns the following object:

Response Context
Common/ResponseCodeAnswer Object containing the return code of the web service.

The responseCode attribute may take one of the values below:

Code label
0 Recurring payment successfully terminated
30 Token not found
32 Subscription not found
99 Undefined error