Create a reward product

curl --request POST \
  --url https://api.synctera.com/v2/reward_products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Premium Cashback Rewards",
  "description": "Cashback rewards for premium checking accounts",
  "reward_config_ids": [
    "5c943c51-e4ff-4e57-9558-08cab6b96398"
  ]
}
'

import requests

url = "https://api.synctera.com/v2/reward_products"

payload = {
    "name": "Premium Cashback Rewards",
    "description": "Cashback rewards for premium checking accounts",
    "reward_config_ids": ["5c943c51-e4ff-4e57-9558-08cab6b96398"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Premium Cashback Rewards',
    description: 'Cashback rewards for premium checking accounts',
    reward_config_ids: ['5c943c51-e4ff-4e57-9558-08cab6b96398']
  })
};

fetch('https://api.synctera.com/v2/reward_products', 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.synctera.com/v2/reward_products",
  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([
    'name' => 'Premium Cashback Rewards',
    'description' => 'Cashback rewards for premium checking accounts',
    'reward_config_ids' => [
        '5c943c51-e4ff-4e57-9558-08cab6b96398'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.synctera.com/v2/reward_products"

	payload := strings.NewReader("{\n  \"name\": \"Premium Cashback Rewards\",\n  \"description\": \"Cashback rewards for premium checking accounts\",\n  \"reward_config_ids\": [\n    \"5c943c51-e4ff-4e57-9558-08cab6b96398\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.synctera.com/v2/reward_products")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Premium Cashback Rewards\",\n  \"description\": \"Cashback rewards for premium checking accounts\",\n  \"reward_config_ids\": [\n    \"5c943c51-e4ff-4e57-9558-08cab6b96398\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/reward_products")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Premium Cashback Rewards\",\n  \"description\": \"Cashback rewards for premium checking accounts\",\n  \"reward_config_ids\": [\n    \"5c943c51-e4ff-4e57-9558-08cab6b96398\"\n  ]\n}"

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

{
  "name": "Premium Cashback Rewards",
  "reward_config_ids": [
    "5c943c51-e4ff-4e57-9558-08cab6b96398"
  ],
  "creation_time": "2024-01-15T10:00:00Z",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b96312",
  "last_updated_time": "2024-06-01T12:00:00Z",
  "tenant": "abcdef_ghijkl",
  "description": "Cashback rewards for premium checking accounts"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

POST

reward_products

Create a reward product

curl --request POST \
  --url https://api.synctera.com/v2/reward_products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Premium Cashback Rewards",
  "description": "Cashback rewards for premium checking accounts",
  "reward_config_ids": [
    "5c943c51-e4ff-4e57-9558-08cab6b96398"
  ]
}
'

import requests

url = "https://api.synctera.com/v2/reward_products"

payload = {
    "name": "Premium Cashback Rewards",
    "description": "Cashback rewards for premium checking accounts",
    "reward_config_ids": ["5c943c51-e4ff-4e57-9558-08cab6b96398"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Premium Cashback Rewards',
    description: 'Cashback rewards for premium checking accounts',
    reward_config_ids: ['5c943c51-e4ff-4e57-9558-08cab6b96398']
  })
};

fetch('https://api.synctera.com/v2/reward_products', 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.synctera.com/v2/reward_products",
  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([
    'name' => 'Premium Cashback Rewards',
    'description' => 'Cashback rewards for premium checking accounts',
    'reward_config_ids' => [
        '5c943c51-e4ff-4e57-9558-08cab6b96398'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.synctera.com/v2/reward_products"

	payload := strings.NewReader("{\n  \"name\": \"Premium Cashback Rewards\",\n  \"description\": \"Cashback rewards for premium checking accounts\",\n  \"reward_config_ids\": [\n    \"5c943c51-e4ff-4e57-9558-08cab6b96398\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.synctera.com/v2/reward_products")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Premium Cashback Rewards\",\n  \"description\": \"Cashback rewards for premium checking accounts\",\n  \"reward_config_ids\": [\n    \"5c943c51-e4ff-4e57-9558-08cab6b96398\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/reward_products")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Premium Cashback Rewards\",\n  \"description\": \"Cashback rewards for premium checking accounts\",\n  \"reward_config_ids\": [\n    \"5c943c51-e4ff-4e57-9558-08cab6b96398\"\n  ]\n}"

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

{
  "name": "Premium Cashback Rewards",
  "reward_config_ids": [
    "5c943c51-e4ff-4e57-9558-08cab6b96398"
  ],
  "creation_time": "2024-01-15T10:00:00Z",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b96312",
  "last_updated_time": "2024-06-01T12:00:00Z",
  "tenant": "abcdef_ghijkl",
  "description": "Cashback rewards for premium checking accounts"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Reward product to create

name

string

required

Name of the reward product bundle.

Example:

"Premium Cashback Rewards"

description

string

Description of the reward product bundle.

Example:

"Cashback rewards for premium checking accounts"

reward_config_ids

string<uuid>[]

Reward config IDs associated with this product.

Example:

["5c943c51-e4ff-4e57-9558-08cab6b96398"]

status

enum<string>

Available options:

active,

inactive

Response

Created reward product

name

string

required

Name of the reward product bundle.

Example:

"Premium Cashback Rewards"

reward_config_ids

string<uuid>[]

required

Reward config IDs associated with this product.

Example:

["5c943c51-e4ff-4e57-9558-08cab6b96398"]

status

enum<string>

required

Available options:

active,

inactive

creation_time

string<date-time>

required

read-only

Example:

"2024-01-15T10:00:00Z"

string<uuid>

required

Unique identifier for this reward product.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b96312"

last_updated_time

string<date-time>

required

read-only

Example:

"2024-06-01T12:00:00Z"

tenant

string

required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

description

string

Description of the reward product bundle.

Example:

"Cashback rewards for premium checking accounts"

List reward products Get a reward product

⌘I

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Create a reward product

Authorizations

Headers

Body

Response