List fee configs

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

import requests

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

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/v2/fee_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/fee_configs",
  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/fee_configs"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.synctera.com/v2/fee_configs")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "fee_configs": [
    {
      "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": "ACH Outgoing Debit Fee",
      "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": "Charged when an ACH debit is initiated",
      "in_auth": false,
      "respect_balance_checks": false,
      "reverse_with_parent": true,
      "rule_config": {
        "foreign_transaction": {
          "home_country_code": "US"
        },
        "mcc_based": {
          "mcc_ranges": [
            {
              "lower": "5411",
              "upper": "5499"
            }
          ]
        },
        "schedule_monthly_if_below_minimum": {
          "minimum_balance": 10000
        }
      },
      "template_id": "8b943c51-e4ff-4e57-9558-08cab6b96234"
    }
  ],
  "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"
}

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

fee_configs

List fee configs

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

import requests

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

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/v2/fee_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/fee_configs",
  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/fee_configs"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.synctera.com/v2/fee_configs")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "fee_configs": [
    {
      "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": "ACH Outgoing Debit Fee",
      "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": "Charged when an ACH debit is initiated",
      "in_auth": false,
      "respect_balance_checks": false,
      "reverse_with_parent": true,
      "rule_config": {
        "foreign_transaction": {
          "home_country_code": "US"
        },
        "mcc_based": {
          "mcc_ranges": [
            {
              "lower": "5411",
              "upper": "5499"
            }
          ]
        },
        "schedule_monthly_if_below_minimum": {
          "minimum_balance": 10000
        }
      },
      "template_id": "8b943c51-e4ff-4e57-9558-08cab6b96234"
    }
  ],
  "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"
}

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

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"

description

string[]

description_like

string

Case insensitive wildcard search for description, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.

fee_category

enum<string>[]

The category of event that triggers or schedules this fee. Trigger-based categories (ach:, wire:, card:, account:) fire when a matching transaction is posted. Scheduled categories (schedule:*) fire on a time-based cadence.

Available options:

ach:outgoing,

ach:outgoing_debit,

ach:outgoing_credit,

ach:incoming,

ach:outgoing_credit_return,

ach:incoming_debit_return,

ach:incoming_credit_return,

wire:outgoing_domestic,

wire:outgoing_international,

wire:incoming,

card:atm_withdrawal,

card:atm_out_of_network,

card:foreign_transaction,

card:cash_advance,

card:cash_advance_quasi_cash,

card:cash_advance_gaming_betting,

card:cash_advance_financial_services,

card:mcc_based,

account:overdraft,

account:nsf,

account:statement_paper,

schedule:monthly,

schedule:account_anniversary,

schedule:daily_while_overdrawn,

schedule:monthly_if_dormant,

schedule:monthly_if_below_minimum

fee_category_like

string

Case insensitive wildcard search for fee_category, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.

from_creation_time

string<date-time>

from_last_updated_time

string<date-time>

string<uuid>[]

name

string[]

name_like

string

Case insensitive wildcard search for name, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.

reverse_with_parent

boolean

sort_by

enum<string>[]

Available options:

creation_time:asc,

creation_time:desc,

fee_category:asc,

fee_category:desc

status

enum<string>[]

Available options:

active,

inactive

status_like

string

Case insensitive wildcard search for status, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.

template_id

string<uuid>[]

to_creation_time

string<date-time>

to_last_updated_time

string<date-time>

Response

List of fee configs

fee_configs

object[]

required

Array of fee configs

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"

Update a fee product Create a fee config

⌘I

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

List fee configs

Authorizations

Query Parameters

Response