List rewards

curl --request GET \
  --url https://api.synctera.com/v2/rewards \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.synctera.com/v2/rewards', 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/rewards",
  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/v2/rewards"

	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/v2/rewards")

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

{
  "rewards": [
    {
      "account_id": "12943c51-e4ff-4e57-9558-08cab6b96364",
      "amount": 1000,
      "template_id": "64943c51-e4ff-4e57-9558-08cab6b96352",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "currency": "USD",
      "description": "Referral Reward",
      "id": "44943c51-e4ff-4e57-9558-08cab6b96321",
      "internal_account_id": "42943c51-e4ff-4e57-9558-08cab6b963c8",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "subtype": "ACCOUNT_OPENING_BONUS",
      "tenant": "abcdef_ghijkl",
      "transaction_id": "11943c51-e4ff-4e57-9558-08cab6b96333",
      "metadata": {},
      "note": "Reduced account reward based on phone call with customer",
      "derived_from_uuid": "55943c51-e4ff-4e57-9558-08cab6b96400",
      "reward_category": "cashback:card:mcc",
      "reward_config_id": "77943c51-e4ff-4e57-9558-08cab6b96600",
      "reward_product_id": "66943c51-e4ff-4e57-9558-08cab6b96500"
    }
  ],
  "next_page_token": "a8937a0d"
}

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

GET

rewards

List rewards

curl --request GET \
  --url https://api.synctera.com/v2/rewards \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.synctera.com/v2/rewards', 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/rewards",
  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/v2/rewards"

	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/v2/rewards")

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

{
  "rewards": [
    {
      "account_id": "12943c51-e4ff-4e57-9558-08cab6b96364",
      "amount": 1000,
      "template_id": "64943c51-e4ff-4e57-9558-08cab6b96352",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "currency": "USD",
      "description": "Referral Reward",
      "id": "44943c51-e4ff-4e57-9558-08cab6b96321",
      "internal_account_id": "42943c51-e4ff-4e57-9558-08cab6b963c8",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "subtype": "ACCOUNT_OPENING_BONUS",
      "tenant": "abcdef_ghijkl",
      "transaction_id": "11943c51-e4ff-4e57-9558-08cab6b96333",
      "metadata": {},
      "note": "Reduced account reward based on phone call with customer",
      "derived_from_uuid": "55943c51-e4ff-4e57-9558-08cab6b96400",
      "reward_category": "cashback:card:mcc",
      "reward_config_id": "77943c51-e4ff-4e57-9558-08cab6b96600",
      "reward_product_id": "66943c51-e4ff-4e57-9558-08cab6b96500"
    }
  ],
  "next_page_token": "a8937a0d"
}

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

Query Parameters

string<uuid>[]

Return the reward with the specified id. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

reward_template_id

string<uuid>[]

Return rewards resources with a reward template of the specified id. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

description

string

Return rewards with the specified description.

subtype

enum<string>

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

start_time

string<date-time>

Return rewards created at or after this time.

end_time

string<date-time>

Return rewards created before this time.

account_id

string<uuid>[]

Return rewards for the specified account.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

derived_from_uuid

string<uuid>[]

Return rewards that were derived from (triggered by) the specified transaction UUID. Useful for surfacing the rewards associated with a given posted/pending transaction. Multiple IDs can be provided as a comma-separated list.

Example:

"54702cd9-789a-4a89-b2c6-ee168d26c540"

limit

integer

default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1

Example:

100

page_token

string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

Response

List of rewards

rewards

Reward response object · object[]

required

Array of rewards

Show child attributes

next_page_token

string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

List rewards

Authorizations

Query Parameters

Response