This guide outlines how you can customize the redemption experience for your users by incorporating branding, colors, and imagery. By applying a template to your order, you can seamlessly integrate your brand identity into the Runa redemption workflow.

📘

Templates do not have an effect on the Playground API

We do not currently support templates as part of Playground orders. If you place an order with a template ID on the Playground, the redemption experience will use the default Runa styling. Your API response will show the template ID if one was used.

Using redemption templates

1. Creating a custom template

Visit User Redemption templates in Runa portal to create a custom template for your redemption experience. This template allows you to define the look and feel of the email and user redemption pages, including branding elements.

🚧

How templates are applied

The template will only be applied to the parts of the redemption experience you use on orders. If you do not send emails via Runa your customised email template will not be sent to your recipients.

2. Template ID

After creating a template, you will be assigned a unique template ID. This ID is crucial for associating your customized template with specific orders on the Runa API.

3. Integrating template into API requests

distribution_method in the Create Order API accepts template_id on the payload.

Use the template ID you have obtained from the previous step while making your order. Here’s an example request payload:

Example API Request

{
  "payment_method": {
    "type": "ACCOUNT_BALANCE",
    "currency": "GBP"
  },
  "items": [
    {
      "face_value": 10,
      "products": {
        "type": "SINGLE",
        "value": "AMZ-GB"
      },
      "distribution_method": {
        "type": "EMAIL",
        "email_address": "[email protected]",
        "template_id": "YOUR_TEMPLATE_ID"
      }
    }
  ]
}

Replace YOUR_TEMPLATE_ID with your user redemption template ID you have created earlier.

You will be able to retrieve the template_id used on an order on Get Order Details endpoint.

Limitations

We currently support a maximum of 10 unique redemption templates usage per order. Please talk to your Account Managers if you need support with this.