Get a Reward template

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

import requests

url = "https://api.synctera.com/v1/reward_templates/{reward_template_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_templates/{reward_template_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_templates/{reward_template_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_templates/{reward_template_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_templates/{reward_template_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

{
  "currency": "USD",
  "internal_account_id": "42943c51-e4ff-4e57-9558-08cab6b963c8",
  "is_enabled": true,
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "85943c51-e4ff-4e57-9558-08cab6b96364",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "subtype": "ACCOUNT_OPENING_BONUS",
  "tenant": "abcdef_ghijkl",
  "amount": 1000,
  "description": "Referral Reward",
  "metadata": {}
}

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

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

GET

reward_templates

{reward_template_id}

Get a Reward template

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

import requests

url = "https://api.synctera.com/v1/reward_templates/{reward_template_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_templates/{reward_template_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_templates/{reward_template_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_templates/{reward_template_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_templates/{reward_template_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

{
  "currency": "USD",
  "internal_account_id": "42943c51-e4ff-4e57-9558-08cab6b963c8",
  "is_enabled": true,
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "85943c51-e4ff-4e57-9558-08cab6b96364",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "subtype": "ACCOUNT_OPENING_BONUS",
  "tenant": "abcdef_ghijkl",
  "amount": 1000,
  "description": "Referral Reward",
  "metadata": {}
}

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

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

string<uuid>

required

The unique identifier of a reward template

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6"

Response

Returned reward template

currency

string

required

currency for the reward, as a three character ISO 4217 alphabetic currency code.

Example:

"USD"

internal_account_id

string<uuid>

required

The ID of default internal_account to use as the source of the reward transfer. Cannot be a system internal account.

Example:

"42943c51-e4ff-4e57-9558-08cab6b963c8"

is_enabled

boolean

required

Whether the reward template is enabled. If false, rewards cannot be created from this template.

Example:

true

creation_time

string<date-time>

required

read-only

The timestamp representing when the reward template was created

Example:

"2010-05-06T12:23:34.321Z"

string<uuid>

required

The ID of the reward template.

Example:

"85943c51-e4ff-4e57-9558-08cab6b96364"

last_updated_time

string<date-time>

required

read-only

The timestamp representing when the reward template was last modified

Example:

"2010-05-06T12:23:34.321Z"

subtype

enum<string>

required

A short string representing the sub-type of the reward. This will be used as the subtype of the resulting transaction.

Available options:

ACCOUNT_OPENING_BONUS,

ACCOUNT_OPENING_BONUS_REVERSAL,

CASHBACK,

CASHBACK_REVERSAL,

INTEREST_RATE_BONUS,

INTEREST_RATE_BONUS_REVERSAL,

LOAN_INTEREST_RATE_REDUCTION,

LOAN_INTEREST_RATE_REDUCTION_REVERSAL,

MANUAL_ADJUSTMENT,

MANUAL_ADJUSTMENT_REVERSAL,

MILES,

MILES_REVERSAL,

MISCELLANEOUS,

MISCELLANEOUS_REVERSAL,

POINTS,

POINTS_REVERSAL,

REFERRAL_BONUS,

REFERRAL_BONUS_REVERSAL

tenant

string

required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

amount

integer

The default amount of the reward in ISO 4217 minor currency units, e.g. cents. The internal account will be debited this amount. Can be overridden when creating a reward.

Example:

1000

description

string

The description of the reward template.

Example:

"Referral Reward"

metadata

object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Get a Reward template

Authorizations

Path Parameters

Response