Create Spend Control

Create a spend control

Request body

action_caseboolean required

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

action_declineboolean required

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

amount_limitinteger required

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

creation_timestring date-time

The timestamp representing when the spend control was created

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.

idstring uuid

Spend Control ID

is_activeboolean required

Indicates if spend control is active

last_modified_timestring date-time

The timestamp representing when the spend control was last modified

merchant_category_codesstring[]

merchant category codes for spend control

namestring required

Name assigned to spend control

payment_sub_typesstring[]

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_typesPaymentType[]

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.

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

The scope of the spend control

Example request

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

Response

Spend control details

number_of_related_accountsinteger required

A count of how many accounts are using this spend control