RocketKOR

COMING SOON

Update, Activate, or Deactivate a Card Restriction

Update a restriction that has been created for an issued card. You can also activate or deactivate a restriction by setting active to true or false.

To update, activate, or deactivate a restriction, you will need:

  • ID of the integrated Financial Account linked to the issued card
  • ID of the restriction

Endpoint

PUT /v1/integrated-cards/{financialAccountId}/restrictions/{id}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

financialAccountId  REQUIRED

string (UUID)

ID of the integrated Financial Account linked to the issued card.

id  REQUIRED

string (UUID)

ID of the card restriction.

Request Body

financialAccountId

string (UUID)

This parameter has been deprecated in favor of the financialAccountId path parameter.

type  

string enum

Type of card restriction. The following values are supported.

Acquirer Controls

Value

Description

ACQUIRER_ID

Acquirer ID

ACQUIRER_ID_MERCHANT_ID

Acquirer ID and Merchant ID

ACQUIRER_ID_DEVICE_ID

Acquirer ID and Device ID

Merchant Controls

Value

Description

MERCHANT_ID

Merchant ID

MERCHANT_NAME

Merchant Name

BRAND_MERCHANT_ID

Brand Merchant ID

MERCHANT_GROUPS

Merchant Group ID

MCC_GROUPS

Merchant Category Code (MCC) Group ID

Device Controls

Value

Description

DEVICE_OR_TERMINAL_ID

Device or Terminal ID

Channel Controls

Value

Description

BLOCK_ONLINE_TRANSACTIONS

Block Online Transactions

BLOCK_POS_PURCHASES

Block POS (point of sale) Purchases

BLOCK_ATM_WITHDRAWALS

Block ATM Withdrawals

BLOCK_PHONE_AND_MAIL_TRANSACTIONS 

Block by Phone or Mail Transactions

BLOCK_INTERNATIONAL_TRANSACTIONS_CH

Block International Transactions

Transaction Limit Controls

Value

Description

PURCHASE_TRANSACTION_AMOUNT_LIMIT

Purchase Transaction Amount Limit

DAILY_PURCHASE_LIMIT

Daily Purchase Limit

CASH_WITHDRAWAL_TRANSACTION_AMOUNT_LIMIT

Cash Withdrawal Transaction Amount Limit

DAILY_CASH_WITHDRAWAL_LIMIT

Daily Cash Withdrawal Limit

Location Controls

Value

Description

CITY

City

STATE

State

COUNTRY

Country

COUNTRY_ZIPCODE

Country and Zip Code

CARDHOLDER_CITY

Cardholder City

CARDHOLDER_STATE

Cardholder State

CARDHOLDER_COUNTRY

Cardholder Country

BLOCK_INTERNATIONAL_TRANSACTIONS_LOC

Block International Transactions

BLOCK_DOMESTIC_TRANSACTIONS_LOC

Block Domestic Transactions

Load Controls

Value

Description

MAXIMUM_CARD_BALANCE_LIMIT

Maximum Card Balance Limit

DAILY_LOAD_AMOUNT

Daily Load Amount

DAILY_LOAD_FREQUENCY

Daily Load Frequency

MONTHLY_LOAD_AMOUNT

Monthly Load Amount

MONTHLY_LOAD_FREQUENCY

Monthly Load Frequency

operator  

string enum, values: EQ, NE, GT, GE, LT, LE, BW, NB, IN, NI, CT, NC, LK, NL

Operates on the restriction value. The following values are supported:

  • EQ  Equal to
  • NE  Not equal to
  • GT  Greater than
  • GE  Greater than or equal to
  • LT  Less than
  • LE  Less than or equal to
  • BW  Between
  • NB  Not between
  • IN  In
  • NI  Not in
  • CT  Contains
  • NC  Not contains
  • LK  Like
  • NL  Not like

value  

string

Value of the restriction.

If type is set to MERCHANT_GROUPS, enter one or more Merchant Group IDs.

If type is set to MCC_GROUPS, enter one or more Merchant Category Code (MCC) Group IDs.

mode  

string enum, values: ALLOW, BLOCK

Whether transactions that comply with the restriction should be allowed or blocked. The following values are supported:

  • ALLOW  Allow transactions that comply with the restriction.
  • BLOCK  Block transactions that comply with the restriction.

active

boolean, default: true

Whether the restriction is active.

startDateTime

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Start date and time of the restriction. To create a permanent restriction, leave this field blank.

endDateTime

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

End date and time of the restriction. To create a permanent restriction, leave this field blank.

Returns

Returns the Card Restriction object. This object contains the restriction details.

SAMPLE REQUEST

				
					{
  "active": true
}
				
			

SAMPLE RESPONSE

				
					{
  "financialAccountId": "7d08a89d-2ac5-4ed3-a6ca-ad7c974c994e",
  "type": "ACQUIRER_ID",
  "operator": "EQ",
  "value": "1234",
  "mode": "ALLOW",
  "active": true,
  "startDateTime": "2023-02-13T02:36:05.410Z",
  "endDateTime": "2024-02-13T02:36:05.410Z",
  "id": "9e573a4c-7859-4ec2-bf57-aace7dcf5981",
  "createdBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "employee"
  },
  "createdAt": "2021-09-20T22:09:31.947Z",
  "updatedBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "employee"
  },
  "updatedAt": "2021-10-20T22:09:31.947Z"
}