Answer Subscription

Object containing recurring payment details.

Response reference

Recurring payment identifier.

Format

Shop ID.

Format

Token associated with a payment method.

Only tokens associated with a credit card are supported.

Format

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

Format

Custom values linked to the transaction, in JSON format.

Example of a call

For example, to pass a custom value, such as the Buyer's eye color, add the following to your query:

{
    "metadata": {
        "eyesColor": "blue"
    }
}

This value will be returned in the newly created transaction object.

You can also use the metadata " orderInfo1 ", " orderInfo2 " and " orderInfo3 " to send complementary information about the order.

This data can be found later in the Extra tab of the transaction details via your Merchant Back Office.

Format

Recurring payment start date in ISO 8601 format defined by W3C.

Format

Recurring payment termination date.

Format

Amount of the first installments. Its value must be a positive integer (e.g.: 1234 for 12.34 EUR).

Format

Number of installments for applying the amount specified in initalAmount.

Format

Amount of subscription installments, excluding those possibly defined by initialAmount.

The value must be expressed in the smallest unit of the currency.

Format

Currency used for the payment of subscription installments. Alphabetical code in upper case according to the ISO 4217 alpha-3 standard.

Eg: "EUR" for the euro.

Possible values

The possible values are:

Format

Number of past installments.

Format

Total number of installments.

Format

Description of the recurring payment rule in the form of a rrule (RFC-5545).

For more information on how to generate a RRULE:

• RRULE specification
• RRULE generator
• Examples of recurrence rules

Format

Description associated with the subscription.

Format