In some cases, normal customer approval processes can be bypassed in order to handle customers who may have transactions of values that exceed common amounts. This can be supported by identifying valued or trusted customers as VIPs and implementing VIP tiers with your Trustly integration.

📘

Trustly Contract Agreement Required

Self-service onboarding for the VIP customer tier product feature is not available at this time. Please contact your Trustly representative to inquire about enabling this feature for your app and associated Trustly API keys.

Integration Steps Overview

Prerequisites

1. Define VIP tiers together with Trustly (this is done during contract agreements)
2. Your application must provide unique customer IDs. These will be passed to Trustly APIs under the externalId field.

🚧

Restricted APIs

Utilizing the API endpoints mentioned in this article with an AccessId not associated with a merchant ID configured for VIP tiers will not result in the expected behavior.

VIP Tier Management

VIP tiers are referenced by positive integer values beginning with 1 and iterating by units of one.

Merchants can make ongoing updates to a player's VIP status; promote, demote, or remove them from the program entirely by using the APIs documented in this guide.

Adding New Customers as VIPs

Add VIP Customers Upon Initial Signup

To add VIP status to a new customer, pass the appropriate VIP tier when the customer is signing up for Online Banking via the Establish Data object provided to the Trustly UI. In addition to standard required properties, the following properties must be included for the customer to successfully be provided VIP status:

1. Customer Name
2. VIP tier value

Example Establish Data Object for new VIP customer:

{
  "merchantId": "123456",
  "merchantReference": "uniqueTransaction123_jsmith",
  "paymentType": "deferred",
  "customer": {
    "name": "Jane Smith",
    "email": "[email protected]",
    "vip": 2,
    "address": {
      "address1": "2000 Broadway St",
      "city": "Redwood City",
      "state": "CA",
      "zip": "94063",
      "country": "US"
    }
  }
}

Update VIP tier for existing players

To update the VIP tier of an existing VIP customer (to either promote or demote them) use the Update Customer or Update Customer by External ID API endpoints.

Update Customer by ID

Call the Update Customer endpoint and provide any relevant customer details to be updated along with the desired VIP tier.

Example API Call

// POST https://trustly.one/api/v1/customers/012345678

{
  "name": "Jane Smith",
  "customerId": "012345678",
  "merchantId": "123456",
  "vip": 1
}

Update Customer by External ID

If your Trustly integration utilizes the externalId field, you can also call the Update Customer by External ID endpoint. Provide any relevant customer details to be updated along with the desired VIP tier.

Example API Call

// POST https://trustly.one/api/v1/customers?externalId=ABC098

{
  "name": "Jane Smith",
  "externalId": "012345678",
  "merchantId": "123456",
  "vip": 1
}

Remove Customers from VIP

To remove VIP status from an existing customer use the Update Customer or Update Customer by External ID API endpoints and provide the vip property set to a value of 0.

Update Customer

Example API Call

// POST https://trustly.one/api/v1/customers/012345678

{
  "name": "Jane Smith",
  "externalId": "ABC098",
  "merchantId": "123456",
  "vip": 0
}

Update Customer by External ID

If your Trustly integration utilizes the externalId field, you can also remove an existing VIP customer from your VIP program by using the Update Customer by External Id endpoint. Provide any relevant customer details to be updated along with the vip property set to a value 0.

Example API Call

// POST https://trustly.one/api/v1/customers?externalId=ABC098

{
  "name": "Jane Smith",
  "externalId": "ABC098",
  "merchantId": "123456",
  "vip": 0
}