Sign in

v1

latestOpenAPI 3.1.02026-07-241210356.3 KB
Recurring Payments

Credit Card Renewal Notification

This endpoint is used to notify the customer about the renewal of their credit card for a recurring payment, a payment page link will be attached to the email. There's a possibility to disable sending the email and return a payment page link instead for the representative to fill in the new credit card details.

  • Requires a payment page associated with the recurring payment terminal.
post/RecurringPayments/CreditCardRenewal/{recurring_uid}

Path parameters

recurring_uidstring required

Recurring payment unique identifier

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Request body

terminal_uidstring required

Terminal unique identifier

disable_send_emailboolean

If set to true, a notification email will not be sent to the customer and payment page link will be returned instead. The payment page link returned, allows to fill in the new credit card details. This is useful for cases where there isn't a need to send an email to the customer, for example, when the customer is already on the phone with the representative and the representative fills in the new credit card details.

Response

200

dataobject

Example response

{
  "result": {
    "status": "success",
    "description": "operation has been success"
  }
}