Sign in

v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
Merchant controls

Update an authorisation control

Updates the details of a given authorisation control.

put/cards/{cardId}/auth-controls/{authControlId}

Path parameters

cardIdstring uuid required

The ID of the card to work with.

Example:e9293471-5eb3-4dbc-916c-dbaf9e2deefd
authControlIdstring uuid required

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091
personIdstring uuid

The ID of the person to work with.

Example:775596ae-2624-40af-a9dc-9756110a4a04

Request body

namestring

The name of the authorisation control.

activeboolean

If the auth control is active. Default is true.

startTimestring date-time

Date and time when the control goes into effect, in UTC.

endTimestring date-time

Date and time when the control ends, in UTC.

Example request

{
  "name": "Spending controls",
  "active": true,
  "startTime": "2023-03-14T12:08:53Z",
  "endTime": "2023-03-14T12:08:53Z",
  "merchantScope": {
    "mcc": "3596",
    "mid": "string",
    "mccGroup": "Airlines"
  }
}

Response

OK

namestring required

The name of the authorisation control.

idstring uuid

Unique identifier of the resource. If an id is not provided one will be generated.

activeboolean

If the auth control is active. Default is true.

startTimestring date-time

Date and time when the control goes into effect, in UTC.

endTimestring date-time

Date and time when the control ends, in UTC.

Example response

{
  "name": "Spending controls",
  "id": "a1e54aed-8a68-4602-a792-30f4c67497cf",
  "active": true,
  "startTime": "2023-03-14T12:08:53Z",
  "endTime": "2023-03-14T12:08:53Z",
  "merchantScope": {
    "mcc": "3596",
    "mid": "string",
    "mccGroup": "Airlines"
  }
}