Transaction/Update Web Service
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
For more information on statuses, see the following article: Transaction lifecycle.
Request parameters
uuid
Unique transaction ID generated by the payment gateway.
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 |
| Lev Bulgare (975) | BGN | 2 |
| Brazilian real (986) | BRL | 2 |
| Canadian dollar (124) | CAD | 2 |
| Swiss franc (756) | CHF | 2 |
| Chinese renminbi (156) | CNY | 1 |
| Czech koruna (203) | CZK | 2 |
| Danish crown (208) | DKK | 2 |
| Euro (978) | EUR | 2 |
| Pound Sterling (826) | GBP | 2 |
| Hong Kong dollar (344) | HKD | 2 |
| Kuna Croate (191) | HRK | 2 |
| Hungarian forint (348) | HUF | 2 |
| Indian rupee (356) | INR | 2 |
| Indonesian rupiah (360) | IDR | 2 |
| Japanese yen (392) | JPY | 0 |
| Cambodian riel (116) | KHR | 0 |
| South Korean won (410) | KRW | 0 |
| Mexican peso (484) | MXN | 2 |
| Malaysian ringgit (458) | MYR | 2 |
| New Zealand dollar (554) | NZD | 2 |
| Norwegian crown (578) | NOK | 2 |
| Philippine peso (608) | PHP | 2 |
| Polish zloty (985) | PLN | 2 |
| Leu Roumain (946) | RON | 2 |
| Russian ruble (643) | RUB | 2 |
| Singapore dollar (702) | SGD | 2 |
| Swedish krona (752) | SEK | 2 |
| Thai baht (764) | THB | 2 |
| Turkish lira (949) | TRY | 2 |
| New Taiwan dollar (901) | TWD | 2 |
| US dollar (840) | USD | 2 |
| CFP Franc (953) | XPF | 0 |
| South African rand (710) | ZAR | 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 |
Response reference
The web service returns the following object:
| Response | Context |
|---|---|
| Common/ResponseCodeAnswer | Object containing the return code of the web service. |
See response reference for more information.