Create an authorisation control beta

Creates an authorisation control for a given card. This prevents the card from being used with certain merchants, specified by their Merchant Category Code (MCC) or Merchant Identifier (MID).

Use mcc to block an entire merchant category or mid to block a specific merchant.

You can update a card's authorisation control at any point.

SecurityCommonAuth
Request
path Parameters
cardId
required
string <uuid> <= 36 characters

The ID of the card to work with.

Example: e9293471-5eb3-4dbc-916c-dbaf9e2deefd
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
personId
string <uuid> <= 36 characters

The ID of the person to work with.

Example: personId=775596ae-2624-40af-a9dc-9756110a4a04
Request Body schema: application/json

Body

name
required
string <= 255 characters

The name of the authorisation control.

id
string <uuid> <= 36 characters

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

active
boolean

If the auth control is active. Default is true.

startTime
string <date-time>

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

endTime
string <date-time>

Date and time when the control ends, in UTC.

object
Responses
201

Created

post/cards/{cardId}/auth-controls
Request samples
application/json
{
  • "name": "Spending controls",
  • "id": "a1e54aed-8a68-4602-a792-30f4c67497cf",
  • "active": true,
  • "startTime": "2023-03-14T12:08:53Z",
  • "endTime": "2023-03-14T12:08:53Z",
  • "merchantScope": {
    }
}
Response samples
application/json
{
  • "name": "Spending controls",
  • "id": "a1e54aed-8a68-4602-a792-30f4c67497cf",
  • "active": true,
  • "startTime": "2023-03-14T12:08:53Z",
  • "endTime": "2023-03-14T12:08:53Z",
  • "merchantScope": {
    }
}