v1

latestSwagger 2.02026-08-047766481.4 KB
notification thresholds

Add a notification threshold to an account

Requires accounts:read and either of accounts:write or accounts:write:all scopes.

post/accounts/{accountId}/notification-thresholds

Path parameters

accountIdstring uuid required

The Account Id

Request body

valueinteger required

The value of the threshold in minor units of the currency, eg. pennies for GBP. This can also be a negative value e.g. -10000.

type'gt' | 'lt' required

The type of threshold, either great than or less than

Example request

{
  "value": 10000,
  "type": "lt"
}

Response

Successful Notification Threshold Response

metaobject

Example response

{
  "data": {
    "id": "199cae84-6876-4dc6-b905-9de7593be6d0",
    "value": 10000,
    "type": "lt"
  }
}