Charge/CreateSubscription Web Service

The Charge/CreateSubscription REST Web Service allows you to make recurring payments (subscriptions) from an alias ( Creating an alias ).

For SEPA direct debits, include in the paymentMethodToken field the unique mandate reference (UMR) and an effective date greater than or equal to 14 days.

To be notified of the result of a payment, the rule "Notification URL when creating a recurring payment" must be activated and configured from thebom_expert(menuSettings > Notification rules).

Check the settings of theResponse:Subscription.

Input parameters

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

Example: 30050 for EUR 300.50.

Format

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

Eg: "EUR" for the euro.

Format

Possible values

. The possible values are:

Public comment.

Format

Description associated with the subscription.

Format

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

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

Custom values linked to the transaction, in JSON format.

Example of a call

For example, to pass a custom value, add the following to your query:

{
    "metadata": {
        "MyValueKey": "1234"
    }
}

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

Token associated with a payment method.

Format

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

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

For technical reasons, it is not possible to define subscription periods shorter than one day.
The keywords "SECONDLY" / "MINUTELY" / "HOURLY" are therefore not taken into account.

Format

Payment source.

Format

Possible values

. The possible values are:

Merchant ID number. If this field is populated, make sure you use the appropriate MID depending on the card scheme.

Format

Transaction validation mode.

Format

Possible values

. The possible values are:

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 Merchant Back Office will be used.

It can be set in the Merchant Back Office by all authorized persons.

If the capture delay is higher than 365 days in the payment request, it will be automatically reset to 365 days.

Format

Number of deferred months to be applied to the first installment of payment in installments. Field specific to acquirers in Latin America.

Format

Number of installments.

Format

Number of new attempts available in case the payment is rejected (1 by default).

Format

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

Format

Response reference

The web service returns the following object:

See response reference for more information.