Create a reward supplier

curl --request POST \
  --url https://api.extole.io/v6/reward-suppliers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "auto_fulfillment_enabled": true,
  "cash_back_max": 1,
  "cash_back_min": 1,
  "cash_back_percentage": 1,
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "data": {
    "data_key": "data_key"
  },
  "description": "description",
  "display_name": "display_name",
  "display_type": "display_type",
  "enabled": true,
  "face_value": 1,
  "face_value_algorithm_type": "CASH_BACK",
  "face_value_type": "AUD",
  "limit_per_day": 1,
  "limit_per_hour": 1,
  "missing_fulfillment_alert_delay_ms": 1,
  "missing_fulfillment_alert_enabled": true,
  "missing_fulfillment_auto_fail_delay_ms": 1,
  "missing_fulfillment_auto_fail_enabled": true,
  "name": "name",
  "partner_reward_key_type": "COUPON",
  "partner_reward_supplier_id": "partner_reward_supplier_id",
  "reward_email_auto_send_enabled": true,
  "reward_expires_at": "2025-10-24T02:00:00-07:00",
  "reward_supplier_type": "CUSTOM_REWARD",
  "state_transitions": {
    "state_transitions_key": [
      "CANCELED"
    ]
  },
  "tags": [
    "tag"
  ],
  "type": "ACCOUNT_CREDIT"
}
'

import requests

url = "https://api.extole.io/v6/reward-suppliers"

payload = {
    "auto_fulfillment_enabled": True,
    "cash_back_max": 1,
    "cash_back_min": 1,
    "cash_back_percentage": 1,
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "data": { "data_key": "data_key" },
    "description": "description",
    "display_name": "display_name",
    "display_type": "display_type",
    "enabled": True,
    "face_value": 1,
    "face_value_algorithm_type": "CASH_BACK",
    "face_value_type": "AUD",
    "limit_per_day": 1,
    "limit_per_hour": 1,
    "missing_fulfillment_alert_delay_ms": 1,
    "missing_fulfillment_alert_enabled": True,
    "missing_fulfillment_auto_fail_delay_ms": 1,
    "missing_fulfillment_auto_fail_enabled": True,
    "name": "name",
    "partner_reward_key_type": "COUPON",
    "partner_reward_supplier_id": "partner_reward_supplier_id",
    "reward_email_auto_send_enabled": True,
    "reward_expires_at": "2025-10-24T02:00:00-07:00",
    "reward_supplier_type": "CUSTOM_REWARD",
    "state_transitions": { "state_transitions_key": ["CANCELED"] },
    "tags": ["tag"],
    "type": "ACCOUNT_CREDIT"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    auto_fulfillment_enabled: true,
    cash_back_max: 1,
    cash_back_min: 1,
    cash_back_percentage: 1,
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    data: {data_key: 'data_key'},
    description: 'description',
    display_name: 'display_name',
    display_type: 'display_type',
    enabled: true,
    face_value: 1,
    face_value_algorithm_type: 'CASH_BACK',
    face_value_type: 'AUD',
    limit_per_day: 1,
    limit_per_hour: 1,
    missing_fulfillment_alert_delay_ms: 1,
    missing_fulfillment_alert_enabled: true,
    missing_fulfillment_auto_fail_delay_ms: 1,
    missing_fulfillment_auto_fail_enabled: true,
    name: 'name',
    partner_reward_key_type: 'COUPON',
    partner_reward_supplier_id: 'partner_reward_supplier_id',
    reward_email_auto_send_enabled: true,
    reward_expires_at: '2025-10-24T02:00:00-07:00',
    reward_supplier_type: 'CUSTOM_REWARD',
    state_transitions: {state_transitions_key: ['CANCELED']},
    tags: ['tag'],
    type: 'ACCOUNT_CREDIT'
  })
};

fetch('https://api.extole.io/v6/reward-suppliers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v6/reward-suppliers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'auto_fulfillment_enabled' => true,
    'cash_back_max' => 1,
    'cash_back_min' => 1,
    'cash_back_percentage' => 1,
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'data' => [
        'data_key' => 'data_key'
    ],
    'description' => 'description',
    'display_name' => 'display_name',
    'display_type' => 'display_type',
    'enabled' => true,
    'face_value' => 1,
    'face_value_algorithm_type' => 'CASH_BACK',
    'face_value_type' => 'AUD',
    'limit_per_day' => 1,
    'limit_per_hour' => 1,
    'missing_fulfillment_alert_delay_ms' => 1,
    'missing_fulfillment_alert_enabled' => true,
    'missing_fulfillment_auto_fail_delay_ms' => 1,
    'missing_fulfillment_auto_fail_enabled' => true,
    'name' => 'name',
    'partner_reward_key_type' => 'COUPON',
    'partner_reward_supplier_id' => 'partner_reward_supplier_id',
    'reward_email_auto_send_enabled' => true,
    'reward_expires_at' => '2025-10-24T02:00:00-07:00',
    'reward_supplier_type' => 'CUSTOM_REWARD',
    'state_transitions' => [
        'state_transitions_key' => [
                'CANCELED'
        ]
    ],
    'tags' => [
        'tag'
    ],
    'type' => 'ACCOUNT_CREDIT'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v6/reward-suppliers"

	payload := strings.NewReader("{\n  \"auto_fulfillment_enabled\": true,\n  \"cash_back_max\": 1,\n  \"cash_back_min\": 1,\n  \"cash_back_percentage\": 1,\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"data\": {\n    \"data_key\": \"data_key\"\n  },\n  \"description\": \"description\",\n  \"display_name\": \"display_name\",\n  \"display_type\": \"display_type\",\n  \"enabled\": true,\n  \"face_value\": 1,\n  \"face_value_algorithm_type\": \"CASH_BACK\",\n  \"face_value_type\": \"AUD\",\n  \"limit_per_day\": 1,\n  \"limit_per_hour\": 1,\n  \"missing_fulfillment_alert_delay_ms\": 1,\n  \"missing_fulfillment_alert_enabled\": true,\n  \"missing_fulfillment_auto_fail_delay_ms\": 1,\n  \"missing_fulfillment_auto_fail_enabled\": true,\n  \"name\": \"name\",\n  \"partner_reward_key_type\": \"COUPON\",\n  \"partner_reward_supplier_id\": \"partner_reward_supplier_id\",\n  \"reward_email_auto_send_enabled\": true,\n  \"reward_expires_at\": \"2025-10-24T02:00:00-07:00\",\n  \"reward_supplier_type\": \"CUSTOM_REWARD\",\n  \"state_transitions\": {\n    \"state_transitions_key\": [\n      \"CANCELED\"\n    ]\n  },\n  \"tags\": [\n    \"tag\"\n  ],\n  \"type\": \"ACCOUNT_CREDIT\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.extole.io/v6/reward-suppliers")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"auto_fulfillment_enabled\": true,\n  \"cash_back_max\": 1,\n  \"cash_back_min\": 1,\n  \"cash_back_percentage\": 1,\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"data\": {\n    \"data_key\": \"data_key\"\n  },\n  \"description\": \"description\",\n  \"display_name\": \"display_name\",\n  \"display_type\": \"display_type\",\n  \"enabled\": true,\n  \"face_value\": 1,\n  \"face_value_algorithm_type\": \"CASH_BACK\",\n  \"face_value_type\": \"AUD\",\n  \"limit_per_day\": 1,\n  \"limit_per_hour\": 1,\n  \"missing_fulfillment_alert_delay_ms\": 1,\n  \"missing_fulfillment_alert_enabled\": true,\n  \"missing_fulfillment_auto_fail_delay_ms\": 1,\n  \"missing_fulfillment_auto_fail_enabled\": true,\n  \"name\": \"name\",\n  \"partner_reward_key_type\": \"COUPON\",\n  \"partner_reward_supplier_id\": \"partner_reward_supplier_id\",\n  \"reward_email_auto_send_enabled\": true,\n  \"reward_expires_at\": \"2025-10-24T02:00:00-07:00\",\n  \"reward_supplier_type\": \"CUSTOM_REWARD\",\n  \"state_transitions\": {\n    \"state_transitions_key\": [\n      \"CANCELED\"\n    ]\n  },\n  \"tags\": [\n    \"tag\"\n  ],\n  \"type\": \"ACCOUNT_CREDIT\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/reward-suppliers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"auto_fulfillment_enabled\": true,\n  \"cash_back_max\": 1,\n  \"cash_back_min\": 1,\n  \"cash_back_percentage\": 1,\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"data\": {\n    \"data_key\": \"data_key\"\n  },\n  \"description\": \"description\",\n  \"display_name\": \"display_name\",\n  \"display_type\": \"display_type\",\n  \"enabled\": true,\n  \"face_value\": 1,\n  \"face_value_algorithm_type\": \"CASH_BACK\",\n  \"face_value_type\": \"AUD\",\n  \"limit_per_day\": 1,\n  \"limit_per_hour\": 1,\n  \"missing_fulfillment_alert_delay_ms\": 1,\n  \"missing_fulfillment_alert_enabled\": true,\n  \"missing_fulfillment_auto_fail_delay_ms\": 1,\n  \"missing_fulfillment_auto_fail_enabled\": true,\n  \"name\": \"name\",\n  \"partner_reward_key_type\": \"COUPON\",\n  \"partner_reward_supplier_id\": \"partner_reward_supplier_id\",\n  \"reward_email_auto_send_enabled\": true,\n  \"reward_expires_at\": \"2025-10-24T02:00:00-07:00\",\n  \"reward_supplier_type\": \"CUSTOM_REWARD\",\n  \"state_transitions\": {\n    \"state_transitions_key\": [\n      \"CANCELED\"\n    ]\n  },\n  \"tags\": [\n    \"tag\"\n  ],\n  \"type\": \"ACCOUNT_CREDIT\"\n}"

response = http.request(request)
puts response.read_body

{
  "cash_back_max": 123,
  "cash_back_min": 123,
  "cash_back_percentage": 123,
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "created_date": "2025-10-24T02:00:00-07:00",
  "display_name": "<string>",
  "display_type": "<string>",
  "enabled": true,
  "face_value": 123,
  "face_value_algorithm_type": "CASH_BACK",
  "face_value_type": "AUD",
  "id": "<string>",
  "limit_per_day": 123,
  "limit_per_hour": 123,
  "name": "<string>",
  "partner_reward_key_type": "COUPON",
  "partner_reward_supplier_id": "<string>",
  "reward_expires_at": "2025-10-24T02:00:00-07:00",
  "reward_supplier_type": "CUSTOM_REWARD",
  "state_transitions": {},
  "tags": [
    "<string>"
  ],
  "updated_date": "2025-10-24T02:00:00-07:00",
  "auto_fulfillment_enabled": true,
  "data": {},
  "missing_fulfillment_alert_delay_ms": 123,
  "missing_fulfillment_alert_enabled": true,
  "missing_fulfillment_auto_fail_delay_ms": 123,
  "missing_fulfillment_auto_fail_enabled": true,
  "reward_email_auto_send_enabled": true,
  "type": "ACCOUNT_CREDIT"
}

POST

reward-suppliers

Create a reward supplier

curl --request POST \
  --url https://api.extole.io/v6/reward-suppliers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "auto_fulfillment_enabled": true,
  "cash_back_max": 1,
  "cash_back_min": 1,
  "cash_back_percentage": 1,
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "data": {
    "data_key": "data_key"
  },
  "description": "description",
  "display_name": "display_name",
  "display_type": "display_type",
  "enabled": true,
  "face_value": 1,
  "face_value_algorithm_type": "CASH_BACK",
  "face_value_type": "AUD",
  "limit_per_day": 1,
  "limit_per_hour": 1,
  "missing_fulfillment_alert_delay_ms": 1,
  "missing_fulfillment_alert_enabled": true,
  "missing_fulfillment_auto_fail_delay_ms": 1,
  "missing_fulfillment_auto_fail_enabled": true,
  "name": "name",
  "partner_reward_key_type": "COUPON",
  "partner_reward_supplier_id": "partner_reward_supplier_id",
  "reward_email_auto_send_enabled": true,
  "reward_expires_at": "2025-10-24T02:00:00-07:00",
  "reward_supplier_type": "CUSTOM_REWARD",
  "state_transitions": {
    "state_transitions_key": [
      "CANCELED"
    ]
  },
  "tags": [
    "tag"
  ],
  "type": "ACCOUNT_CREDIT"
}
'

import requests

url = "https://api.extole.io/v6/reward-suppliers"

payload = {
    "auto_fulfillment_enabled": True,
    "cash_back_max": 1,
    "cash_back_min": 1,
    "cash_back_percentage": 1,
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "data": { "data_key": "data_key" },
    "description": "description",
    "display_name": "display_name",
    "display_type": "display_type",
    "enabled": True,
    "face_value": 1,
    "face_value_algorithm_type": "CASH_BACK",
    "face_value_type": "AUD",
    "limit_per_day": 1,
    "limit_per_hour": 1,
    "missing_fulfillment_alert_delay_ms": 1,
    "missing_fulfillment_alert_enabled": True,
    "missing_fulfillment_auto_fail_delay_ms": 1,
    "missing_fulfillment_auto_fail_enabled": True,
    "name": "name",
    "partner_reward_key_type": "COUPON",
    "partner_reward_supplier_id": "partner_reward_supplier_id",
    "reward_email_auto_send_enabled": True,
    "reward_expires_at": "2025-10-24T02:00:00-07:00",
    "reward_supplier_type": "CUSTOM_REWARD",
    "state_transitions": { "state_transitions_key": ["CANCELED"] },
    "tags": ["tag"],
    "type": "ACCOUNT_CREDIT"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    auto_fulfillment_enabled: true,
    cash_back_max: 1,
    cash_back_min: 1,
    cash_back_percentage: 1,
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    data: {data_key: 'data_key'},
    description: 'description',
    display_name: 'display_name',
    display_type: 'display_type',
    enabled: true,
    face_value: 1,
    face_value_algorithm_type: 'CASH_BACK',
    face_value_type: 'AUD',
    limit_per_day: 1,
    limit_per_hour: 1,
    missing_fulfillment_alert_delay_ms: 1,
    missing_fulfillment_alert_enabled: true,
    missing_fulfillment_auto_fail_delay_ms: 1,
    missing_fulfillment_auto_fail_enabled: true,
    name: 'name',
    partner_reward_key_type: 'COUPON',
    partner_reward_supplier_id: 'partner_reward_supplier_id',
    reward_email_auto_send_enabled: true,
    reward_expires_at: '2025-10-24T02:00:00-07:00',
    reward_supplier_type: 'CUSTOM_REWARD',
    state_transitions: {state_transitions_key: ['CANCELED']},
    tags: ['tag'],
    type: 'ACCOUNT_CREDIT'
  })
};

fetch('https://api.extole.io/v6/reward-suppliers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v6/reward-suppliers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'auto_fulfillment_enabled' => true,
    'cash_back_max' => 1,
    'cash_back_min' => 1,
    'cash_back_percentage' => 1,
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'data' => [
        'data_key' => 'data_key'
    ],
    'description' => 'description',
    'display_name' => 'display_name',
    'display_type' => 'display_type',
    'enabled' => true,
    'face_value' => 1,
    'face_value_algorithm_type' => 'CASH_BACK',
    'face_value_type' => 'AUD',
    'limit_per_day' => 1,
    'limit_per_hour' => 1,
    'missing_fulfillment_alert_delay_ms' => 1,
    'missing_fulfillment_alert_enabled' => true,
    'missing_fulfillment_auto_fail_delay_ms' => 1,
    'missing_fulfillment_auto_fail_enabled' => true,
    'name' => 'name',
    'partner_reward_key_type' => 'COUPON',
    'partner_reward_supplier_id' => 'partner_reward_supplier_id',
    'reward_email_auto_send_enabled' => true,
    'reward_expires_at' => '2025-10-24T02:00:00-07:00',
    'reward_supplier_type' => 'CUSTOM_REWARD',
    'state_transitions' => [
        'state_transitions_key' => [
                'CANCELED'
        ]
    ],
    'tags' => [
        'tag'
    ],
    'type' => 'ACCOUNT_CREDIT'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v6/reward-suppliers"

	payload := strings.NewReader("{\n  \"auto_fulfillment_enabled\": true,\n  \"cash_back_max\": 1,\n  \"cash_back_min\": 1,\n  \"cash_back_percentage\": 1,\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"data\": {\n    \"data_key\": \"data_key\"\n  },\n  \"description\": \"description\",\n  \"display_name\": \"display_name\",\n  \"display_type\": \"display_type\",\n  \"enabled\": true,\n  \"face_value\": 1,\n  \"face_value_algorithm_type\": \"CASH_BACK\",\n  \"face_value_type\": \"AUD\",\n  \"limit_per_day\": 1,\n  \"limit_per_hour\": 1,\n  \"missing_fulfillment_alert_delay_ms\": 1,\n  \"missing_fulfillment_alert_enabled\": true,\n  \"missing_fulfillment_auto_fail_delay_ms\": 1,\n  \"missing_fulfillment_auto_fail_enabled\": true,\n  \"name\": \"name\",\n  \"partner_reward_key_type\": \"COUPON\",\n  \"partner_reward_supplier_id\": \"partner_reward_supplier_id\",\n  \"reward_email_auto_send_enabled\": true,\n  \"reward_expires_at\": \"2025-10-24T02:00:00-07:00\",\n  \"reward_supplier_type\": \"CUSTOM_REWARD\",\n  \"state_transitions\": {\n    \"state_transitions_key\": [\n      \"CANCELED\"\n    ]\n  },\n  \"tags\": [\n    \"tag\"\n  ],\n  \"type\": \"ACCOUNT_CREDIT\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.extole.io/v6/reward-suppliers")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"auto_fulfillment_enabled\": true,\n  \"cash_back_max\": 1,\n  \"cash_back_min\": 1,\n  \"cash_back_percentage\": 1,\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"data\": {\n    \"data_key\": \"data_key\"\n  },\n  \"description\": \"description\",\n  \"display_name\": \"display_name\",\n  \"display_type\": \"display_type\",\n  \"enabled\": true,\n  \"face_value\": 1,\n  \"face_value_algorithm_type\": \"CASH_BACK\",\n  \"face_value_type\": \"AUD\",\n  \"limit_per_day\": 1,\n  \"limit_per_hour\": 1,\n  \"missing_fulfillment_alert_delay_ms\": 1,\n  \"missing_fulfillment_alert_enabled\": true,\n  \"missing_fulfillment_auto_fail_delay_ms\": 1,\n  \"missing_fulfillment_auto_fail_enabled\": true,\n  \"name\": \"name\",\n  \"partner_reward_key_type\": \"COUPON\",\n  \"partner_reward_supplier_id\": \"partner_reward_supplier_id\",\n  \"reward_email_auto_send_enabled\": true,\n  \"reward_expires_at\": \"2025-10-24T02:00:00-07:00\",\n  \"reward_supplier_type\": \"CUSTOM_REWARD\",\n  \"state_transitions\": {\n    \"state_transitions_key\": [\n      \"CANCELED\"\n    ]\n  },\n  \"tags\": [\n    \"tag\"\n  ],\n  \"type\": \"ACCOUNT_CREDIT\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/reward-suppliers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"auto_fulfillment_enabled\": true,\n  \"cash_back_max\": 1,\n  \"cash_back_min\": 1,\n  \"cash_back_percentage\": 1,\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"data\": {\n    \"data_key\": \"data_key\"\n  },\n  \"description\": \"description\",\n  \"display_name\": \"display_name\",\n  \"display_type\": \"display_type\",\n  \"enabled\": true,\n  \"face_value\": 1,\n  \"face_value_algorithm_type\": \"CASH_BACK\",\n  \"face_value_type\": \"AUD\",\n  \"limit_per_day\": 1,\n  \"limit_per_hour\": 1,\n  \"missing_fulfillment_alert_delay_ms\": 1,\n  \"missing_fulfillment_alert_enabled\": true,\n  \"missing_fulfillment_auto_fail_delay_ms\": 1,\n  \"missing_fulfillment_auto_fail_enabled\": true,\n  \"name\": \"name\",\n  \"partner_reward_key_type\": \"COUPON\",\n  \"partner_reward_supplier_id\": \"partner_reward_supplier_id\",\n  \"reward_email_auto_send_enabled\": true,\n  \"reward_expires_at\": \"2025-10-24T02:00:00-07:00\",\n  \"reward_supplier_type\": \"CUSTOM_REWARD\",\n  \"state_transitions\": {\n    \"state_transitions_key\": [\n      \"CANCELED\"\n    ]\n  },\n  \"tags\": [\n    \"tag\"\n  ],\n  \"type\": \"ACCOUNT_CREDIT\"\n}"

response = http.request(request)
puts response.read_body

{
  "cash_back_max": 123,
  "cash_back_min": 123,
  "cash_back_percentage": 123,
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "created_date": "2025-10-24T02:00:00-07:00",
  "display_name": "<string>",
  "display_type": "<string>",
  "enabled": true,
  "face_value": 123,
  "face_value_algorithm_type": "CASH_BACK",
  "face_value_type": "AUD",
  "id": "<string>",
  "limit_per_day": 123,
  "limit_per_hour": 123,
  "name": "<string>",
  "partner_reward_key_type": "COUPON",
  "partner_reward_supplier_id": "<string>",
  "reward_expires_at": "2025-10-24T02:00:00-07:00",
  "reward_supplier_type": "CUSTOM_REWARD",
  "state_transitions": {},
  "tags": [
    "<string>"
  ],
  "updated_date": "2025-10-24T02:00:00-07:00",
  "auto_fulfillment_enabled": true,
  "data": {},
  "missing_fulfillment_alert_delay_ms": 123,
  "missing_fulfillment_alert_enabled": true,
  "missing_fulfillment_auto_fail_delay_ms": 123,
  "missing_fulfillment_auto_fail_enabled": true,
  "reward_email_auto_send_enabled": true,
  "type": "ACCOUNT_CREDIT"
}

Authorizations

Authorization

string

header

required

Body

application/json

Option 1
Option 2
Option 3
Option 4

Body of a POST /v6/reward-suppliers request.

face_value_type

required

Choose between static or dynamic face value type. Buildtime expressions use RewardSupplierBuildtimeContext.

Available options:

AUD,

BRL,

CAD,

CNY,

EUR,

GBP,

HKD,

INR,

JPY,

KRW,

MONTH,

MXN,

NZD,

PERCENT_OFF,

POINTS,

TRY,

TWD,

USD

reward_supplier_type

enum<string>

required

Available options:

CUSTOM_REWARD

type

enum<string>

required

Available options:

ACCOUNT_CREDIT,

LOYALTY_POINTS

cash_back_max

Choose between static or dynamic cash back max. Buildtime expressions use RewardSupplierBuildtimeContext.

cash_back_min

Choose between static or dynamic cash back min. Buildtime expressions use RewardSupplierBuildtimeContext.

cash_back_percentage

Choose between static or dynamic cash back percentage. Buildtime expressions use RewardSupplierBuildtimeContext.

component_ids

string[]

component_references

object[]

Show child attributes

description

Choose between static or dynamic description. Buildtime expressions use RewardSupplierBuildtimeContext.

display_name

Choose between static or dynamic display name. Buildtime expressions use RewardSupplierBuildtimeContext.

display_type

Choose between static or dynamic display type. Buildtime expressions use RewardSupplierBuildtimeContext.

enabled

Choose between static or dynamic enabled. Buildtime expressions use RewardSupplierBuildtimeContext.

face_value

Choose between static or dynamic face value. Buildtime expressions use RewardSupplierBuildtimeContext.

face_value_algorithm_type

Choose between static or dynamic face value algorithm type. Buildtime expressions use RewardSupplierBuildtimeContext.

Available options:

CASH_BACK,

FIXED

limit_per_day

Choose between static or dynamic limit per day. Buildtime expressions use RewardSupplierBuildtimeContext.

limit_per_hour

Choose between static or dynamic limit per hour. Buildtime expressions use RewardSupplierBuildtimeContext.

name

Choose between static or dynamic name. Buildtime expressions use RewardSupplierBuildtimeContext.

partner_reward_key_type

enum<string>

Available options:

COUPON,

ID,

LINK

partner_reward_supplier_id

string

reward_expires_at

Choose between static or dynamic reward expires at. Buildtime expressions use RewardSupplierBuildtimeContext. Runtime expressions use EarnedRewardEvaluationContext.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

Response

Successful response

Option 1
Option 2
Option 3
Option 4

Stored custom reward supplier definition. Fields name, display_name, face_value_algorithm_type, face_value, cash_back_percentage, cash_back_min, cash_back_max, limit_per_day, limit_per_hour, face_value_type, display_type, enabled, and reward_expires_at are unevaluated and appear in buildtime-evaluatable form.

cash_back_max

required

The cash back max as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use RewardSupplierBuildtimeContext.

cash_back_min

required

The cash back min as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use RewardSupplierBuildtimeContext.

cash_back_percentage

required

The cash back percentage as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use RewardSupplierBuildtimeContext.

component_ids

string[]

required

component_references

object[]

required

Show child attributes

created_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

display_name

required

The display name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use RewardSupplierBuildtimeContext.

display_type

required

The display type as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use RewardSupplierBuildtimeContext.

enabled

required

The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use RewardSupplierBuildtimeContext.

face_value

required

The face value as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use RewardSupplierBuildtimeContext.

face_value_algorithm_type

required

The face value algorithm type as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use RewardSupplierBuildtimeContext.

Available options:

CASH_BACK,

FIXED

face_value_type

required

The face value type as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use RewardSupplierBuildtimeContext.

Available options:

AUD,

BRL,

CAD,

CNY,

EUR,

GBP,

HKD,

INR,

JPY,

KRW,

MONTH,

MXN,

NZD,

PERCENT_OFF,

POINTS,

TRY,

TWD,

USD

string

required

read-only

limit_per_day

required

The limit per day as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use RewardSupplierBuildtimeContext.

limit_per_hour

required

The limit per hour as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use RewardSupplierBuildtimeContext.

name

required

The name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use RewardSupplierBuildtimeContext.

partner_reward_key_type

enum<string>

required

Available options:

COUPON,

ID,

LINK

partner_reward_supplier_id

string

required

reward_expires_at

required

The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use RewardSupplierBuildtimeContext. Runtime expressions use EarnedRewardEvaluationContext.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

reward_supplier_type

enum<string>

required

Available options:

CUSTOM_REWARD

state_transitions

object

required

Show child attributes

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Create a reward supplier

Authorizations

Body

Response