Limit available products in a Payout Link

This guide will provide you with step-by-step instructions on how to limit the products that the recipient can redeem when they receive a Payout Link.

After the recipient clicks on their Payout Link, they will be directed to a page where they can choose from a selection of available products. They have the flexibility to decide how they want to allocate the face value of their balance among these products.

The recipient has the option to split the total balance across multiple available products, as illustrated in the example below.

To restrict the available products in a Payout Link, you can define the desired products within the order items when making a request to the Create Order endpoint. Here are some examples to assist you in creating your payload.

Below is an order request that allows the end user to allocate their face value across two products, namely Amazon and Adidas UK:

{
  "payment_method": {
    "type": "ACCOUNT_BALANCE",
    "currency": "GBP"
  },
  "items": [
    {
      "face_value": 10,
      "distribution_method": {
        "type": "PAYOUT_LINK"
      },
      "products": {
        "type": "MULTIPLE",
        "values": ["AMZ-GB", "ADAS-GB"]
      }
    }
  ]
}

If you'd like to restrict the product selection to a single product, please refer to the example order request below. This limits the user to redeem their total face value on a single product, specifically Amazon UK:

{
  "payment_method": {
    "type": "ACCOUNT_BALANCE",
    "currency": "GBP"
  },
  "items": [
    {
      "face_value": 10,
      "distribution_method": {
        "type": "PAYOUT_LINK"
      },
      "products": {
        "type": "SINGLE",
        "value": "AMZ-GB"
      }
    }
  ]
}

❗️

Multiple country orders are not supported

Please be aware that when placing an order, it is essential to ensure that all selected products within the order items belong to the same country. We currently do not support combining products from different countries in a single order. Your order will be rejected.

Exploring and Selecting Products from Runa Product Network

To choose the products you want to include in your order, you can explore Runa's product network using the List Products endpoint. Follow the steps below to utilize this endpoint effectively:

1. Select a Country Code: Begin by selecting a country code from our list of supported countries. This code will determine the available products specific to that country.
2. Make a request to the List Products endpoint, providing the selected country code as a query parameter. This will ensure the retrieval of the product list tailored to the chosen country.

To quickly test out the endpoint and view the product list, you can navigate to the API reference for the List Products endpoint.

Here is an example of a successful response that demonstrates different denomination type values for the products. It illustrates the distinction between open and fixed denomination types:

• open products will include minimum_value and maximum_value fields. This means that the recipient can redeem gift cards within a range of values. The minimum_value indicates the minimum allowed value (50 in this case), while the maximum_value represents the maximum value allowed (500 in this case). When placing an order, ensure that the face_value of your order items is at least equal to the minimum value of the products included, so the recipient has enough credits to redeem the gift cards.
• fixed products will include an available_denominations field. The recipient can only spend their credits on gift cards with specific denominations. In the example below, recipients can spend their credits on Walmart gift cards with denominations of either $5 or $10, as specified in the available_denominations field.

[
  {
    "code": "AIRBB-CA",
    "name": "Airbnb CA",
    "image_url": "https://image.com/airbnb.png",
    "denomination_type": "open",
    "categories": [
      {
        "code": "travel",
        "name": "Travel"
      }
    ],
    "minimum_value": 50,
    "maximum_value": 500,
    "available_denominations": null
  },
  {
    "code": "WMART-CA",
    "name": "Walmart CA",
    "image_url": "https://image.com/walmart.png",
    "denomination_type": "fixed",
    "categories": [
      {
        "code": "department-stores",
        "name": "Department Stores"
      }
    ],
    "available_denominations": [5, 10]
  }
]

🚧

Temporarily unavailable products

We recommend to refresh your product catalogue regularly because it is possible that products will be temporarily unavailable due to outages of our downstream providers.