v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Spend Controls

List Spend Controls

List spend controls

get/spend_controls

Query parameters

amount_limit_gteinteger

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

amount_limit_lteinteger

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

scope'ACCOUNT' | 'BANK' | 'FINTECH'

The scope of the spend control

return results with this scope

num_related_accounts_gteinteger

return results that are associated with at least this many accounts

num_related_accountsinteger

return results that are associated with this many accounts

num_related_accounts_lteinteger

return results that are associated with at most this many accounts

sort_bystring[]

Specifies the sort order for returned Spend Controls.

payment_type'ACH' | 'CARD' | 'CASH' | 'CHECK' | 'EFT_CA' | 'EXTERNAL_CARD' | 'INTERNAL_TRANSFER' | 'SYNCTERA_PAY' | 'WIRE'

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.

namestring

return results that match this name

idstring[]

return results with these comma-separated IDs

direction'CREDITS' | 'DEBITS'

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.

is_activeboolean

return results that match this active status

limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100
account_idstring uuid
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

return results matching this account ID

amount_limitinteger

return results matching this amount limit

Response

Spend control details

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "spend_controls": [
    {
      "creation_time": "2010-05-06T12:23:34.321Z",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "is_active": true,
      "last_modified_time": "2010-05-06T12:23:34.321Z",
      "merchant_category_codes": [
        "5600–5699"
      ]
    }
  ],
  "next_page_token": "a8937a0d"
}