support
Back to documentation
Search
Categories
Tags
Charge/CreatePayment
webService
Charge/CreatePaymentOrder
webService
Charge/CreateSubscription
webService
Charge/CreateToken
webService
Charge/CreateTokenFromTransaction
webService
Charge/PaymentOrder/Get
webService
Charge/PaymentOrder/Update
webService
Charge/SDKTest
webService
Order/Get
webService
Subscription/Cancel
webService
Subscription/Get
webService
Subscription/Update
webService
Token/Cancel
webService
Token/Get
webService
Token/Reactivate
webService
Token/Update
webService
Transaction/CancelOrRefund
webService
CustomerWallet/Get
webService
CustomerWallet/Update
webService
Transaction/Capture
webService
Transaction/Duplicate
webService
Transaction/Get
webService
Transaction/Update
webService
Transaction/Validate
webService
Risk/AddToGreyList
webService
PCI/Charge/Authenticate (PCI)
PCI
webService
PCI/Charge/CreatePayment (PCI)
PCI
webService
PCI/Charge/CreateToken (PCI)
PCI
webService
Token/Update (PCI)
PCI
webService
PCI/Charge/VerifyPaymentMethod
PCI
webService
AuthenticationResponseData
answer
Charge/PaymentForm
answer
OrderTransactions
answer
Payment
answer
PaymentOrder
answer
Common/ResponseCodeAnswer
answer
Subscription
answer
SubscriptionCreated
answer
Transaction
answer
Token
answer
CustomerWallet
answer
GreyList
answer
main parametersexpand all
subscriptionId
shopId
paymentMethodToken
orderId
metadata
[1]
:
effectDate
cancelDate
initialAmount
initialAmountNumber
amount
currency
pastPaymentsNumber
totalPaymentsNumber
rrule
description
Try me
Documentation

Answer Subscription

Object containing recurring payment details.

Response reference

subscriptionId

Recurring payment identifier.

Format

shopId

Shop ID.

Format

paymentMethodToken

Token associated with a payment method.

Only tokens associated with a credit card are supported.

Format

orderId

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

Format

metadata

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 Expert Back Office.

Format

effectDate

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

Format

cancelDate

Recurring payment termination date.

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

amount

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

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

Format

currency

The currency used for the payment of subscription instalments. Alphabetical code in upper case according to ISO 4217 alpha-3.

Eg: "EUR" for the euro.

Possible values

The possible values are:

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

Format

pastPaymentsNumber

Number of past installments.

Format

totalPaymentsNumber

Total number of installments.

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:

  • RRULE specification
  • RRULE generator
  • Examples of recurrence rules

Format

description

Description associated with the subscription.

Format