Get a reward config

curl --request GET \
  --url https://api.synctera.com/v1/reward_configs/{reward_config_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.synctera.com/v1/reward_configs/{reward_config_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.synctera.com/v1/reward_configs/{reward_config_id}', 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/v1/reward_configs/{reward_config_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.synctera.com/v1/reward_configs/{reward_config_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v1/reward_configs/{reward_config_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "amount_config": {
    "amount_type": "fixed",
    "config": {
      "fixed_amount": {
        "amount": 300
      },
      "percentage": {
        "basis_points": 300
      },
      "transaction_amount_tiered": {
        "tiers": [
          {
            "amount_type": "fixed",
            "config": {
              "fixed_amount": {
                "amount": 300
              },
              "percentage": {
                "basis_points": 300
              }
            },
            "up_to": 10000
          }
        ]
      }
    }
  },
  "name": "Grocery Store Cashback",
  "reward_category": "cashback:card:mcc",
  "status": "active",
  "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
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

GET

reward_configs

{reward_config_id}

Get a reward config

curl --request GET \
  --url https://api.synctera.com/v1/reward_configs/{reward_config_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.synctera.com/v1/reward_configs/{reward_config_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.synctera.com/v1/reward_configs/{reward_config_id}', 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/v1/reward_configs/{reward_config_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.synctera.com/v1/reward_configs/{reward_config_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v1/reward_configs/{reward_config_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "amount_config": {
    "amount_type": "fixed",
    "config": {
      "fixed_amount": {
        "amount": 300
      },
      "percentage": {
        "basis_points": 300
      },
      "transaction_amount_tiered": {
        "tiers": [
          {
            "amount_type": "fixed",
            "config": {
              "fixed_amount": {
                "amount": 300
              },
              "percentage": {
                "basis_points": 300
              }
            },
            "up_to": 10000
          }
        ]
      }
    }
  },
  "name": "Grocery Store Cashback",
  "reward_category": "cashback:card:mcc",
  "status": "active",
  "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
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

Authorizations

Authorization

string

header

required

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

Path Parameters

reward_config_id

string<uuid>

required

Unique identifier of a reward config.

Example:

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

Response

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.

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"

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Get a reward config

Authorizations

Path Parameters

Response