Skip to main content
GET
/
spend_controls
List Spend Controls
curl --request GET \
  --url https://api.synctera.com/v2/spend_controls
{
  "spend_controls": [
    {
      "action_case": true,
      "action_decline": true,
      "amount_limit": 1,
      "creation_time": "2010-05-06T12:23:34.321Z",
      "direction": "DEBITS",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "is_active": true,
      "last_modified_time": "2010-05-06T12:23:34.321Z",
      "managed_by": "PLATFORM",
      "merchant_category_codes": [
        "5600–5699"
      ],
      "name": "<string>",
      "payment_sub_types": [
        "ACH.INCOMING_CREDIT"
      ],
      "payment_types": [
        "ACH"
      ],
      "time_range": {
        "days": 16,
        "time_range_type": "ROLLING_WINDOW_DAYS"
      },
      "number_of_related_accounts": 1,
      "tenant": "abcdef_ghijkl"
    }
  ],
  "next_page_token": "a8937a0d"
}

Query Parameters

​
account_id
string<uuid>[]

Originating account IDs. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

​
payment_type
enum<string>

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,
INTERNAL_TRANSFER,
EFT_CA,
EXTERNAL_CARD,
WIRE,
SYNCTERA_PAY
​
amount_limit
integer

return results matching this amount limit

Required range: x >= 0
​
amount_limit_gte
integer

return results with an amount limit greater than or equal to this

Required range: x >= 0
​
amount_limit_lte
integer

return results with an amount limit less than or equal to this

Required range: x >= 0
​
num_related_accounts
integer

return results that are associated with this many accounts

Required range: x >= 0
​
num_related_accounts_gte
integer

return results that are associated with at least this many accounts

Required range: x >= 0
​
num_related_accounts_lte
integer

return results that are associated with at most this many accounts

Required range: x >= 0
​
is_active
boolean

return results that match this active status

​
name
string

return results that match this name

​
direction
enum<string>

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:
DEBITS,
CREDITS
​
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

​
id
string<uuid>[]

IDs. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

​
sort_by
enum<string>[]

Specifies the sort order for returned Spend Controls.

Response

Spend control details

​
spend_controls
object[]
required

Array of Spend Controls

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