support
Back to documentation
Search
Categories
Tags
main parametersexpand all
uuid
required
orderId
comment
card related options
cardUpdate
amount
required
currency
required
manualValidation
expectedCaptureDate
Try me
Documentation

Transaction/Update 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/Transaction/Update

The Transaction/Update REST Web Service allows to change some characteristics of an existing transaction:

  • Changing transaction amount (downward),
  • Changing the desired capture date,
  • Changing the validation mode (possibility to shift from manual validation to automatic validation but not the other way around).

The transactions that can be subject to modification have one of the following detailedStatus (es):

  • AUTHORISED_TO_VALIDATE
  • WAITING_AUTHORISATION_TO_VALIDATE
  • WAITING_AUTHORISATION
  • AUTHORISED

Plus d'infos sur les statuts, consultez : Cycle de vie d'une transaction.

Consultez les paramètres de la réponse Transaction.

Input parameters

uuid

Unique transaction ID generated by the payment gateway.

Format

orderId

Order reference defined by the Merchant.Does not support UTF-8 characters.

Format

comment

Public comment.

Format

orderId

Order reference defined by the Merchant.Does not support UTF-8 characters.

Format

cardUpdate.amount

Payment amount in its smallest currency unit (cent for euro).

Example: 30050 for EUR 300.50.

Format

cardUpdate.currency

Payment currency. Alphabetic code in uppercase according to alpha-3 (ISO 4217).

Eg: "EUR" for the euro.

Format

Possible values

. The possible values are:

Currency ISO 4217 ENCODING Fractional unit
Australian dollar (036) AUD 2
Canadian dollar (124) CAD 2
Swiss franc (756) CHF 2
Danish crown (208) DKK 2
Euro (978) EUR 2
Pound Sterling (826) GBP 2
Japanese yen (392) JPY 0
Norwegian crown (578) NOK 2
Swedish krona (752) SEK 2
US dollar (840) USD 2

expectedCaptureDate

Path: cardUpdate.expectedCaptureDate

Date of capture in the bank expressed in ISO 8601 format defined by W3C.

Format

manualValidation

Path: cardUpdate.manualValidation

Transaction validation mode.

Format

Possible values

. The possible values are:

value Description
NO Automatic validation by the payment gateway.
YES Manual validation by the Merchant.
null Default configuration of the selected shop (configurable in the Merchant Back Office).

Response reference

The web service returns the following object:

Response Context
Transaction Object containing transaction details.

See response reference for more information.