Recurring payments

Overview

Tokenisation allows you to implement recurring payments by saving a token representing the customer's card or bank account and using that on subsequent charges.

Unlike payment plans, you are responsible for managing the customer's subscription yourself—the cancellation, reactivation, and charging of them are all your responsibility.

To implement a recurring charge, first, you'll need to charge the customer normally, for instance, via direct charge or the Revio payments page.

With Revio, you can tokenise customer Cards and Bank account details for future charges.

Tokenisation

Tokens are stored against the client_id and multiple tokens can be created and stored per client


How it works

When a customer has made a payment and tokenisation has been successful, the purchase_id from the purchase is the recurring token that can be stored and used for future charges using the Charge endpoint.

  • Create a purchase
  • Client makes payment to tokenise recurring payment method
  • Utilise recurring payment tokens to charge a customer card or bank account
{
"id": "2f497792-c925-4567-9cb8-8d28f0a4a137" -> Recurring token
  "due": 1663426106,
  "type": "purchase",
// ...
  },
  "issued": "2022-09-17",
  "status": "paid",
// ...
  },
  "marked_as_paid": false,
  "status_history": [
    {
      "status": "created",
      "timestamp": 1663422506
    },
    {
      "status": "viewed",
      "timestamp": 1663422535
    },
    {
      "status": "pending_execute",
      "timestamp": 1663422575
    },
    {
      "status": "paid",
      "timestamp": 1663422578
    }
  ],
// ...
  "transaction_data": {
    "flow": "payform",
    "extra": {
      "card_type": "debit",
      "card_brand": "mastercard",
      "masked_pan": "555555******4444",
      "card_issuer": "ciagroup",
      "expiry_year": 22,
      "expiry_month": 9,
      "cardholder_name": "Test",
      "card_issuer_country": "BR"
    },
// ...

You can also return all client recurring tokens using the GET recurring_tokens endpoint.