Create a fee config

curl --request POST \
  --url https://api.synctera.com/v2/fee_configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_config": {
    "config": {}
  },
  "name": "ACH Outgoing Debit Fee",
  "template_id": "8b943c51-e4ff-4e57-9558-08cab6b96234",
  "description": "Charged when an ACH debit is initiated",
  "in_auth": false,
  "respect_balance_checks": false,
  "reverse_with_parent": true,
  "rule_config": {}
}
'

import requests

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

payload = {
    "amount_config": { "config": {} },
    "name": "ACH Outgoing Debit Fee",
    "template_id": "8b943c51-e4ff-4e57-9558-08cab6b96234",
    "description": "Charged when an ACH debit is initiated",
    "in_auth": False,
    "respect_balance_checks": False,
    "reverse_with_parent": True,
    "rule_config": {}
}
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: 'ACH Outgoing Debit Fee',
    template_id: '8b943c51-e4ff-4e57-9558-08cab6b96234',
    description: 'Charged when an ACH debit is initiated',
    in_auth: false,
    respect_balance_checks: false,
    reverse_with_parent: true,
    rule_config: {}
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount_config' => [
        'config' => [
                
        ]
    ],
    'name' => 'ACH Outgoing Debit Fee',
    'template_id' => '8b943c51-e4ff-4e57-9558-08cab6b96234',
    'description' => 'Charged when an ACH debit is initiated',
    'in_auth' => false,
    'respect_balance_checks' => false,
    'reverse_with_parent' => true,
    'rule_config' => [
        
    ]
  ]),
  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/fee_configs"

	payload := strings.NewReader("{\n  \"amount_config\": {\n    \"config\": {}\n  },\n  \"name\": \"ACH Outgoing Debit Fee\",\n  \"template_id\": \"8b943c51-e4ff-4e57-9558-08cab6b96234\",\n  \"description\": \"Charged when an ACH debit is initiated\",\n  \"in_auth\": false,\n  \"respect_balance_checks\": false,\n  \"reverse_with_parent\": true,\n  \"rule_config\": {}\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/fee_configs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount_config\": {\n    \"config\": {}\n  },\n  \"name\": \"ACH Outgoing Debit Fee\",\n  \"template_id\": \"8b943c51-e4ff-4e57-9558-08cab6b96234\",\n  \"description\": \"Charged when an ACH debit is initiated\",\n  \"in_auth\": false,\n  \"respect_balance_checks\": false,\n  \"reverse_with_parent\": true,\n  \"rule_config\": {}\n}")
  .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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount_config\": {\n    \"config\": {}\n  },\n  \"name\": \"ACH Outgoing Debit Fee\",\n  \"template_id\": \"8b943c51-e4ff-4e57-9558-08cab6b96234\",\n  \"description\": \"Charged when an ACH debit is initiated\",\n  \"in_auth\": false,\n  \"respect_balance_checks\": false,\n  \"reverse_with_parent\": true,\n  \"rule_config\": {}\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": "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"
}

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

fee_configs

Create a fee config

curl --request POST \
  --url https://api.synctera.com/v2/fee_configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_config": {
    "config": {}
  },
  "name": "ACH Outgoing Debit Fee",
  "template_id": "8b943c51-e4ff-4e57-9558-08cab6b96234",
  "description": "Charged when an ACH debit is initiated",
  "in_auth": false,
  "respect_balance_checks": false,
  "reverse_with_parent": true,
  "rule_config": {}
}
'

import requests

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

payload = {
    "amount_config": { "config": {} },
    "name": "ACH Outgoing Debit Fee",
    "template_id": "8b943c51-e4ff-4e57-9558-08cab6b96234",
    "description": "Charged when an ACH debit is initiated",
    "in_auth": False,
    "respect_balance_checks": False,
    "reverse_with_parent": True,
    "rule_config": {}
}
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: 'ACH Outgoing Debit Fee',
    template_id: '8b943c51-e4ff-4e57-9558-08cab6b96234',
    description: 'Charged when an ACH debit is initiated',
    in_auth: false,
    respect_balance_checks: false,
    reverse_with_parent: true,
    rule_config: {}
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount_config' => [
        'config' => [
                
        ]
    ],
    'name' => 'ACH Outgoing Debit Fee',
    'template_id' => '8b943c51-e4ff-4e57-9558-08cab6b96234',
    'description' => 'Charged when an ACH debit is initiated',
    'in_auth' => false,
    'respect_balance_checks' => false,
    'reverse_with_parent' => true,
    'rule_config' => [
        
    ]
  ]),
  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/fee_configs"

	payload := strings.NewReader("{\n  \"amount_config\": {\n    \"config\": {}\n  },\n  \"name\": \"ACH Outgoing Debit Fee\",\n  \"template_id\": \"8b943c51-e4ff-4e57-9558-08cab6b96234\",\n  \"description\": \"Charged when an ACH debit is initiated\",\n  \"in_auth\": false,\n  \"respect_balance_checks\": false,\n  \"reverse_with_parent\": true,\n  \"rule_config\": {}\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/fee_configs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount_config\": {\n    \"config\": {}\n  },\n  \"name\": \"ACH Outgoing Debit Fee\",\n  \"template_id\": \"8b943c51-e4ff-4e57-9558-08cab6b96234\",\n  \"description\": \"Charged when an ACH debit is initiated\",\n  \"in_auth\": false,\n  \"respect_balance_checks\": false,\n  \"reverse_with_parent\": true,\n  \"rule_config\": {}\n}")
  .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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount_config\": {\n    \"config\": {}\n  },\n  \"name\": \"ACH Outgoing Debit Fee\",\n  \"template_id\": \"8b943c51-e4ff-4e57-9558-08cab6b96234\",\n  \"description\": \"Charged when an ACH debit is initiated\",\n  \"in_auth\": false,\n  \"respect_balance_checks\": false,\n  \"reverse_with_parent\": true,\n  \"rule_config\": {}\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": "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"
}

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

Fee 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

fee_category

enum<string>

required

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

name

string

required

Human-readable name for this fee rule.

Example:

"ACH Outgoing Debit Fee"

template_id

string<uuid>

required

ID of the fee template that provides accounting setup (internal account, currency, subtype) for automated fee posting. Required for trigger-based and scheduled fees.

Example:

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

description

string

Description of this fee rule.

Example:

"Charged when an ACH debit is initiated"

in_auth

boolean

default:false

When true, this fee is evaluated and held at authorization time (when the parent hold is created) rather than post-hoc when the transaction is posted. The fee hold is batched with the main hold in a single atomic centinel request.

Example:

false

respect_balance_checks

boolean

When true, posting this fee respects the account's balance constraints. If the account has insufficient balance at the time of posting, the fee is held rather than posted immediately. A daily retry job will attempt to post held fees once the account balance is sufficient.

Example:

false

reverse_with_parent

boolean

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

Example:

true

rule_config

object

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

Show child attributes

status

enum<string>

Available options:

active,

inactive

Response

Created fee config

amount_config

object

required

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

Show child attributes

fee_category

enum<string>

required

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

name

string

required

Human-readable name for this fee rule.

Example:

"ACH Outgoing Debit Fee"

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 fee 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 fee rule.

Example:

"Charged when an ACH debit is initiated"

in_auth

boolean

default:false

Example:

false

respect_balance_checks

boolean

Example:

false

reverse_with_parent

boolean

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

Example:

true

rule_config

object

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

Show child attributes

template_id

string<uuid>

ID of the fee template that provides accounting setup (internal account, currency, subtype) for automated fee posting. Required for trigger-based and scheduled fees.

Example:

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

List fee configs Get a fee config

⌘I

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Create a fee config

Authorizations

Headers

Body

Response