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

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.

User Redemption Templates do not have an effect in the Playground environment

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.

Note while an email preview is shown, this will only be used if you opt to send emails via Runa as part of the order request.

2

Grab the 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

Use the template ID in your order request

When placing an order set the template_id field in the distribution_method payload to the ID you have obtained from the previous step.

Request example
{
    "payment_method": {
        "type": "ACCOUNT_BALANCE",
        "currency": "GBP"
    },
    "items": [
        {
            "face_value": 10,
            "products": {
                "type": "SINGLE",
                "value": "AMZ-GB"
            },
            "distribution_method": {
                "type": "EMAIL",
                "email_address": "name@domain.test",
                "template_id": "YOUR_TEMPLATE_ID"
            }
        }
    ]
}

See the order request reference for more details.

​
Supported branding elements

The follow elements from the payout link and email (if you choose to send emails via Runa) can be customized:

ElementAreaDescription
LogoEmail & payout linkYour logo will be shown in email and the payout link.
Primary ColorEmail & payout linkA primary color can be used for the email and payout link.
Background ColorEmail & payout linkA background color can be used for the email and payout link.
Sender NameEmailA custom sender name can be used for email delivery.
SubjectEmailA custom subject can be used for email delivery.
MessageEmailA custom message can be used for email delivery.
Banner ImageEmailA custom banner image can be used for email delivery.
Privacy Policy URLEmailA custom privacy policy URL can be added to the email.

​
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.