Update a fee config

curl --request PATCH \
  --url https://api.synctera.com/v1/fee_configs/{fee_config_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "in_auth": true,
  "name": "<string>",
  "respect_balance_checks": true,
  "reverse_with_parent": true,
  "rule_config": {},
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.synctera.com/v1/fee_configs/{fee_config_id}"

payload = {
    "description": "<string>",
    "in_auth": True,
    "name": "<string>",
    "respect_balance_checks": True,
    "reverse_with_parent": True,
    "rule_config": {},
    "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    in_auth: true,
    name: '<string>',
    respect_balance_checks: true,
    reverse_with_parent: true,
    rule_config: {},
    template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.synctera.com/v1/fee_configs/{fee_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/fee_configs/{fee_config_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'in_auth' => true,
    'name' => '<string>',
    'respect_balance_checks' => true,
    'reverse_with_parent' => true,
    'rule_config' => [
        
    ],
    'template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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/v1/fee_configs/{fee_config_id}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"in_auth\": true,\n  \"name\": \"<string>\",\n  \"respect_balance_checks\": true,\n  \"reverse_with_parent\": true,\n  \"rule_config\": {},\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.synctera.com/v1/fee_configs/{fee_config_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"in_auth\": true,\n  \"name\": \"<string>\",\n  \"respect_balance_checks\": true,\n  \"reverse_with_parent\": true,\n  \"rule_config\": {},\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"in_auth\": true,\n  \"name\": \"<string>\",\n  \"respect_balance_checks\": true,\n  \"reverse_with_parent\": true,\n  \"rule_config\": {},\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "creation_time": "2024-01-15T10:00:00Z",
  "id": "5c943c51-e4ff-4e57-9558-08cab6b96398",
  "last_updated_time": "2024-06-01T12:00:00Z",
  "tenant": "abcdef_ghijkl",
  "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",
  "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
}

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

PATCH

fee_configs

{fee_config_id}

Update a fee config

curl --request PATCH \
  --url https://api.synctera.com/v1/fee_configs/{fee_config_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "in_auth": true,
  "name": "<string>",
  "respect_balance_checks": true,
  "reverse_with_parent": true,
  "rule_config": {},
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.synctera.com/v1/fee_configs/{fee_config_id}"

payload = {
    "description": "<string>",
    "in_auth": True,
    "name": "<string>",
    "respect_balance_checks": True,
    "reverse_with_parent": True,
    "rule_config": {},
    "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    in_auth: true,
    name: '<string>',
    respect_balance_checks: true,
    reverse_with_parent: true,
    rule_config: {},
    template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.synctera.com/v1/fee_configs/{fee_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/fee_configs/{fee_config_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'in_auth' => true,
    'name' => '<string>',
    'respect_balance_checks' => true,
    'reverse_with_parent' => true,
    'rule_config' => [
        
    ],
    'template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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/v1/fee_configs/{fee_config_id}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"in_auth\": true,\n  \"name\": \"<string>\",\n  \"respect_balance_checks\": true,\n  \"reverse_with_parent\": true,\n  \"rule_config\": {},\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.synctera.com/v1/fee_configs/{fee_config_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"in_auth\": true,\n  \"name\": \"<string>\",\n  \"respect_balance_checks\": true,\n  \"reverse_with_parent\": true,\n  \"rule_config\": {},\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"in_auth\": true,\n  \"name\": \"<string>\",\n  \"respect_balance_checks\": true,\n  \"reverse_with_parent\": true,\n  \"rule_config\": {},\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "creation_time": "2024-01-15T10:00:00Z",
  "id": "5c943c51-e4ff-4e57-9558-08cab6b96398",
  "last_updated_time": "2024-06-01T12:00:00Z",
  "tenant": "abcdef_ghijkl",
  "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",
  "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
}

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

fee_config_id

string<uuid>

required

Unique identifier of a fee config.

Example:

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

Body

application/json

Fee config fields to update

Partial update for a fee config. Omitted fields are left unchanged. amount_config and rule_config are each replaced atomically when provided. Neither amount_config nor rule_config can be cleared; omit them to leave them unchanged.

amount_config

object

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

Show child attributes

description

string

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:

account:nsf,

account:overdraft,

account:statement_paper,

ach:incoming,

ach:incoming_credit_return,

ach:incoming_debit_return,

ach:outgoing,

ach:outgoing_credit,

ach:outgoing_credit_return,

ach:outgoing_debit,

card:atm_out_of_network,

card:atm_withdrawal,

card:cash_advance,

card:cash_advance_financial_services,

card:cash_advance_gaming_betting,

card:cash_advance_quasi_cash,

card:foreign_transaction,

card:mcc_based,

schedule:account_anniversary,

schedule:daily_while_overdrawn,

schedule:monthly,

schedule:monthly_if_below_minimum,

schedule:monthly_if_dormant,

wire:incoming,

wire:outgoing_domestic,

wire:outgoing_international

in_auth

boolean

name

string

respect_balance_checks

boolean

reverse_with_parent

boolean

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

template_id

string<uuid>

Response

Updated fee config

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.

Example:

"abcdef_ghijkl"

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:

account:nsf,

account:overdraft,

account:statement_paper,

ach:incoming,

ach:incoming_credit_return,

ach:incoming_debit_return,

ach:outgoing,

ach:outgoing_credit,

ach:outgoing_credit_return,

ach:outgoing_debit,

card:atm_out_of_network,

card:atm_withdrawal,

card:cash_advance,

card:cash_advance_financial_services,

card:cash_advance_gaming_betting,

card:cash_advance_quasi_cash,

card:foreign_transaction,

card:mcc_based,

schedule:account_anniversary,

schedule:daily_while_overdrawn,

schedule:monthly,

schedule:monthly_if_below_minimum,

schedule:monthly_if_dormant,

wire:incoming,

wire:outgoing_domestic,

wire:outgoing_international

name

string

required

Human-readable name for this fee rule.

Example:

"ACH Outgoing Debit Fee"

status

enum<string>

required

Available options:

active,

inactive

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

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"

Get a fee config List fee categories

⌘I

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Update a fee config

Authorizations

Path Parameters

Body

Response