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,
  "amount_limit": 1,
  "direction": "CREDITS",
  "is_active": true,
  "managed_by": "BANK",
  "merchant_category_codes": [
    "5600–5699"
  ],
  "name": "<string>",
  "payment_sub_types": [
    "ACH.INCOMING_CREDIT"
  ],
  "payment_types": [
    "ACH"
  ],
  "time_range": {
    "time_range_type": "ROLLING_WINDOW_DAYS"
  }
}'
{
  "action_case": true,
  "action_decline": true,
  "amount_limit": 1,
  "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",
  "managed_by": "BANK",
  "merchant_category_codes": [
    "5600–5699"
  ],
  "name": "<string>",
  "payment_sub_types": [
    "ACH.INCOMING_CREDIT"
  ],
  "payment_types": [
    "ACH"
  ],
  "time_range": {
    "time_range_type": "ROLLING_WINDOW_DAYS"
  },
  "number_of_related_accounts": 1,
  "tenant": "abcdef_ghijkl"
}

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

​
amount_limit
integer
required

Monetary limit for the spend control in the smallest currency unit (eg cents)

Required range: x >= 0
​
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
object
required

The time range to which the spend control applies

​
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 length: 10

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

​
payment_sub_types
enum<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.

Response

Spend control details

​
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

​
amount_limit
integer
required

Monetary limit for the spend control in the smallest currency unit (eg cents)

Required range: x >= 0
​
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
object
required

The time range to which the spend control applies

​
number_of_related_accounts
integer
required

A count of how many accounts are using this spend control

Required range: x >= 0
​
tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

​
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 length: 10

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

​
payment_sub_types
enum<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.