Create a reward config

curl --request POST \
  --url https://api.synctera.com/v2/reward_configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_config": {
    "config": {}
  },
  "name": "Grocery Store Cashback",
  "reward_category": "cashback:card:mcc",
  "template_id": "8b943c51-e4ff-4e57-9558-08cab6b96234",
  "description": "1% cashback on all grocery purchases",
  "reverse_with_parent": false,
  "reward_type": "instant_cashback",
  "rule_config": {
    "mcc_cashback": {
      "mcc_ranges": [
        {
          "lower": "5411",
          "upper": "5499"
        }
      ]
    }
  }
}
'

import requests

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

payload = {
    "amount_config": { "config": {} },
    "name": "Grocery Store Cashback",
    "reward_category": "cashback:card:mcc",
    "template_id": "8b943c51-e4ff-4e57-9558-08cab6b96234",
    "description": "1% cashback on all grocery purchases",
    "reverse_with_parent": False,
    "reward_type": "instant_cashback",
    "rule_config": { "mcc_cashback": { "mcc_ranges": [
                {
                    "lower": "5411",
                    "upper": "5499"
                }
            ] } }
}
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({
    amount_config: {config: {}},
    name: 'Grocery Store Cashback',
    reward_category: 'cashback:card:mcc',
    template_id: '8b943c51-e4ff-4e57-9558-08cab6b96234',
    description: '1% cashback on all grocery purchases',
    reverse_with_parent: false,
    reward_type: 'instant_cashback',
    rule_config: {mcc_cashback: {mcc_ranges: [{lower: '5411', upper: '5499'}]}}
  })
};

fetch('https://api.synctera.com/v2/reward_configs', 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_configs",
  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([
    'amount_config' => [
        'config' => [
                
        ]
    ],
    'name' => 'Grocery Store Cashback',
    'reward_category' => 'cashback:card:mcc',
    'template_id' => '8b943c51-e4ff-4e57-9558-08cab6b96234',
    'description' => '1% cashback on all grocery purchases',
    'reverse_with_parent' => false,
    'reward_type' => 'instant_cashback',
    'rule_config' => [
        'mcc_cashback' => [
                'mcc_ranges' => [
                                [
                                                                'lower' => '5411',
                                                                'upper' => '5499'
                                ]
                ]
        ]
    ]
  ]),
  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_configs"

	payload := strings.NewReader("{\n  \"amount_config\": {\n    \"config\": {}\n  },\n  \"name\": \"Grocery Store Cashback\",\n  \"reward_category\": \"cashback:card:mcc\",\n  \"template_id\": \"8b943c51-e4ff-4e57-9558-08cab6b96234\",\n  \"description\": \"1% cashback on all grocery purchases\",\n  \"reverse_with_parent\": false,\n  \"reward_type\": \"instant_cashback\",\n  \"rule_config\": {\n    \"mcc_cashback\": {\n      \"mcc_ranges\": [\n        {\n          \"lower\": \"5411\",\n          \"upper\": \"5499\"\n        }\n      ]\n    }\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_configs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount_config\": {\n    \"config\": {}\n  },\n  \"name\": \"Grocery Store Cashback\",\n  \"reward_category\": \"cashback:card:mcc\",\n  \"template_id\": \"8b943c51-e4ff-4e57-9558-08cab6b96234\",\n  \"description\": \"1% cashback on all grocery purchases\",\n  \"reverse_with_parent\": false,\n  \"reward_type\": \"instant_cashback\",\n  \"rule_config\": {\n    \"mcc_cashback\": {\n      \"mcc_ranges\": [\n        {\n          \"lower\": \"5411\",\n          \"upper\": \"5499\"\n        }\n      ]\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"amount_config\": {\n    \"config\": {}\n  },\n  \"name\": \"Grocery Store Cashback\",\n  \"reward_category\": \"cashback:card:mcc\",\n  \"template_id\": \"8b943c51-e4ff-4e57-9558-08cab6b96234\",\n  \"description\": \"1% cashback on all grocery purchases\",\n  \"reverse_with_parent\": false,\n  \"reward_type\": \"instant_cashback\",\n  \"rule_config\": {\n    \"mcc_cashback\": {\n      \"mcc_ranges\": [\n        {\n          \"lower\": \"5411\",\n          \"upper\": \"5499\"\n        }\n      ]\n    }\n  }\n}"

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

{
  "amount_config": {
    "config": {
      "fixed_amount": {
        "amount": 300
      },
      "percentage": {
        "basis_points": 300
      },
      "transaction_amount_tiered": {
        "tiers": [
          {
            "config": {
              "fixed_amount": {
                "amount": 300
              },
              "percentage": {
                "basis_points": 300
              }
            },
            "up_to": 10000
          }
        ]
      }
    }
  },
  "name": "Grocery Store Cashback",
  "reward_category": "cashback:card:mcc",
  "creation_time": "2024-01-15T10:00:00Z",
  "id": "5c943c51-e4ff-4e57-9558-08cab6b96398",
  "last_updated_time": "2024-06-01T12:00:00Z",
  "tenant": "abcdef_ghijkl",
  "description": "1% cashback on all grocery purchases",
  "reverse_with_parent": false,
  "reward_type": "instant_cashback",
  "rule_config": {
    "mcc_cashback": {
      "mcc_ranges": [
        {
          "lower": "5411",
          "upper": "5499"
        }
      ]
    }
  },
  "template_id": "8b943c51-e4ff-4e57-9558-08cab6b96234"
}

{
  "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_configs

Create a reward config

curl --request POST \
  --url https://api.synctera.com/v2/reward_configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_config": {
    "config": {}
  },
  "name": "Grocery Store Cashback",
  "reward_category": "cashback:card:mcc",
  "template_id": "8b943c51-e4ff-4e57-9558-08cab6b96234",
  "description": "1% cashback on all grocery purchases",
  "reverse_with_parent": false,
  "reward_type": "instant_cashback",
  "rule_config": {
    "mcc_cashback": {
      "mcc_ranges": [
        {
          "lower": "5411",
          "upper": "5499"
        }
      ]
    }
  }
}
'

import requests

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

payload = {
    "amount_config": { "config": {} },
    "name": "Grocery Store Cashback",
    "reward_category": "cashback:card:mcc",
    "template_id": "8b943c51-e4ff-4e57-9558-08cab6b96234",
    "description": "1% cashback on all grocery purchases",
    "reverse_with_parent": False,
    "reward_type": "instant_cashback",
    "rule_config": { "mcc_cashback": { "mcc_ranges": [
                {
                    "lower": "5411",
                    "upper": "5499"
                }
            ] } }
}
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({
    amount_config: {config: {}},
    name: 'Grocery Store Cashback',
    reward_category: 'cashback:card:mcc',
    template_id: '8b943c51-e4ff-4e57-9558-08cab6b96234',
    description: '1% cashback on all grocery purchases',
    reverse_with_parent: false,
    reward_type: 'instant_cashback',
    rule_config: {mcc_cashback: {mcc_ranges: [{lower: '5411', upper: '5499'}]}}
  })
};

fetch('https://api.synctera.com/v2/reward_configs', 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_configs",
  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([
    'amount_config' => [
        'config' => [
                
        ]
    ],
    'name' => 'Grocery Store Cashback',
    'reward_category' => 'cashback:card:mcc',
    'template_id' => '8b943c51-e4ff-4e57-9558-08cab6b96234',
    'description' => '1% cashback on all grocery purchases',
    'reverse_with_parent' => false,
    'reward_type' => 'instant_cashback',
    'rule_config' => [
        'mcc_cashback' => [
                'mcc_ranges' => [
                                [
                                                                'lower' => '5411',
                                                                'upper' => '5499'
                                ]
                ]
        ]
    ]
  ]),
  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_configs"

	payload := strings.NewReader("{\n  \"amount_config\": {\n    \"config\": {}\n  },\n  \"name\": \"Grocery Store Cashback\",\n  \"reward_category\": \"cashback:card:mcc\",\n  \"template_id\": \"8b943c51-e4ff-4e57-9558-08cab6b96234\",\n  \"description\": \"1% cashback on all grocery purchases\",\n  \"reverse_with_parent\": false,\n  \"reward_type\": \"instant_cashback\",\n  \"rule_config\": {\n    \"mcc_cashback\": {\n      \"mcc_ranges\": [\n        {\n          \"lower\": \"5411\",\n          \"upper\": \"5499\"\n        }\n      ]\n    }\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_configs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount_config\": {\n    \"config\": {}\n  },\n  \"name\": \"Grocery Store Cashback\",\n  \"reward_category\": \"cashback:card:mcc\",\n  \"template_id\": \"8b943c51-e4ff-4e57-9558-08cab6b96234\",\n  \"description\": \"1% cashback on all grocery purchases\",\n  \"reverse_with_parent\": false,\n  \"reward_type\": \"instant_cashback\",\n  \"rule_config\": {\n    \"mcc_cashback\": {\n      \"mcc_ranges\": [\n        {\n          \"lower\": \"5411\",\n          \"upper\": \"5499\"\n        }\n      ]\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"amount_config\": {\n    \"config\": {}\n  },\n  \"name\": \"Grocery Store Cashback\",\n  \"reward_category\": \"cashback:card:mcc\",\n  \"template_id\": \"8b943c51-e4ff-4e57-9558-08cab6b96234\",\n  \"description\": \"1% cashback on all grocery purchases\",\n  \"reverse_with_parent\": false,\n  \"reward_type\": \"instant_cashback\",\n  \"rule_config\": {\n    \"mcc_cashback\": {\n      \"mcc_ranges\": [\n        {\n          \"lower\": \"5411\",\n          \"upper\": \"5499\"\n        }\n      ]\n    }\n  }\n}"

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

{
  "amount_config": {
    "config": {
      "fixed_amount": {
        "amount": 300
      },
      "percentage": {
        "basis_points": 300
      },
      "transaction_amount_tiered": {
        "tiers": [
          {
            "config": {
              "fixed_amount": {
                "amount": 300
              },
              "percentage": {
                "basis_points": 300
              }
            },
            "up_to": 10000
          }
        ]
      }
    }
  },
  "name": "Grocery Store Cashback",
  "reward_category": "cashback:card:mcc",
  "creation_time": "2024-01-15T10:00:00Z",
  "id": "5c943c51-e4ff-4e57-9558-08cab6b96398",
  "last_updated_time": "2024-06-01T12:00:00Z",
  "tenant": "abcdef_ghijkl",
  "description": "1% cashback on all grocery purchases",
  "reverse_with_parent": false,
  "reward_type": "instant_cashback",
  "rule_config": {
    "mcc_cashback": {
      "mcc_ranges": [
        {
          "lower": "5411",
          "upper": "5499"
        }
      ]
    }
  },
  "template_id": "8b943c51-e4ff-4e57-9558-08cab6b96234"
}

{
  "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 config to create

amount_config

object

required

Amount calculation parameters for a fee config. amount_type determines which config field is used.

Show child attributes

name

string

required

Human-readable name for this reward rule.

Example:

"Grocery Store Cashback"

reward_category

enum<string>

required

The category of event that triggers this reward. Trigger-based categories fire when a matching card transaction is posted.

Available options:

cashback:card:mcc

template_id

string<uuid>

required

ID of the reward template that provides accounting setup for automated reward posting. Required for trigger-based rewards.

Example:

"8b943c51-e4ff-4e57-9558-08cab6b96234"

description

string

Description of this reward rule.

Example:

"1% cashback on all grocery purchases"

reverse_with_parent

boolean

When true, reversals of the triggering transaction also reverse this reward.

Example:

false

reward_type

enum<string>

How the reward is delivered to the account holder. instant_cashback = credited to the account on every qualifying transaction. Future types (not yet implemented): accrued_cashback, vendor_points.

Available options:

instant_cashback

rule_config

object

Category-specific rule parameters. Provide the field that matches the reward_config's reward_category; all other fields must be omitted.

Show child attributes

status

enum<string>

Available options:

active,

inactive

Response

Created reward config

amount_config

object

required

Amount calculation parameters for a fee config. amount_type determines which config field is used.

Show child attributes

name

string

required

Human-readable name for this reward rule.

Example:

"Grocery Store Cashback"

reward_category

enum<string>

required

The category of event that triggers this reward. Trigger-based categories fire when a matching card transaction is posted.

Available options:

cashback:card:mcc

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

Example:

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

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 this reward rule.

Example:

"1% cashback on all grocery purchases"

reverse_with_parent

boolean

When true, reversals of the triggering transaction also reverse this reward.

Example:

false

reward_type

enum<string>

How the reward is delivered to the account holder. instant_cashback = credited to the account on every qualifying transaction. Future types (not yet implemented): accrued_cashback, vendor_points.

Available options:

instant_cashback

rule_config

object

Category-specific rule parameters. Provide the field that matches the reward_config's reward_category; all other fields must be omitted.

Show child attributes

template_id

string<uuid>

ID of the reward template that provides accounting setup for automated reward posting. Required for trigger-based rewards.

Example:

"8b943c51-e4ff-4e57-9558-08cab6b96234"

List reward configs Get a reward config

⌘I

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Create a reward config

Authorizations

Headers

Body

Response