Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
spend-controls

Add a new authorisation rule

Creates an authorisation rule. It won't be enabled unless it is applied.

{% admonition type="warning" %} An ALLOW rule permits only the transactions that match the specified criteria and blocks all others. For instance, a rule allowing SGD transactions will block all transactions that are not in SGD. {% /admonition %}

post/v3/spend/applications/{clientId}/spend-controls/rules

Path parameters

clientIdstring required

The application client ID.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Request body

type'MCC' | 'CURRENCY'

The type of authorisation rule.

operation'ALLOW' | 'BLOCK'

Determines whether the transactions should be allowed or blocked.

descriptionstring

The description of the authorisation rule.

valuesstring[]

A list of values based on the type of rule. For example, setting MCC as type requires values to be set as ["1234", "5678"].

Response

The created rule.

idinteger

The unique ID for the authorisation rule.

type'MCC' | 'CURRENCY'

The type of authorisation rule.

operation'ALLOW' | 'BLOCK'

Determines whether the transactions should be allowed or blocked.

descriptionstring

The description of the authorisation rule.

valuesstring[]

A list of values based on the type of rule configured.

Example response

{
  "id": 123,
  "description": "my authorisation rule",
  "type": "MCC",
  "operation": "BLOCK",
  "values": [
    "1234",
    "5678"
  ]
}