Recurring Payment

Recurring payment is supported for Invoice, Loan and Card payments. Intention is to use it for subscriptions or frequent automatic charges.

How it works

First time the customer need to complete normal checkout purchase where all personal details and consent for recurring payment is entered. After the consent has been given the partner is allowed to do auomatic charges without customer dialogue.

For Partner

Partner initialize the recurring payment by setting the property recurringPayment to “checked” or “unchecked” in the checkoutSetup section in the api post: /api/partner/payments .

After a completed checkout session where consent forrecurring has been given the partner receives a recurringPaymentToken in the response.

For each following recurring charge the partner needs to call authorizeRecurringPayment with the recurring token and purchaseid from original checkout purchase.

POST: /api/partner/payments

{
  "items": [
    {
      "description": "string",
      "notes": "string",
      "amount": 0,
      "taxCode": "string",
      "taxAmount": 0,
      "quantity": 0
    }
  ],
  "checkoutSetup": {
    "recurringPayments": "Hidden",
    "emailInvoice": "Hidden",
    "language": "English",
    "mode": "B2C",
    "completedNotificationUrl": "string",
    "displayItems": true,
    "smsNewsletterSubscription": "Hidden",
    "emailNewsletterSubscription": "Hidden"
  }
}

POST /api/partner/payments/{purchaseid}/authorizerecurringpayment

RecurringAuthorization will return if successful a new purchase id and ordermanagement process follows normal procecss for purchases.

{
  "recurringPaymentToken": "string",
  "items": [
    {
      "description": "string",
      "notes": "string",
      "amount": 0,
      "taxCode": "string",
      "taxAmount": 0,
      "quantity": 0
    }
  ],
  "orderReference": "string"
}

For more information please read at the api reference section and swagger.