Subscription/Update Web Service
The Subscription/Update REST Web Service allows to update a recurring payment, for example:
- Payment installments: an amount, a currency, an expiry date, a status, etc.
- Buyer details.
This operation cannot be called if the effective date has passed.
Request parameters
amount
Payment amount in its smallest currency unit (cent for euro).
Example: 30050 for EUR 300.50.
Format
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 |
description
Description associated with the subscription.
Format
effectDate
Recurring payment start date in ISO 8601 format defined by W3C.
Format
initialAmount
Amount of the first installments. Its value must be a positive integer (e.g.: 1234 for 12.34 EUR).
Format
initialAmountNumber
Number of installments for applying the amount specified in initalAmount.
Format
paymentMethodToken
Token associated with a payment method.
Only tokens associated with a credit card are supported.
Format
rrule
Description of the recurring payment rule in the form of a rrule (RFC-5545).
For more information on how to generate a RRULE:
Format
subscriptionId
Recurring payment identifier.
Format
paymentSource
Path: transactionOptions.cardOptions.paymentSource
Payment source.
Format
Possible values
The possible values are:
| Value | Description |
|---|---|
| EC | E-Commerce: the data of the means of payment are entered by the buyer. This value allows a strong authentication during the payment. |
| MOTO | MAIL OR TELEPHONE ORDER: entry by an operator.The payment information is sent by mail or e-mail. Requires a VAD contract. |
| CC | Call Center: payment made through a call center. Requires a VAD contract. |
| OTHER | Other sales channel.Returned output value for payments made via the |
| Absent ou null | The default value is "EC". |
mid
Path: transactionOptions.cardOptions.mid
Merchant ID number. If this field is populated, make sure you use the appropriate MID depending on the card scheme.
Format
manualValidation
Path: transactionOptions.cardOptions.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 |
captureDelay
Path: transactionOptions.cardOptions.captureDelay
Delay to be applied to the capture date.
Description
Indicates the delay (in days) before the capture.
If this parameter is not passed, then the default value set in the
It can be set in the
If the capture delay is higher than 365 days in the payment request, it will be automatically reset to 365 days.
Format
firstInstallmentDelay
Path: transactionOptions.cardOptions.firstInstallmentDelay
Number of deferred months to be applied to the first installment of payment in installments. Field specific to acquirers in Latin America.
Format
installmentNumber
Path: transactionOptions.cardOptions.installmentNumber
Number of installments.
Format
retry
Path: transactionOptions.cardOptions.retry
Number of new attempts available in case the payment is rejected (3 by default).
Format
debitCreditSelector
Path: transactionOptions.cardOptions.debitCreditSelector
This field is specific to Brazil for multiplo card management.
"Multiplo" cards are payment cards (Elo, Visa or MasterCard) that allow to pay using:
- Either immediate debit: the amount is debited immediately, and the merchant is credited on D+1.
- or in credit: the debit is deferred and the amount can be debited in one or more installments. The merchant is credited later with all or only part of the total amount.
This field allows you to force the use of the card in debit or credit mode.
Possible values
| values | Description |
|---|---|
| DEBIT | Using the "debit" function of the card. |
| CREDIT | Using the "credit" function of the card. |
Format
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.