Skip to main content
POST
/
spend_controls
Create Spend Control
curl --request POST \
  --url https://api.synctera.com/v1/spend_controls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action_case": true,
  "action_decline": true,
  "direction": "CREDITS",
  "is_active": true,
  "name": "<string>",
  "time_range": {
    "time_range_type": "FOREVER"
  },
  "aggregation_level": "ACCOUNT",
  "amount_limit": 1,
  "geo_restrictions": {
    "countries": [
      "CA",
      "GB",
      "US"
    ],
    "mode": "ALLOW_LIST",
    "country_sources": [
      "COUNTER_PARTY"
    ]
  },
  "managed_by": "BANK",
  "merchant_category_codes": [
    "5600–5699"
  ],
  "payment_sub_types": [
    "<string>"
  ],
  "payment_types": [
    "ACH"
  ],
  "scope": "ACCOUNT",
  "transaction_count_limit": 1
}
'
{
  "number_of_related_accounts": 1,
  "number_of_related_cards": 1,
  "number_of_related_customers": 1,
  "tenant": "abcdef_ghijkl",
  "action_case": true,
  "action_decline": true,
  "creation_time": "2010-05-06T12:23:34.321Z",
  "direction": "CREDITS",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "is_active": true,
  "last_modified_time": "2010-05-06T12:23:34.321Z",
  "name": "<string>",
  "time_range": {
    "time_range_type": "FOREVER"
  },
  "aggregation_level": "ACCOUNT",
  "amount_limit": 1,
  "geo_restrictions": {
    "countries": [
      "CA",
      "GB",
      "US"
    ],
    "mode": "ALLOW_LIST",
    "country_sources": [
      "COUNTER_PARTY"
    ]
  },
  "managed_by": "BANK",
  "merchant_category_codes": [
    "5600–5699"
  ],
  "payment_sub_types": [
    "<string>"
  ],
  "payment_types": [
    "ACH"
  ],
  "scope": "ACCOUNT",
  "transaction_count_limit": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Details of the spend control to create

​
action_case
boolean
required

If set, create a case for transactions that do not conform to the spend control

​
action_decline
boolean
required

If set, decline transactions that do not conform to the spend control

​
direction
enum<string>
required

The direction of funds flow to which a spend control applies. To limit the rate of funds flowing out of an account, use DEBIT. To limit the rate of funds flowing in to an account, use CREDIT. If this is not set, the spend control applies to debits (ie spending) only.

Available options:
CREDITS,
DEBITS
​
is_active
boolean
required

Indicates if spend control is active

Example:

true

​
name
string
required

Name assigned to spend control

​
time_range
Forever · object
required

The time range to which the spend control applies

​
aggregation_level
enum<string>

Controls how spend is measured for enforcement:

  • ACCOUNT - Per-account: each account's spend is checked independently (default)
  • CUSTOMER - Per-customer: spend is aggregated across all accounts owned by the customer
  • CARDS - Per-card: spend is aggregated per specific card
Available options:
ACCOUNT,
CARDS,
CUSTOMER
​
amount_limit
integer<int64>

Monetary limit for the spend control in the smallest currency unit (eg cents). At least one of amount_limit and transaction_count_limit must be specified.

Required range: x >= 0
​
geo_restrictions
object

Geographic restrictions for spend controls

​
managed_by
enum<string>

The type of resource manager

Available options:
BANK,
FINTECH,
PLATFORM
​
merchant_category_codes
string[]

merchant category codes for spend control

Maximum array length: 10

specify a specific MCC or a range of MCCs using a dash (-)

Pattern: ^\d{4}(-\d{4})?$
​
payment_sub_types
string[]

A list of payment sub-types to which a spend control will apply, if set. If not set or the array is empty, then the spend control will apply to all sub-types.

​
payment_types
enum<string>[]

A list of payment types to which a spend control will apply, if set. If not set or the array is empty, then the spend control will apply to all types of payments.

The type of payment to which a spend control applies. If this is not set, the spend control applies to all spending, regardless of payment type.

Available options:
ACH,
CARD,
CASH,
CHECK,
EFT_CA,
EXTERNAL_CARD,
INTERNAL_TRANSFER,
SYNCTERA_PAY,
WIRE
​
scope
enum<string>
default:ACCOUNT

The scope determines which accounts this spend control applies to:

  • ACCOUNT - Applies only to accounts explicitly linked via account mappings (default)
  • CUSTOMER - Applies only to customers explicitly linked via customer mappings
  • CARDS - Applies only to cards explicitly linked via card mappings
  • FINTECH - Automatically applies to all accounts under the fintech tenant
  • BANK - Automatically applies to all accounts under the bank tenant
Available options:
ACCOUNT,
BANK,
CARDS,
CUSTOMER,
FINTECH
​
transaction_count_limit
integer<int64>

Number of transactions allowed by the spend control, regardless of transaction amounts. At least one of amount_limit and transaction_count_limit must be specified.

Required range: x >= 0

Response

Spend control details

​
number_of_related_accounts
integer
required

A count of how many accounts are using this spend control

Required range: x >= 0
​
number_of_related_cards
integer
required

A count of how many cards are using this spend control

Required range: x >= 0
​
number_of_related_customers
integer
required

A count of how many customers are using this spend control

Required range: x >= 0
​
tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

​
action_case
boolean
required

If set, create a case for transactions that do not conform to the spend control

​
action_decline
boolean
required

If set, decline transactions that do not conform to the spend control

​
creation_time
string<date-time>
required

The timestamp representing when the spend control was created

Example:

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

​
direction
enum<string>
required

The direction of funds flow to which a spend control applies. To limit the rate of funds flowing out of an account, use DEBIT. To limit the rate of funds flowing in to an account, use CREDIT. If this is not set, the spend control applies to debits (ie spending) only.

Available options:
CREDITS,
DEBITS
​
id
string<uuid>
required

Spend Control ID

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
is_active
boolean
required

Indicates if spend control is active

Example:

true

​
last_modified_time
string<date-time>
required

The timestamp representing when the spend control was last modified

Example:

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

​
name
string
required

Name assigned to spend control

​
time_range
Forever · object
required

The time range to which the spend control applies

​
aggregation_level
enum<string>

Controls how spend is measured for enforcement:

  • ACCOUNT - Per-account: each account's spend is checked independently (default)
  • CUSTOMER - Per-customer: spend is aggregated across all accounts owned by the customer
  • CARDS - Per-card: spend is aggregated per specific card
Available options:
ACCOUNT,
CARDS,
CUSTOMER
​
amount_limit
integer<int64>

Monetary limit for the spend control in the smallest currency unit (eg cents). At least one of amount_limit and transaction_count_limit must be specified.

Required range: x >= 0
​
geo_restrictions
object

Geographic restrictions for spend controls

​
managed_by
enum<string>

The type of resource manager

Available options:
BANK,
FINTECH,
PLATFORM
​
merchant_category_codes
string[]

merchant category codes for spend control

Maximum array length: 10

specify a specific MCC or a range of MCCs using a dash (-)

Pattern: ^\d{4}(-\d{4})?$
​
payment_sub_types
string[]

A list of payment sub-types to which a spend control will apply, if set. If not set or the array is empty, then the spend control will apply to all sub-types.

​
payment_types
enum<string>[]

A list of payment types to which a spend control will apply, if set. If not set or the array is empty, then the spend control will apply to all types of payments.

The type of payment to which a spend control applies. If this is not set, the spend control applies to all spending, regardless of payment type.

Available options:
ACH,
CARD,
CASH,
CHECK,
EFT_CA,
EXTERNAL_CARD,
INTERNAL_TRANSFER,
SYNCTERA_PAY,
WIRE
​
scope
enum<string>
default:ACCOUNT

The scope determines which accounts this spend control applies to:

  • ACCOUNT - Applies only to accounts explicitly linked via account mappings (default)
  • CUSTOMER - Applies only to customers explicitly linked via customer mappings
  • CARDS - Applies only to cards explicitly linked via card mappings
  • FINTECH - Automatically applies to all accounts under the fintech tenant
  • BANK - Automatically applies to all accounts under the bank tenant
Available options:
ACCOUNT,
BANK,
CARDS,
CUSTOMER,
FINTECH
​
transaction_count_limit
integer<int64>

Number of transactions allowed by the spend control, regardless of transaction amounts. At least one of amount_limit and transaction_count_limit must be specified.

Required range: x >= 0