# Visa Transaction Controls
Empower consumers to control how, when and where their cards are used.

## Version: 1

### Servers

| URL | Description |
| --- | ----------- |
| https://sandbox.api.visa.com | Sandbox server |

---
## Authorization Decision API
The Authorization Decision API enables an authorization processor to request an authorization decision recommendation based on cardholder rules configured in consumer transaction controls.  In addition, the API enables the authorization processor to update an authorization decision with the actual decision that was rendered. 

<br/><br/>
<b>NOTE:</b> Future enhancements to this API may introduce new data elements being available in the payload. Client implementations should be designed to accommodate these enhancements to ensure existing behavior and functionality are not adversely impacted

### [GET] /vctc/validation/v1/decisions/{decisionID}
**Retrieve the details of a specific decision record**

#### Parameters

| Name | Located in | Description | Required | Schema | Style | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ----- | ------- |
| decisionID | path | The ID of the document for the document to be returned | Yes | string | simple | No |
| showControlsSnapShot | query | This flag is required to view the controls snap shot at the time of processing the decision. | No | string | form | Yes |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

### [PUT] /vctc/validation/v1/decisions/{decisionID}
**Update the state of a specific decision record**

#### Parameters

| Name | Located in | Description | Required | Schema | Style | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ----- | ------- |
| decisionID | path | The ID of the document for the document to be updated | Yes | string | simple | No |

#### Request Body

decisionUpdate

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

### [POST] /vctc/validation/v1/decisions/cardinquiry
**Retrieve a list of decision records for a card**

#### Request Body

decisionHistoryRequest

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"documentIds"**: [ string ], **"paymentToken"**: string, **"paginationData"**: { **"pageLimit"**: string, **"startIndex"**: string }, **"primaryAccountNumber"**: string }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"status"**: string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS", **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

### [GET] /vctc/validation/v1/decisions/history
**Retrieve a list of decision records for a sponsor**

#### Parameters

| Name | Located in | Description | Required | Schema | Style | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ----- | ------- |
| limit | query | Page size to be returned | Yes | string | form | Yes |
| page | query | Page number to be returned | Yes | string | form | Yes |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"status"**: string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS", **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

### [POST] /vctc/validation/v1/preevaluations
**Request a Pre-Evaluation recommendation on a transaction before it is run**

#### Request Body

preEvaluationRequest

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "PREEVAL", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"paymentToken"**: { **"value"**: string, **"tokenType"**: string, **"requestorID"**: string, **"assuranceLevel"**: string, **"expirationDate"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"wasProcessorDeclined"**: boolean, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"decisionID"**: string, **"decisionResponse"**: { **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"decisionResponseTimeStamp"**: string } }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

### [POST] /vctc/validation/v1/consumertransactioncontrols/decisioninquiry
**Retrieve a list of decision records by reterivalReferenceNumber**

#### Request Body

decisionRequest

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"dateTimeLocal"**: string, **"cardAcceptorTerminalID"**: string, **"retrievalReferenceNumber"**: string }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"status"**: string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND", **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

### [POST] /vctc/validation/v1/decisions
**Request a decision on pending transaction or send notification or advice for completed transaction**

Request a decision on pending transaction or send notification/advice for completed transaction

#### Request Body

decisionRequest

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"paymentToken"**: { **"value"**: string, **"tokenType"**: string, **"requestorID"**: string, **"assuranceLevel"**: string, **"expirationDate"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"wasProcessorDeclined"**: boolean, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"decisionID"**: string, **"decisionResponse"**: { **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"decisionResponseTimeStamp"**: string } }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

---
## Alert History and Customer Profiles API
The Alert History and Customer Profile APIs are used to manage customer profiles and their contact information for issuers who participate in the Visa Alert Delivery Service. All issuers can use this API to retrieve a history of VTC notifications. 
<br/><br/>
<b>NOTE:</b> Future enhancements to this API may introduce new data elements being available in the payload. Client implementations should be designed to accommodate these enhancements to ensure existing behavior and functionality are not adversely impacted.

### [POST] /vctc/customerrules/v1/consumertransactioncontrols/customer/notificationInquiry
**Account Notifications Inquiry**

Retrieves a summary of notifications based on either the primaryAccountNumber or paymentToken depending on which value is in the request.

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string }, **"pagination"**: { **"pageLimit"**: string, **"startIndex"**: string }, **"documentIds"**: [ string ], **"paymentToken"**: string, **"includeAlertDetails"**: boolean, **"primaryAccountNumber"**: string, **"includeContactDetails"**: boolean, **"includeMerchantDetails"**: boolean }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"notificationDetails"**: [ { **"outboundCallDetails"**: { **"status"**: string, **"message"**: string, **"httpVerb"**: string, **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string }, **"httpResponseCode"**: integer }, **"notificationDetailId"**: string, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [GET] /vctc/customerrules/v1/consumertransactioncontrols/customer/{userIdentifier}
**Retrieve an Existing Customer Profile by the userIdentifier**

Retrieves an existing customer profile by the user identifier

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| userIdentifier | path | Uniquely identifies the cardholder who is to receive the alert message. The userIdentifier should be a GUID but at a minimum it must be unique per enrolling application and must not contain any PII data. It is mandatory for all VTC notifications. The maximum number of characters allowed is 72. | Yes | string | No |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"cards"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"tokens"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"lastName"**: string, **"firstName"**: string, **"createdOnDate"**: string, **"userIdentifier"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"preferredLanguage"**: string, **"lastUpdateTimeStamp"**: string, **"preferredCountryCode"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [PATCH] /vctc/customerrules/v1/consumertransactioncontrols/customer/{userIdentifier}
**Update an Existing Customer Profile by the userIdentifier**

Updates an existing customer profile by the userIdentifier

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| userIdentifier | path | The user identifier of the customer profile document | Yes | string | No |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"lastName"**: string, **"firstName"**: string, **"countryCode"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"preferredLanguage"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"cards"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"tokens"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"lastName"**: string, **"firstName"**: string, **"createdOnDate"**: string, **"userIdentifier"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"preferredLanguage"**: string, **"lastUpdateTimeStamp"**: string, **"preferredCountryCode"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [PUT] /vctc/customerrules/v1/consumertransactioncontrols/customer/{userIdentifier}/alerts/preferences
**Replaces one or more Existing Alert Preferences on an Enrolled Account (DEPRECATED)**

Replaces existing alert preferences on the enrolled account

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| userIdentifier | path | The user identifier of the customer profile document | Yes | string | No |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"alertPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"cards"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"tokens"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"lastName"**: string, **"firstName"**: string, **"createdOnDate"**: string, **"userIdentifier"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"preferredLanguage"**: string, **"lastUpdateTimeStamp"**: string, **"preferredCountryCode"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [POST] /vctc/customerrules/v1/consumertransactioncontrols/customer/{userIdentifier}/alerts/preferences
**Add one or more Tailored Alert Preferences to an Enrolled Account (DEPRECATED)**

Adds one or more alert preferences to the enrolled account

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| userIdentifier | path | The user identifier of the customer profile document | Yes | string | No |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"alertPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"cards"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"tokens"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"lastName"**: string, **"firstName"**: string, **"createdOnDate"**: string, **"userIdentifier"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"preferredLanguage"**: string, **"lastUpdateTimeStamp"**: string, **"preferredCountryCode"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [DELETE] /vctc/customerrules/v1/consumertransactioncontrols/customer/{userIdentifier}/alerts/preferences
**Removes one or more Existing Alert Preferences from an Enrolled Account (DEPRECATED)**

Removes one or more alert preferences from the enrolled account

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| userIdentifier | path | The user identifier of the customer profile document | Yes | string | No |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"alertPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"cards"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"tokens"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"lastName"**: string, **"firstName"**: string, **"createdOnDate"**: string, **"userIdentifier"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"preferredLanguage"**: string, **"lastUpdateTimeStamp"**: string, **"preferredCountryCode"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [PUT] /vctc/customerrules/v1/consumertransactioncontrols/customer/{userIdentifier}/{documentId}/alerts/preferences
**Replaces one or more Existing Alert Preferences on an Enrolled Account**

Replaces existing alert preferences on an enrolled account

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| userIdentifier | path | The user identifier of the customer profile document | Yes | string | No |
| documentId | path |  | Yes | string | No |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"portfolioID"**: string, **"alertPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"cards"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"tokens"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"lastName"**: string, **"firstName"**: string, **"createdOnDate"**: string, **"userIdentifier"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"preferredLanguage"**: string, **"lastUpdateTimeStamp"**: string, **"preferredCountryCode"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [POST] /vctc/customerrules/v1/consumertransactioncontrols/customer/{userIdentifier}/{documentId}/alerts/preferences
**Add one or more Tailored Alert Preferences to an Enrolled Account**

Add one or more tailored alert preferences to an enrolled account.

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| userIdentifier | path | The user identifier of the customer profile document | Yes | string | No |
| documentId | path |  | Yes | string | No |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"portfolioID"**: string, **"alertPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"cards"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"tokens"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"lastName"**: string, **"firstName"**: string, **"createdOnDate"**: string, **"userIdentifier"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"preferredLanguage"**: string, **"lastUpdateTimeStamp"**: string, **"preferredCountryCode"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [DELETE] /vctc/customerrules/v1/consumertransactioncontrols/customer/{userIdentifier}/{documentId}/alerts/preferences
**Removes one or more Existing Alert Preferences from an Enrolled Account**

Removes one or more alert preferences from an enrolled account

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| userIdentifier | path | The user identifier of the customer profile document | Yes | string | No |
| documentId | path |  | Yes | string | No |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"portfolioID"**: string, **"alertPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"cards"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"tokens"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"lastName"**: string, **"firstName"**: string, **"createdOnDate"**: string, **"userIdentifier"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"preferredLanguage"**: string, **"lastUpdateTimeStamp"**: string, **"preferredCountryCode"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [POST] /vctc/customerrules/v3/consumertransactioncontrols/customer/notificationInquiry
**Account Notifications Inquiry**

Get notifications summary for all alerts by primaryAccountNumbers, paymentTokens, or documentIds

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string }, **"pagination"**: { **"pageLimit"**: string, **"startIndex"**: string }, **"documentIds"**: [ string ], **"paymentTokens"**: [ string ], **"includeAlertDetails"**: boolean, **"includeContactDetails"**: boolean, **"primaryAccountNumbers"**: [ string ], **"includeMerchantDetails"**: boolean }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"notificationDetails"**: [ { **"notificationId"**: string, **"notificationStatus"**: string, <br>**Available values:** "SUCCESSFULLY_SENT", "CLIENT_ERROR", "SYSTEM_ERROR", "CONFIRMATION_PENDING", **"outboundCallDetails"**: { **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } }, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"appID"**: string, **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [GET] /vctc/customerrules/v1/consumertransactioncontrols/customer/notifications
**Account Notifications Inquiry By ID**

Retrieves a summary of notifications based on the documentId, decisionId or userIdentifier sent in the request. Only one identifier can be used at a time.

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| notificationId | query | Notification ID to search for | No | string | Yes |
| decisionId | query | Decision ID to search for | No | string | Yes |
| documentId | query | Control document ID to search for | No | string | Yes |
| userIdentifier | query | User identifier to search for | No | string | Yes |
| page | query | Page number to be returned | Yes | string | Yes |
| limit | query | Page size to be returned | Yes | string | Yes |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"notificationDetails"**: [ { **"outboundCallDetails"**: { **"status"**: string, **"message"**: string, **"httpVerb"**: string, **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string }, **"httpResponseCode"**: integer }, **"notificationDetailId"**: string, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [POST] /vctc/customerrules/v1/consumertransactioncontrols/customer
**Create a New Customer Profile**

Creates a New Customer Profile

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"lastName"**: string, **"firstName"**: string, **"countryCode"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"communityCode"**: string, **"userIdentifier"**: string, **"preferredLanguage"**: string, **"primaryAccountNumber"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"cards"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"tokens"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"lastName"**: string, **"firstName"**: string, **"createdOnDate"**: string, **"userIdentifier"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"preferredLanguage"**: string, **"lastUpdateTimeStamp"**: string, **"preferredCountryCode"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 201 | Created | **application/json**: { **"resource"**: { **"createdOnDate"**: string, **"userIdentifier"**: string }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: integer }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

---
## Customer Rules API
The Customer Rules API is used to enroll, configure and retrieve an account&apos;s card control settings.  
<br/><br/>
<b>NOTE:</b> Future enhancements to this API may introduce new data elements being available in the payload. Client implementations should be designed to accommodate these enhancements to ensure existing behavior and functionality are not adversely impacted.

### [POST] /vctc/customerrules/v1/transactiontypecontrols/cardinquiry
**Retrieve the list of available transaction type controls for a card**

Retrieve list of available transaction type controls for a primaryAccountNumber or paymentToken

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"paymentToken"**: string, **"primaryAccountNumber"**: string }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"status"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", **"availableTransactionTypeRules"**: [ { **"name"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" }, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [POST] /vctc/customerrules/v1/consumertransactioncontrols/accounts/accountupdate
**Update the existing account number with a new one on a control document**

Replace the primaryAccountNumber or paymentToken of a control document with a new primaryAccountNumber or paymentToken (Card Replacement)

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| user-ID | header | User ID of the person/system who invokes the service | No | string | No |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"newAccountID"**: string, **"currentAccountID"**: string }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"status"**: string, <br>**Available values:** "SUCCESS" }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [DELETE] /vctc/customerrules/v1/consumertransactioncontrols/accounts/accountupdate
**Delete Control Document By an Account Identifier**

Delete a Control Document using the primaryAccountNumber or paymentToken

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| user-ID | header | User ID of the person/system who invokes the service | No | string | No |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"paymentToken"**: string, **"primaryAccountNumber"**: string }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"status"**: string, <br>**Available values:** "SUCCESS" }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 207 | Partial Success |  |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [GET] /vctc/customerrules/v1/consumertransactioncontrols/{documentID}/rules
**Retrieve the Transaction Control Document**

Retrieve a Control Document

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| documentID | path | The documentID of the control document to be returned. | Yes | string | No |
| userIdentifier | query | Uniquely identifies the cardholder who is to receive the alert message. The userIdentifier should be a GUID but at a minimum it must be unique per enrolling application and must not contain any PII data. It is mandatory for all VTC notifications. The maximum number of characters allowed is 72. | No | string | Yes |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [PUT] /vctc/customerrules/v1/consumertransactioncontrols/{documentID}/rules
**Update the existing control(s) within the Transaction Control Document**

Replace all details of the existing Transaction Control Document

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| user-ID | header | User ID of the person/system who invokes the service | No | string | No |
| documentID | path | The documentID of the transaction control document to be updated. | Yes | string | No |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [POST] /vctc/customerrules/v1/consumertransactioncontrols/{documentID}/rules
**Create a new control(s) within the Transaction Control Document**

Add or update control(s) within the Transaction Control Document

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| user-ID | header | User ID of the person/system who invokes the service | No | string | No |
| documentID | path | The documentID of the transaction control document. | Yes | string | No |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [DELETE] /vctc/customerrules/v1/consumertransactioncontrols/{documentID}/rules
**Delete existing Control rules within the Transaction Control Document**

Delete existing Control rules within the Transaction Control Document.

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| user-ID | header | User ID of the person/system who invokes the service | No | string | No |
| documentID | path | The documentID of the transaction control document from where control rules to be deleted, Does not delete the document | Yes | string | No |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [POST] /vctc/customerrules/v1/consumertransactioncontrols/accounts/decoupletokens
**Decouple Tokens**

Couple/Decouple a list of tokens from/to corresponding PAN

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| user-ID | header | User ID of the person/system who invokes the service | No | string | No |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"decoupleTokenRequest"**: [ { **"paymentToken"**: string, **"shouldDecouple"**: boolean, <br>**Available values:** false, **"primaryAccountNumber"**: string } ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"status"**: string, <br>**Available values:** "Success", "PartialSuccess", "Failed", **"response"**: [ { **"index"**: integer, **"reason"**: string, **"documentID"**: string, **"statusCode"**: integer, **"shouldDecouple"**: boolean } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [DELETE] /vctc/customerrules/v1/consumertransactioncontrols/{documentID}
**Delete a Control Document by its documentID**

Delete a Control Document.

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| user-ID | header | User ID of the person/system who invokes the service | No | string | No |
| documentID | path | The documentID of the customer transaction control document to be de-enrolled, Document will be deleted. | Yes | string | No |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: object, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [POST] /vctc/customerrules/v1/consumertransactioncontrols
**Enroll a card for transaction control**

Enroll an account in Visa Transaction Controls (VTC)

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"paymentToken"**: string, **"primaryAccountNumber"**: string, **"alertsEnrollmentDetails"**: { **"lastName"**: string, **"firstName"**: string, **"countryCode"**: string, **"portfolioID"**: string, **"communityCode"**: string, **"userIdentifier"**: string, **"preferredLanguage"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] } }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [POST] /vctc/customerrules/v1/merchanttypecontrols/cardinquiry
**Retrieve the list of available merchant type controls for a card**

Retrieve the list of the Merchant control types available for a primaryAccountNumber or paymentToken

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"paymentToken"**: string, **"primaryAccountNumber"**: string }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"status"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", **"availableMerchantTypeRules"**: [ { **"name"**: string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" }, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" ], <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [POST] /vctc/customerrules/v1/consumertransactioncontrols/inquiries/cardinquiry
**Get Transaction Control Document List by Primary Account Number**

Get Transaction Control Document List by a PrimaryAccountNumber or PaymentToken

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"paymentToken"**: string, **"primaryAccountNumber"**: string }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"controlDocuments"**: [ { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"requestedAppID"**: string, **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [GET] /vctc/customerrules/v1/consumertransactioncontrols/{documentID}/controlHistory
**Get a transaction Control Document History by Primary Account Number and Date Range**

Get Transaction Control Changes History(Audit) by documentID

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| documentID | path | The documentID of the transaction control document to be returned. | Yes | string | No |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"responseMessage"**: string, **"controlDocuments"**: [ { **"status"**: string, <br>**Available values:** "ENROLLED", "DEENROLLED", "ADD_CONTROLS", "UPDATE_CONTROLS", "DELETE_CONTROLS", "DELETE_CARD_EXCEPTION", "CARD_EXCEPTION", "DELETE_PAN", "UPDATE_PAN", "BATCH_ADD_CONTROLS", "UPDATE_TOKEN", "DELETE_TOKEN", "SYSTEM_UPDATE", "SYSTEM_CREATE", "SYSTEM_MODIFY", "SYSTEM_DELETE", "ADD_RELATIONSHIP", "UPDATE_RELATIONSHIP", "DELETE_RELATIONSHIP", "ADD_FLEX_RULES", "UPDATE_FLEX_RULES", "DELETE_FLEX_RULES", "DELETE_CARD", "UPDATE_CARD", "ADD_UPDATE_FLEX_RULES", "REPLACE_CARD", **"userId"**: string, **"documentID"**: string, **"createdOnDate"**: string, **"requestedAppID"**: string, **"requestedDocumentID"**: string, **"transactionControlDocument"**: { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [POST] /vctc/customerrules/v1/consumertransactioncontrols/walletservices/accountinquiry
**Set of API resources targeted for Issuers and Third Party Mobile wallet applications**

This returns all rules configured and available for a given primaryAccountNumber, paymentToken or documentID

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"documentIDs"**: [ string ], **"paymentTokens"**: [ string ], **"primaryAccountNumbers"**: [ string ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"accountInquiryResponse"**: [ { **"status"**: string, **"documentID"**: string, **"paymentToken"**: string, **"controlDocuments"**: [ { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ], **"allAvailableControls"**: { **"ruleCategories"**: [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" ], <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"merchantTypeRules"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" ], <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", **"transactionTypeRules"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" }, **"primaryAccountNumber"**: string } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [POST] /vctc/customerrules/v1/consumertransactioncontrols/controlHistory
**Get Transaction Control Changes History by documentID**

Retrieve a history of changes made to the control document since it was created listed chronologically. Each "snapshot" represents the state of a control document after being updated.  A single PrimaryAccountNumber can have multiple control documents in VTC.

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| page | query | Page number to be returned | No | string | Yes |
| limit | query | Page size to be returned | No | string | Yes |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"endDate"**: string, **"startDate"**: string, **"paymentToken"**: string, **"primaryAccountNumber"**: string }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"responseMessage"**: string, **"controlDocuments"**: [ { **"status"**: string, <br>**Available values:** "ENROLLED", "DEENROLLED", "ADD_CONTROLS", "UPDATE_CONTROLS", "DELETE_CONTROLS", "DELETE_CARD_EXCEPTION", "CARD_EXCEPTION", "DELETE_PAN", "UPDATE_PAN", "BATCH_ADD_CONTROLS", "UPDATE_TOKEN", "DELETE_TOKEN", "SYSTEM_UPDATE", "SYSTEM_CREATE", "SYSTEM_MODIFY", "SYSTEM_DELETE", "ADD_RELATIONSHIP", "UPDATE_RELATIONSHIP", "DELETE_RELATIONSHIP", "ADD_FLEX_RULES", "UPDATE_FLEX_RULES", "DELETE_FLEX_RULES", "DELETE_CARD", "UPDATE_CARD", "ADD_UPDATE_FLEX_RULES", "REPLACE_CARD", **"userId"**: string, **"documentID"**: string, **"createdOnDate"**: string, **"requestedAppID"**: string, **"requestedDocumentID"**: string, **"transactionControlDocument"**: { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [GET] /vctc/customerrules/v1/applications/configuration
**Retrieve the App's configuration data for notification callback settings**

Retrieve an App's Notification callback settings

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"status"**: string, <br>**Available values:** "NOT_CONFIGURED", "CONFIGURED", **"callBackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [PUT] /vctc/customerrules/v1/applications/configuration
**Update the App's configuration data for notification callback settings**

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"callBackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean }, **"fxCallBackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"status"**: string, <br>**Available values:** "NOT_CONFIGURED", "CONFIGURED", **"callBackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [POST] /vctc/customerrules/v1/configuration/cardinquiry
**Retrieve list of available payment control types for a card**

Retrieve list of available rule categories for a primaryAccountNumber or paymentToken

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"paymentToken"**: string, **"primaryAccountNumber"**: string }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"status"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", **"availableControlTypes"**: [ { **"name"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

### [POST] /vctc/customerrules/v1/consumertransactioncontrols/batch
**Batch Enrollment**

Enroll a Batch of Accounts in Visa Transaction Controls

#### Parameters

| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| user-ID | header | User ID of the person/system who invokes the service | No | string | No |

#### Request Body

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"cardsType"**: string, **"controlRules"**: { **"globalControl"**: { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean }, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean } ], **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean } ] }, **"enrolledCards"**: [ { **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"accountIdentifier"**: string } ], **"forceEnrollment"**: boolean }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"status"**: string, **"disqualifyingCards"**: [ { **"cards"**: [ string ], **"description"**: string } ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |
| 201 | Created |  |
| 207 | Partial Success |  |
| 400 | Bad Request |  |
| 403 | Forbidden Access |  |
| 404 | Not Found |  |
| 405 | Method Not Allowed |  |
| 406 | Not Acceptable |  |
| 409 | Conflict |  |
| 422 | Invalid Data |  |
| 500 | Internal Server Error |  |
| 503 | Service Unavailable |  |

---
## Program Administration API
The Transaction Controls Program Administration API enables Issuers to change program configurations for their sponsorID.

<br/><br/>
<b>NOTE:</b> Future enhancements to this API may introduce new data elements being available in the payload. Client implementations should be designed to accommodate these enhancements to ensure existing behavior and functionality are not adversely impacted.

### [GET] /vctc/programadmin/v1/sponsors/configuration
**Retrieve rule configuration and capabilities allowed for an issuer**

Retrieve list of rule categories that issuer has made available to its cardholders

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | ok | **application/json**: { **"resource"**: { **"status"**: string, **"cardPrefixes"**: [ { **"cardType"**: string, **"cardBrand"**: string, **"isVTCAllowed"**: boolean, **"prefixEndRange"**: string, **"callBackSettings"**: { **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean }, **"prefixStartRange"**: string, **"cardProgramIdentifier"**: string, **"prefixRangeIdentifier"**: string } ], **"availablePaymentRuleTypes"**: [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", "PCT_AGENT" ], **"configuredPaymentRuleTypes"**: [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" ], **"cardEnrollmentCallbackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

### [PUT] /vctc/programadmin/v1/sponsors/configuration
**Modify rule configuration and capabilities allowed for an issuer**

Update existing set of rule categories with a new set for use by issuer's cardholders

#### Request Body

request

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"ruleCategories"**: [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" ], **"isSpendLimitAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"cardEnrollmentCallbackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | ok | **application/json**: { **"resource"**: { **"lastUpdateTimeStamp"**: string }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

### [POST] /vctc/programadmin/v1/sponsors/configuration
**Create rule configuration and capabilities allowed for an issuer**

Add new rule categories for use by issuer's cardholders

#### Request Body

request

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"ruleCategories"**: [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | ok | **application/json**: { **"resource"**: { **"lastUpdateTimeStamp"**: string }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

### [DELETE] /vctc/programadmin/v1/sponsors/configuration
**Delete rule configuration and capabilities allowed for an issuer**

Delete the consumer transaction controls that the issuer has made avaiable to its cardholders

#### Request Body

request

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"ruleCategories"**: [ string, <br>**Available values:** "PCT_GLOBAL, PCT_TRANSACTION, PCT_MERCHANT" ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | ok | **application/json**: { **"resource"**: { **"lastUpdateTimeStamp"**: string }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

### [GET] /vctc/programadmin/v1/configuration/transactiontypecontrols
**Retrieve transaction controls allowed for an issuer**

Retrieve the list of transaction type controls that the issuer has made available to its cardholders

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | ok | **application/json**: { **"resource"**: { **"status"**: string, **"availableTransactionTypeRules"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"configuredTransactionTypeRules"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ] }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

### [PUT] /vctc/programadmin/v1/configuration/transactiontypecontrols
**Modify transaction controls allowed for an issuer**

Update existing set of transaction type controls with a new set for the issuer's cardholders

#### Request Body

request

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"transactionTypeRules"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Accepted | **application/json**: { **"resource"**: { **"lastUpdateTimeStamp"**: string }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

### [POST] /vctc/programadmin/v1/configuration/transactiontypecontrols
**Create transaction controls allowed for an issuer**

Add new transaction type controls for the issuer's cardholders

#### Request Body

request

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"transactionTypeRules"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | ok | **application/json**: { **"resource"**: { **"lastUpdateTimeStamp"**: string }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

### [DELETE] /vctc/programadmin/v1/configuration/transactiontypecontrols
**Delete transaction controls allowed for an issuer**

Delete transaction type controls that the issuer has made available to its cardholders

#### Request Body

request

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"transactionTypeRules"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ] }<br> |

#### Responses

| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | ok | **application/json**: { **"resource"**: { **"lastUpdateTimeStamp"**: string }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }<br> |

---
### Webhooks

### [POST] /ConsumerTransactionControls/v1/enrollments
**Enroll a card**

#### Request Body

payload

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"paymentToken"**: string, **"bankAccountNumber"**: string, **"primaryAccountNumber"**: string }<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | OK |
| 201 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden Access |
| 404 | Resource Not Found |
| 422 | Invalid Data |
| 500 | Internal Server Error |
| 503 | Service Maintenance |

### [DELETE] /ConsumerTransactionControls/v1/enrollments
**De-enroll a card**

#### Request Body

payload

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"paymentToken"**: string, **"bankAccountNumber"**: string, **"primaryAccountNumber"**: string }<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | OK |
| 201 | Created |
| 204 | No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden Access |
| 404 | Resource Not Found |
| 422 | Invalid Data |
| 500 | Internal Server Error |
| 503 | Service Maintenance |

### [POST] /ConsumerTransactionControls/v1/notifications
**Alert Notification**

#### Request Body

payload

| Required | Schema |
| -------- | ------ |
|  Yes | **application/json**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: object, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } }<br> |

#### Responses

| Code | Description |
| ---- | ----------- |
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |

### [POST] /ConsumerTransactionControls/v1/notifications/pushNotification
**Push Notification**

---
### Schemas

#### BalanceInfo Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| sign | string, <br>**Available values:** "C", "D" | The sign for balance amount, either positive (C) or negative (D).<br>*Enum:* `"C"`, `"D"` | Yes |
| balanceAmount | double | The balance remaining on the card after the transaction occurs. Can be up to 12 digits long with up to three decimal points. | Yes |
| balanceAmountType | string | A two digit code that identifies the amount type. Balance account type 00 = code for payment transactions. | Yes |
| balanceAccountType | string | A two digit code that identifies the account type. Balance account type 28 = prepaid load trx, 72 = prepaid activation transaction. | Yes |
| balanceTransactionCurrencyCode | string | Three digit code that identifies what currency was used for the transaction. | Yes |

#### CollectionResourceOfGetDecisionDocument-4 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND", **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | The time the request is received. Value is in UTC time | Yes |
| processingTimeinMs | long | The processing time in milliseconds | Yes |

#### CollectionResourceOfGetDecisionDocument-3 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS", **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### PreEvalDecisionRequest-6 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "PREEVAL" | The decision request type.<br>*Enum:* `"PREEVAL"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| paymentToken | { **"value"**: string, **"tokenType"**: string, **"requestorID"**: string, **"assuranceLevel"**: string, **"expirationDate"**: string } |  | No |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| primaryAccountNumber | string | The card number for which the decision is to be made, must be between 13 and 19 numeric digits<br>*Example:* `"4000123456789010"` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### CollectionResourceOfGetDecisionDocument-6 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS", **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### SponsorConfigurationDocument Schema

Configuration settings for sponsors.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| appID | string | Identifier for the application requesting to be enabled by the Sponsor/Issuer. | Yes |
| region | string, <br>**Available values:** "AP", "CAN", "CEMEA", "VE", "LAC", "US" | Two or three letter state or region code.<br>*Enum:* `"AP"`, `"CAN"`, `"CEMEA"`, `"VE"`, `"LAC"`, `"US"`<br>*Example:* `"US"` | No |
| sponsorID | string | Identifier assigned to sponsor. | Yes |
| appGroupID | string | Group ID for the applications managing transaction controls. | No |
| sponsorBID | string | Identifier assigned to sponsor's business identity. | No |
| sponsorName | string | Name of sponsor being configured. | Yes |
| appWhiteList | [ { **"type"**: string, **"appID"**: string, **"appType"**: string, **"cardPrefixes"**: [ { **"cardType"**: string, **"cardBrand"**: string, **"isLeadPAN"**: boolean, **"sponsorBID"**: string, **"countryCode"**: string, **"portfolioID"**: string, **"currencyCode"**: string, **"isVTCAllowed"**: boolean, **"isFlexAllowed"**: boolean, **"prefixEndRange"**: string, **"prefixStartRange"**: string, **"cardProgramIdentifier"**: string, **"prefixRangeIdentifier"**: string, **"cardPrefixSponsorLevel"**: boolean, **"isFlexReportingAllowed"**: boolean, **"whiteListConfiguration"**: { **"isFxAlertsAllowed"**: boolean, **"isCardGroupAllowed"**: boolean, **"isTimeDelayAllowed"**: boolean, **"rulesConfiguration"**: [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ], **"isSpendLimitAllowed"**: boolean, **"merchantControlTypes"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"blackListForSpendLimit"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"isMultiCurrencyAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFlexMITRoutingEnabled"**: boolean, **"transactionControlTypes"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"isAlertOnReversalAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"isLastMileDeliveryAllowed"**: boolean, **"customMerchantControlTypes"**: [ string ], **"customAlertsPayloadSettings"**: { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] }, **"isTimeDelayAutoRemovalAllowed"**: boolean } } ], **"applicationName"**: string, **"lastUpdateTimeStamp"**: string, **"defaultWhiteListConfiguration"**: { **"isFxAlertsAllowed"**: boolean, **"isCardGroupAllowed"**: boolean, **"isTimeDelayAllowed"**: boolean, **"rulesConfiguration"**: [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ], **"isSpendLimitAllowed"**: boolean, **"merchantControlTypes"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"blackListForSpendLimit"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"isMultiCurrencyAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFlexMITRoutingEnabled"**: boolean, **"transactionControlTypes"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"isAlertOnReversalAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"isLastMileDeliveryAllowed"**: boolean, **"customMerchantControlTypes"**: [ string ], **"customAlertsPayloadSettings"**: { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] }, **"isTimeDelayAutoRemovalAllowed"**: boolean } } ] | List of app IDs enabled in the allowlist. | No |
| cardPrefixes | [ { **"cardType"**: string, **"cardBrand"**: string, **"isLeadPAN"**: boolean, **"sponsorBID"**: string, **"countryCode"**: string, **"portfolioID"**: string, **"currencyCode"**: string, **"isVTCAllowed"**: boolean, **"isFlexAllowed"**: boolean, **"prefixEndRange"**: string, **"callBackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean }, **"prefixStartRange"**: string, **"cardProgramIdentifier"**: string, **"prefixRangeIdentifier"**: string, **"isFlexReportingAllowed"**: boolean } ] |  | Yes |
| shardEnabled | boolean | Indicates if data sharding is enabled.<br>*Example:* `true` | No |
| createdOnDate | dateTime | Timestamp when control was added, in UTC. | No |
| destinationBIN | string |  | No |
| isDeclineOnAFT | boolean | Indicates if a decline is enabled on AFT.<br>*Example:* `true` | No |
| migrationStage | string, <br>**Available values:** "REPLICA_ONLY", "BEFORE_MIGRATION", "DURING_MIGRATION", "AFTER_MIGRATION", "SHARD_ONLY" | The stage of sharding migration for the sponsor level.<br>*Enum:* `"REPLICA_ONLY"`, `"BEFORE_MIGRATION"`, `"DURING_MIGRATION"`, `"AFTER_MIGRATION"`, `"SHARD_ONLY"`<br>*Example:* `"SHARD_ONLY"` | No |
| primaryCluster | string | Database cluster designated to handle primary operations for sponsor's configuration.<br>*Example:* `"VDP"` | Yes |
| isAlertPreferenceV1 | boolean | Indicates if the sponsor has enabled the v1 alert preferences response.<br>**Read-only** | No |
| lastUpdateTimeStamp | string | Timestamp of when the resource was last updated in UTC.<br>*Example:* `"2023-03-21T04:56:20.000Z"` | No |
| registeredApplication | string | Details of an application that is registered to interact with sponsor's configuration. | No |
| transactionControlsConfiguration | { **"countryCode"**: string, **"currencyCode"**: string, **"ruleCategories"**: [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", "PCT_GEO", "PCT_GLOBAL", "PCT_MERCHANT", "PCT_TRANSACTION" ], **"isFxAlertsAllowed"**: boolean, **"isCardGroupAllowed"**: boolean, **"isTimeDelayAllowed"**: boolean, **"isSpendLimitAllowed"**: boolean, **"merchantControlTypes"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"blackListForSpendLimit"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"isMultiCurrencyAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFlexMITRoutingEnabled"**: boolean, **"transactionControlTypes"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"isAlertOnReversalAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"isLastMileDeliveryAllowed"**: boolean, **"customMerchantControlTypes"**: [ string ], **"customAlertsPayloadSettings"**: { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] }, **"isTimeDelayAutoRemovalAllowed"**: boolean, **"enrollmentNotificationCallBackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean }, **"deEnrollmentNotificationCallBackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } } | Settings for transaction controls. | Yes |

#### PreEvalDecisionRequest-5 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "PREEVAL" | The decision request type.<br>*Enum:* `"PREEVAL"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| paymentToken | { **"value"**: string, **"tokenType"**: string, **"requestorID"**: string, **"assuranceLevel"**: string, **"expirationDate"**: string } |  | No |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| primaryAccountNumber | string | The card number for which the decision is to be made, must be between 13 and 19 numeric digits<br>*Example:* `"4000123456789010"` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### CollectionResourceOfGetDecisionDocument-5 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS", **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### PreEvalDecisionRequest-4 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "PREEVAL" | The decision request type.<br>*Enum:* `"PREEVAL"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| paymentToken | { **"value"**: string, **"tokenType"**: string, **"requestorID"**: string, **"assuranceLevel"**: string, **"expirationDate"**: string } |  | No |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| primaryAccountNumber | string | The card number for which the decision is to be made, must be between 13 and 19 numeric digits<br>*Example:* `"4000123456789010"` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### PreEvalDecisionRequest-3 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "PREEVAL" | The decision request type.<br>*Enum:* `"PREEVAL"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| paymentToken | { **"value"**: string, **"tokenType"**: string, **"requestorID"**: string, **"assuranceLevel"**: string, **"expirationDate"**: string } |  | No |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| primaryAccountNumber | string | The card number for which the decision is to be made, must be between 13 and 19 numeric digits<br>*Example:* `"4000123456789010"` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### PaginationData-1 Schema

Pagination details for this request.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastPage | boolean | Indicates if this is the last page within the paginationData. | Yes |
| firstPage | boolean | Indicates if this is the first page within the paginationData. | Yes |
| pageLimit | string | Maximum number of pages to return. Numeric, between 1 and 100.<br>*Example:* `"50"` | Yes |
| startIndex | string | Page start location. Must be numeric.<br>*Example:* `"1"` | Yes |
| totalCount | long | Total number of decisions available.<br>*Example:* `10` | Yes |
| totalPages | integer | Total number of pages for the result set, based on pageLimit provided.<br>*Example:* `1` | Yes |
| recordCount | integer | Total number of decisions returned in the response.<br>*Example:* `1` | Yes |

#### PreEvalDecisionRequest-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "PREEVAL" | The decision request type.<br>*Enum:* `"PREEVAL"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| paymentToken | { **"value"**: string, **"tokenType"**: string, **"requestorID"**: string, **"assuranceLevel"**: string, **"expirationDate"**: string } |  | No |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| primaryAccountNumber | string | The card number for which the decision is to be made, must be between 13 and 19 numeric digits<br>*Example:* `"4000123456789010"` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### PreEvalDecisionRequest-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "PREEVAL" | The decision request type.<br>*Enum:* `"PREEVAL"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| paymentToken | { **"value"**: string, **"tokenType"**: string, **"requestorID"**: string, **"assuranceLevel"**: string, **"expirationDate"**: string } |  | No |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| primaryAccountNumber | string | The card number for which the decision is to be made, must be between 13 and 19 numeric digits<br>*Example:* `"4000123456789010"` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### AlertTransactionOutcome-1 Schema

Outcome of the transaction.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionID | string | Decision ID corresponding to the alerts.<br>*Example:* `"v-304-f1f11166-f3b3-4465-b995-61edb244c178"` | Yes |
| documentID | string | Uniquely identifies the control document that triggered the notification.<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | No |
| alertDetails | [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ] | List of alerts triggered for a transaction that should be delivered to the cardholder. If transaction was declined, only a single alert detail will be present. | Yes |
| notificationID | string | Unique notification detail identifier.<br>*Example:* `"ctc-vd-45366159-40c2-43fc-914e-7cf7177badfd"` | Yes |
| transactionLimit | { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer } | Number of transactions to be allowed/approved, after which subsequent transactions will be declined. | No |
| declineResponseCode | string | Response code indicating why the transaction was declined.<br>*Example:* `"50"` | No |
| transactionApproved | string, <br>**Available values:** "APPROVED", "DECLINED" | Indicates if transaction was approved.<br>*Enum:* `"APPROVED"`, `"DECLINED"`<br>*Example:* `"APPROVED"` | Yes |
| decisionResponseTimeStamp | string | Timestamp of when the decision was returned in UTC.<br>*Example:* `"2023-05-25T18:45:55.000Z"` | Yes |

#### PaginationData-2 Schema

Pagination details for this request.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastPage | boolean | Indicates if this is the last page within the paginationData. | Yes |
| firstPage | boolean | Indicates if this is the first page within the paginationData. | Yes |
| pageLimit | string | Maximum number of pages to return. Numeric, between 1 and 100.<br>*Example:* `"50"` | Yes |
| startIndex | string | Page start location. Must be numeric.<br>*Example:* `"1"` | Yes |
| totalCount | long | Total number of decisions available.<br>*Example:* `10` | Yes |
| totalPages | integer | Total number of pages for the result set, based on pageLimit provided.<br>*Example:* `1` | Yes |
| recordCount | integer | Total number of decisions returned in the response.<br>*Example:* `1` | Yes |

#### DecisionDocument-3 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionID | string | The decisionID assigned to the decision request.  This value is generated by the API. | Yes |
| paymentToken | string | Masked payment token. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| decisionUpdate | { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } |  | Yes |
| decisionRequest | { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string } |  | Yes |
| decisionResponse | { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string } |  | Yes |
| primaryAccountNumber | string | Masked primary account number. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | Yes |
| transactionControlsnapshot | [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] |  | No |

#### DateTimeRange-1 Schema

When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| endTime | string | End time in UTC of a timeRange that bounds a control. Only transactions attempted during the specified timeRange will trigger this control. The format of the string is in 24hr time using YYYY-MM-DD hh:mm:ss format.<br>*Example:* `"2023-03-21T04:56:56.000Z"` | Yes |
| startTime | string | Start time in UTC of a timeRange that bounds a control. Only transactions attempted during the specified timeRange will trigger this control. The format of the string is in 24hr time using YYYY-MM-DD hh:mm:ss format.<br>*Example:* `"2023-03-21T04:56:56.000Z"` | Yes |

#### DecisionDocument-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionID | string | The decisionID assigned to the decision request.  This value is generated by the API. | Yes |
| paymentToken | string | Masked payment token. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| decisionUpdate | { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } |  | Yes |
| decisionRequest | { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string } |  | Yes |
| decisionResponse | { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string } |  | Yes |
| primaryAccountNumber | string | Masked primary account number. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | Yes |
| transactionControlsnapshot | [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] |  | No |

#### MerchantOverrideableControl Schema

List of merchant controls configured for the card.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } | When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time. | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } | Provide cardDetails to set up controls and restrict access based on cardholder name or card sequence number. If used, the processor must provide the same transaction data when invoking the decision request and the authorization engine will attempt to use the details to locate a transaction control. If the card data is not matched from the transaction data, the control will not affect the transaction. | No |
| spendLimit | { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer } | Used to track and manage total approved account purchases over a period of time. All amounts are based on the cardholderBillAmount in the authorization request. The actual amount submitted for settlement can differ (e.g. tips, hotel, car rental...). | No |
| controlType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" | Indicates specific control type. Valid transactionControls values begin with: "TCT_", valid merchantControls values begin with: "MCT_". When alertType is DECLINE_BY_ISSUER, the only valid controlType value is ALL.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| alertThreshold | double | Maximum value of an approved purchase for this control type before triggering an alert when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if an alert should be sent.<br>*Example:* `1000` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| filterByCountry | { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] } | Allows cardholders to specify in which countries their card can, or cannot, be used depending on which child attribute is configured. | No |
| impulseDelayEnd | string | Time in UTC when impulseDelayPeriod expires. Value is calculated by adding the impulseDelayPeriod value to the impulseDelayStart value.<br>*Example:* `"1319"`<br>**Read-only** | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| declineThreshold | double | Maximum value of a purchase for this control type before triggering a decline when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if a decline should be triggered.<br>*Example:* `1000` | No |
| isControlEnabled | boolean | Indicates if this control type will be applied during transaction processing. | Yes |
| shouldDeclineAll | boolean | Indicates if VTC will trigger a decline for all transactions related to this control type. Default value will be false. If false, other control settings (e.g. declineThreshold) will be checked. | No |
| impulseDelayStart | string | Time in UTC the initial impulseDelayPeriod was received on a merchant control.<br>*Example:* `"1319"`<br>**Read-only** | No |
| impulseDelayPeriod | string | Indicates the time merchantControls should be inactive. When autoRemoval is set to false, controls will continue to block transactions until impulse delay is removed. When autoRemoval is set to true, impulse is expired. No action is needed to unblock.<br>*Example:* `"1439"` | No |
| shouldAlertOnDecline | boolean | Indicates if VTC will trigger a decline notification for all transactions matching the associated control type. If false, no alerts will be sent for declined transactions related to this control type. | No |
| impulseDelayRemaining | string | Time remaining before the impulseDelayPeriod expires.<br>*Example:* `"719"`<br>**Read-only** | No |
| shouldTargetSpecificCard | boolean | Indicates if card details are required. Card details will be used to locate a transaction control.<br>**Read-only** | No |
| declineAllNonTokenizeTransactions | boolean | When set to "true," transactions performed with primaryAccountNumber will be declined. Only token-based transactions will continue to process as normal. Used when the physical card is lost or misplaced but the cardholder wants to continue transacting via their mobile phone. | No |

#### DecisionDocument-5 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionID | string | The decisionID assigned to the decision request.  This value is generated by the API. | Yes |
| paymentToken | string | Masked payment token. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| decisionUpdate | { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } |  | Yes |
| decisionRequest | { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string } |  | Yes |
| decisionResponse | { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string } |  | Yes |
| primaryAccountNumber | string | Masked primary account number. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | Yes |
| transactionControlsnapshot | [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] |  | No |

#### DecisionDocument-4 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionID | string | The decisionID assigned to the decision request.  This value is generated by the API. | Yes |
| paymentToken | string | Masked payment token. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| decisionUpdate | { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } |  | Yes |
| decisionRequest | { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string } |  | Yes |
| decisionResponse | { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string } |  | Yes |
| primaryAccountNumber | string | Masked primary account number. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | Yes |
| transactionControlsnapshot | [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] |  | No |

#### DecisionDocument-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionID | string | The decisionID assigned to the decision request.  This value is generated by the API. | Yes |
| paymentToken | string | Masked payment token. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| decisionUpdate | { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } |  | Yes |
| decisionRequest | { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string } |  | Yes |
| decisionResponse | { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string } |  | Yes |
| primaryAccountNumber | string | Masked primary account number. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | Yes |
| transactionControlsnapshot | [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] |  | No |

#### CollectionResourceTransactionControlReportsResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"responseMessage"**: string, **"controlDocuments"**: [ { **"status"**: string, <br>**Available values:** "ENROLLED", "DEENROLLED", "ADD_CONTROLS", "UPDATE_CONTROLS", "DELETE_CONTROLS", "DELETE_CARD_EXCEPTION", "CARD_EXCEPTION", "DELETE_PAN", "UPDATE_PAN", "BATCH_ADD_CONTROLS", "UPDATE_TOKEN", "DELETE_TOKEN", "SYSTEM_UPDATE", "SYSTEM_CREATE", "SYSTEM_MODIFY", "SYSTEM_DELETE", "ADD_RELATIONSHIP", "UPDATE_RELATIONSHIP", "DELETE_RELATIONSHIP", "ADD_FLEX_RULES", "UPDATE_FLEX_RULES", "DELETE_FLEX_RULES", "DELETE_CARD", "UPDATE_CARD", "ADD_UPDATE_FLEX_RULES", "REPLACE_CARD", **"userId"**: string, **"documentID"**: string, **"createdOnDate"**: string, **"requestedAppID"**: string, **"requestedDocumentID"**: string, **"transactionControlDocument"**: { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } } ] } | Transaction control document being returned. | No |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceSponsorConfigTransactionTypeCardEnquiryTransactionControlResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", **"availableTransactionTypeRules"**: [ { **"name"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" }, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ] } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceStatusResponseType-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### TransactionControlsConfiguration Schema

Settings for transaction controls.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | Yes |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | Yes |
| ruleCategories | [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", "PCT_GEO", "PCT_GLOBAL", "PCT_MERCHANT", "PCT_TRANSACTION" ] | Rule categories enabled for the Sponsor ID. | Yes |
| isFxAlertsAllowed | boolean | Indicates if fx alerts feature is allowed.<br>*Example:* `true` | No |
| isCardGroupAllowed | boolean | Indicates if the issuer has subscribed (true) or not subscribed (false) for group control feature.<br>*Example:* `true` | No |
| isTimeDelayAllowed | boolean | Indicates if time delay feature is allowed.<br>*Example:* `true` | No |
| isSpendLimitAllowed | boolean | Indicates if spend limit control feature is allowed.<br>*Example:* `true` | No |
| merchantControlTypes | [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ] | Types of controls enabled on merchant transactions. | No |
| blackListForSpendLimit | [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ] | List of control types disabled for global spend limit in the deny list. | No |
| isMultiCurrencyAllowed | boolean | Indicates if multi-currency control feature is allowed.<br>*Example:* `true` | No |
| isDetokenizationAllowed | boolean | Indicates if the PAN should be found (true) or not (false) from the Token.<br>*Example:* `true` | No |
| isFlexMITRoutingEnabled | boolean | Determines if the sponsor has enabled for VTC Flex MIT routing | No |
| transactionControlTypes | [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ] | Types of controls enabled on transactions. | No |
| isAlertOnReversalAllowed | boolean | Indicates if the sponsor is enrolled in VTC alert on reversal.<br>*Example:* `true` | No |
| isFilterByCountryAllowed | boolean | Indicates if the filter by country feature is allowed.<br>*Example:* `true` | No |
| isTokenDecouplingAllowed | boolean | Indicates if the Token can be decoupled from the PAN. | No |
| isLastMileDeliveryAllowed | boolean | Indicates if sponsor is enrolled in Visa Transaction Alerts (VTA) last mile delivery program.<br>*Example:* `true` | No |
| customMerchantControlTypes | [ string ] | Types of custom controls enabled on merchant transactions. | No |
| customAlertsPayloadSettings | { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] } | Settings for custom alert payloads. | No |
| isTimeDelayAutoRemovalAllowed | boolean | Indicates if autoremoval of time delay feature is allowed.<br>*Example:* `true` | No |
| enrollmentNotificationCallBackSettings | { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } | URL posted following card enrollment or de-enrollment. | Yes |
| deEnrollmentNotificationCallBackSettings | { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } | URL posted following card enrollment or de-enrollment. | No |

#### NotificationDetailsContactPreferenceDetails-2 Schema

List of contacts associated with alert preference.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of contact. If "Inactive", default contact preferences will deliver last mile alerts to cardholder.<br>*Example:* `"Active"` | No |
| message | string | Transaction information sent to the cardholder as SMS, email, or push notification. <br>*Example:* `"No controls found for given time range."` | No |
| isVerified | boolean | Indicates if contact type has been verified by issuer. Contacts mapped to cardholder must be verified. Currently, VISA only supports the double opt in verification for SMS-type contacts if field is set to false. For any other contact type, Visa will not conduct additional verification. Issuer should only allow verified contacts to be used as contact preferences. Double opt in feature is not supported in sandbox. For last mile alert delivery testing in sandbox this field must be set to true.<br>*Example:* `true` | No |
| contactType | string | Channel to deliver alert message. Supported channels include SMS, Push, Email. (Only email is supported in sandbox.)<br>*Example:* `"Email"` | No |
| contactValue | string | Email address, phone number or device ID associated with contactType.<br>*Example:* `"alexmiller@example.com"` | No |

#### NotificationDetailsContactPreferenceDetails-1 Schema

List of contacts associated with alert preference.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of contact. If "InActive", default contact preferences will deliver last mile alerts to cardholder.<br>*Example:* `"Active"` | No |
| message | string | Transaction information sent to the cardholder as SMS, email, or push notification. <br>*Example:* `"No controls found for given time range."` | No |
| isVerified | boolean | Indicates if contact type has been verified by issuer. Contacts mapped to cardholder must be verified. Currently, VISA only supports the double opt in verification for SMS-type contacts if field is set to false. For any other contact type, Visa will not conduct additional verification. Issuer should only allow verified contacts to be used as contact preferences. Double opt in feature is not supported in sandbox. For last mile alert delivery testing in sandbox this field must be set to true.<br>*Example:* `true` | No |
| contactType | string | Channel to deliver alert message. Supported channels include SMS, Push, Email. (Only email is supported in sandbox.)<br>*Example:* `"Email"` | No |
| contactValue | string | Email address, phone number or device ID associated with contactType.<br>*Example:* `"alexmiller@example.com"` | No |

#### CollectionResourceOfGetDecisionDocument-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS", **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CreatedCustomerProfileDocument Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| createdOnDate | string | Timestamp when control was added, in UTC. | Yes |
| userIdentifier | string | Unique identifier for the cardholder | Yes |

#### CollectionResourceStatusResponseType Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceOfGetDecisionDocument-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS", **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### DecisionHistoryResponse-6 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS" | Status of the request<br>*Enum:* `"AVAILABLE_RECORDS"`, `"NO_RECORDS"` | Yes |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] | List of decision Documents | Yes |

#### DecisionHistoryResponse-5 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS" | Status of the request<br>*Enum:* `"AVAILABLE_RECORDS"`, `"NO_RECORDS"` | Yes |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] | List of decision Documents | Yes |

#### DecisionHistoryResponse-4 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS" | Status of the request<br>*Enum:* `"AVAILABLE_RECORDS"`, `"NO_RECORDS"` | Yes |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] | List of decision Documents | Yes |

#### EnrolledCard-1 Schema

List of valid cards added to be enrolled.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| accountIdentifier | string | Card number to be enrolled in VTC. Can be PAN, bank account number or token.<br>*Example:* `"4000123456789010"` | Yes |

#### CollectionResourceCreatedCustomerProfileDocument Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"createdOnDate"**: string, **"userIdentifier"**: string } |  | Yes |
| receivedTimestamp | string |  | Yes |
| processingTimeinMs | integer |  | Yes |

#### CardInquiryRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paymentToken | string | Token account number for which the control details are to be returned.<br>*Example:* `"4000123456789010"` | No |
| primaryAccountNumber | string | Card account number for which the control details are to be returned.<br>*Example:* `"4000123456789010"` | Yes |

#### SummaryInquiryResponse Schema

List of controls and alerts configured/available for a given PAN, token, or documentID.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of control document.<br>*Example:* `"ACTIVE"` | No |
| documentID | string | System-generated ID for the control document bound to the account identifier (primaryAccountNumber/paymentToken).<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | No |
| paymentToken | string | Payment token (first and last four digit unmasked) for which list of the transaction control documents have been retrieved.<br>*Example:* `"4000-xxxx-xxxx-9010"` | No |
| controlDocuments | [ { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] | List of transaction control documents. | No |
| allAvailableControls | { **"ruleCategories"**: [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" ], **"merchantTypeRules"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"transactionTypeRules"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "TCT_AFT" ] } | List of all rules and control types available for the given primaryAccountNumber or documentID. | No |
| primaryAccountNumber | string | Primary account number (first digit and last four digits unmasked) for which list of the transaction control documents have been retrieved.<br>*Example:* `"4000-xxxx-xxxx-9010"` | No |

#### ExchangeRateDetails-1 Schema

Exchange rate details provided in the notification payload for a cross-currency transaction when Issuer has configured FX Alerts.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxStatus | string | Indicates if FX_ALERT was complete.<br>*Example:* `"COMPLETE"` | No |
| pfxIndicator | string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED" | Indicates if transaction is eligible for the exchange rate to persist from processing to clearing or if a rate was applied for a full financial transaction (0220/0420).<br>*Enum:* `"ELIGIBLE"`, `"NOT_ELIGIBLE"`, `"APPLIED"`<br>*Example:* `"ELIGIBLE"`<br>**Read-only** | No |
| visaExchangeRate | double | Exchange rate provided by VIP in the authorization message.<br>*Example:* `0.05` | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"`<br>**Read-only** | No |
| exchangeRateMarkUp | double | Calculated exchange rate mark up.<br>*Example:* `0.58` | No |
| ecbExchangeRateInfo | { **"exchangeRate"**: double, **"lastUpdatedDate"**: string } | ECB exchange rates and effective dates. | No |
| fxRateTableIdentifier | string | 5-byte Rate Table ID performing all required multi-currency processing (format 1-alpha, 4-numeric).<br>*Example:* `"a0000"`<br>**Read-only** | No |

#### BulkEnrollmentResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of the call: Success, Partial_Success or Failure.<br>*Example:* `"SUCCESS"` | Yes |
| disqualifyingCards | [ { **"cards"**: [ string ], **"description"**: string } ] | List of disqualifying cards. These cards were not eligible to be added to the group, and will be returned in the response with partial success. HTTP status code will be 207. DisqualifyingCards will not be visible when HTTP status code is 200. | No |

#### ContactPreferenceDetails Schema

List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of contact. Valid values are "Active" and "InActive". If set to "InActive", default contact preferences will deliver last mile alerts to the cardholder.<br>*Example:* `"Active"` | No |
| isVerified | boolean | Indicates if the contact type has been verified by the issuer. Contacts mapped to cardholder must be verified. For SMS-type contacts, VISA only supports double opt-in verification if this field is set to false. For other contact types, Visa will not conduct additional verification. Issuers should only allow verified contacts to be used as contact preferences. The double opt-in feature is not supported in sandbox. For last mile alert delivery testing in sandbox, this field must be set to true.<br>*Example:* `true` | No |
| callingCode | string | Code for SMS contact types. If not set for an SMS contact, default value is "1".<br>*Example:* `"52"` | No |
| contactType | string | Channel to deliver alert message. Supported channels include SMS, Push, Email. (Only email is supported in sandbox.)<br>*Example:* `"Email"` | Yes |
| contactValue | string | Email address, phone number or device ID associated with contactType.<br>*Example:* `"alexmiller@example.com"` | Yes |
| preferredEmailFormat | string, <br>**Available values:** "Plain", "RichText", "Html" | Preferred email format for email contact types. If not provided for an email contact, default value is set to "Plain".<br>*Enum:* `"Plain"`, `"RichText"`, `"Html"`<br>*Example:* `"Plain"` | No |

#### CollectionResourceCustomerProfileDocument Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"cards"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"tokens"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"lastName"**: string, **"firstName"**: string, **"createdOnDate"**: string, **"userIdentifier"**: string, **"isProfileActive"**: boolean, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"preferredLanguage"**: string, **"lastUpdateTimeStamp"**: string, **"preferredCountryCode"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### WhiteListAppTransactionControlsConfiguration Schema

Default settings for the allowlist.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| isFxAlertsAllowed | boolean | Indicates if fx alerts feature is allowed.<br>*Example:* `true` | No |
| isCardGroupAllowed | boolean | Indicates if the issuer has subscribed (true) or not subscribed (false) for group control feature.<br>*Example:* `true` | No |
| isTimeDelayAllowed | boolean | Indicates if time delay feature is allowed.<br>*Example:* `true` | No |
| rulesConfiguration | [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ] |  | Yes |
| isSpendLimitAllowed | boolean | Indicates if spend limit control feature is allowed.<br>*Example:* `true` | No |
| merchantControlTypes | [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ] | Types of controls enabled on merchant transactions. | No |
| blackListForSpendLimit | [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ] | List of control types disabled for global spend limit in the deny list. | No |
| isMultiCurrencyAllowed | boolean | Indicates if multi-currency control feature is allowed.<br>*Example:* `true` | No |
| isDetokenizationAllowed | boolean | Indicates if the PAN should be found (true) or not (false) from the Token.<br>*Example:* `true` | No |
| isFlexMITRoutingEnabled | boolean | Determines if the sponsor has enabled for VTC Flex MIT routing | No |
| transactionControlTypes | [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ] | Types of controls enabled on transactions. | No |
| isAlertOnReversalAllowed | boolean | Indicates if the sponsor is enrolled in VTC alert on reversal.<br>*Example:* `true` | No |
| isFilterByCountryAllowed | boolean | Indicates if the filter by country feature is allowed.<br>*Example:* `true` | No |
| isTokenDecouplingAllowed | boolean | Indicates if the Token can be decoupled from the PAN. | No |
| isLastMileDeliveryAllowed | boolean | Indicates if sponsor is enrolled in Visa Transaction Alerts (VTA) last mile delivery program.<br>*Example:* `true` | No |
| customMerchantControlTypes | [ string ] | Types of custom controls enabled on merchant transactions. | No |
| customAlertsPayloadSettings | { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] } | Settings for custom alert payloads. | No |
| isTimeDelayAutoRemovalAllowed | boolean | Indicates if autoremoval of time delay feature is allowed.<br>*Example:* `true` | No |

#### TypedGroupControl-1 Schema

List of transaction controls configured for the card.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } | When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time. | No |
| spendLimit | { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer } | Used to track and manage total approved account purchases over a period of time. All amounts are based on the cardholderBillAmount in the authorization request. The actual amount submitted for settlement can differ (e.g. tips, hotel, car rental...). | No |
| controlType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" | Indicates specific control type. Valid transactionControls values begin with: "TCT_", valid merchantControls values begin with: "MCT_". ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`<br>*Example:* `"TCT_ATM_WITHDRAWAL"` | Yes |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| alertThreshold | double | Maximum value of an approved purchase for this control type before triggering an alert when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if an alert should be sent.<br>*Example:* `1000` | No |
| filterByCountry | { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] } | Allows cardholders to specify in which countries their card can, or cannot, be used depending on which child attribute is configured. | No |
| declineThreshold | double | Maximum value of a purchase for this control type before triggering a decline when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if a decline should be triggered.<br>*Example:* `1000` | No |
| shouldDeclineAll | boolean | Indicates if VTC will trigger a decline for all transactions related to this control type. Default value will be false. If false, other control settings (e.g. declineThreshold) will be checked. | No |
| transactionLimit | { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer } | Number of transactions to be allowed/approved, after which subsequent transactions will be declined. | No |
| shouldAlertOnDecline | boolean | Indicates if VTC will trigger a decline notification for all transactions matching the associated control type. If false, no alerts will be sent for declined transactions related to this control type. | No |

#### AppConfigurationCallBackSettingsResponseType Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "NOT_CONFIGURED", "CONFIGURED" | Status of callback configuration.<br>*Enum:* `"NOT_CONFIGURED"`, `"CONFIGURED"`<br>*Example:* `"CONFIGURED"` | Yes |
| callBackSettings | { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } | URL posted following card enrollment or de-enrollment. | Yes |

#### AllAvailableControls Schema

List of all rules and control types available for the given primaryAccountNumber or documentID.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ruleCategories | [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" ] | Allowed rule categories configured for this Sponsor ID.<br>*Example:* `"PCT_GLOBAL"` | No |
| merchantTypeRules | [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ] | Allowed merchant control types configured for this Sponsor ID.<br>*Example:* `"MCT_AIRFARE"` | No |
| transactionTypeRules | [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "TCT_AFT" ] | Allowed merchant control types configured for this Sponsor ID.<br>*Example:* `"TCT_ATM_WITHDRAW"` | No |

#### NotificationDetailsV2-1 Schema

The response resource container. Contains notification details found.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| notificationDetails | [ { **"notificationId"**: string, **"notificationStatus"**: string, <br>**Available values:** "SUCCESSFULLY_SENT", "CLIENT_ERROR", "SYSTEM_ERROR", "CONFIRMATION_PENDING", **"outboundCallDetails"**: { **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } }, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"appID"**: string, **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] | List of notification details found for this request. | Yes |

#### CallBackSettings-1 Schema

URL posted following card enrollment or de-enrollment.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| payloadVersion | string | Payload version to generate for this callback endpoint. Valid values are V1 or V3.<br>*Example:* `"V1"` | No |
| callBackEndpoint | string | Alert notification callback URL.<br>*Example:* `"https://issuer.api.com/sampleVCTChostprocessor/consumertransactioncontrols/enrollments"` | Yes |
| isCallBackDisabled | boolean | Indicates if callback is turned on (false) or off (true). | Yes |
| iscallBackEndpointLocal | boolean | Indicates if callback URL is on a local network. Default value is false. Sent via WSI. | No |

#### DecisionDocument-6 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionID | string | The decisionID assigned to the decision request.  This value is generated by the API. | Yes |
| paymentToken | string | Masked payment token. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| decisionUpdate | { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } |  | Yes |
| decisionRequest | { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string } |  | Yes |
| decisionResponse | { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string } |  | Yes |
| primaryAccountNumber | string | Masked primary account number. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | Yes |
| transactionControlsnapshot | [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] |  | No |

#### CallBackSettings-2 Schema

URL posted following card enrollment or de-enrollment.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| payloadVersion | string | Payload version to generate for this callback endpoint. Valid values are V1 or V3.<br>*Example:* `"V1"` | No |
| callBackEndpoint | string | Alert notification callback URL.<br>*Example:* `"https://issuer.api.com/sampleVCTChostprocessor/consumertransactioncontrols/enrollments"` | Yes |
| isCallBackDisabled | boolean | Indicates if callback is turned on (false) or off (true). | Yes |
| iscallBackEndpointLocal | boolean | Indicates if callback URL is on a local network. Default value is false. Sent via WSI. | No |

#### DecoupleTokenRequest Schema

Object indicating if the PAN or token should be decoupled.  Either the primaryAccountNumber or paymentToken field must be set.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paymentToken | string | Token account number for which the control is to be established.<br>*Example:* `"4000123456789010"` | No |
| shouldDecouple | boolean | Indicates if tokens should be liberated from any card control settings placed on the primaryAccountNumber. If set to 'true' on an enrolled paymentToken the token will operate independently of the PAN's card controls. If set to 'true' on a primaryAccountNumber all related token transactions will be ignored by the PAN's card controls. | Yes |
| primaryAccountNumber | string | Primary account number for which the control is to be established.<br>*Example:* `"4000123456789010"` | No |

#### BulkEnrollmentResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of the call: Success, Partial_Success or Failure.<br>*Example:* `"SUCCESS"` | Yes |
| disqualifyingCards | [ { **"cards"**: [ string ], **"description"**: string } ] | List of disqualifying cards. These cards were not eligible to be added to the group, and will be returned in the response with partial success. HTTP status code will be 207. DisqualifyingCards will not be visible when HTTP status code is 200. | No |

#### AlertOutboundCallDetailsV2-1 Schema

Outbound call details.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorDetails | [ { **"code"**: string, **"reason"**: string } ] | List of error details that occurred during request processing. Includes error codes and messages. | No |
| alertPreferences | { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } |  | No |

#### AppConfigurationCallBackSettingsRequestType Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| callBackSettings | { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } | URL posted following card enrollment or de-enrollment. | Yes |
| fxCallBackSettings | { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } | Alert notification fx callback settings. | No |

#### PaymentToken Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| value | string | The token number for which the decision is to be made, must be between 13 and 19 numeric digits. | Yes |
| tokenType | string | The type of the token. Valid values are: 01, 02, 03, 04, 05, 06 | No |
| requestorID | string | The requestor id associated to the token. | No |
| assuranceLevel | string | The value that indicates the confidence level of the token to PAN/cardholder binding Maximum of 2 digits. | No |
| expirationDate | string | The token expiration date in yyyymm format. Maximum of 6 characters | No |

#### TransactionControlDocument4CardInq-1 Schema

Adding AppId to  Transaction Control Document for Card Inquiry API

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documentID | string | System-generated ID for the control document bound to the account identifier (primaryAccountNumber/paymentToken).<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | No |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| createdOnDate | string | Timestamp when control was added, in UTC<br>*Example:* `"2023-03-21 04:56:12.561"` | No |
| globalControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | Used to set rules that apply to all transactions performed with this account. | No |
| requestedAppID | string | The requested App ID | No |
| shouldDecouple | boolean | Indicates if tokens should be liberated from any card control settings placed on the primaryAccountNumber. If set to "true" on an enrolled paymentToken, the token will operate independently of the PAN's card controls. If set to "true" on a primaryAccountNumber, all related token transactions will be ignored by the PAN's card controls. | No |
| merchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of merchant controls configured for the card. | No |
| lastUpdateTimeStamp | string | Timestamp of when the resource was last updated in UTC.<br>*Example:* `"2025-05-13 04:09:18.799"` | No |
| transactionControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of transaction controls configured for the card. | No |
| customMerchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of custom merchant controls configured for the card. | No |

#### AlertTransactionDetailsV2-1 Schema

Details of the transaction.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| nameOnCard | string | Cardholder name as encoded on the payment instrument.<br>*Example:* `"Alex Miller"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string } | Merchant details. | No |
| paymentToken | string | Masked payment token. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | Yes |
| exchangeRateDetails | { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string } | Exchange rate details provided in the notification payload for a cross-currency transaction when Issuer has configured FX Alerts. | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| primaryAccountNumber | string | Masked primary account number. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| requestReceivedTimeStamp | string | Time, in UTC, the request is received.<br>*Example:* `"'2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | No |

#### MerchantInfo-3 Schema

Merchant details.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| city | string | City where the merchant is located.<br>*Example:* `"San Francisco"` | No |
| name | string | Name of the merchant's business.<br>*Example:* `"Alex Miller Bakery"` | No |
| region | string | Two or three letter state or region code.<br>*Example:* `"US"` | No |
| postalCode | string | Five to nine digit postal/zip code for the merchant.<br>*Example:* `"94105"` | No |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | Yes |
| addressLines | [ string ] | Address of the merchant.<br>*Example:* `"1000 Main Street San Francisco, CA 94105"` | No |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | Yes |
| acceptorTaxId | string | Merchant's Acceptor Tax ID.<br>*Example:* `"123456789"` | No |
| anticipatedAmount | number | The anticipated amount refers to the expected or estimated amount of money involved in a transaction<br>*Example:* `200` | No |
| transactionAmount | number | Total transaction amount in local merchant currency.<br>*Example:* `200` | No |
| merchantAcquirerID | string | The Merchant Acquirer ID is a unique identifier assigned to an acquiring bank or financial institution by Visa. This ID is used to identify the acquiring bank in the payment processing system, allowing for the routing and processing of transactions. <br>*Example:* `"45678"` | No |
| merchantCategoryCode | string | ISO 8583 four-digit merchant classification code identifying the merchant by their business line.<br>*Example:* `"5542"` | Yes |
| cardAcceptorTerminalID | string | Terminal ID of the card acceptor.<br>*Example:* `"45678"` | No |
| cardAcceptorIdentificationCode | string | Merchant card acceptor ID.<br>*Example:* `"123456789"` | No |

#### CollectionResourceSponsorConfigurationDocument Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"appID"**: string, **"region"**: string, <br>**Available values:** "AP", "CAN", "CEMEA", "VE", "LAC", "US", **"sponsorID"**: string, **"appGroupID"**: string, **"sponsorBID"**: string, **"sponsorName"**: string, **"appWhiteList"**: [ { **"type"**: string, **"appID"**: string, **"appType"**: string, **"cardPrefixes"**: [ { **"cardType"**: string, **"cardBrand"**: string, **"isLeadPAN"**: boolean, **"sponsorBID"**: string, **"countryCode"**: string, **"portfolioID"**: string, **"currencyCode"**: string, **"isVTCAllowed"**: boolean, **"isFlexAllowed"**: boolean, **"prefixEndRange"**: string, **"prefixStartRange"**: string, **"cardProgramIdentifier"**: string, **"prefixRangeIdentifier"**: string, **"cardPrefixSponsorLevel"**: boolean, **"isFlexReportingAllowed"**: boolean, **"whiteListConfiguration"**: { **"isFxAlertsAllowed"**: boolean, **"isCardGroupAllowed"**: boolean, **"isTimeDelayAllowed"**: boolean, **"rulesConfiguration"**: [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ], **"isSpendLimitAllowed"**: boolean, **"merchantControlTypes"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"blackListForSpendLimit"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"isMultiCurrencyAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFlexMITRoutingEnabled"**: boolean, **"transactionControlTypes"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"isAlertOnReversalAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"isLastMileDeliveryAllowed"**: boolean, **"customMerchantControlTypes"**: [ string ], **"customAlertsPayloadSettings"**: { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] }, **"isTimeDelayAutoRemovalAllowed"**: boolean } } ], **"applicationName"**: string, **"lastUpdateTimeStamp"**: string, **"defaultWhiteListConfiguration"**: { **"isFxAlertsAllowed"**: boolean, **"isCardGroupAllowed"**: boolean, **"isTimeDelayAllowed"**: boolean, **"rulesConfiguration"**: [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ], **"isSpendLimitAllowed"**: boolean, **"merchantControlTypes"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"blackListForSpendLimit"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"isMultiCurrencyAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFlexMITRoutingEnabled"**: boolean, **"transactionControlTypes"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"isAlertOnReversalAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"isLastMileDeliveryAllowed"**: boolean, **"customMerchantControlTypes"**: [ string ], **"customAlertsPayloadSettings"**: { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] }, **"isTimeDelayAutoRemovalAllowed"**: boolean } } ], **"cardPrefixes"**: [ { **"cardType"**: string, **"cardBrand"**: string, **"isLeadPAN"**: boolean, **"sponsorBID"**: string, **"countryCode"**: string, **"portfolioID"**: string, **"currencyCode"**: string, **"isVTCAllowed"**: boolean, **"isFlexAllowed"**: boolean, **"prefixEndRange"**: string, **"callBackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean }, **"prefixStartRange"**: string, **"cardProgramIdentifier"**: string, **"prefixRangeIdentifier"**: string, **"isFlexReportingAllowed"**: boolean } ], **"shardEnabled"**: boolean, **"createdOnDate"**: dateTime, **"destinationBIN"**: string, **"isDeclineOnAFT"**: boolean, **"migrationStage"**: string, <br>**Available values:** "REPLICA_ONLY", "BEFORE_MIGRATION", "DURING_MIGRATION", "AFTER_MIGRATION", "SHARD_ONLY", **"primaryCluster"**: string, **"isAlertPreferenceV1"**: boolean, **"lastUpdateTimeStamp"**: string, **"registeredApplication"**: string, **"transactionControlsConfiguration"**: { **"countryCode"**: string, **"currencyCode"**: string, **"ruleCategories"**: [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", "PCT_GEO", "PCT_GLOBAL", "PCT_MERCHANT", "PCT_TRANSACTION" ], **"isFxAlertsAllowed"**: boolean, **"isCardGroupAllowed"**: boolean, **"isTimeDelayAllowed"**: boolean, **"isSpendLimitAllowed"**: boolean, **"merchantControlTypes"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"blackListForSpendLimit"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"isMultiCurrencyAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFlexMITRoutingEnabled"**: boolean, **"transactionControlTypes"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"isAlertOnReversalAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"isLastMileDeliveryAllowed"**: boolean, **"customMerchantControlTypes"**: [ string ], **"customAlertsPayloadSettings"**: { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] }, **"isTimeDelayAutoRemovalAllowed"**: boolean, **"enrollmentNotificationCallBackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean }, **"deEnrollmentNotificationCallBackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } } } | Configuration settings for sponsors. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21T04:56:12.551Z"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### PaginationData Schema

Pagination details for this request.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastPage | boolean | Indicates if this is the last page within the paginationData. | Yes |
| firstPage | boolean | Indicates if this is the first page within the paginationData. | Yes |
| pageLimit | string | Maximum number of pages to return. Numeric, between 1 and 100.<br>*Example:* `"50"` | Yes |
| startIndex | string | Page start location. Must be numeric.<br>*Example:* `"1"` | Yes |
| totalCount | long | Total number of decisions available.<br>*Example:* `10` | Yes |
| totalPages | integer | Total number of pages for the result set, based on pageLimit provided.<br>*Example:* `1` | Yes |
| recordCount | integer | Total number of decisions returned in the response.<br>*Example:* `1` | Yes |

#### TypedGroupControl Schema

List of transaction controls configured for the card.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } | When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time. | No |
| spendLimit | { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer } | Used to track and manage total approved account purchases over a period of time. All amounts are based on the cardholderBillAmount in the authorization request. The actual amount submitted for settlement can differ (e.g. tips, hotel, car rental...). | No |
| controlType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" | Indicates specific control type. Valid transactionControls values begin with: "TCT_", valid merchantControls values begin with: "MCT_". ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| alertThreshold | double | Maximum value of an approved purchase for this control type before triggering an alert when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if an alert should be sent.<br>*Example:* `1000` | No |
| filterByCountry | { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] } | Allows cardholders to specify in which countries their card can, or cannot, be used depending on which child attribute is configured. | No |
| declineThreshold | double | Maximum value of a purchase for this control type before triggering a decline when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if a decline should be triggered.<br>*Example:* `1000` | No |
| shouldDeclineAll | boolean | Indicates if VTC will trigger a decline for all transactions related to this control type. Default value will be false. If false, other control settings (e.g. declineThreshold) will be checked. | No |
| transactionLimit | { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer } | Number of transactions to be allowed/approved, after which subsequent transactions will be declined. | No |
| shouldAlertOnDecline | boolean | Indicates if VTC will trigger a decline notification for all transactions matching the associated control type. If false, no alerts will be sent for declined transactions related to this control type. | No |

#### CollectionResourceOfRate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"key"**: string, **"toCurrencyCode"**: string, **"exchangeRateECB"**: string, **"lastUpdatedDate"**: string, **"expiryDateTimeMs"**: long, **"fromCurrencyCode"**: string } |  | Yes |
| receivedTimestamp | string | The time the request is received. Value is in UTC time | Yes |
| processingTimeinMs | long | The processing time in milliseconds | Yes |

#### PagingControlInformation Schema

Paging control information.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| pageLimit | string | Maximum number of pages to return. Numeric, between 1 and 100.<br>*Example:* `"50"` | Yes |
| startIndex | string | Page start location. Must be numeric.<br>*Example:* `"1"` | Yes |

#### MerchantInfo-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| city | string | City where the merchant is located.<br>*Example:* `"San Francisco"` | No |
| name | string | Name of the merchant's business.<br>*Example:* `"Alex Miller Bakery"` | No |
| region | string | Two or three letter state or region code.<br>*Example:* `"US"` | No |
| postalCode | string | Five to nine digit postal/zip code for the merchant.<br>*Example:* `"94105"` | No |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | Yes |
| addressLines | [ string ] | Address of the merchant.<br>*Example:* `"1000 Main Street San Francisco, CA 94105"` | No |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | Yes |
| transactionAmount | number | Total transaction amount in local merchant currency.<br>*Example:* `200` | No |
| merchantCategoryCode | string | ISO 8583 four-digit merchant classification code identifying the merchant by their business line.<br>*Example:* `"5542"` | Yes |
| cardAcceptorTerminalID | string | Terminal ID of the card acceptor.<br>*Example:* `"45678"` | No |

#### MerchantInfo-2 Schema

Merchant details.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| city | string | City where the merchant is located.<br>*Example:* `"San Francisco"` | No |
| name | string | Name of the merchant's business.<br>*Example:* `"Alex Miller Bakery"` | No |
| region | string | Two or three letter state or region code.<br>*Example:* `"US"` | No |
| postalCode | string | Five to nine digit postal/zip code for the merchant.<br>*Example:* `"94105"` | No |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | Yes |
| addressLines | [ string ] | Address of the merchant.<br>*Example:* `"1000 Main Street San Francisco, CA 94105"` | No |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | Yes |
| acceptorTaxId | string | Merchant's Acceptor Tax ID.<br>*Example:* `"123456789"` | No |
| anticipatedAmount | number | The anticipated amount refers to the expected or estimated amount of money involved in a transaction<br>*Example:* `200` | No |
| transactionAmount | number | Total transaction amount in local merchant currency.<br>*Example:* `200` | No |
| merchantAcquirerID | string | The Merchant Acquirer ID is a unique identifier assigned to an acquiring bank or financial institution by Visa. This ID is used to identify the acquiring bank in the payment processing system, allowing for the routing and processing of transactions. <br>*Example:* `"45678"` | No |
| merchantCategoryCode | string | ISO 8583 four-digit merchant classification code identifying the merchant by their business line.<br>*Example:* `"5542"` | Yes |
| cardAcceptorTerminalID | string | Terminal ID of the card acceptor.<br>*Example:* `"45678"` | No |
| cardAcceptorIdentificationCode | string | Merchant card acceptor ID.<br>*Example:* `"123456789"` | No |

#### UserInformation Schema

Optional object to provide the ability to carry additional information about the user that defined the control

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string | Name of the user who configured the control. Required if userInformation is present.<br>*Example:* `"Alex Miller"` | Yes |
| bankingIdentifier | string | Identifier for the issuer to map the username.<br>*Example:* `"BI"` | No |
| applicationDefinedAttributes | [ string ] | Application attributes defined by the issuer.<br>*Example:* `"APP"` | No |

#### CustomerProfilePatchRequest-13 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastName | string | Last name of the cardholder.<br>*Example:* `"Miller"` | Yes |
| firstName | string | First name of the cardholder.<br>*Example:* `"Alex"` | Yes |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | Yes |
| isProfileActive | boolean, <br>**Available values:** true, false | Indicates if customer profile is active. If set to false, alerts cannot be delivered.<br>*Enum:* `true`, `false` | Yes |
| preferredLanguage | string | Preferred language for last mile alerts. Current languages supported are "en-us" (English US) and "es-us"(Spanish US).<br>*Example:* `"en-us"` | Yes |
| defaultAlertsPreferences | [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact. | Yes |

#### WalletServicesAccountInquiryRequest-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documentIDs | [ string ] | List of available transaction control documentIDs where configured rules are required.<br>*Example:* `"[ctc-vd-857a8766-160b-498d-820f-bf4339949c1b]"` | No |
| paymentTokens | [ string ] | List of payment tokens with associated contact details.<br>*Example:* `["4000123456789010","4000123456789011"]` | No |
| primaryAccountNumbers | [ string ] | List of available primary account numbers where configured rules are required.<br>*Example:* `["4000123456789010","4000123456789011"]` | No |

#### CardContactInformation Schema

List of payment tokens with associated contact details.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documentID | string | System-generated ID for the control document bound to the account identifier (primaryAccountNumber/paymentToken).<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | Yes |
| portfolioID | string | Visa-issued identifier for the issuer card prefix. Used when an alert requires different messaging for different segments of a card portfolio. If not configured will default to 001.<br>*Example:* `"003"`<br>**Read-only** | No |
| paymentToken | string | Payment token passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| isProfileActive | boolean | Indicates if customer profile is active. If set to false, alerts cannot be delivered.<br>**Read-only** | Yes |
| alertsPreferences | [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] | List of alert preferences for specific alert types. | Yes |
| primaryAccountNumber | string | Primary account number passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |

#### CardEnquiryMerchantControlResponse-1 Schema

List of merchant control types available for this card.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" | Names of all merchant control types available for this card.<br>*Enum:* `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`<br>*Example:* `"MCT_AIRFARE"` | Yes |

#### TransactionControlReportsResponse-1 Schema

Transaction control document being returned.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| responseMessage | string | Details relating to the management and outcome of the response message.<br>*Example:* `"No controls found for given time range."` | No |
| controlDocuments | [ { **"status"**: string, <br>**Available values:** "ENROLLED", "DEENROLLED", "ADD_CONTROLS", "UPDATE_CONTROLS", "DELETE_CONTROLS", "DELETE_CARD_EXCEPTION", "CARD_EXCEPTION", "DELETE_PAN", "UPDATE_PAN", "BATCH_ADD_CONTROLS", "UPDATE_TOKEN", "DELETE_TOKEN", "SYSTEM_UPDATE", "SYSTEM_CREATE", "SYSTEM_MODIFY", "SYSTEM_DELETE", "ADD_RELATIONSHIP", "UPDATE_RELATIONSHIP", "DELETE_RELATIONSHIP", "ADD_FLEX_RULES", "UPDATE_FLEX_RULES", "DELETE_FLEX_RULES", "DELETE_CARD", "UPDATE_CARD", "ADD_UPDATE_FLEX_RULES", "REPLACE_CARD", **"userId"**: string, **"documentID"**: string, **"createdOnDate"**: string, **"requestedAppID"**: string, **"requestedDocumentID"**: string, **"transactionControlDocument"**: { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } } ] | List of transaction control documents. | No |

#### AlertOutboundCallDetails-13 Schema

Outbound call details.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of the request.<br>*Example:* `"SUCCESS"` | No |
| message | string | Transaction information sent to the cardholder as SMS, email, or push notification. <br>*Example:* `"No controls found for given time range."` | No |
| httpVerb | string | HTTP method used.<br>*Example:* `"POST"` | Yes |
| errorDetails | [ { **"code"**: string, **"reason"**: string } ] | List of error details that occurred during request processing. Includes error codes and messages. | No |
| alertPreferences | { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } |  | No |
| httpResponseCode | integer | Three-digit HTTP code that provides information about request results.<br>*Example:* `200` | Yes |

#### CreateTransactionControlRequestType Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paymentToken | string | Payment token passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| primaryAccountNumber | string | Primary account number passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| alertsEnrollmentDetails | { **"lastName"**: string, **"firstName"**: string, **"countryCode"**: string, **"portfolioID"**: string, **"communityCode"**: string, **"userIdentifier"**: string, **"preferredLanguage"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] } | All alerts enrollment details for the cardholder, if enrolled for last mile delivery of alert notifications through VTA. | No |

#### TimeRange-2 Schema

When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| endTime | string | End time in UTC of a timeRange that bounds a control. Only transactions attempted during the specified timeRange will trigger this control. The format of the string is in 24hr time using HH:MM format.<br>*Example:* `"04:56"` | Yes |
| startTime | string | Start time in UTC of a timeRange that bounds a control. Only transactions attempted during the specified timeRange will trigger this control. Formatted in 24hr time using HH:MM format.<br>*Example:* `"04:56"` | Yes |
| timeZoneID | string | Time zone to be applied to related object in Area/Location format. For example: 'America/Denver' is in United States MST. If not provided, assumed to be UTC. timeZoneID can be applied within timeRange and spendLimit fields to affect endDateTime, startDateTime, endTime, and startTime fields.<br>*Example:* `"UTC"` | Yes |

#### CollectionResourceTransactionControlListResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"controlDocuments"**: [ { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"requestedAppID"**: string, **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### TimeRange-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| endTime | string | End time in UTC of a timeRange that bounds a control. Only transactions attempted during the specified timeRange will trigger this control. The format of the string is in 24hr time using HH:MM format.<br>*Example:* `"04:56"` | Yes |
| startTime | string | Start time in UTC of a timeRange that bounds a control. Only transactions attempted during the specified timeRange will trigger this control. Formatted in 24hr time using HH:MM format.<br>*Example:* `"04:56"` | Yes |
| timeZoneID | string | Time zone to be applied to related object in Area/Location format. For example: 'America/Denver' is in United States MST. If not provided, assumed to be UTC. timeZoneID can be applied within timeRange and spendLimit fields to affect endDateTime, startDateTime, endTime, and startTime fields.<br>*Example:* `"UTC"` | Yes |

#### AlertTransactionDetails-2 Schema

Details of the transaction.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| nameOnCard | string | Cardholder name as encoded on the payment instrument.<br>*Example:* `"Alex Miller"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string } | Merchant details. | No |
| paymentToken | string | Masked payment token. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | Yes |
| exchangeRateDetails | { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string } | Exchange rate details provided in the notification payload for a cross-currency transaction when Issuer has configured FX Alerts. | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| primaryAccountNumber | string | Masked primary account number. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| requestReceivedTimeStamp | string | Time, in UTC, the request is received.<br>*Example:* `"'2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | No |

#### AlertTransactionDetails-1 Schema

Details of the transaction.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| nameOnCard | string | Cardholder name as encoded on the payment instrument.<br>*Example:* `"Alex Miller"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string } | Merchant details. | No |
| paymentToken | string | Masked payment token. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | Yes |
| exchangeRateDetails | { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string } | Exchange rate details provided in the notification payload for a cross-currency transaction when Issuer has configured FX Alerts. | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| primaryAccountNumber | string | Masked primary account number. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| requestReceivedTimeStamp | string | Time, in UTC, the request is received.<br>*Example:* `"'2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | No |

#### TransactionControlDocument4CardInq Schema

Adding AppId to  Transaction Control Document for Card Inquiry API

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documentID | string | System-generated ID for the control document bound to the account identifier (primaryAccountNumber/paymentToken).<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | No |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| createdOnDate | string | Timestamp when control was added, in UTC<br>*Example:* `"2023-03-21 04:56:12.561"` | No |
| globalControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | Used to set rules that apply to all transactions performed with this account. | No |
| requestedAppID | string | The requested App ID | No |
| shouldDecouple | boolean | Indicates if tokens should be liberated from any card control settings placed on the primaryAccountNumber. If set to "true" on an enrolled paymentToken, the token will operate independently of the PAN's card controls. If set to "true" on a primaryAccountNumber, all related token transactions will be ignored by the PAN's card controls. | No |
| merchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of merchant controls configured for the card. | No |
| lastUpdateTimeStamp | string | Timestamp of when the resource was last updated in UTC.<br>*Example:* `"2025-05-13 04:09:18.799"` | No |
| transactionControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of transaction controls configured for the card. | No |
| customMerchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of custom merchant controls configured for the card. | No |

#### CollectionResourceNotificationDetailsV2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"notificationDetails"**: [ { **"notificationId"**: string, **"notificationStatus"**: string, <br>**Available values:** "SUCCESSFULLY_SENT", "CLIENT_ERROR", "SYSTEM_ERROR", "CONFIRMATION_PENDING", **"outboundCallDetails"**: { **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } }, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"transactionDetails"**: { **"nameOnCard"**: string, **"MerchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: object, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: string, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "NONE", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] } | The response resource container. Contains notification details found. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CTCSupportedEntitiesRequest-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paymentToken | string | Payment token passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| primaryAccountNumber | string | Primary account number passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |

#### SummaryInquiryResponse-1 Schema

List of controls and alerts configured/available for a given PAN, token, or documentID.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of control document.<br>*Example:* `"ACTIVE"` | No |
| documentID | string | System-generated ID for the control document bound to the account identifier (primaryAccountNumber/paymentToken).<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | No |
| paymentToken | string | Payment token (first and last four digit unmasked) for which list of the transaction control documents have been retrieved.<br>*Example:* `"4000-xxxx-xxxx-9010"` | No |
| controlDocuments | [ { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] | List of transaction control documents. | No |
| allAvailableControls | { **"ruleCategories"**: [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" ], <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"merchantTypeRules"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" ], <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", **"transactionTypeRules"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" } | List of all rules and control types available for the given primaryAccountNumber or documentID. | No |
| primaryAccountNumber | string | Primary account number (first digit and last four digits unmasked) for which list of the transaction control documents have been retrieved.<br>*Example:* `"4000-xxxx-xxxx-9010"` | No |

#### CollectionResourceAccountUpdateResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "SUCCESS" } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received<br>*Example:* `"2025-05-27 05:13:30.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### DecisionHistoryResponse-3 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS" | Status of the request<br>*Enum:* `"AVAILABLE_RECORDS"`, `"NO_RECORDS"` | Yes |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] | List of decision Documents | Yes |

#### DecisionHistoryResponse-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS" | Status of the request<br>*Enum:* `"AVAILABLE_RECORDS"`, `"NO_RECORDS"` | Yes |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] | List of decision Documents | Yes |

#### DecisionHistoryResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS" | Status of the request<br>*Enum:* `"AVAILABLE_RECORDS"`, `"NO_RECORDS"` | Yes |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] | List of decision Documents | Yes |

#### NotificationDetailsFound Schema

The response resource container. Contains notification details found.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| notificationId | string | Unique notification detail identifier.<br>*Example:* `"ctc-vd-45366159-40c2-43fc-914e-7cf7177badfd"` | Yes |
| notificationStatus | string, <br>**Available values:** "SUCCESSFULLY_SENT", "CLIENT_ERROR", "SYSTEM_ERROR", "CONFIRMATION_PENDING" | Notification status.<br>*Enum:* `"SUCCESSFULLY_SENT"`, `"CLIENT_ERROR"`, `"SYSTEM_ERROR"`, `"CONFIRMATION_PENDING"`<br>*Example:* `"SUCCESSFULLY_SENT"` | Yes |
| outboundCallDetails | { **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } } | Outbound call details. | No |
| outBoundAlertsNotificationPayload | { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"transactionDetails"**: { **"nameOnCard"**: string, **"MerchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: object, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: string, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "NONE", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } | Outbound alerts notification payload. | Yes |

#### DecisionUpdateRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionType | string, <br>**Available values:** "COMPLETE" | The decision request type<br>*Enum:* `"COMPLETE"` | Yes |
| transactionApproved | string, <br>**Available values:** "APPROVED", "DECLINED" | The decision for the completed transaction<br>*Enum:* `"APPROVED"`, `"DECLINED"` | Yes |
| isDeclineResultOfTransactionControl | boolean | Indicates whether the decline decision is the result of the transaction control recommendation.  If not present true will be assumed | No |

#### BaseControl Schema

Used to set rules that apply to all transactions performed with this account.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } | When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time. | No |
| spendLimit | { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer } | Used to track and manage total approved account purchases over a period of time. All amounts are based on the cardholderBillAmount in the authorization request. The actual amount submitted for settlement can differ (e.g. tips, hotel, car rental...). | No |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| alertThreshold | double | Maximum value of an approved purchase (cardholderBillAmount) for this control type before triggering an alert when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if an alert should be sent.<br>*Example:* `1000` | No |
| filterByCountry | { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] } | Allows cardholders to specify in which countries their card can, or cannot, be used depending on which child attribute is configured. | No |
| declineThreshold | double | Maximum value of a purchase (cardholderBillAmount) for this control type before triggering a decline when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if a decline should be triggered.<br>*Example:* `1000` | No |
| shouldDeclineAll | boolean | Indicates if VTC will trigger a decline for all transactions related to this control type. Default value will be false. If false, other control settings (e.g. declineThreshold) will be checked. | No |
| transactionLimit | { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer } | Number of transactions to be allowed/approved, after which subsequent transactions will be declined. | No |
| shouldAlertOnDecline | boolean | Indicates if VTC will trigger a decline notification for all transactions matching the associated control type. If false, no alerts will be sent for declined transactions related to this control type. | No |

#### BaseControl-1 Schema

Used to set rules that apply to all transactions performed with this account.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } | When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time. | No |
| spendLimit | { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer } | Used to track and manage total approved account purchases over a period of time. All amounts are based on the cardholderBillAmount in the authorization request. The actual amount submitted for settlement can differ (e.g. tips, hotel, car rental...). | No |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| alertThreshold | double | Maximum value of an approved purchase for this control type before triggering an alert when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if an alert should be sent.<br>*Example:* `1000` | No |
| filterByCountry | { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] } | Allows cardholders to specify in which countries their card can, or cannot, be used depending on which child attribute is configured. | No |
| declineThreshold | double | Maximum value of a purchase for this control type before triggering a decline when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if a decline should be triggered.<br>*Example:* `1000` | No |
| shouldDeclineAll | boolean | Indicates if VTC will trigger a decline for all transactions related to this control type. Default value will be false. If false, other control settings (e.g. declineThreshold) will be checked. | No |
| transactionLimit | { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer } | Number of transactions to be allowed/approved, after which subsequent transactions will be declined. | No |
| shouldAlertOnDecline | boolean | Indicates if VTC will trigger a decline notification for all transactions matching the associated control type. If false, no alerts will be sent for declined transactions related to this control type. | No |

#### DecisionResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| shouldAlert | boolean | Indicates whether an an alert should be generated | Yes |
| shouldDecline | boolean | Indicates the decline decision/recommendation depending on decision type | Yes |
| declineRuleType | string | indicates thedecline Rule type that triggered the decline decision, only present when shouldDecline is true | No |
| responseMessage | string, <br>**Available values:** "CARD_NOT_ENROLLED" | This field provides more information on the disposition of the response<br>*Enum:* `"CARD_NOT_ENROLLED"` | No |
| alertsRuleDetail | [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ] | List of rules that triggered alerts, only present when alerts are triggerd for a decision | No |
| declineRuleDetail | { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } |  | No |
| declineRuleCategory | string | indicates the decline Rule Category that triggered the decline decision, only present when shouldDecline is true | No |
| declineThresholdAmount | double | indicates the decline threshold amount that was used to trigger the decline decision, only present when shouldDecline is true and a decline threshold has been defined. | No |
| declineControlTargetType | string | Defines the control level that triggered the alert/decline.<br>*Example:* `"CARD_LEVEL"` | No |
| decisionResponseTimeStamp | string | This value will be set automatically when the decision response is sent. Value is in UTC time<br>*Example:* `"2022-05-25 18:45:55"` | Yes |

#### AlertPreferencesRequest-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| alertPreferences | [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] |  | Yes |

#### WalletServicesAccountInquiryResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| accountInquiryResponse | [ { **"status"**: string, **"documentID"**: string, **"paymentToken"**: string, **"controlDocuments"**: [ { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ], **"allAvailableControls"**: { **"ruleCategories"**: [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" ], **"merchantTypeRules"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"transactionTypeRules"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "TCT_AFT" ] }, **"primaryAccountNumber"**: string } ] |  | No |

#### EcbExchangeRateInfo-1 Schema

ECB exchange rates and effective dates.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| exchangeRate | double | ECB rate from the ECB table.<br>*Example:* `123.456` | No |
| lastUpdatedDate | string | Timestamp of when the resource was last updated in UTC. Effective from the ECB table (batch date).<br>*Example:* `"2023-05-25T18:45:55.000Z"` | No |

#### DecisionRequest-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM" | The decision request type.<br>*Enum:* `"RECOMMENDED"`, `"COMPLETE"`, `"ADVICE"`, `"INFORM"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| paymentToken | { **"value"**: string, **"tokenType"**: string, **"requestorID"**: string, **"assuranceLevel"**: string, **"expirationDate"**: string } |  | No |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| primaryAccountNumber | string | The card number for which the decision is to be made, must be between 13 and 19 numeric digits<br>*Example:* `"4000123456789010"` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### RuleDetailV2-1 Schema

List of alerts triggered for a transaction that should be delivered to the cardholder. If transaction was declined, only a single alert detail will be present.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| appID | string | App ID for the control that triggered the alert/decline.<br>*Example:* `"vd-b971963f-12d9-4a28-a8dc-80bf9c31"` | Yes |
| appName | string | App name for the control that triggered the alert/decline.<br>*Example:* `"Issuer App"` | No |
| ruleType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" | Rule type for the control that triggered the alert/decline.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |
| alertReason | string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND" | Reason for the alert. Only present in alertDetails.<br>*Enum:* `"DECLINE_ALL"`, `"DECLINE_TRANS_LIMIT"`, `"DECLINE_BREACHED_AMT"`, `"ALERT_BREACHED_AMT"`, `"DECLINE_BY_ISSUER"`, `"DECLINE_BY_SPEND_LIMIT"`, `"ALERT_BREACHED_SPEND"`<br>*Example:* `"DECLINE_TRANS_LIMIT"` | No |
| ruleCategory | string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" | Rule category for the control that triggered the alert/decline.<br>*Enum:* `"PCT_GLOBAL"`, `"PCT_TRANSACTION"`, `"PCT_MERCHANT"`<br>*Example:* `"PCT_GLOBAL"` | Yes |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 72 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| thresholdAmount | double | Threshold amount for the control that triggered the alert/decline. Only present if thresholdAmount breach caused the trigger.<br>*Example:* `1000` | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| controlTargetType | string | Defines the control level that triggered the alert/decline.<br>*Example:* `"CARD_LEVEL"` | Yes |

#### SponsorConfigObject Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE" | Status of the rule category or control type (eligible or not eligible).<br>*Enum:* `"ELIGIBLE"`, `"NOT_ELIGIBLE"`<br>*Example:* `"ELIGIBLE"` | Yes |
| lastUpdateTimeStamp | string | The time the sponsor configuration was updated. Value is in UTC time | No |
| availableControlTypes | [ object ] |  | No |
| isDetokenizationAllowed | boolean | isDetokenizationAllowed determines if the Token needs to be deTokenized or not. If it's set to true, then in future we will call VTS to de-Tokenize the Token | No |
| isTokenDecouplingAllowed | boolean | isDecouplingAllowed determines if the Token can be decoupled from a PAN or not. | No |
| availablePaymentRuleTypes | [ object ] | Control types available for the Sponsor/Issuer. | No |
| availableMerchantTypeRules | [ object ] | List of merchant control types available for this card. | No |
| configuredPaymentRuleTypes | [ object ] | Rule categories assigned to this card | No |
| configuredMerchantTypeRules | [ object ] | Merchant control types assigned to the Sponsor/Issuer. | No |
| availableTransactionTypeRules | [ object ] | Transaction control types available for the Sponsor/Issuer. | No |
| configuredTransactionTypeRules | [ object ] | Transaction control types assigned to the Sponsor/Issuer. | No |

#### RuleDetailV2 Schema

List of alerts triggered for a transaction that should be delivered to the cardholder. If transaction was declined, only a single alert detail will be present.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| appName | string | App name for the control that triggered the alert/decline.<br>*Example:* `"Issuer App"` | No |
| ruleType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE" | Rule type for the control that triggered the alert/decline.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`, `"NONE"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |
| alertReason | string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "NONE" | Reason for the alert. Only present in alertDetails.<br>*Enum:* `"DECLINE_ALL"`, `"DECLINE_TRANS_LIMIT"`, `"DECLINE_BREACHED_AMT"`, `"ALERT_BREACHED_AMT"`, `"DECLINE_BY_ISSUER"`, `"DECLINE_BY_SPEND_LIMIT"`, `"ALERT_BREACHED_SPEND"`, `"NONE"`<br>*Example:* `"DECLINE_TRANS_LIMIT"` | No |
| ruleCategory | string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" | Rule category for the control that triggered the alert/decline.<br>*Enum:* `"PCT_GLOBAL"`, `"PCT_TRANSACTION"`, `"PCT_MERCHANT"`<br>*Example:* `"PCT_GLOBAL"` | Yes |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 72 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| thresholdAmount | double | Threshold amount for the control that triggered the alert/decline. Only present if thresholdAmount breach caused the trigger.<br>*Example:* `1000` | No |
| triggeringAppID | string | App ID for the control that triggered the alert/decline.<br>*Example:* `"vd-b971963f-12d9-4a28-a8dc-80bf9c31"` | Yes |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| controlTargetType | string | Defines the control level that triggered the alert/decline.<br>*Example:* `"CARD_LEVEL"` | Yes |

#### CardEnquiryTransactionControlResponse Schema

Transaction control types available for this card.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" | Names of all control types available for this card.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |

#### CollectionResourceTransactionControlDocument Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### SponsorMerchantControlsRequestType Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| merchantTypeRules | [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT, MCT_AIRFARE, MCT_ALCOHOL, MCT_APPAREL_AND_ACCESSORIES, MCT_AUTOMOTIVE, MCT_CAR_RENTAL, MCT_ELECTRONICS, MCT_SPORT_AND_RECREATION, MCT_GAMBLING, MCT_GAS_AND_PETROLEUM, MCT_GROCERY, MCT_HOTEL_AND_LODGING, MCT_HOUSEHOLD, MCT_PERSONAL_CARE, MCT_SMOKE_AND_TOBACCO, MCT_DINING" ] | Merchant control types enabled for the Sponsor/Issuer.<br>*Example:* `"[MCT_AIRFARE, MCT_GROCERY]"` | Yes |

#### SponsorConfigObject-1 Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Configuration status. | Yes |
| cardPrefixes | [ { **"cardType"**: string, **"cardBrand"**: string, **"isVTCAllowed"**: boolean, **"prefixEndRange"**: string, **"callBackSettings"**: { **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean }, **"prefixStartRange"**: string, **"cardProgramIdentifier"**: string, **"prefixRangeIdentifier"**: string } ] | List of card prefixes configured for this Sponsor ID | Yes |
| availablePaymentRuleTypes | [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", "PCT_AGENT" ] | Available Rule categories configured for this Sponsor ID | Yes |
| configuredPaymentRuleTypes | [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" ] | Configured Rule categories configured for this Sponsor ID | Yes |
| cardEnrollmentCallbackSettings | { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } | URL of the card enrollment service that will be posted when a new card is enrolled or de-enrolled | Yes |

#### AllAvailableControls-1 Schema

List of all rules and control types available for the given primaryAccountNumber or documentID.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ruleCategories | [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" ], <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" | Allowed rule categories configured for this Sponsor ID.<br>*Enum:* `"PCT_GLOBAL"`, `"PCT_TRANSACTION"`, `"PCT_MERCHANT"`<br>*Example:* `"PCT_GLOBAL"` | No |
| merchantTypeRules | [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" ], <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" | Allowed merchant control types configured for this Sponsor ID.<br>*Enum:* `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`<br>*Example:* `"MCT_AIRFARE"` | No |
| transactionTypeRules | [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" | Allowed merchant control types configured for this Sponsor ID.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | No |

#### MerchantInfo Schema

Merchant details.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| city | string | City where the merchant is located.<br>*Example:* `"San Francisco"` | No |
| name | string | Name of the merchant's business.<br>*Example:* `"Alex Miller Bakery"` | No |
| region | string | Two or three letter state or region code.<br>*Example:* `"US"` | No |
| postalCode | string | Five to nine digit postal/zip code for the merchant.<br>*Example:* `"94105"` | No |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | Yes |
| addressLines | [ string ] | Address of the merchant.<br>*Example:* `"1000 Main Street San Francisco, CA 94105"` | No |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | Yes |
| acceptorTaxId | string | Merchant's Acceptor Tax ID.<br>*Example:* `"123456789"` | No |
| anticipatedAmount | number | The anticipated amount refers to the expected or estimated amount of money involved in a transaction<br>*Example:* `200` | No |
| transactionAmount | object | Total transaction amount in local merchant currency.<br>*Example:* `"0.62"` | No |
| merchantAcquirerID | string | The Merchant Acquirer ID is a unique identifier assigned to an acquiring bank or financial institution by Visa. This ID is used to identify the acquiring bank in the payment processing system, allowing for the routing and processing of transactions. <br>*Example:* `"45678"` | No |
| merchantCategoryCode | string | ISO 8583 four-digit merchant classification code identifying the merchant by their business line.<br>*Example:* `"5542"` | Yes |
| cardAcceptorTerminalID | string | Terminal ID of the card acceptor.<br>*Example:* `"45678"` | No |
| cardAcceptorIdentificationCode | string | Merchant card acceptor ID.<br>*Example:* `"123456789"` | No |

#### TransactionControlListResponse Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| controlDocuments | [ { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"requestedAppID"**: string, **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] | List of transaction control documents. | No |

#### CreateTransactionControlRequestType-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paymentToken | string | Payment token passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| primaryAccountNumber | string | Primary account number passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| alertsEnrollmentDetails | { **"lastName"**: string, **"firstName"**: string, **"countryCode"**: string, **"portfolioID"**: string, **"communityCode"**: string, **"userIdentifier"**: string, **"preferredLanguage"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] } | All alerts enrollment details for the cardholder, if enrolled for last mile delivery of alert notifications through VTA. | No |

#### DecisionUpdateModel Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionType | string, <br>**Available values:** "COMPLETE" | The decision request type<br>*Enum:* `"COMPLETE"` | Yes |
| lastUpdateTimeStamp | string | This field will be set automatically when the decision update is received. Value is in UTC time. | Yes |
| transactionApproved | string, <br>**Available values:** "APPROVED", "DECLINED" | The decision for the completed transaction<br>*Enum:* `"APPROVED"`, `"DECLINED"` | Yes |
| isDeclineResultOfTransactionControl | boolean | Indicates whether the decline decision is the result of the transaction control recommendation.  If not present true will be assumed | No |

#### AlertNotificationDeliveryCallbackPayloadV2-1 Schema

Outbound alerts notification payload.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| transactionTypes | [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" | Enum for the type of transaction.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |
| transactionDetails | { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string } | Details of the transaction. | Yes |
| transactionOutcome | { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"appID"**: string, **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } | Outcome of the transaction. | Yes |

#### NotificationDetailsFound-1 Schema

The response resource container. Contains notification details found.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| notificationId | string | Unique notification detail identifier.<br>*Example:* `"ctc-vd-45366159-40c2-43fc-914e-7cf7177badfd"` | Yes |
| notificationStatus | string, <br>**Available values:** "SUCCESSFULLY_SENT", "CLIENT_ERROR", "SYSTEM_ERROR", "CONFIRMATION_PENDING" | Notification status.<br>*Enum:* `"SUCCESSFULLY_SENT"`, `"CLIENT_ERROR"`, `"SYSTEM_ERROR"`, `"CONFIRMATION_PENDING"`<br>*Example:* `"SUCCESSFULLY_SENT"` | Yes |
| outboundCallDetails | { **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } } | Outbound call details. | No |
| outBoundAlertsNotificationPayload | { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"appID"**: string, **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } | Outbound alerts notification payload. | Yes |

#### AppWhiteList Schema

List of app IDs enabled in the allowlist.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string | Type of application requesting to be enabled by the Sponsor/Issuer.<br>*Example:* `"ISSUER"` | Yes |
| appID | string | Identifier for the application requesting to be enabled by the Sponsor/Issuer.<br>*Example:* `"vd-b971963f-12d9-4a28-a8dc-80bf9c31"` | Yes |
| appType | string |  | No |
| cardPrefixes | [ { **"cardType"**: string, **"cardBrand"**: string, **"isLeadPAN"**: boolean, **"sponsorBID"**: string, **"countryCode"**: string, **"portfolioID"**: string, **"currencyCode"**: string, **"isVTCAllowed"**: boolean, **"isFlexAllowed"**: boolean, **"prefixEndRange"**: string, **"prefixStartRange"**: string, **"cardProgramIdentifier"**: string, **"prefixRangeIdentifier"**: string, **"cardPrefixSponsorLevel"**: boolean, **"isFlexReportingAllowed"**: boolean, **"whiteListConfiguration"**: { **"isFxAlertsAllowed"**: boolean, **"isCardGroupAllowed"**: boolean, **"isTimeDelayAllowed"**: boolean, **"rulesConfiguration"**: [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ], **"isSpendLimitAllowed"**: boolean, **"merchantControlTypes"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"blackListForSpendLimit"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"isMultiCurrencyAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFlexMITRoutingEnabled"**: boolean, **"transactionControlTypes"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"isAlertOnReversalAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"isLastMileDeliveryAllowed"**: boolean, **"customMerchantControlTypes"**: [ string ], **"customAlertsPayloadSettings"**: { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] }, **"isTimeDelayAutoRemovalAllowed"**: boolean } } ] | List of card prefixes enabled for the Whitelisted App ID. | No |
| applicationName | string | Name of the application requesting to be enabled by the Sponsor/Issuer.<br>*Example:* `"Visa Mobile App"` | Yes |
| lastUpdateTimeStamp | string | Timestamp of when the resource was last updated in UTC.<br>*Example:* `"2023-03-21T04:56:20.000Z"` | No |
| defaultWhiteListConfiguration | { **"isFxAlertsAllowed"**: boolean, **"isCardGroupAllowed"**: boolean, **"isTimeDelayAllowed"**: boolean, **"rulesConfiguration"**: [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ], **"isSpendLimitAllowed"**: boolean, **"merchantControlTypes"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"blackListForSpendLimit"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"isMultiCurrencyAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFlexMITRoutingEnabled"**: boolean, **"transactionControlTypes"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"isAlertOnReversalAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"isLastMileDeliveryAllowed"**: boolean, **"customMerchantControlTypes"**: [ string ], **"customAlertsPayloadSettings"**: { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] }, **"isTimeDelayAutoRemovalAllowed"**: boolean } | Default settings for the allowlist. | No |

#### AlertOutboundCallDetails Schema

Outbound call details.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of the request.<br>*Example:* `"SUCCESS"` | No |
| message | string | Transaction information sent to the cardholder as SMS, email, or push notification. <br>*Example:* `"No controls found for given time range."` | No |
| httpVerb | string | HTTP method used.<br>*Example:* `"POST"` | Yes |
| errorDetails | [ { **"code"**: string, **"reason"**: string } ] | List of error details that occurred during request processing. Includes error codes and messages. | No |
| alertPreferences | { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } |  | No |
| httpResponseCode | integer | Three-digit HTTP code that provides information about request results.<br>*Example:* `200` | Yes |

#### CustomerProfileDocument-13 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cards | [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ] | List of PANs with associated contact details. | Yes |
| tokens | [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ] | List of payment tokens with associated contact details. | Yes |
| lastName | string | Last name of the cardholder.<br>*Example:* `"Miller"` | Yes |
| firstName | string | First name of the cardholder.<br>*Example:* `"Alex"` | Yes |
| createdOnDate | string | Timestamp when control was added, in UTC.<br>*Example:* `"2025-05-13 04:09:18.799"` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 72 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | Yes |
| isProfileActive | boolean, <br>**Available values:** true, false | Indicates if customer profile is active. If set to false, alerts cannot be delivered.<br>*Enum:* `true`, `false` | Yes |
| alertsPreferences | [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] | List of alert preferences for specific alert types.<br>**Read-only** | Yes |
| preferredLanguage | string | Preferred language for last mile alerts. Current languages supported are "en-us" (English US) and "es-us"(Spanish US).<br>*Example:* `"en-us"` | Yes |
| lastUpdateTimeStamp | string | Timestamp of when the resource was last updated in UTC.<br>*Example:* `"2025-05-13 04:09:18.799"` | No |
| preferredCountryCode | string | Uppercase ISO ALPHA-3 3-letter country code. Currently only "USA" supported.<br>*Example:* `"USA"` | Yes |
| defaultAlertsPreferences | [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact. | Yes |

#### CollectionResourceTransactionControlDocument-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### FilterByCountry Schema

Allows cardholders to specify in which countries their card can, or cannot, be used depending on which child attribute is configured.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| controlEnabledCountryList | [ string ] | List of countries where this control will be applied. Uppercase ISO 3166 3-letter country code.<br>*Example:* `["USA","CAN","GBR"]` | No |
| controlDisabledCountryList | [ string ] | List of countries where this control will not be applied. Uppercase ISO 3166 3-letter country code.<br>*Example:* `["USA","CAN","GBR"]` | No |

#### FilterByCountry-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| controlEnabledCountryList | [ string ] | List of countries where this control will be applied. Uppercase ISO 3166 3-letter country code.<br>*Example:* `"[USA]"` | No |
| controlDisabledCountryList | [ string ] | List of countries where this control will not be applied. Uppercase ISO 3166 3-letter country code.<br>*Example:* `"[USA]"` | No |

#### CollectionResourceVoid Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | object | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CardDetail Schema

Provide cardDetails to set up controls and restrict access based on cardholder name or card sequence number. If used, the processor must provide the same transaction data when invoking the decision request and the authorization engine will attempt to use the details to locate a transaction control. If the card data is not matched from the transaction data, the control will not affect the transaction.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| nameOnCard | string | Cardholder name as encoded on the payment instrument.<br>*Example:* `"Alex Miller"` | No |
| sequenceOnCard | string | Card sequence number as encoded on the payment instrument.<br>*Example:* `"003"` | No |

#### AlertOutboundCallDetails-1 Schema

Outbound call details.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of the request.<br>*Example:* `"SUCCESS"` | No |
| message | string | Transaction information sent to the cardholder as SMS, email, or push notification. <br>*Example:* `"No controls found for given time range."` | No |
| httpVerb | string | HTTP method used.<br>*Example:* `"POST"` | Yes |
| errorDetails | [ { **"code"**: string, **"reason"**: string } ] | List of error details that occurred during request processing. Includes error codes and messages. | No |
| alertPreferences | { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } |  | No |
| httpResponseCode | integer | Three-digit HTTP code that provides information about request results.<br>*Example:* `200` | Yes |

#### StatusResponseType Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of contact. If "InActive", default contact preferences will deliver last mile alerts to cardholder. | No |

#### NotificationInquiryRequestPayload Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string } | When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time. | No |
| pagination | { **"pageLimit"**: string, **"startIndex"**: string } | Paging control information. | Yes |
| documentIds | [ string ] | List of documentIDs for which Alert History is requested.<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | No |
| paymentToken | string | Token account number for which the control is to be established.<br>*Example:* `"4000123456789010"` | No |
| includeAlertDetails | boolean | Indicates if alertDetails object will be populated in response. Defaults to false. | No |
| primaryAccountNumber | string | Card account number for which the control details are to be returned.<br>*Example:* `"4000123456789010"` | No |
| includeContactDetails | boolean | Indicates if contacts object will be populated in response. Defaults to false. | No |
| includeMerchantDetails | boolean | Indicates if merchantInfo object will be populated in response. Defaults to false. | No |

#### FilterByCountry-2 Schema

Allows cardholders to specify in which countries their card can, or cannot, be used depending on which child attribute is configured.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| controlEnabledCountryList | [ string ] | List of countries where this control will be applied. Uppercase ISO 3166 3-letter country code.<br>*Example:* `"[USA]"` | No |
| controlDisabledCountryList | [ string ] | List of countries where this control will not be applied. Uppercase ISO 3166 3-letter country code.<br>*Example:* `"[USA]"` | No |

#### AlertPreferences-13 Schema

List of alert preferences for specific alert types.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| contacts | [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contacts associated with alert preference. | Yes |
| alertType | string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER" | Transaction events supported with generated alerts. ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Enum:* `"DECLINE_ALL"`, `"DECLINE_BREACHED_AMT"`, `"ALERT_BREACHED_AMT"`, `"DECLINE_BY_SPEND_LIMIT"`, `"ALERT_BREACHED_SPEND"`, `"DECLINE_BY_ISSUER"`<br>*Example:* `"DECLINE_ALL"` | Yes |
| controlType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" | Indicates specific control type. Valid transactionControls values begin with: "TCT_", valid merchantControls values begin with: "MCT_". ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`, `"GLOBAL"`, `"ALL"`<br>*Example:* `"TCT_ATM_WITHDRAWAL"` | Yes |

#### DecisionHistoryRequest Schema

Get Decision History Page by Card - Request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documentIds | [ string ] | The list of documentId of control document. All the documentIds must point to the same pan | No |
| paymentToken | string | Token account number for which the control details are to be returned.<br>*Example:* `"4000123456789010"` | No |
| paginationData | { **"pageLimit"**: string, **"startIndex"**: string } | Paging control information. | No |
| primaryAccountNumber | string | The card number for the list of documents, must be between 13 and 19 numeric digits | No |

#### SpendLimit Schema

Used to track and manage total approved account purchases over a period of time. All amounts are based on the cardholderBillAmount in the authorization request. The actual amount submitted for settlement can differ (e.g. tips, hotel, car rental...).

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING" | Time period that the control spans. LMT_MONTH: until the end of that month. LMT_WEEK: 7-day period. LMT_DAY: 24 hour period. LMT_DATE_RANGE: date range specified in startDateTime and endDateTime. LMT_RECURRING: recurring period, number of days specified in recurringCycleTime.<br>*Enum:* `"LMT_MONTH"`, `"LMT_WEEK"`, `"LMT_DAY"`, `"LMT_DATE_RANGE"`, `"LMT_RECURRING"`<br>*Example:* `"LMT_WEEK"` | Yes |
| timeZoneID | string | Time zone to be applied to related object in Area/Location format. For example: 'America/Denver' is in United States MST. If not provided, assumed to be UTC. timeZoneID can be applied within timeRange and spendLimit fields to affect endDateTime, startDateTime, endTime, and startTime fields.<br>*Example:* `"UTC"` | No |
| endDateTime | string | End date and time in UTC of a timeRange that bounds a control.<br>*Example:* `"2025-06-21 04:56"` | No |
| startDateTime | string | Starting date and time of a date and time range bounding a control, in the time zone set by the timeZoneID.<br>*Example:* `"2025-06-21 03:51"` | No |
| alertThreshold | double | Maximum total value of approved purchases within the time period before triggering an alert. Purchases that meet or exceed the limit set to this control type will not trigger another spendLimit alert until everything is reset when the next time period begins.<br>*Example:* `1000` | No |
| currentPeriodEnd | string | Ending timestamp for current spending period in UTC.<br>*Example:* `"2025-06-21 04:56:00"` | No |
| declineThreshold | double | Maximum total value of approved purchases within the time period before triggering a decline.<br>*Example:* `1000` | Yes |
| currentPeriodSpend | double | Total amount of all approved transactions performed within the time period for this control type. Reset once a new time period begins by the amount of the first transaction.<br>*Example:* `200` | Yes |
| recurringCycleTime | integer | Number of days after which the currentPeriodSpend is reset and a new cycle begins. Required only when type = LMT_RECURRING; in all other cases, the field is optional and even if present, it will be ignored.<br>*Example:* `366` | No |

#### AlertNotificationDeliveryCallbackPayloadV2 Schema

Outbound alerts notification payload.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| transactionTypes | [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ] | Enum for the type of transaction.<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |
| transactionDetails | { **"nameOnCard"**: string, **"MerchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: object, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: string, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string } | Details of the transaction. | Yes |
| transactionOutcome | { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "NONE", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } | Outcome of the transaction. | Yes |

#### NotificationInquiryRequestV2 Schema

NotificationInquiryRequestPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string } | When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time. | No |
| pagination | { **"pageLimit"**: string, **"startIndex"**: string } | Paging control information. | Yes |
| documentIds | [ string ] | List of documentIDs for which Alert History is requested.<br>*Example:* `"[ctc-vd-857a8766-160b-498d-820f-bf4339949c1b]"` | No |
| paymentTokens | [ string ] | List of payment tokens with associated contact details.<br>*Example:* `[4000123456789010]` | No |
| includeAlertDetails | boolean | Indicates if alertDetails object will be populated in response. Defaults to false. | No |
| includeContactDetails | boolean | Indicates if contacts object will be populated in response. Defaults to false. | No |
| primaryAccountNumbers | [ string ] | Card number for which alert history details are to be returned.<br>*Example:* `[4000123456789010]` | No |
| includeMerchantDetails | boolean | Indicates if merchantInfo object will be populated in response. Defaults to false. | No |

#### CollectionResourceSponsorConfigObject Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", **"lastUpdateTimeStamp"**: string, **"availableControlTypes"**: [ object ], **"isDetokenizationAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"availablePaymentRuleTypes"**: [ object ], **"availableMerchantTypeRules"**: [ object ], **"configuredPaymentRuleTypes"**: [ object ], **"configuredMerchantTypeRules"**: [ object ], **"availableTransactionTypeRules"**: [ object ], **"configuredTransactionTypeRules"**: [ object ] } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21T04:56:12.551Z"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### TransactionLimit Schema

Number of transactions to be allowed/approved, after which subsequent transactions will be declined.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| maxTransactionCount | integer | Number of transactions permitted. After the transaction count is reached, then subsequent transactions are declined. Counts apply to specific processing codes, on Visa processed transactions, and is limited to the Global control type.<br>*Example:* `10` | Yes |
| currentTransactionCount | integer | Total number of transactions approved since the start of this limit. Counts will apply where processing code is present, on Visa processed transactions. currentTransactionCount is limited for use only with the Global control type.<br>*Example:* `10` | No |

#### CardEnquiryTransactionControlResponse-1 Schema

Transaction control types available for this card.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" | Names of all control types available for this card.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |

#### NotificationDetails-1 Schema

The response resource container. Contains notification details found.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| notificationDetails | [ { **"outboundCallDetails"**: { **"status"**: string, **"message"**: string, **"httpVerb"**: string, **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string }, **"httpResponseCode"**: integer }, **"notificationDetailId"**: string, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] | List of notification details found for this request. | Yes |

#### Error-1 Schema

List of error details that occurred during request processing. Includes error codes and messages.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string | HTTP error code. 3xx = Redirection, 4xx = Client Error, 5xx = Server Error.<br>*Example:* `"400"` | No |
| reason | string | Indicates reason for failure or error.<br>*Example:* `"VTA Error"` | No |

#### StatusResponseType-1 Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of contact. If "Inactive", default contact preferences will deliver last mile alerts to cardholder. | No |

#### CollectionResourceWhiteListAppControlTypeObject Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "CONFIGURED,NOT_CONFIGURED", **"cardPrefixes"**: [ { **"cardType"**: string, **"cardBrand"**: string, **"isLeadPAN"**: boolean, **"sponsorBID"**: string, **"countryCode"**: string, **"portfolioID"**: string, **"currencyCode"**: string, **"isVTCAllowed"**: boolean, **"isFlexAllowed"**: boolean, **"prefixEndRange"**: string, **"callBackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean }, **"prefixStartRange"**: string, **"cardProgramIdentifier"**: string, **"prefixRangeIdentifier"**: string, **"isFlexReportingAllowed"**: boolean } ], **"isSpendLimitAllowed"**: boolean, **"lastUpdateTimeStamp"**: string, **"detokenizationAllowed"**: boolean, **"isMultiCurrencyAllowed"**: boolean, **"tokenDecouplingAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"availablePaymentRuleTypes"**: [ object ], **"availableMerchantTypeRules"**: [ object ], **"configuredPaymentRuleTypes"**: [ object ], **"configuredMerchantTypeRules"**: [ object ], **"availableTransactionTypeRules"**: [ object ], **"configuredTransactionTypeRules"**: [ object ] } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21T04:56:12.551Z"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### PreEvalDecisionRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "PREEVAL" | The decision request type.<br>*Enum:* `"PREEVAL"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| paymentToken | { **"value"**: string, **"tokenType"**: string, **"requestorID"**: string, **"assuranceLevel"**: string, **"expirationDate"**: string } |  | No |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| primaryAccountNumber | string | The card number for which the decision is to be made, must be between 13 and 19 numeric digits<br>*Example:* `"4000123456789010"` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### CollectionResourceBulkDecoupleTokenResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "Success", "PartialSuccess", "Failed", **"response"**: [ { **"index"**: integer, **"reason"**: string, **"documentID"**: string, **"statusCode"**: integer, **"shouldDecouple"**: boolean } ] } | The response resource container. Contains status of operation and list of tokens to decouple. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CardInquiryRequest-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paymentToken | string | Token account number for which the control details are to be returned.<br>*Example:* `"4000123456789010"` | No |
| primaryAccountNumber | string | Card account number for which the control details are to be returned.<br>*Example:* `"4000123456789010"` | Yes |

#### GroupTransactionControlRequest Schema

All control types to be applied to the list of cards being enrolled.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| globalControl | { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean } | Used to set rules that apply to all transactions performed with this account. | No |
| merchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean } ] | If provided, includes the list of defined merchant controls that have been configured for the card. | No |
| transactionControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean } ] | List of transaction controls configured for the card. | No |

#### SponsorTransactionControlsRequestType Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| transactionTypeRules | [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ] | Transaction control types enabled for the Sponsor/Issuer.<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |

#### FxCallBackSettings-1 Schema

Alert notification fx callback settings.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| payloadVersion | string | Payload version to generate for this callback endpoint. Valid values are V1 or V3.<br>*Example:* `"V1"` | No |
| callBackEndpoint | string | Alert notification callback URL.<br>*Example:* `"https://issuer.api.com/sampleVCTChostprocessor/consumertransactioncontrols/enrollments"` | Yes |
| isCallBackDisabled | boolean | Indicates if callback is turned on (false) or off (true). | Yes |
| iscallBackEndpointLocal | boolean | Indicates if callback URL is on a local network. Default value is false. Sent via WSI. | No |

#### NotificationDetailsV2-13 Schema

The response resource container. Contains notification details found.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| notificationDetails | [ { **"notificationId"**: string, **"notificationStatus"**: string, <br>**Available values:** "SUCCESSFULLY_SENT", "CLIENT_ERROR", "SYSTEM_ERROR", "CONFIRMATION_PENDING", **"outboundCallDetails"**: { **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } }, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"appID"**: string, **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] | List of notification details found for this request. | Yes |

#### TransactionControlReportsDocument-1 Schema

List of transaction control documents.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "ENROLLED", "DEENROLLED", "ADD_CONTROLS", "UPDATE_CONTROLS", "DELETE_CONTROLS", "DELETE_CARD_EXCEPTION", "CARD_EXCEPTION", "DELETE_PAN", "UPDATE_PAN", "BATCH_ADD_CONTROLS", "UPDATE_TOKEN", "DELETE_TOKEN", "SYSTEM_UPDATE", "SYSTEM_CREATE", "SYSTEM_MODIFY", "SYSTEM_DELETE", "ADD_RELATIONSHIP", "UPDATE_RELATIONSHIP", "DELETE_RELATIONSHIP", "ADD_FLEX_RULES", "UPDATE_FLEX_RULES", "DELETE_FLEX_RULES", "DELETE_CARD", "UPDATE_CARD", "ADD_UPDATE_FLEX_RULES", "REPLACE_CARD" | Status of contact. If "Inactive", default contact preferences will deliver last mile alerts to cardholder.<br>*Enum:* `"ENROLLED"`, `"DEENROLLED"`, `"ADD_CONTROLS"`, `"UPDATE_CONTROLS"`, `"DELETE_CONTROLS"`, `"DELETE_CARD_EXCEPTION"`, `"CARD_EXCEPTION"`, `"DELETE_PAN"`, `"UPDATE_PAN"`, `"BATCH_ADD_CONTROLS"`, `"UPDATE_TOKEN"`, `"DELETE_TOKEN"`, `"SYSTEM_UPDATE"`, `"SYSTEM_CREATE"`, `"SYSTEM_MODIFY"`, `"SYSTEM_DELETE"`, `"ADD_RELATIONSHIP"`, `"UPDATE_RELATIONSHIP"`, `"DELETE_RELATIONSHIP"`, `"ADD_FLEX_RULES"`, `"UPDATE_FLEX_RULES"`, `"DELETE_FLEX_RULES"`, `"DELETE_CARD"`, `"UPDATE_CARD"`, `"ADD_UPDATE_FLEX_RULES"`, `"REPLACE_CARD"`<br>*Example:* `"ENROLLED"` | No |
| userId | string | User ID of the person/system invoking the service.<br>*Example:* `"1222"` | No |
| documentID | string | Uniquely identifies the control document that triggered the notification.<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | Yes |
| createdOnDate | string | Timestamp when control was added, in UTC.<br>*Example:* `"2023-03-21 04:56:12.561"` | No |
| requestedAppID | string | Unique ID assigned by VDP to identify a transaction control management application.<br>*Example:* `"vd-b971963f-12d9-4a28-a8dc-80bf9c31"` | No |
| requestedDocumentID | string | System generated ID for the control document bound to the PAN or token.<br>*Example:* `"ctc-vd-b971963f-12d9-4a28-a8dc-80bf9c31e9f6"` | No |
| transactionControlDocument | { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } |  | No |

#### CardDetail-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| nameOnCard | string | Cardholder name as encoded on the payment instrument.<br>*Example:* `"Alex Miller"` | No |
| sequenceOnCard | string | Card sequence number as encoded on the payment instrument.<br>*Example:* `"003"` | No |

#### TimeRange Schema

When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| endTime | string | End time in UTC of a timeRange that bounds a control. Only transactions attempted during the specified timeRange will trigger this control. The format of the string is in 24hr time using HH:MM format.<br>*Example:* `"04:56"` | Yes |
| startTime | string | Start time in UTC of a timeRange that bounds a control. Only transactions attempted during the specified timeRange will trigger this control. Formatted in 24hr time using HH:MM format.<br>*Example:* `"04:56"` | Yes |
| timeZoneID | string | Time zone to be applied to related object in Area/Location format. For example: 'America/Denver' is in United States MST. If not provided, assumed to be UTC. timeZoneID can be applied within timeRange and spendLimit fields to affect endDateTime, startDateTime, endTime, and startTime fields.<br>*Example:* `"UTC"` | Yes |

#### AlertPreferences-1 Schema

List of alert preferences for specific alert types.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| contacts | [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contacts associated with alert preference. | Yes |
| alertType | string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER" | Transaction events supported with generated alerts. ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Enum:* `"DECLINE_ALL"`, `"DECLINE_BREACHED_AMT"`, `"ALERT_BREACHED_AMT"`, `"DECLINE_BY_SPEND_LIMIT"`, `"ALERT_BREACHED_SPEND"`, `"DECLINE_BY_ISSUER"`<br>*Example:* `"DECLINE_ALL"` | Yes |
| controlType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" | Indicates specific control type. Valid transactionControls values begin with: "TCT_", valid merchantControls values begin with: "MCT_". When alertType is DECLINE_BY_ISSUER, the only valid controlType value is ALL.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`, `"GLOBAL"`, `"ALL"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |

#### CardDetail-2 Schema

Provide cardDetails to set up controls and restrict access based on cardholder name or card sequence number. If used, the processor must provide the same transaction data when invoking the decision request and the authorization engine will attempt to use the details to locate a transaction control. If the card data is not matched from the transaction data, the control will not affect the transaction.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| nameOnCard | string | Cardholder name as encoded on the payment instrument.<br>*Example:* `"Alex Miller"` | No |
| sequenceOnCard | string | Card sequence number as encoded on the payment instrument.<br>*Example:* `"003"` | No |

#### ContactPreferenceDetails-2 Schema

List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of contact. If "InActive", default contact preferences will deliver last mile alerts to cardholder.<br>*Example:* `"Active"` | No |
| isVerified | boolean, <br>**Available values:** true, false | Indicates if contact type has been verified by issuer. Contacts mapped to cardholder must be verified. Currently, VISA only supports the double opt in verification for SMS-type contacts if field is set to false. For any other contact type, Visa will not conduct additional verification. Issuer should only allow verified contacts to be used as contact preferences. Double opt in feature is not supported in sandbox. For last mile alert delivery testing in sandbox this field must be set to true.<br>*Enum:* `true`, `false`<br>*Example:* `true` | No |
| callingCode | string | Code for SMS contact types. If not set for an SMS contact, default value is "1".<br>*Example:* `"52"` | No |
| contactType | string | Channel to deliver alert message. Supported channels include SMS, Push, Email. (Only email is supported in sandbox.)<br>*Example:* `"Email"` | Yes |
| contactValue | string | Email address, phone number or device ID associated with contactType.<br>*Example:* `"alexmiller@example.com"` | Yes |
| preferredEmailFormat | string, <br>**Available values:** "Plain", "RichText", "Html" | Preferred email format for email contact types. If not provided for an email contact, default value is set to "Plain".<br>*Enum:* `"Plain"`, `"RichText"`, `"Html"`<br>*Example:* `"Plain"` | No |

#### CustomerProfile-1 Schema

All alerts enrollment details for the cardholder, if enrolled for last mile delivery of alert notifications through VTA.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastName | string | Last name of the cardholder.<br>*Example:* `"Miller"` | Yes |
| firstName | string | First name of the cardholder.<br>*Example:* `"Alex"` | Yes |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | Yes |
| portfolioID | string | Visa-issued identifier for the issuer card prefix. Used when an alert requires different messaging for different segments of a card portfolio. If not configured will default to 001.<br>*Example:* `"003"` | No |
| communityCode | string | Default community assigned by API. The default is the sponsor BID description.<br>*Example:* `"123456789"`<br>**Read-only** | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 72 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | Yes |
| preferredLanguage | string | Preferred language for last mile alerts. Current languages supported are "en-us" (English US) and "es-us"(Spanish US).<br>*Example:* `"en-us"` | Yes |
| defaultAlertsPreferences | [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact. | Yes |

#### CollectionResourceAppConfigurationCallBackSettingsResponseType Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "NOT_CONFIGURED", "CONFIGURED", **"callBackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### NotificationDetails-13 Schema

The response resource container. Contains notification details found.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| notificationDetails | [ { **"outboundCallDetails"**: { **"status"**: string, **"message"**: string, **"httpVerb"**: string, **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string }, **"httpResponseCode"**: integer }, **"notificationDetailId"**: string, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] | List of notification details found for this request. | Yes |

#### CollectionResourceAccountUpdateResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "SUCCESS" } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received<br>*Example:* `"2025-05-27 05:13:30.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### SponsorRuleCategoryRequestType Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ruleCategories | [ string, <br>**Available values:** "PCT_GLOBAL, PCT_TRANSACTION, PCT_MERCHANT" ] | Allowed rule categories configured for this Sponsor ID. | Yes |

#### DecoupleTokenResponseObject Schema

Object informing the status of the request.  The documentID field will be set when the request was successful.  On a failure, the statusCode and reason fields will be set

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| index | integer | Index from request to correlate the response to.<br>*Example:* `0` | Yes |
| reason | string | Indicates reason for failure or error.<br>*Example:* `"VTA Error"` | No |
| documentID | string | Updated document ID.<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | No |
| statusCode | integer | HTTP status code to be set on failure. Values that can be set here are 400, 403, 404, and 422.<br>*Example:* `400` | No |
| shouldDecouple | boolean | Indicates if tokens should be liberated from any card control settings placed on the primaryAccountNumber. If set to "true" on an enrolled paymentToken, the token will operate independently of the PAN's card controls. If set to "true" on a primaryAccountNumber, all related token transactions will be ignored by the PAN's card controls. | No |

#### NotificationDetailsAlertPreferences-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| contacts | [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ] | List of contacts associated with alert preference. | No |
| alertType | string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER" | Transaction events supported with generated alerts. ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Enum:* `"DECLINE_ALL"`, `"DECLINE_BREACHED_AMT"`, `"ALERT_BREACHED_AMT"`, `"DECLINE_BY_SPEND_LIMIT"`, `"ALERT_BREACHED_SPEND"`, `"DECLINE_BY_ISSUER"`<br>*Example:* `"DECLINE_ALL"` | No |
| controlType | string | Indicates specific control type. Valid transactionControls values begin with: "TCT_", valid merchantControls values begin with: "MCT_". ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Example:* `"TCT_ATM_WITHDRAW"` | No |

#### ContactPreferenceDetails-1 Schema

List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of contact. Valid values are "Active" and "InActive". If set to "InActive", default contact preferences will deliver last mile alerts to the cardholder.<br>*Example:* `"Active"` | No |
| isVerified | boolean, <br>**Available values:** true, false | Indicates if the contact type has been verified by the issuer. Contacts mapped to cardholder must be verified. For SMS-type contacts, VISA only supports double opt-in verification if this field is set to false. For other contact types, Visa will not conduct additional verification. Issuers should only allow verified contacts to be used as contact preferences. The double opt-in feature is not supported in sandbox. For last mile alert delivery testing in sandbox, this field must be set to true.<br>*Enum:* `true`, `false`<br>*Example:* `true` | No |
| callingCode | string | Code for SMS contact types. If not set for an SMS contact, default value is "1".<br>*Example:* `"52"` | No |
| contactType | string | Channel to deliver alert message. Supported channels include SMS, Push, Email. (Only email is supported in sandbox.)<br>*Example:* `"Email"` | Yes |
| contactValue | string | Email address, phone number or device ID associated with contactType.<br>*Example:* `"alexmiller@example.com"` | Yes |
| preferredEmailFormat | string, <br>**Available values:** "Plain", "RichText", "Html" | Preferred email format for email contact types. If not provided for an email contact, default value is set to "Plain".<br>*Enum:* `"Plain"`, `"RichText"`, `"Html"`<br>*Example:* `"Plain"` | No |

#### CurrencyConversion-1 Schema

Currency conversion details. Sets a currency for the control type.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| convertedAmount | number | Transaction amount, converted to the control-type currency using the Visa Exchange Rate.<br>*Example:* `100` | No |
| fromCurrencyCode | string | Indicates the currency that was used to perform the conversion to the cardholder’s control currency.<br>*Example:* `"840"` | No |
| visaExchangeRate | string | The rate used by VisaNet to convert the transaction amount (field 4) to the cardholder billing amount (field 6) including the optional issuer fee (OIF). When a Client participates in multi-currency feature, this field includes the VisaNet rate used to convert the transaction/cardholder billing  amount to the currency of the control-type.<br>*Example:* `"0.05"` | No |
| controlCurrencyCode | string | Currency code that was defined for the control-type.<br>*Example:* `"840"` | No |

#### AccountUpdateRequest-1 Schema

Account update request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| newAccountID | string | New account ID, between 13 and 19 digits.<br>*Example:* `"4000123456789010"` | Yes |
| currentAccountID | string | Current account ID, between 13 and 19 digits.<br>*Example:* `"4000123456789010"` | Yes |

#### FxCallBackSettings Schema

Alert notification fx callback settings.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| payloadVersion | string | Payload version to generate for this callback endpoint. Valid values are V1 or V3.<br>*Example:* `"V1"` | No |
| callBackEndpoint | string | Alert notification callback URL.<br>*Example:* `"https://api.issuer.example/sampleVCTChostprocessor/consumertransactioncontrols/enrollments"` | Yes |
| isCallBackDisabled | boolean | Indicates if callback is turned on (false) or off (true). | Yes |
| iscallBackEndpointLocal | boolean | Indicates if callback URL is on a local network. Default value is false. Sent via WSI. | No |

#### BulkDecoupleTokenRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decoupleTokenRequest | [ { **"paymentToken"**: string, **"shouldDecouple"**: boolean, **"primaryAccountNumber"**: string } ] | List of objects informing couple/decouple request. Minimum 1 object, maximum 100 objects. | Yes |

#### DecisionRequestBody Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH" | The decision request type.<br>*Enum:* `"RECOMMENDED"`, `"COMPLETE"`, `"ADVICE"`, `"INFORM"`, `"PREAUTH"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| decisionRequestTimeStamp | string | Timestamp of when the decision was requested in UTC.<br>*Example:* `"2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### GetDecisionDocument Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND" | Status of the request<br>*Enum:* `"SUCCESS"`, `"RESOURCE_NOT_FOUND"` | Yes |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] | List of decision Documents | Yes |

#### AlertNotifyDetail-13 Schema

List of notification details found for this request.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| outboundCallDetails | { **"status"**: string, **"message"**: string, **"httpVerb"**: string, **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string }, **"httpResponseCode"**: integer } | Outbound call details. | Yes |
| notificationDetailId | string | Unique identifier used to locate a list of notification identifiers.<br>*Example:* `"ctc-vd-45366159-40c2-43fc-914e-7cf7177badfd"` | No |
| outBoundAlertsNotificationPayload | { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } | Outbound alerts notification payload. | Yes |

#### AlertPreferencesRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| alertPreferences | [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] |  | Yes |

#### CollectionResourceBulkDecoupleTokenResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "Success", "PartialSuccess", "Failed", **"response"**: [ { **"index"**: integer, **"reason"**: string, **"documentID"**: string, **"statusCode"**: integer, **"shouldDecouple"**: boolean } ] } | The response resource container. Contains status of operation and list of tokens to decouple. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### TransactionControlDocument-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documentID | string | System-generated ID for the control document bound to the account identifier (primaryAccountNumber/paymentToken).<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | No |
| createdOnDate | string | Timestamp when control was added, in UTC<br>*Example:* `"2023-03-21 04:56:12.561"` | No |
| globalControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | Used to set rules that apply to all transactions performed with this account. | No |
| shouldDecouple | boolean | Indicates if tokens should be liberated from any card control settings placed on the primaryAccountNumber. If set to "true" on an enrolled paymentToken, the token will operate independently of the PAN's card controls. If set to "true" on a primaryAccountNumber, all related token transactions will be ignored by the PAN's card controls. | No |
| merchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of merchant controls configured for the card. | No |
| lastUpdateTimeStamp | string | Timestamp of when the resource was last updated in UTC.<br>*Example:* `"2023-03-21 04:56:20"` | No |
| transactionControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of transaction controls configured for the card. | No |

#### BulkEnrollmentRequest-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardsType | string | Indicates if account is primaryAccountNumber or paymentToken. Valid values are PAN or token. If not provided, PAN is assumed.<br>*Example:* `"PAN"` | No |
| controlRules | { **"globalControl"**: { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean }, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean } ], **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean } ] } | All control types to be applied to the list of cards being enrolled. | Yes |
| enrolledCards | [ { **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"accountIdentifier"**: string } ] | List of valid cards added to be enrolled. | Yes |
| forceEnrollment | boolean | Indicates if the previously enrolled control document will be overwritten. | Yes |

#### CardContactInformation-1 Schema

List of payment tokens with associated contact details.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documentID | string | System-generated ID for the control document bound to the account identifier (primaryAccountNumber/paymentToken).<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | Yes |
| portfolioID | string | Visa-issued identifier for the issuer card prefix. Used when an alert requires different messaging for different segments of a card portfolio. If not configured will default to 001.<br>*Example:* `"003"`<br>**Read-only** | No |
| paymentToken | string | Payment token passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| isProfileActive | boolean, <br>**Available values:** true, false | Indicates if customer profile is active. If set to false, alerts cannot be delivered.<br>*Enum:* `true`, `false`<br>**Read-only** | Yes |
| alertsPreferences | [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] | List of alert preferences for specific alert types. | Yes |
| primaryAccountNumber | string | Primary account number passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |

#### CollectionResourceNotificationDetails Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"notificationDetails"**: [ { **"outboundCallDetails"**: { **"status"**: string, **"message"**: string, **"httpVerb"**: string, **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string }, **"httpResponseCode"**: integer }, **"notificationDetailId"**: string, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: object, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] } | The response resource container. Contains notification details found. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### DecisionDocument Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionID | string | The decisionID assigned to the decision request.  This value is generated by the API. | Yes |
| paymentToken | string | Masked payment token. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| decisionUpdate | { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } |  | Yes |
| decisionRequest | { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string } |  | Yes |
| decisionResponse | { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string } |  | Yes |
| primaryAccountNumber | string | Masked primary account number. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | Yes |
| transactionControlsnapshot | [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] |  | No |

#### PagingControlInformation-1 Schema

Paging control information.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| pageLimit | string | Maximum number of pages to return. Numeric, between 1 and 100.<br>*Example:* `"50"` | Yes |
| startIndex | string | Page start location. Must be numeric.<br>*Example:* `"1"` | Yes |

#### SponsorRuleCategoryType Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ruleCategories | [ string, <br>**Available values:** "PCT_GLOBAL, PCT_TRANSACTION, PCT_MERCHANT" ] | Allowed rule categories configured for this Sponsor ID. | Yes |
| isSpendLimitAllowed | boolean | isSpendLimitAllowed is dependent on the sponsor whether it allows setting up spend limit control or not | No |
| isMultiCurrencyAllowed | boolean | isMultiCurrencyAllowed flag determines if an sponsor allows multi currency controls. | No |
| isFilterByCountryAllowed | boolean | isFilterByCountryAllowed is dependent on the sponsor whether it allows setting up country enable or disabled list | No |
| cardEnrollmentCallbackSettings | { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } | URL posted following card enrollment or de-enrollment. | No |

#### DateTimeRange Schema

When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| endTime | string | End time in UTC of a timeRange that bounds a control. Only transactions attempted during the specified timeRange will trigger this control. The format of the string is in 24hr time using YYYY-MM-DD hh:mm:ss format.<br>*Example:* `"2023-03-21T04:56:56.000Z"` | Yes |
| startTime | string | Start time in UTC of a timeRange that bounds a control. Only transactions attempted during the specified timeRange will trigger this control. The format of the string is in 24hr time using YYYY-MM-DD hh:mm:ss format.<br>*Example:* `"2023-03-21T04:56:56.000Z"` | Yes |

#### CollectionResourceWalletServicesAccountInquiryResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"accountInquiryResponse"**: [ { **"status"**: string, **"documentID"**: string, **"paymentToken"**: string, **"controlDocuments"**: [ { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ], **"allAvailableControls"**: { **"ruleCategories"**: [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" ], **"merchantTypeRules"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"transactionTypeRules"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "TCT_AFT" ] }, **"primaryAccountNumber"**: string } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### WalletServicesAccountInquiryResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| accountInquiryResponse | [ { **"status"**: string, **"documentID"**: string, **"paymentToken"**: string, **"controlDocuments"**: [ { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ], **"allAvailableControls"**: { **"ruleCategories"**: [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" ], <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"merchantTypeRules"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" ], <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", **"transactionTypeRules"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" }, **"primaryAccountNumber"**: string } ] |  | No |

#### CollectionResourceOfDecisionDocument Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### SponsorConfigControlTypeObject-1 Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastUpdateTimeStamp | string | Timestamp of when the resource was last updated. Format: yyyy-MM-dd HH:mm:ss<br>*Example:* `"2025-08-18 04:35:39"` | Yes |

#### SponsorConfigControlTypeObject-2 Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastUpdateTimeStamp | string | This value will be set automatically when the sponsor configuration document is updated. Value is in UTC time.<br>*Example:* `"2025-08-21 02:51:43"` | Yes |

#### CollectionResourceNotificationDetailsV2-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"notificationDetails"**: [ { **"notificationId"**: string, **"notificationStatus"**: string, <br>**Available values:** "SUCCESSFULLY_SENT", "CLIENT_ERROR", "SYSTEM_ERROR", "CONFIRMATION_PENDING", **"outboundCallDetails"**: { **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } }, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"appID"**: string, **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] } | The response resource container. Contains notification details found. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### DecoupleTokenResponseObject-1 Schema

Object informing the status of the request.  The documentID field will be set when the request was successful.  On a failure, the statusCode and reason fields will be set

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| index | integer | Index from request to correlate the response to.<br>*Example:* `0` | Yes |
| reason | string | Indicates reason for failure or error.<br>*Example:* `"VTA Error"` | No |
| documentID | string | Updated document ID.<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | No |
| statusCode | integer | HTTP status code to be set on failure. Values that can be set here are 400, 403, 404, and 422.<br>*Example:* `400` | No |
| shouldDecouple | boolean | Indicates if tokens should be liberated from any card control settings placed on the primaryAccountNumber. If set to "true" on an enrolled paymentToken, the token will operate independently of the PAN's card controls. If set to "true" on a primaryAccountNumber, all related token transactions will be ignored by the PAN's card controls. | No |

#### CollectionResourceOfDecisionResponseType Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionID"**: string, **"decisionResponse"**: { **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"decisionResponseTimeStamp"**: string } } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CardContactInformation-13 Schema

List of payment tokens with associated contact details.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documentID | string | System-generated ID for the control document bound to the account identifier (primaryAccountNumber/paymentToken).<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | Yes |
| portfolioID | string | Visa-issued identifier for the issuer card prefix. Used when an alert requires different messaging for different segments of a card portfolio. If not configured will default to 001.<br>*Example:* `"003"`<br>**Read-only** | No |
| paymentToken | string | Payment token passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| isProfileActive | boolean, <br>**Available values:** true, false | Indicates if customer profile is active. If set to false, alerts cannot be delivered.<br>*Enum:* `true`, `false`<br>**Read-only** | Yes |
| alertsPreferences | [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] | List of alert preferences for specific alert types. | Yes |
| primaryAccountNumber | string | Primary account number passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |

#### DecisionResponseType Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionID | string | Unique ID assigned to this decision request | Yes |
| decisionResponse | { **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"decisionResponseTimeStamp"**: string } |  | No |

#### CollectionResourceSponsorConfigRuleCategoryCardEnquiryRuleCategoryResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", **"availableControlTypes"**: [ { **"name"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" } ] } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### BulkDecoupleTokenResponse-1 Schema

The response resource container. Contains status of operation and list of tokens to decouple.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "Success", "PartialSuccess", "Failed" | Status of the call: Success, Partial_Success or Failure.<br>*Enum:* `"Success"`, `"PartialSuccess"`, `"Failed"`<br>*Example:* `"Success"` | Yes |
| response | [ { **"index"**: integer, **"reason"**: string, **"documentID"**: string, **"statusCode"**: integer, **"shouldDecouple"**: boolean } ] |  | Yes |

#### AlertTransactionOutcome Schema

Outcome of the transaction.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionID | string | Decision ID corresponding to the alerts.<br>*Example:* `"v-304-f1f11166-f3b3-4465-b995-61edb244c178"` | Yes |
| documentID | string | Uniquely identifies the control document that triggered the notification.<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | No |
| alertDetails | [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ] | List of alerts triggered for a transaction that should be delivered to the cardholder. If transaction was declined, only a single alert detail will be present. | Yes |
| notificationID | string | Unique notification detail identifier.<br>*Example:* `"ctc-vd-45366159-40c2-43fc-914e-7cf7177badfd"` | Yes |
| transactionLimit | { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer } | Number of transactions to be allowed/approved, after which subsequent transactions will be declined. | No |
| declineResponseCode | string | Response code indicating why the transaction was declined.<br>*Example:* `"50"` | No |
| transactionApproved | string, <br>**Available values:** "APPROVED", "DECLINED" | Indicates if transaction was approved.<br>*Enum:* `"APPROVED"`, `"DECLINED"`<br>*Example:* `"APPROVED"` | Yes |
| decisionResponseTimeStamp | string | Timestamp of when the decision was returned in UTC.<br>*Example:* `"2023-05-25T18:45:55.000Z"` | Yes |

#### FxInfo Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| visaExchangeRate | double | Contains the rate used by VisaNet to convert the transaction amount (field 4) to the cardholder billing amount (field 6) including the optional issuer fee (OIF).When a Client participates in multi-currency feature, this field includes the VisaNet rate used to convert the transaction/cardholder billing  amount to the currency of the control-type.<br>*Example:* `0.05` | No |
| crossCurrencyIndicator | boolean | Indicates if this transaction is cross currency or not. | No |

#### TypeOverrideableControl Schema

List of transaction controls configured for the card.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } | When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time. | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } | Provide cardDetails to set up controls and restrict access based on cardholder name or card sequence number. If used, the processor must provide the same transaction data when invoking the decision request and the authorization engine will attempt to use the details to locate a transaction control. If the card data is not matched from the transaction data, the control will not affect the transaction. | No |
| spendLimit | { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer } | Used to track and manage total approved account purchases over a period of time. All amounts are based on the cardholderBillAmount in the authorization request. The actual amount submitted for settlement can differ (e.g. tips, hotel, car rental...). | No |
| controlType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" | Indicates specific control type. Valid transactionControls values begin with: "TCT_", valid merchantControls values begin with: "MCT_". ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| alertThreshold | double | Maximum value of an approved purchase for this control type before triggering an alert when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if an alert should be sent.<br>*Example:* `1000` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| filterByCountry | { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] } | Allows cardholders to specify in which countries their card can, or cannot, be used depending on which child attribute is configured. | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| declineThreshold | double | Maximum value of a purchase for this control type before triggering a decline when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if a decline should be triggered.<br>*Example:* `1000` | No |
| isControlEnabled | boolean | Indicates if this control type will be applied during transaction processing. | Yes |
| shouldDeclineAll | boolean | Indicates if VTC will trigger a decline for all transactions related to this control type. Default value will be false. If false, other control settings (e.g. declineThreshold) will be checked. | No |
| shouldAlertOnDecline | boolean | Indicates if VTC will trigger a decline notification for all transactions matching the associated control type. If false, no alerts will be sent for declined transactions related to this control type. | No |
| shouldTargetSpecificCard | boolean | Indicates if card details are required. Card details will be used to locate a transaction control.<br>**Read-only** | No |
| declineAllNonTokenizeTransactions | boolean | When set to "true," transactions performed with primaryAccountNumber will be declined. Only token-based transactions will continue to process as normal. Used when the physical card is lost or misplaced but the cardholder wants to continue transacting via their mobile phone. | No |

#### WhiteListTransactionControlsRequestType Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| transactionTypeRules | [ string, <br>**Available values:** "TCT_ATM_WITHDRAW, TCT_AUTO_PAY, TCT_BRICK_AND_MORTAR, TCT_CROSS_BORDER, TCT_E_COMMERCE, TCT_CONTACTLESS, TCT_PURCHASE_RETURN, TCT_OCT" ] | Allowed merchant control types configured for this App ID.<br>*Example:* `"TCT_ATM_WITHDRAW"` | No |

#### TransactionControlDocument-8 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documentID | string | System-generated ID for the control document bound to the account identifier (primaryAccountNumber/paymentToken).<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | No |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| createdOnDate | string | Timestamp when control was added, in UTC<br>*Example:* `"2025-05-13 04:09:18.799"` | No |
| globalControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | Used to set rules that apply to all transactions performed with this account. | No |
| shouldDecouple | boolean | Indicates if tokens should be liberated from any card control settings placed on the primaryAccountNumber. If set to "true" on an enrolled paymentToken, the token will operate independently of the PAN's card controls. If set to "true" on a primaryAccountNumber, all related token transactions will be ignored by the PAN's card controls. | No |
| merchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of merchant controls configured for the card. | No |
| lastUpdateTimeStamp | string | Timestamp of when the resource was last updated in UTC.<br>*Example:* `"2025-05-27 05:13:30"` | No |
| transactionControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of transaction controls configured for the card. | No |
| customMerchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of custom merchant controls configured for the card. | No |

#### BulkEnrollmentRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardsType | string | Indicates if account is primaryAccountNumber or paymentToken. Valid values are PAN or token. If not provided, PAN is assumed.<br>*Example:* `"PAN"` | No |
| controlRules | { **"globalControl"**: { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean }, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean } ], **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean } ] } | All control types to be applied to the list of cards being enrolled. | Yes |
| enrolledCards | [ { **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"accountIdentifier"**: string } ] | List of valid cards added to be enrolled. | Yes |
| forceEnrollment | boolean | Indicates if the previously enrolled control document will be overwritten. | Yes |

#### TransactionControlListResponse-1 Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| controlDocuments | [ { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"requestedAppID"**: string, **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] | List of transaction control documents. | No |

#### CollectionResourceAppConfigurationCallBackSettingsResponseType-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "NOT_CONFIGURED", "CONFIGURED", **"callBackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### RuleDetail Schema

List of alerts triggered for a transaction that should be delivered to the cardholder. If transaction was declined, only a single alert detail will be present.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ruleType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE" | Rule type for the control that triggered the alert/decline.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`, `"NONE"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |
| alertReason | string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL" | Reason for the alert. Only present in alertDetails.<br>*Enum:* `"DECLINE_ALL"`, `"DECLINE_TRANS_LIMIT"`, `"DECLINE_BREACHED_AMT"`, `"ALERT_BREACHED_AMT"`, `"DECLINE_BY_ISSUER"`, `"DECLINE_BY_SPEND_LIMIT"`, `"ALERT_BREACHED_SPEND"`, `"FX_ALERTS"`, `"ALERT_BREACHED_AMT_REVERSAL"`<br>*Example:* `"DECLINE_TRANS_LIMIT"` | No |
| ruleCategory | string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" | Rule category for the control that triggered the alert/decline.<br>*Enum:* `"PCT_GLOBAL"`, `"PCT_TRANSACTION"`, `"PCT_MERCHANT"`<br>*Example:* `"PCT_GLOBAL"` | Yes |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 72 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| thresholdAmount | double | Threshold amount for the control that triggered the alert/decline. Only present if thresholdAmount breach caused the trigger.<br>*Example:* `1000` | No |
| triggeringAppID | string | App ID for the control that triggered the alert.<br>*Example:* `"vd-b971963f-12d9-4a28-a8dc-80bf9c31"` | Yes |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| controlTargetType | string | Defines the control level that triggered the alert/decline.<br>*Example:* `"CARD_LEVEL"` | No |
| currencyConversion | { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } | Currency conversion details. Sets a currency for the control type. | No |

#### CollectionResourceOfDecisionHistoryResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### WhiteListMerchantControlsRequestType Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| merchantTypeRules | [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT, MCT_AIRFARE, MCT_ALCOHOL, MCT_APPAREL_AND_ACCESSORIES, MCT_AUTOMOTIVE, MCT_CAR_RENTAL, MCT_ELECTRONICS, MCT_SPORT_AND_RECREATION, MCT_GAMBLING, MCT_GAS_AND_PETROLEUM, MCT_GROCERY, MCT_HOTEL_AND_LODGING, MCT_HOUSEHOLD, MCT_PERSONAL_CARE, MCT_SMOKE_AND_TOBACCO, MCT_DINING" ] | Allowed merchant control types configured for this App ID.<br>*Example:* `"[MCT_AIRFARE, MCT_GROCERY]"` | No |

#### WhiteListRuleConfigRequestType Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| rulesConfiguration | [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ] | Allowed rule categories configured for this Sponsor ID. | No |

#### CustomerProfileFacade-10 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastName | string | Last name of the cardholder.<br>*Example:* `"Miller"` | Yes |
| firstName | string | First name of the cardholder.<br>*Example:* `"Alex"` | Yes |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | Yes |
| portfolioID | string | Visa-issued identifier for the issuer card prefix. Used when an alert requires different messaging for different segments of a card portfolio. If not configured will default to 001.<br>*Example:* `"003"` | No |
| paymentToken | string | Payment token passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| communityCode | string | Default community assigned by API. The default is the sponsor BID description.<br>*Example:* `"123456789"`<br>**Read-only** | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 72 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | Yes |
| preferredLanguage | string | Preferred language for last mile alerts. Current languages supported are "en-us" (English US) and "es-us"(Spanish US).<br>*Example:* `"en-us"` | Yes |
| primaryAccountNumber | string | Primary account number passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| defaultAlertsPreferences | [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact. | Yes |

#### CollectionResourceOfDecisionDocument-3 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### AlertOutboundCallDetailsV2-13 Schema

Outbound call details.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorDetails | [ { **"code"**: string, **"reason"**: string } ] | List of error details that occurred during request processing. Includes error codes and messages. | No |
| alertPreferences | { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } |  | No |

#### CustomerProfileFacade-13 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastName | string | Last name of the cardholder.<br>*Example:* `"Miller"` | Yes |
| firstName | string | First name of the cardholder.<br>*Example:* `"Alex"` | Yes |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | No |
| portfolioID | string | Visa-issued identifier for the issuer card prefix. Used when an alert requires different messaging for different segments of a card portfolio. If not configured will default to 001.<br>*Example:* `"003"` | No |
| paymentToken | string | Payment token passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| communityCode | string | Default community assigned by API. The default is the sponsor BID description.<br>*Example:* `"123456789"`<br>**Read-only** | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 72 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | Yes |
| preferredLanguage | string | Preferred language for last mile alerts. Current languages supported are "en-us" (English US) and "es-us"(Spanish US).<br>*Example:* `"en-us"` | No |
| primaryAccountNumber | string | Primary account number passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| defaultAlertsPreferences | [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact. | Yes |

#### CollectionResourceOfDecisionDocument-4 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### AlertTransactionDetails Schema

Details of the transaction.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| nameOnCard | string | Cardholder name as encoded on the payment instrument.<br>*Example:* `"Alex Miller"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: object, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string } | Merchant details. | No |
| paymentToken | string | Masked payment token. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | Yes |
| exchangeRateDetails | { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string } | Exchange rate details provided in the notification payload for a cross-currency transaction when Issuer has configured FX Alerts. | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| primaryAccountNumber | string | Masked primary account number. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| requestReceivedTimeStamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | No |

#### CollectionResourceOfDecisionDocument-5 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceOfDecisionDocument-6 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### AlertNotifyDetail Schema

List of notification details found for this request.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| outboundCallDetails | { **"status"**: string, **"message"**: string, **"httpVerb"**: string, **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string }, **"httpResponseCode"**: integer } | Outbound call details. | Yes |
| notificationDetailId | string | Unique identifier used to locate a list of notification identifiers.<br>*Example:* `"ctc-vd-45366159-40c2-43fc-914e-7cf7177badfd"` | No |
| outBoundAlertsNotificationPayload | { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: object, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } | Outbound alerts notification payload. | Yes |

#### NotificationDetailsAlertPreferences-13 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| contacts | [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ] | List of contacts associated with alert preference. | No |
| alertType | string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER" | Transaction events supported with generated alerts. ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Enum:* `"DECLINE_ALL"`, `"DECLINE_BREACHED_AMT"`, `"ALERT_BREACHED_AMT"`, `"DECLINE_BY_SPEND_LIMIT"`, `"ALERT_BREACHED_SPEND"`, `"DECLINE_BY_ISSUER"`<br>*Example:* `"DECLINE_ALL"` | No |
| controlType | string | Indicates specific control type. Valid transactionControls values begin with: "TCT_", valid merchantControls values begin with: "MCT_". ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Example:* `"TCT_ATM_WITHDRAWAL"` | No |

#### CustomerProfileDocument Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cards | [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ] | List of PANs with associated contact details. | Yes |
| tokens | [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ] | List of payment tokens with associated contact details. | Yes |
| lastName | string | Last name of the cardholder.<br>*Example:* `"Miller"` | Yes |
| firstName | string | First name of the cardholder.<br>*Example:* `"Alex"` | Yes |
| createdOnDate | string | Timestamp when control was added, in UTC.<br>*Example:* `"2025-05-13 04:09:18.799"` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 72 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | Yes |
| isProfileActive | boolean | Indicates if customer profile is active. If set to false, alerts cannot be delivered. | Yes |
| alertsPreferences | [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] | List of alert preferences for specific alert types.<br>**Read-only** | Yes |
| preferredLanguage | string | Preferred language for last mile alerts. Current languages supported are "en-us" (English US) and "es-us"(Spanish US).<br>*Example:* `"en-us"` | Yes |
| lastUpdateTimeStamp | string | Timestamp of when the resource was last updated in UTC.<br>*Example:* `"2025-05-13 04:09:18.799"` | No |
| preferredCountryCode | string | Uppercase ISO ALPHA-3 3-letter country code. Currently only "USA" supported.<br>*Example:* `"USA"` | Yes |
| defaultAlertsPreferences | [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact. | Yes |

#### CardPrefixAppWhiteList Schema

List of card prefixes enabled for the Whitelisted App ID.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardType | string |  | No |
| cardBrand | string |  | No |
| isLeadPAN | boolean | Indicates if the PAN is Lead PAN. | No |
| sponsorBID | string |  | No |
| countryCode | string |  | No |
| portfolioID | string | Visa-issued identifier for the issuer card prefix. Used when an alert requires different messaging for different segments of a card portfolio. If not configured will default to 001.<br>*Example:* `"003"`<br>**Read-only** | No |
| currencyCode | string |  | No |
| isVTCAllowed | boolean | Indicates if BINs are allowed to use VTC. | No |
| isFlexAllowed | boolean | Indicates if the Flex feature is allowed. | No |
| prefixEndRange | string | Ending point of a valid range of card prefixes between 4 and 12 digits. | No |
| prefixStartRange | string | Starting point of a valid range of card prefixes between 4 and 12 digits. | Yes |
| cardProgramIdentifier | string | BIN or Card Range enabled  by the Sponsor/Issuer.<br>*Example:* `"CONSUMER"` | No |
| prefixRangeIdentifier | string | prefixRangeIdentifier not mandatory field. | No |
| cardPrefixSponsorLevel | boolean |  | No |
| isFlexReportingAllowed | boolean | Indicates if BINs need to generate daily reports. | No |
| whiteListConfiguration | { **"isFxAlertsAllowed"**: boolean, **"isCardGroupAllowed"**: boolean, **"isTimeDelayAllowed"**: boolean, **"rulesConfiguration"**: [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ], **"isSpendLimitAllowed"**: boolean, **"merchantControlTypes"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"blackListForSpendLimit"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"isMultiCurrencyAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFlexMITRoutingEnabled"**: boolean, **"transactionControlTypes"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"isAlertOnReversalAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"isLastMileDeliveryAllowed"**: boolean, **"customMerchantControlTypes"**: [ string ], **"customAlertsPayloadSettings"**: { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] }, **"isTimeDelayAutoRemovalAllowed"**: boolean } | Default settings for the allowlist. | Yes |

#### AlertPreferencesRequestV2-13 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| portfolioID | string | Visa-issued identifier for the issuer card prefix. Used when an alert requires different messaging for different segments of a card portfolio. If not configured will default to 001.<br>*Example:* `"003"` | No |
| alertPreferences | [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] |  | Yes |

#### TransactionControlRequestType-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| globalControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | Used to set rules that apply to all transactions performed with this account. | No |
| merchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of merchant controls configured for the card. | No |
| transactionControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of transaction controls configured for the card. | No |
| customMerchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of custom merchant controls configured for the card. | No |

#### RequestModelForTransactionControlsHistoryByTimeRange Schema

Request model for Transaction Controls history by time range

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| endDate | string | End date (YYYY-MM-DD) from which transaction control documents have to be returned.<br>*Example:* `"2023-04-12T00:00:00.000Z"` | No |
| startDate | string | Start date (YYYY-MM-DD) from which transaction control documents have to be returned.<br>*Example:* `"2023-04-12T00:00:00.000Z"` | No |
| paymentToken | string | Token account number for which the control details are to be returned.<br>*Example:* `"4000123456789010"` | No |
| primaryAccountNumber | string | Card account number for which the control details are to be returned.<br>*Example:* `"4000123456789010"` | No |

#### DecisionResponseReply Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| shouldDecline | boolean | Indicates the decline decision/recommendation depending on decision type | Yes |
| declineRuleType | string | indicates thedecline Rule type that triggered the decline decision, only present when shouldDecline is true | No |
| responseMessage | string, <br>**Available values:** "CARD_NOT_ENROLLED" | This field provides more information on the disposition of the response<br>*Enum:* `"CARD_NOT_ENROLLED"` | No |
| declineRuleCategory | string | indicates the decline Rule Category that triggered the decline decision, only present when shouldDecline is true | No |
| declineThresholdAmount | double | indicates the decline threshold amount that was used to trigger the decline decision, only present when shouldDecline is true and a decline threshold has been defined. | No |
| decisionResponseTimeStamp | string | This value will be set automatically when the decision response is sent. Value is in UTC time<br>*Example:* `"2022-05-25 18:45:55"` | Yes |

#### NotificationDetailsFound-13 Schema

The response resource container. Contains notification details found.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| notificationId | string | Unique notification detail identifier.<br>*Example:* `"ctc-vd-45366159-40c2-43fc-914e-7cf7177badfd"` | Yes |
| notificationStatus | string, <br>**Available values:** "SUCCESSFULLY_SENT", "CLIENT_ERROR", "SYSTEM_ERROR", "CONFIRMATION_PENDING" | Notification status.<br>*Enum:* `"SUCCESSFULLY_SENT"`, `"CLIENT_ERROR"`, `"SYSTEM_ERROR"`, `"CONFIRMATION_PENDING"`<br>*Example:* `"SUCCESSFULLY_SENT"` | Yes |
| outboundCallDetails | { **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } } | Outbound call details. | No |
| outBoundAlertsNotificationPayload | { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"appID"**: string, **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } | Outbound alerts notification payload. | Yes |

#### NotificationDetailsAlertPreferences Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| contacts | [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ] | List of contacts associated with alert preference. | No |
| alertType | string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER" | Transaction events supported with generated alerts. ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Enum:* `"DECLINE_ALL"`, `"DECLINE_BREACHED_AMT"`, `"ALERT_BREACHED_AMT"`, `"DECLINE_BY_SPEND_LIMIT"`, `"ALERT_BREACHED_SPEND"`, `"DECLINE_BY_ISSUER"`<br>*Example:* `"DECLINE_ALL"` | No |
| controlType | string | Indicates specific control type. Valid transactionControls values begin with: "TCT_", valid merchantControls values begin with: "MCT_". ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Example:* `"TCT_ATM_WITHDRAW"` | No |

#### CTCSupportedEntitiesRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paymentToken | string | Payment token passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| primaryAccountNumber | string | Primary account number passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |

#### AlertTransactionOutcomeV2 Schema

Outcome of the transaction.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionID | string | Decision ID corresponding to the alerts.<br>*Example:* `"v-304-f1f11166-f3b3-4465-b995-61edb244c178"` | Yes |
| documentID | string | Uniquely identifies the control document that triggered the notification.<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | Yes |
| alertDetails | [ { **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "NONE", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ] | List of alerts triggered for a transaction that should be delivered to the cardholder. If transaction was declined, only a single alert detail will be present. | No |
| notificationID | string | Unique notification detail identifier.<br>*Example:* `"ctc-vn-b157bd50-1a68-43d4-bb22-ad8e693fea1b"` | Yes |
| transactionLimit | { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer } | Number of transactions to be allowed/approved, after which subsequent transactions will be declined. | No |
| declineResponseCode | string | Response code indicating why the transaction was declined.<br>*Example:* `"50"` | No |
| transactionApproved | string, <br>**Available values:** "APPROVED", "DECLINED" | Indicates if transaction was approved.<br>*Enum:* `"APPROVED"`, `"DECLINED"`<br>*Example:* `"APPROVED"` | Yes |
| decisionResponseTimeStamp | string | Timestamp of when the decision was returned in UTC.<br>*Example:* `"2023-05-25T18:45:55.000Z"` | Yes |

#### WhiteListAppControlTypeObject Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "CONFIGURED,NOT_CONFIGURED" | Configuration status<br>*Enum:* `"CONFIGURED,NOT_CONFIGURED"` | Yes |
| cardPrefixes | [ { **"cardType"**: string, **"cardBrand"**: string, **"isLeadPAN"**: boolean, **"sponsorBID"**: string, **"countryCode"**: string, **"portfolioID"**: string, **"currencyCode"**: string, **"isVTCAllowed"**: boolean, **"isFlexAllowed"**: boolean, **"prefixEndRange"**: string, **"callBackSettings"**: { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean }, **"prefixStartRange"**: string, **"cardProgramIdentifier"**: string, **"prefixRangeIdentifier"**: string, **"isFlexReportingAllowed"**: boolean } ] | Card Prefix List allowed for the Whitelisted App ID | No |
| isSpendLimitAllowed | boolean | isSpendLimitAllowed is dependent on the sponsor whether it allows setting up spend limit control or not | No |
| lastUpdateTimeStamp | string | This description = will be set automatically when the sponsor configuration document is updated. Value is in UTC time | Yes |
| detokenizationAllowed | boolean |  | No |
| isMultiCurrencyAllowed | boolean | isMultiCurrencyAllowed flag determines if an sponsor allows multi currency controls. | No |
| tokenDecouplingAllowed | boolean |  | No |
| isDetokenizationAllowed | boolean | isDetokenizationAllowed determines if the Token needs to be deTokenized or not. If it's set to true, then in future we will call VTS to de-Tokenize the Token | No |
| isFilterByCountryAllowed | boolean | isFilterByCountryAllowed is dependent on the sponsor whether it allows setting up enabled or disabled country list | No |
| isTokenDecouplingAllowed | boolean | isTokenDecouplingAllowed determines if the Token can be decoupled from a PAN or not. | No |
| availablePaymentRuleTypes | [ object ] | Available Rule categories configured for this App ID. Rules Configuration contains the Rules Category, isAlertAllowed and isDeclineAllowed | No |
| availableMerchantTypeRules | [ object ] | List of merchant control types available for this card. | No |
| configuredPaymentRuleTypes | [ object ] | Configured Rule categories configured for this App ID. Rules Configuration contains the Rules Category, isAlertAllowed and isDeclineAllowed | No |
| configuredMerchantTypeRules | [ object ] | Merchant control types asigned to this whitelist appID | No |
| availableTransactionTypeRules | [ object ] | Transaction control types available for this whitelist appID | No |
| configuredTransactionTypeRules | [ object ] | Transaction control types assigned to this whitelist appID | No |

#### CollectionResourceSponsorConfigControlTypeObject Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"lastUpdateTimeStamp"**: string } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21T04:56:12.551Z"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### SponsorConfigControlTypeObject-5 Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastUpdateTimeStamp | string | This value will be set automatically when the sponsor configuration document is updated. Format: yyyy-MM-dd HH:mm:ss<br>*Example:* `"2025-08-18 04:33:10"` | Yes |

#### SponsorConfigControlTypeObject-6 Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastUpdateTimeStamp | string | This value will be set automatically when the sponsor configuration document is updated. Value is in UTC time.<br>*Example:* `"2025-08-21 02:40:48"` | Yes |

#### SponsorConfigControlTypeObject-3 Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Configuration status. | Yes |
| availableTransactionTypeRules | [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ] | Transaction control types available for the Sponsor/Issuer. | Yes |
| configuredTransactionTypeRules | [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ] | Transaction control types assigned to the Sponsor/Issuer. | Yes |

#### OverrideableControl Schema

Used to set rules that apply to all transactions performed with this account.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } | When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time. | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } | Provide cardDetails to set up controls and restrict access based on cardholder name or card sequence number. If used, the processor must provide the same transaction data when invoking the decision request and the authorization engine will attempt to use the details to locate a transaction control. If the card data is not matched from the transaction data, the control will not affect the transaction. | No |
| spendLimit | { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer } | Used to track and manage total approved account purchases over a period of time. All amounts are based on the cardholderBillAmount in the authorization request. The actual amount submitted for settlement can differ (e.g. tips, hotel, car rental...). | No |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| alertThreshold | double | Maximum value of an approved purchase for this control type before triggering an alert when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if an alert should be sent.<br>*Example:* `1000` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| filterByCountry | { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] } | Allows cardholders to specify in which countries their card can, or cannot, be used depending on which child attribute is configured. | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| declineThreshold | double | Maximum value of a purchase for this control type before triggering a decline when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if a decline should be triggered.<br>*Example:* `1000` | No |
| isControlEnabled | boolean | Indicates if this control type will be applied during transaction processing. | Yes |
| shouldDeclineAll | boolean | Indicates if VTC will trigger a decline for all transactions related to this control type. Default value will be false. If false, other control settings (e.g. declineThreshold) will be checked. | No |
| transactionLimit | { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer } | Number of transactions to be allowed/approved, after which subsequent transactions will be declined. | No |
| shouldAlertOnDecline | boolean | Indicates if VTC will trigger a decline notification for all transactions matching the associated control type. If false, no alerts will be sent for declined transactions related to this control type. | No |
| shouldTargetSpecificCard | boolean | Indicates if card details are required. Card details will be used to locate a transaction control.<br>**Read-only** | No |
| declineAllNonTokenizeTransactions | boolean | When set to "true," transactions performed with primaryAccountNumber will be declined. Only token-based transactions will continue to process as normal. Used when the physical card is lost or misplaced but the cardholder wants to continue transacting via their mobile phone. | No |

#### SponsorConfigControlTypeObject-4 Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastUpdateTimeStamp | string | This value will be set automatically when the sponsor configuration document is updated. Value is in UTC time.<br>*Example:* `"2025-08-21 03:06:12"` | Yes |

#### DecisionRequestBody-5 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH" | The decision request type.<br>*Enum:* `"RECOMMENDED"`, `"COMPLETE"`, `"ADVICE"`, `"INFORM"`, `"PREAUTH"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| decisionRequestTimeStamp | string | Timestamp of when the decision was requested in UTC.<br>*Example:* `"2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### DecisionRequestBody-4 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH" | The decision request type.<br>*Enum:* `"RECOMMENDED"`, `"COMPLETE"`, `"ADVICE"`, `"INFORM"`, `"PREAUTH"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| decisionRequestTimeStamp | string | Timestamp of when the decision was requested in UTC.<br>*Example:* `"2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### NotificationDetails Schema

The response resource container. Contains notification details found.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| notificationDetails | [ { **"outboundCallDetails"**: { **"status"**: string, **"message"**: string, **"httpVerb"**: string, **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string }, **"httpResponseCode"**: integer }, **"notificationDetailId"**: string, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: object, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] | List of notification details found for this request. | Yes |

#### DecisionRequestBody-6 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM" | The decision request type.<br>*Enum:* `"RECOMMENDED"`, `"COMPLETE"`, `"ADVICE"`, `"INFORM"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| decisionRequestTimeStamp | string | Timestamp of when the decision was requested in UTC.<br>*Example:* `"2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### DecisionRequestBody-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH" | The decision request type.<br>*Enum:* `"RECOMMENDED"`, `"COMPLETE"`, `"ADVICE"`, `"INFORM"`, `"PREAUTH"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| decisionRequestTimeStamp | string | Timestamp of when the decision was requested in UTC.<br>*Example:* `"2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### Rate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| key | string |  | No |
| toCurrencyCode | string |  | No |
| exchangeRateECB | string |  | No |
| lastUpdatedDate | string |  | No |
| expiryDateTimeMs | long |  | No |
| fromCurrencyCode | string |  | No |

#### DecisionRequestBody-3 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH" | The decision request type.<br>*Enum:* `"RECOMMENDED"`, `"COMPLETE"`, `"ADVICE"`, `"INFORM"`, `"PREAUTH"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| decisionRequestTimeStamp | string | Timestamp of when the decision was requested in UTC.<br>*Example:* `"2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### TransactionControlDocument Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documentID | string | System-generated ID for the control document bound to the account identifier (primaryAccountNumber/paymentToken).<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | No |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| createdOnDate | string | Timestamp when control was added, in UTC<br>*Example:* `"2025-05-13 04:09:18.799"` | No |
| globalControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | Used to set rules that apply to all transactions performed with this account. | No |
| shouldDecouple | boolean | Indicates if tokens should be liberated from any card control settings placed on the primaryAccountNumber. If set to "true" on an enrolled paymentToken, the token will operate independently of the PAN's card controls. If set to "true" on a primaryAccountNumber, all related token transactions will be ignored by the PAN's card controls. | No |
| merchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of merchant controls configured for the card. | No |
| lastUpdateTimeStamp | string | Timestamp of when the resource was last updated in UTC.<br>*Example:* `"2025-05-27 05:13:30"` | No |
| transactionControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of transaction controls configured for the card. | No |
| customMerchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of custom merchant controls configured for the card. | No |

#### DecisionRequestBody-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } |  | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } |  | No |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH" | The decision request type.<br>*Enum:* `"RECOMMENDED"`, `"COMPLETE"`, `"ADVICE"`, `"INFORM"`, `"PREAUTH"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ] | A list of transaction types that this decision qualifies for.  If this value is present then messageType, processingCode, and pointOfServiceInfo will be ignored. | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| wasProcessorDeclined | boolean | Provided along with decision type INFORM to indicate if the transaction was declined or approved . | No |
| decisionRequestTimeStamp | string | Timestamp of when the decision was requested in UTC.<br>*Example:* `"2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### DecisionResponse-3 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| shouldAlert | boolean | Indicates whether an an alert should be generated | Yes |
| shouldDecline | boolean | Indicates the decline decision/recommendation depending on decision type | Yes |
| declineRuleType | string | indicates thedecline Rule type that triggered the decline decision, only present when shouldDecline is true | No |
| responseMessage | string, <br>**Available values:** "CARD_NOT_ENROLLED" | This field provides more information on the disposition of the response<br>*Enum:* `"CARD_NOT_ENROLLED"` | No |
| alertsRuleDetail | [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ] | List of rules that triggered alerts, only present when alerts are triggerd for a decision | No |
| declineRuleDetail | { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } |  | No |
| declineRuleCategory | string | indicates the decline Rule Category that triggered the decline decision, only present when shouldDecline is true | No |
| declineThresholdAmount | double | indicates the decline threshold amount that was used to trigger the decline decision, only present when shouldDecline is true and a decline threshold has been defined. | No |
| declineControlTargetType | string | Defines the control level that triggered the alert/decline.<br>*Example:* `"CARD_LEVEL"` | No |
| decisionResponseTimeStamp | string | This value will be set automatically when the decision response is sent. Value is in UTC time<br>*Example:* `"2022-05-25 18:45:55"` | Yes |

#### DecisionResponse-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| shouldAlert | boolean | Indicates whether an an alert should be generated | Yes |
| shouldDecline | boolean | Indicates the decline decision/recommendation depending on decision type | Yes |
| declineRuleType | string | indicates thedecline Rule type that triggered the decline decision, only present when shouldDecline is true | No |
| responseMessage | string, <br>**Available values:** "CARD_NOT_ENROLLED" | This field provides more information on the disposition of the response<br>*Enum:* `"CARD_NOT_ENROLLED"` | No |
| alertsRuleDetail | [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ] | List of rules that triggered alerts, only present when alerts are triggerd for a decision | No |
| declineRuleDetail | { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } |  | No |
| declineRuleCategory | string | indicates the decline Rule Category that triggered the decline decision, only present when shouldDecline is true | No |
| declineThresholdAmount | double | indicates the decline threshold amount that was used to trigger the decline decision, only present when shouldDecline is true and a decline threshold has been defined. | No |
| declineControlTargetType | string | Defines the control level that triggered the alert/decline.<br>*Example:* `"CARD_LEVEL"` | No |
| decisionResponseTimeStamp | string | This value will be set automatically when the decision response is sent. Value is in UTC time<br>*Example:* `"2022-05-25 18:45:55"` | Yes |

#### DecisionResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| shouldAlert | boolean | Indicates whether an an alert should be generated | Yes |
| shouldDecline | boolean | Indicates the decline decision/recommendation depending on decision type | Yes |
| declineRuleType | string | indicates thedecline Rule type that triggered the decline decision, only present when shouldDecline is true | No |
| responseMessage | string, <br>**Available values:** "CARD_NOT_ENROLLED" | This field provides more information on the disposition of the response<br>*Enum:* `"CARD_NOT_ENROLLED"` | No |
| alertsRuleDetail | [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ] | List of rules that triggered alerts, only present when alerts are triggerd for a decision | No |
| declineRuleDetail | { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } |  | No |
| declineRuleCategory | string | indicates the decline Rule Category that triggered the decline decision, only present when shouldDecline is true | No |
| declineThresholdAmount | double | indicates the decline threshold amount that was used to trigger the decline decision, only present when shouldDecline is true and a decline threshold has been defined. | No |
| declineControlTargetType | string | Defines the control level that triggered the alert/decline.<br>*Example:* `"CARD_LEVEL"` | No |
| decisionResponseTimeStamp | string | This value will be set automatically when the decision response is sent. Value is in UTC time<br>*Example:* `"2022-05-25 18:45:55"` | Yes |

#### SponsorConfigControlTypeObject Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastUpdateTimeStamp | string | This value will be set automatically when the sponsor configuration document is updated. Value is in UTC time.<br>*Example:* `"2025-08-21 02:49:27"` | Yes |

#### DecisionResponse-6 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| shouldAlert | boolean | Indicates whether an an alert should be generated | Yes |
| shouldDecline | boolean | Indicates the decline decision/recommendation depending on decision type | Yes |
| declineRuleType | string | indicates thedecline Rule type that triggered the decline decision, only present when shouldDecline is true | No |
| responseMessage | string, <br>**Available values:** "CARD_NOT_ENROLLED" | This field provides more information on the disposition of the response<br>*Enum:* `"CARD_NOT_ENROLLED"` | No |
| alertsRuleDetail | [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ] | List of rules that triggered alerts, only present when alerts are triggerd for a decision | No |
| declineRuleDetail | { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } |  | No |
| declineRuleCategory | string | indicates the decline Rule Category that triggered the decline decision, only present when shouldDecline is true | No |
| declineThresholdAmount | double | indicates the decline threshold amount that was used to trigger the decline decision, only present when shouldDecline is true and a decline threshold has been defined. | No |
| declineControlTargetType | string | Defines the control level that triggered the alert/decline.<br>*Example:* `"CARD_LEVEL"` | No |
| decisionResponseTimeStamp | string | This value will be set automatically when the decision response is sent. Value is in UTC time<br>*Example:* `"2022-05-25 18:45:55"` | Yes |

#### DecisionResponse-5 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| shouldAlert | boolean | Indicates whether an an alert should be generated | Yes |
| shouldDecline | boolean | Indicates the decline decision/recommendation depending on decision type | Yes |
| declineRuleType | string | indicates thedecline Rule type that triggered the decline decision, only present when shouldDecline is true | No |
| responseMessage | string, <br>**Available values:** "CARD_NOT_ENROLLED" | This field provides more information on the disposition of the response<br>*Enum:* `"CARD_NOT_ENROLLED"` | No |
| alertsRuleDetail | [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ] | List of rules that triggered alerts, only present when alerts are triggerd for a decision | No |
| declineRuleDetail | { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } |  | No |
| declineRuleCategory | string | indicates the decline Rule Category that triggered the decline decision, only present when shouldDecline is true | No |
| declineThresholdAmount | double | indicates the decline threshold amount that was used to trigger the decline decision, only present when shouldDecline is true and a decline threshold has been defined. | No |
| declineControlTargetType | string | Defines the control level that triggered the alert/decline.<br>*Example:* `"CARD_LEVEL"` | No |
| decisionResponseTimeStamp | string | This value will be set automatically when the decision response is sent. Value is in UTC time<br>*Example:* `"2022-05-25 18:45:55"` | Yes |

#### CollectionResourceWalletServicesAccountInquiryResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"accountInquiryResponse"**: [ { **"status"**: string, **"documentID"**: string, **"paymentToken"**: string, **"controlDocuments"**: [ { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ], **"allAvailableControls"**: { **"ruleCategories"**: [ string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" ], <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"merchantTypeRules"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" ], <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", **"transactionTypeRules"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" }, **"primaryAccountNumber"**: string } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### DecisionResponse-4 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| shouldAlert | boolean | Indicates whether an an alert should be generated | Yes |
| shouldDecline | boolean | Indicates the decline decision/recommendation depending on decision type | Yes |
| declineRuleType | string | indicates thedecline Rule type that triggered the decline decision, only present when shouldDecline is true | No |
| responseMessage | string, <br>**Available values:** "CARD_NOT_ENROLLED" | This field provides more information on the disposition of the response<br>*Enum:* `"CARD_NOT_ENROLLED"` | No |
| alertsRuleDetail | [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ] | List of rules that triggered alerts, only present when alerts are triggerd for a decision | No |
| declineRuleDetail | { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } |  | No |
| declineRuleCategory | string | indicates the decline Rule Category that triggered the decline decision, only present when shouldDecline is true | No |
| declineThresholdAmount | double | indicates the decline threshold amount that was used to trigger the decline decision, only present when shouldDecline is true and a decline threshold has been defined. | No |
| declineControlTargetType | string | Defines the control level that triggered the alert/decline.<br>*Example:* `"CARD_LEVEL"` | No |
| decisionResponseTimeStamp | string | This value will be set automatically when the decision response is sent. Value is in UTC time<br>*Example:* `"2022-05-25 18:45:55"` | Yes |

#### AlertPreferencesRequest-13 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| alertPreferences | [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] |  | Yes |

#### CallBackSettings Schema

URL posted following card enrollment or de-enrollment.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| payloadVersion | string | Payload version to generate for this callback endpoint. Valid values are V1 or V3.<br>*Example:* `"V1"` | No |
| callBackEndpoint | string | Alert notification callback URL.<br>*Example:* `"https://api.issuer.example/sampleVCTChostprocessor/consumertransactioncontrols/enrollments"` | Yes |
| isCallBackDisabled | boolean | Indicates if callback is turned on (false) or off (true). | Yes |
| iscallBackEndpointLocal | boolean | Indicates if callback URL is on a local network. Default value is false. Sent via WSI. | No |

#### EnrolledCard Schema

List of valid cards added to be enrolled.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| accountIdentifier | string | Card number to be enrolled in VTC. Can be PAN, bank account number or token.<br>*Example:* `"4000123456789010"` | Yes |

#### DecisionRequestType Schema

Get Decision Document by Reference Number - Request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmms | No |
| cardAcceptorTerminalID | string | Terminal ID of the card acceptor.<br>*Example:* `"45678"` | No |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |

#### SpendLimit-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING" | Time period that the control spans. LMT_MONTH: until the end of that month. LMT_WEEK: 7-day period. LMT_DAY: 24 hour period. LMT_DATE_RANGE: date range specified in startDateTime and endDateTime. LMT_RECURRING: recurring period, number of days specified in recurringCycleTime.<br>*Enum:* `"LMT_MONTH"`, `"LMT_WEEK"`, `"LMT_DAY"`, `"LMT_DATE_RANGE"`, `"LMT_RECURRING"`<br>*Example:* `"LMT_WEEK"` | Yes |
| timeZoneID | string | Time zone to be applied to related object in Area/Location format. For example: 'America/Denver' is in United States MST. If not provided, assumed to be UTC. timeZoneID can be applied within timeRange and spendLimit fields to affect endDateTime, startDateTime, endTime, and startTime fields.<br>*Example:* `"UTC"` | No |
| endDateTime | string | End time in UTC of a timeRange that bounds a control. Only transactions attempted during the specified timeRange will trigger this control. The format of the string is in 24hr time using HH:MM format.<br>*Example:* `"2023-03-21 04:56:56"` | No |
| startDateTime | string | Starting date and time of a date and time range bounding a control, in the time zone set by the timeZoneID. Only transactions attempted during the specified date and time range will trigger this control. Cannot be in the past. Format is \\"CCYY-MM-DD HH:MM\\". The hour and minute portion is optional: if not provided, these values will be set to \\"00:00\\". This field is required only when type = LMT_DATE_RANGE. If it set when the type = LMT_RECURRING, the control will become active at that time, as if the user set the recurring functionality at that point in time. In all other cases the field is optional and even if present, it will be ignored.<br>*Example:* `"2023-03-21 04:56"` | No |
| alertThreshold | double | Maximum total value of approved purchases within the time period before triggering an alert. Purchases that meet or exceed the limit set to this control type will not trigger another spendLimit alert until everything is reset when the next time period begins.<br>*Example:* `1000` | No |
| declineThreshold | double | Maximum total value of approved purchases within the time period before triggering a decline.<br>*Example:* `1000` | Yes |
| currentPeriodSpend | double | Total amount of all approved transactions performed within the time period for this control type. Reset once a new time period begins by the amount of the first transaction.<br>*Example:* `200` | Yes |
| recurringCycleTime | integer | Number of days after which the currentPeriodSpend is reset and a new cycle begins. Required only when type = LMT_RECURRING; in all other cases, the field is optional and even if present, it will be ignored.<br>*Example:* `366` | No |

#### SponsorConfigMerchantTypeCardEnquiryMerchantControlResponse-1 Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE" | Status of the rule category or control type (eligible or not eligible).<br>*Enum:* `"ELIGIBLE"`, `"NOT_ELIGIBLE"`<br>*Example:* `"ELIGIBLE"` | Yes |
| availableMerchantTypeRules | [ { **"name"**: string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" }, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" ], <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" | List of merchant control types available for this card.<br>*Enum:* `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"` | Yes |

#### SpendLimit-2 Schema

Used to track and manage total approved account purchases over a period of time. All amounts are based on the cardholderBillAmount in the authorization request. The actual amount submitted for settlement can differ (e.g. tips, hotel, car rental...).

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING" | Time period that the control spans. LMT_MONTH: until the end of that month. LMT_WEEK: 7-day period. LMT_DAY: 24 hour period. LMT_DATE_RANGE: date range specified in startDateTime and endDateTime. LMT_RECURRING: recurring period, number of days specified in recurringCycleTime.<br>*Enum:* `"LMT_MONTH"`, `"LMT_WEEK"`, `"LMT_DAY"`, `"LMT_DATE_RANGE"`, `"LMT_RECURRING"`<br>*Example:* `"LMT_WEEK"` | Yes |
| timeZoneID | string | Time zone to be applied to related object in Area/Location format. For example: 'America/Denver' is in United States MST. If not provided, assumed to be UTC. timeZoneID can be applied within timeRange and spendLimit fields to affect endDateTime, startDateTime, endTime, and startTime fields.<br>*Example:* `"UTC"` | No |
| endDateTime | string | End date and time in UTC of a timeRange that bounds a control.<br>*Example:* `"2025-06-21 04:56"` | No |
| startDateTime | string | Starting date and time of a date and time range bounding a control, in the time zone set by the timeZoneID.<br>*Example:* `"2025-06-21 03:51"` | No |
| alertThreshold | double | Maximum total value of approved purchases within the time period before triggering an alert. Purchases that meet or exceed the limit set to this control type will not trigger another spendLimit alert until everything is reset when the next time period begins.<br>*Example:* `1000` | No |
| currentPeriodEnd | string | Ending timestamp for current spending period in UTC.<br>*Example:* `"2025-06-21 04:56:00"` | No |
| declineThreshold | double | Maximum total value of approved purchases within the time period before triggering a decline.<br>*Example:* `1000` | Yes |
| currentPeriodSpend | double | Total amount of all approved transactions performed within the time period for this control type. Reset once a new time period begins by the amount of the first transaction.<br>*Example:* `200` | Yes |
| recurringCycleTime | integer | Number of days after which the currentPeriodSpend is reset and a new cycle begins. Required only when type = LMT_RECURRING; in all other cases, the field is optional and even if present, it will be ignored.<br>*Example:* `366` | No |

#### AccountUpdateRequest Schema

Account update request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| newAccountID | string | New account ID, between 13 and 19 digits.<br>*Example:* `"4000123456789010"` | Yes |
| currentAccountID | string | Current account ID, between 13 and 19 digits.<br>*Example:* `"4000123456789010"` | Yes |

#### NotificationInquiryRequestPayload-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string } | When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time. | No |
| pagination | { **"pageLimit"**: string, **"startIndex"**: string } | Paging control information. | Yes |
| documentIds | [ string ] | List of documentIDs for which Alert History is requested.<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | No |
| paymentToken | string | Token account number for which the control is to be established.<br>*Example:* `"4000123456789010"` | No |
| includeAlertDetails | boolean | Indicates if alertDetails object will be populated in response. Defaults to false. | No |
| primaryAccountNumber | string | Card account number for which the control details are to be returned.<br>*Example:* `"4000123456789010"` | No |
| includeContactDetails | boolean | Indicates if contacts object will be populated in response. Defaults to false. | No |
| includeMerchantDetails | boolean | Indicates if merchantInfo object will be populated in response. Defaults to false. | No |

#### CollectionResourceNotificationDetails-13 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"notificationDetails"**: [ { **"outboundCallDetails"**: { **"status"**: string, **"message"**: string, **"httpVerb"**: string, **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string }, **"httpResponseCode"**: integer }, **"notificationDetailId"**: string, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] } | The response resource container. Contains notification details found. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceSponsorMccGroupRequestResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"customMerchantControlQualifiers"**: [ { **"updatedBy"**: string, **"isEnabledForVTC"**: boolean, **"lastUpdateTimeStamp"**: string, **"merchantControlType"**: string, **"merchantCategoryCodes"**: [ string ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21T04:56:12.551Z"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### PresentationData Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| howPresented | string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT" | Identifies how the transaction entered the payment system<br>*Enum:* `"CUSTOMER_PRESENT"`, `"CUSTOMER_NOT_PRESENT"`, `"MAIL_PHONE_ORDER"`, `"RECURRING_TRANSACTION"`, `"INSTALLMENT_PAYMENT"` | Yes |
| isCardPresent | boolean | Identifies whether the card was present at the merchant location when the transaction entered the payment system | Yes |

#### NotificationDetailsContactPreferenceDetails Schema

List of contacts associated with alert preference.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of contact. If "InActive", default contact preferences will deliver last mile alerts to cardholder.<br>*Example:* `"Active"` | No |
| message | string | Transaction information sent to the cardholder as SMS, email, or push notification. <br>*Example:* `"No controls found for given time range."` | No |
| isVerified | boolean | Indicates if contact type has been verified by issuer. Contacts mapped to cardholder must be verified. Currently, VISA only supports the double opt in verification for SMS-type contacts if field is set to false. For any other contact type, Visa will not conduct additional verification. Issuer should only allow verified contacts to be used as contact preferences. Double opt in feature is not supported in sandbox. For last mile alert delivery testing in sandbox this field must be set to true.<br>*Example:* `true` | No |
| contactType | string | Channel to deliver alert message. Supported channels include SMS, Push, Email. (Only email is supported in sandbox.)<br>*Example:* `"Email"` | No |
| contactValue | string | Email address, phone number or device ID associated with contactType.<br>*Example:* `"alexmiller@example.com"` | No |

#### CustomMerchantControlQualifier Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| updatedBy | string |  | No |
| isEnabledForVTC | boolean |  | No |
| lastUpdateTimeStamp | string |  | No |
| merchantControlType | string |  | No |
| merchantCategoryCodes | [ string ] |  | No |

#### NotificationInquiryRequestV2-1 Schema

NotificationInquiryRequestPayload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string } | When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time. | No |
| pagination | { **"pageLimit"**: string, **"startIndex"**: string } | Paging control information. | Yes |
| documentIds | [ string ] | List of documentIDs for which Alert History is requested.<br>*Example:* `"[ctc-vd-857a8766-160b-498d-820f-bf4339949c1b]"` | No |
| paymentTokens | [ string ] | List of payment tokens with associated contact details.<br>*Example:* `[4000123456789010]` | No |
| includeAlertDetails | boolean | Indicates if alertDetails object will be populated in response. Defaults to false. | No |
| includeContactDetails | boolean | Indicates if contacts object will be populated in response. Defaults to false. | No |
| primaryAccountNumbers | [ string ] | Card number for which alert history details are to be returned.<br>*Example:* `[4000123456789010]` | No |
| includeMerchantDetails | boolean | Indicates if merchantInfo object will be populated in response. Defaults to false. | No |

#### TransactionControlReportsResponse Schema

Transaction control document being returned.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| responseMessage | string | Details relating to the management and outcome of the response message.<br>*Example:* `"No controls found for given time range."` | No |
| controlDocuments | [ { **"status"**: string, <br>**Available values:** "ENROLLED", "DEENROLLED", "ADD_CONTROLS", "UPDATE_CONTROLS", "DELETE_CONTROLS", "DELETE_CARD_EXCEPTION", "CARD_EXCEPTION", "DELETE_PAN", "UPDATE_PAN", "BATCH_ADD_CONTROLS", "UPDATE_TOKEN", "DELETE_TOKEN", "SYSTEM_UPDATE", "SYSTEM_CREATE", "SYSTEM_MODIFY", "SYSTEM_DELETE", "ADD_RELATIONSHIP", "UPDATE_RELATIONSHIP", "DELETE_RELATIONSHIP", "ADD_FLEX_RULES", "UPDATE_FLEX_RULES", "DELETE_FLEX_RULES", "DELETE_CARD", "UPDATE_CARD", "ADD_UPDATE_FLEX_RULES", "REPLACE_CARD", **"userId"**: string, **"documentID"**: string, **"createdOnDate"**: string, **"requestedAppID"**: string, **"requestedDocumentID"**: string, **"transactionControlDocument"**: { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } } ] | List of transaction control documents. | No |

#### ApplicationWhitelistingAPIRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| whitelistedAppIDList | [ { **"appID"**: string, **"appType"**: string, <br>**Available values:** "ISSUER", "THIRDPARTY", **"cardPrefixes"**: [ { **"cardType"**: string, **"cardBrand"**: string, **"isLeadPAN"**: boolean, **"sponsorBID"**: string, **"countryCode"**: string, **"portfolioID"**: string, **"currencyCode"**: string, **"isVTCAllowed"**: boolean, **"isFlexAllowed"**: boolean, **"prefixEndRange"**: string, **"prefixStartRange"**: string, **"cardProgramIdentifier"**: string, **"prefixRangeIdentifier"**: string, **"cardPrefixSponsorLevel"**: boolean, **"isFlexReportingAllowed"**: boolean, **"whiteListConfiguration"**: { **"isFxAlertsAllowed"**: boolean, **"isCardGroupAllowed"**: boolean, **"isTimeDelayAllowed"**: boolean, **"rulesConfiguration"**: [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ], **"isSpendLimitAllowed"**: boolean, **"merchantControlTypes"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"blackListForSpendLimit"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"isMultiCurrencyAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFlexMITRoutingEnabled"**: boolean, **"transactionControlTypes"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"isAlertOnReversalAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"isLastMileDeliveryAllowed"**: boolean, **"customMerchantControlTypes"**: [ string ], **"customAlertsPayloadSettings"**: { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] }, **"isTimeDelayAutoRemovalAllowed"**: boolean } } ], **"applicationName"**: string, **"defaultWhiteListConfiguration"**: { **"isFxAlertsAllowed"**: boolean, **"isCardGroupAllowed"**: boolean, **"isTimeDelayAllowed"**: boolean, **"rulesConfiguration"**: [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ], **"isSpendLimitAllowed"**: boolean, **"merchantControlTypes"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"blackListForSpendLimit"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"isMultiCurrencyAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFlexMITRoutingEnabled"**: boolean, **"transactionControlTypes"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"isAlertOnReversalAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"isLastMileDeliveryAllowed"**: boolean, **"customMerchantControlTypes"**: [ string ], **"customAlertsPayloadSettings"**: { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] }, **"isTimeDelayAutoRemovalAllowed"**: boolean } } ] |  | Yes |

#### AlertNotificationDeliveryCallbackPayload Schema

Outbound alerts notification payload.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| transactionTypes | [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ] | Enum for the type of transaction.<br>*Example:* `"TCT_ATM_WITHDRAW"` | No |
| transactionDetails | { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: object, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string } | Details of the transaction. | Yes |
| transactionOutcome | { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } | Outcome of the transaction. | Yes |

#### TerminalClass Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| isAttended | boolean | Defines whether card accepting device is attended by a person | Yes |
| howOperated | string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE" | Defines how the card accepting device was operated<br>*Enum:* `"CUSTOMER_OPERATED"`, `"CARD_ACCEPTOR_OPERATED"`, `"ADMINISTRATIVE"` | Yes |
| deviceLocation | string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" | Defines the location of the card accepting device <br>*Enum:* `"ON_PREMISE"`, `"OFF_PREMISE"`, `"ELECTRONIC_COMMERCE"` | Yes |

#### AlertNotificationDeliveryCallbackPayloadV2-13 Schema

Outbound alerts notification payload.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| transactionTypes | [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" | Enum for the type of transaction.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |
| transactionDetails | { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string } | Details of the transaction. | Yes |
| transactionOutcome | { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"appID"**: string, **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } | Outcome of the transaction. | Yes |

#### SponsorConfigRuleCategoryCardEnquiryRuleCategoryResponse Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE" | Status of the rule category or control type (eligible or not eligible).<br>*Enum:* `"ELIGIBLE"`, `"NOT_ELIGIBLE"`<br>*Example:* `"ELIGIBLE"` | Yes |
| availableControlTypes | [ { **"name"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" } ] | Control types available for this card. | Yes |

#### MerchantOverrideableControl-8 Schema

List of merchant controls configured for the card.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } | When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time. | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } | Provide cardDetails to set up controls and restrict access based on cardholder name or card sequence number. If used, the processor must provide the same transaction data when invoking the decision request and the authorization engine will attempt to use the details to locate a transaction control. If the card data is not matched from the transaction data, the control will not affect the transaction.<br>**Read-only** | No |
| spendLimit | { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer } | Used to track and manage total approved account purchases over a period of time. All amounts are based on the cardholderBillAmount in the authorization request. The actual amount submitted for settlement can differ (e.g. tips, hotel, car rental...). | No |
| controlType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" | Indicates specific control type. Valid transactionControls values begin with: "TCT_", valid merchantControls values begin with: "MCT_". ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`<br>*Example:* `"TCT_ATM_WITHDRAWAL"` | Yes |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| alertThreshold | double | Maximum value of an approved purchase for this control type before triggering an alert when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if an alert should be sent.<br>*Example:* `1000` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| filterByCountry | { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] } | Allows cardholders to specify in which countries their card can, or cannot, be used depending on which child attribute is configured. | No |
| impulseDelayEnd | string | Time in UTC when impulseDelayPeriod expires. Value is calculated by adding the impulseDelayPeriod value to the impulseDelayStart value.<br>*Example:* `"1319"`<br>**Read-only** | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| declineThreshold | double | Maximum value of a purchase for this control type before triggering a decline when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if a decline should be triggered.<br>*Example:* `1000` | No |
| isControlEnabled | boolean | Indicates if this control type will be applied during transaction processing. | Yes |
| shouldDeclineAll | boolean | Indicates if VTC will trigger a decline for all transactions related to this control type. Default value will be false. If false, other control settings (e.g. declineThreshold) will be checked. | No |
| impulseDelayStart | string | Time in UTC the initial impulseDelayPeriod was received on a merchant control.<br>*Example:* `"1319"`<br>**Read-only** | No |
| impulseDelayPeriod | string | Indicates the time merchantControls should be inactive. When autoRemoval is set to false, controls will continue to block transactions until impulse delay is removed. When autoRemoval is set to true, impulse is expired. No action is needed to unblock.<br>*Example:* `"1439"` | No |
| shouldAlertOnDecline | boolean | Indicates if VTC will trigger a decline notification for all transactions matching the associated control type. If false, no alerts will be sent for declined transactions related to this control type. | No |
| impulseDelayRemaining | string | Time remaining before the impulseDelayPeriod expires.<br>*Example:* `"719"`<br>**Read-only** | No |
| shouldTargetSpecificCard | boolean | Indicates if card details are required. Card details will be used to locate a transaction control.<br>**Read-only** | No |
| declineAllNonTokenizeTransactions | boolean | When set to "true," transactions performed with primaryAccountNumber will be declined. Only token-based transactions will continue to process as normal. Used when the physical card is lost or misplaced but the cardholder wants to continue transacting via their mobile phone. | No |

#### CustomerProfileFacade Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastName | string | Last name of the cardholder.<br>*Example:* `"Miller"` | Yes |
| firstName | string | First name of the cardholder.<br>*Example:* `"Alex"` | Yes |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | No |
| portfolioID | string | Visa-issued identifier for the issuer card prefix. Used when an alert requires different messaging for different segments of a card portfolio. If not configured will default to 001.<br>*Example:* `"003"` | No |
| paymentToken | string | Payment token passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| communityCode | string | Default community assigned by API. The default is the sponsor BID description.<br>*Example:* `"123456789"`<br>**Read-only** | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 72 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | Yes |
| preferredLanguage | string | Preferred language for last mile alerts. Current languages supported are "en-us" (English US) and "es-us"(Spanish US).<br>*Example:* `"en-us"` | No |
| primaryAccountNumber | string | Primary account number passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| defaultAlertsPreferences | [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact. | Yes |

#### GetDecisionDocument-6 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND" | Status of the request<br>*Enum:* `"SUCCESS"`, `"RESOURCE_NOT_FOUND"` | Yes |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] | List of decision Documents | Yes |

#### CollectionResourceTransactionControlListResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"controlDocuments"**: [ { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"requestedAppID"**: string, **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### GetDecisionDocument-5 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND" | Status of the request<br>*Enum:* `"SUCCESS"`, `"RESOURCE_NOT_FOUND"` | Yes |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] | List of decision Documents | Yes |

#### GetDecisionDocument-4 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND" | Status of the request<br>*Enum:* `"SUCCESS"`, `"RESOURCE_NOT_FOUND"` | Yes |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] | List of decision Documents | Yes |

#### CollectionResourceBulkEnrollmentResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, **"disqualifyingCards"**: [ { **"cards"**: [ string ], **"description"**: string } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### MerchantOverrideableControl-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } |  | No |
| spendLimit | { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer } |  | No |
| controlType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" | Indicates specific control type. Valid transactionControls values begin with: "TCT_", valid merchantControls values begin with: "MCT_". ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |
| alertThreshold | double | Maximum value of an approved purchase for this control type before triggering an alert when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if an alert should be sent.<br>*Example:* `1000` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| filterByCountry | { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] } |  | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } |  | No |
| declineThreshold | double | Maximum value of a purchase for this control type before triggering a decline when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if a decline should be triggered.<br>*Example:* `1000` | No |
| isControlEnabled | boolean | Indicates if this control type will be applied during transaction processing. | Yes |
| shouldDeclineAll | boolean | Indicates if VTC will trigger a decline for all transactions related to this control type. Default value will be false. If false, other control settings (e.g. declineThreshold) will be checked. | No |
| transactionLimit | { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer } |  | No |
| impulseDelayPeriod | string | Indicates the time merchantControls should be inactive. When autoRemoval is set to false, controls will continue to block transactions until impulse delay is removed. When autoRemoval is set to true, impulse is expired. No action is needed to unblock.<br>*Example:* `"23:59"` | No |
| shouldAlertOnDecline | boolean | Indicates if VTC will trigger a decline notification for all transactions matching the associated control type. If false, no alerts will be sent for declined transactions related to this control type. | No |
| declineAllNonTokenizeTransactions | boolean | When set to "true," transactions performed with primaryAccountNumber will be declined. Only token-based transactions will continue to process as normal. Used when the physical card is lost or misplaced but the cardholder wants to continue transacting via their mobile phone. | No |

#### GetDecisionDocument-3 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND" | Status of the request<br>*Enum:* `"SUCCESS"`, `"RESOURCE_NOT_FOUND"` | Yes |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] | List of decision Documents | Yes |

#### GetDecisionDocument-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND" | Status of the request<br>*Enum:* `"SUCCESS"`, `"RESOURCE_NOT_FOUND"` | Yes |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] | List of decision Documents | Yes |

#### PaginationIndex Schema

Paging control information.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| pageLimit | string | Maximum number of pages to return. Numeric, between 1 and 100.<br>*Example:* `"50"` | Yes |
| startIndex | string | Page start location. Must be numeric.<br>*Example:* `"1"` | Yes |

#### GetDecisionDocument-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND" | Status of the request<br>*Enum:* `"SUCCESS"`, `"RESOURCE_NOT_FOUND"` | Yes |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] | List of decision Documents | Yes |

#### CardListDescription-1 Schema

List of disqualifying cards. These cards were not eligible to be added to the group, and will be returned in the response with partial success. HTTP status code will be 207. DisqualifyingCards will not be visible when HTTP status code is 200.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cards | [ string ] | List of disqualifying cards.<br>*Example:* `4000123456789010` | Yes |
| description | string | Reason for card disqualification.<br>*Example:* `"These cards are already enrolled with VTC. Set forceEnrollment:true in the request to override existing controls."` | Yes |

#### CollectionResourceNotificationDetails-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"notificationDetails"**: [ { **"outboundCallDetails"**: { **"status"**: string, **"message"**: string, **"httpVerb"**: string, **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string }, **"httpResponseCode"**: integer }, **"notificationDetailId"**: string, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] } | The response resource container. Contains notification details found. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### RequestModelForTransactionControlsHistoryByTimeRange-1 Schema

Request model for Transaction Controls history by time range

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| endDate | string | End date (YYYY-MM-DD) from which transaction control documents have to be returned.<br>*Example:* `"2023-04-12T00:00:00.000Z"` | No |
| startDate | string | Start date (YYYY-MM-DD) from which transaction control documents have to be returned.<br>*Example:* `"2023-04-12T00:00:00.000Z"` | No |
| paymentToken | string | Token account number for which the control details are to be returned.<br>*Example:* `"4000123456789010"` | No |
| primaryAccountNumber | string | Card account number for which the control details are to be returned.<br>*Example:* `"4000123456789010"` | No |

#### CardEnquiryMerchantControlResponse Schema

List of merchant control types available for this card.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" | Names of all merchant control types available for this card.<br>*Enum:* `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`<br>*Example:* `"MCT_AIRFARE"` | Yes |

#### GroupTransactionControlRequest-1 Schema

All control types to be applied to the list of cards being enrolled.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| globalControl | { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean } | Used to set rules that apply to all transactions performed with this account. | No |
| merchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean } ] | If provided, includes the list of defined merchant controls that have been configured for the card. | No |
| transactionControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"declineThreshold"**: double, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean } ] | List of transaction controls configured for the card. | No |

#### CollectionResourceNotificationDetailsV2-13 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"notificationDetails"**: [ { **"notificationId"**: string, **"notificationStatus"**: string, <br>**Available values:** "SUCCESSFULLY_SENT", "CLIENT_ERROR", "SYSTEM_ERROR", "CONFIRMATION_PENDING", **"outboundCallDetails"**: { **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } }, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"appID"**: string, **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] } | The response resource container. Contains notification details found. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceOfGetDecisionDocument Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS", **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CustomerProfilePatchRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastName | string | Last name of the cardholder.<br>*Example:* `"Miller"` | Yes |
| firstName | string | First name of the cardholder.<br>*Example:* `"Alex"` | Yes |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | Yes |
| isProfileActive | boolean | Indicates if customer profile is active. If set to false, alerts cannot be delivered. | Yes |
| preferredLanguage | string | Preferred language for last mile alerts. Current languages supported are "en-us" (English US) and "es-us"(Spanish US).<br>*Example:* `"en-us"` | Yes |
| defaultAlertsPreferences | [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact. | Yes |

#### AppConfigurationCallBackSettingsRequestType-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| callBackSettings | { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } | URL posted following card enrollment or de-enrollment. | Yes |
| fxCallBackSettings | { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } | Alert notification fx callback settings. | No |

#### VdpErrorResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseCode | string | Response code | Yes |
| responseMessage | string | Response message | Yes |

#### ApplicationWhitelistingRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| appID | string | Identifier for the application requesting to be enabled by the Sponsor/Issuer. | Yes |
| appType | string, <br>**Available values:** "ISSUER", "THIRDPARTY" | Type of application requesting to be enabled by the Sponsor/Issuer.<br>*Enum:* `"ISSUER"`, `"THIRDPARTY"` | Yes |
| cardPrefixes | [ { **"cardType"**: string, **"cardBrand"**: string, **"isLeadPAN"**: boolean, **"sponsorBID"**: string, **"countryCode"**: string, **"portfolioID"**: string, **"currencyCode"**: string, **"isVTCAllowed"**: boolean, **"isFlexAllowed"**: boolean, **"prefixEndRange"**: string, **"prefixStartRange"**: string, **"cardProgramIdentifier"**: string, **"prefixRangeIdentifier"**: string, **"cardPrefixSponsorLevel"**: boolean, **"isFlexReportingAllowed"**: boolean, **"whiteListConfiguration"**: { **"isFxAlertsAllowed"**: boolean, **"isCardGroupAllowed"**: boolean, **"isTimeDelayAllowed"**: boolean, **"rulesConfiguration"**: [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ], **"isSpendLimitAllowed"**: boolean, **"merchantControlTypes"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"blackListForSpendLimit"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"isMultiCurrencyAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFlexMITRoutingEnabled"**: boolean, **"transactionControlTypes"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"isAlertOnReversalAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"isLastMileDeliveryAllowed"**: boolean, **"customMerchantControlTypes"**: [ string ], **"customAlertsPayloadSettings"**: { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] }, **"isTimeDelayAutoRemovalAllowed"**: boolean } } ] | List of card prefixes enabled for the Whitelisted App ID. | No |
| applicationName | string | Name of the application requesting to be enabled by the Sponsor/Issuer. | Yes |
| defaultWhiteListConfiguration | { **"isFxAlertsAllowed"**: boolean, **"isCardGroupAllowed"**: boolean, **"isTimeDelayAllowed"**: boolean, **"rulesConfiguration"**: [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ], **"isSpendLimitAllowed"**: boolean, **"merchantControlTypes"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"blackListForSpendLimit"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"isMultiCurrencyAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFlexMITRoutingEnabled"**: boolean, **"transactionControlTypes"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"isAlertOnReversalAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"isLastMileDeliveryAllowed"**: boolean, **"customMerchantControlTypes"**: [ string ], **"customAlertsPayloadSettings"**: { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] }, **"isTimeDelayAutoRemovalAllowed"**: boolean } | Default settings for the allowlist. | No |

#### CustomerProfile Schema

All alerts enrollment details for the cardholder, if enrolled for last mile delivery of alert notifications through VTA.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastName | string | Last name of the cardholder.<br>*Example:* `"Miller"` | Yes |
| firstName | string | First name of the cardholder.<br>*Example:* `"Alex"` | Yes |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | Yes |
| portfolioID | string | Visa-issued identifier for the issuer card prefix. Used when an alert requires different messaging for different segments of a card portfolio. If not configured will default to 001.<br>*Example:* `"003"` | No |
| communityCode | string | Default community assigned by API. The default is the sponsor BID description.<br>*Example:* `"123456789"`<br>**Read-only** | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 72 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | Yes |
| preferredLanguage | string | Preferred language for last mile alerts. Current languages supported are "en-us" (English US) and "es-us"(Spanish US).<br>*Example:* `"en-us"` | Yes |
| defaultAlertsPreferences | [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact. | Yes |

#### CustomerProfileDocument-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cards | [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ] | List of PANs with associated contact details. | No |
| tokens | [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ] | List of payment tokens with associated contact details. | No |
| lastName | string | Last name of the cardholder.<br>*Example:* `"Miller"` | Yes |
| firstName | string | First name of the cardholder.<br>*Example:* `"Alex"` | Yes |
| createdOnDate | string | Timestamp when control was added, in UTC.<br>*Example:* `"2025-05-13 04:09:18.799"` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 72 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | Yes |
| isProfileActive | boolean, <br>**Available values:** true, false | Indicates if customer profile is active. If set to false, alerts cannot be delivered.<br>*Enum:* `true`, `false` | Yes |
| alertsPreferences | [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] | List of alert preferences for specific alert types.<br>**Read-only** | No |
| preferredLanguage | string | Preferred language for last mile alerts. Current languages supported are "en-us" (English US) and "es-us"(Spanish US).<br>*Example:* `"en-us"` | Yes |
| lastUpdateTimeStamp | string | Timestamp of when the resource was last updated in UTC.<br>*Example:* `"2025-05-13 04:09:18.799"` | No |
| preferredCountryCode | string | Uppercase ISO ALPHA-3 3-letter country code. Currently only "USA" supported.<br>*Example:* `"USA"` | Yes |
| defaultAlertsPreferences | [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact. | Yes |

#### CustomerProfileDocument-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cards | [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ] | List of PANs with associated contact details. | Yes |
| tokens | [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ] | List of payment tokens with associated contact details. | Yes |
| lastName | string | Last name of the cardholder.<br>*Example:* `"Miller"` | Yes |
| firstName | string | First name of the cardholder.<br>*Example:* `"Alex"` | Yes |
| createdOnDate | string | Timestamp when control was added, in UTC.<br>*Example:* `"2025-05-13 04:09:18.799"` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 72 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | Yes |
| isProfileActive | boolean, <br>**Available values:** true, false | Indicates if customer profile is active. If set to false, alerts cannot be delivered.<br>*Enum:* `true`, `false` | Yes |
| alertsPreferences | [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] | List of alert preferences for specific alert types.<br>**Read-only** | Yes |
| preferredLanguage | string | Preferred language for last mile alerts. Current languages supported are "en-us" (English US) and "es-us"(Spanish US).<br>*Example:* `"en-us"` | Yes |
| lastUpdateTimeStamp | string | Timestamp of when the resource was last updated in UTC.<br>*Example:* `"2025-05-13 04:09:18.799"` | No |
| preferredCountryCode | string | Uppercase ISO ALPHA-3 3-letter country code. Currently only "USA" supported.<br>*Example:* `"USA"` | Yes |
| defaultAlertsPreferences | [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact. | Yes |

#### ExpirationDate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| mm | string | Value in mm format | Yes |
| yy | string | Value in yy format | Yes |

#### CollectionResourceOfDecisionUpdateModel-6 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND", **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### BulkDecoupleTokenRequest-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decoupleTokenRequest | [ { **"paymentToken"**: string, **"shouldDecouple"**: boolean, <br>**Available values:** false, **"primaryAccountNumber"**: string } ] | List of objects informing couple/decouple request. Minimum 1 object, maximum 100 objects. | Yes |

#### RuleDetail-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ruleType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE" | Rule type for the control that triggered the alert/decline.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`, `"NONE"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |
| alertReason | string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL" | Reason for the alert. Only present in alertDetails.<br>*Enum:* `"DECLINE_ALL"`, `"DECLINE_TRANS_LIMIT"`, `"DECLINE_BREACHED_AMT"`, `"ALERT_BREACHED_AMT"`, `"DECLINE_BY_ISSUER"`, `"DECLINE_BY_SPEND_LIMIT"`, `"ALERT_BREACHED_SPEND"`, `"FX_ALERTS"`, `"ALERT_BREACHED_AMT_REVERSAL"`<br>*Example:* `"DECLINE_TRANS_LIMIT"` | No |
| ruleCategory | string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" | Rule category for the control that triggered the alert/decline.<br>*Enum:* `"PCT_GLOBAL"`, `"PCT_TRANSACTION"`, `"PCT_MERCHANT"`<br>*Example:* `"PCT_GLOBAL"` | Yes |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| thresholdAmount | double | Threshold amount for the control that triggered the alert/decline. Only present if thresholdAmount breach caused the trigger.<br>*Example:* `1000` | No |
| triggeringAppID | string | App ID for the control that triggered the alert.<br>*Example:* `"vd-b971963f-12d9-4a28-a8dc-80bf9c31"` | Yes |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } |  | No |
| controlTargetType | string | Defines the control level that triggered the alert/decline.<br>*Example:* `"CARD_LEVEL"` | No |

#### CollectionResourceOfDecisionDocument-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceOfDecisionUpdateModel-5 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND", **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceOfDecisionDocument-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceOfDecisionUpdateModel-4 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND", **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceOfDecisionUpdateModel-3 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND", **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceOfDecisionUpdateModel-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND", **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceOfDecisionUpdateModel-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND", **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceCustomerProfileDocument-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"cards"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"tokens"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"lastName"**: string, **"firstName"**: string, **"createdOnDate"**: string, **"userIdentifier"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"preferredLanguage"**: string, **"lastUpdateTimeStamp"**: string, **"preferredCountryCode"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### AlertPreferencesRequestV2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| portfolioID | string | Visa-issued identifier for the issuer card prefix. Used when an alert requires different messaging for different segments of a card portfolio. If not configured will default to 001.<br>*Example:* `"003"` | No |
| alertPreferences | [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] |  | Yes |

#### CollectionResourceCustomerProfileDocument-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"cards"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"tokens"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"lastName"**: string, **"firstName"**: string, **"createdOnDate"**: string, **"userIdentifier"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"preferredLanguage"**: string, **"lastUpdateTimeStamp"**: string, **"preferredCountryCode"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### RuleDetail-8 Schema

List of alerts triggered for a transaction that should be delivered to the cardholder. If transaction was declined, only a single alert detail will be present.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ruleType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE" | Rule type for the control that triggered the alert/decline.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`, `"NONE"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |
| alertReason | string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL" | Reason for the alert. Only present in alertDetails.<br>*Enum:* `"DECLINE_ALL"`, `"DECLINE_TRANS_LIMIT"`, `"DECLINE_BREACHED_AMT"`, `"ALERT_BREACHED_AMT"`, `"DECLINE_BY_ISSUER"`, `"DECLINE_BY_SPEND_LIMIT"`, `"ALERT_BREACHED_SPEND"`, `"FX_ALERTS"`, `"ALERT_BREACHED_AMT_REVERSAL"`<br>*Example:* `"DECLINE_TRANS_LIMIT"` | No |
| ruleCategory | string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" | Rule category for the control that triggered the alert/decline.<br>*Enum:* `"PCT_GLOBAL"`, `"PCT_TRANSACTION"`, `"PCT_MERCHANT"`<br>*Example:* `"PCT_GLOBAL"` | Yes |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 72 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| thresholdAmount | double | Threshold amount for the control that triggered the alert/decline. Only present if thresholdAmount breach caused the trigger.<br>*Example:* `1000` | No |
| triggeringAppID | string | App ID for the control that triggered the alert.<br>*Example:* `"vd-b971963f-12d9-4a28-a8dc-80bf9c31"` | Yes |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| controlTargetType | string | Defines the control level that triggered the alert/decline.<br>*Example:* `"CARD_LEVEL"` | No |
| currencyConversion | { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } | Currency conversion details. Sets a currency for the control type. | No |

#### ExchangeRateDetails Schema

Exchange rate details provided in the notification payload for a cross-currency transaction when Issuer has configured FX Alerts.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxStatus | string | Indicates if FX_ALERT was complete.<br>*Example:* `"COMPLETE"` | No |
| pfxIndicator | string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED" | Indicates if transaction is eligible for the exchange rate to persist from processing to clearing or if a rate was applied for a full financial transaction (0220/0420).<br>*Enum:* `"ELIGIBLE"`, `"NOT_ELIGIBLE"`, `"APPLIED"`<br>*Example:* `"ELIGIBLE"`<br>**Read-only** | No |
| visaExchangeRate | double | Exchange rate provided by VIP in the authorization message.<br>*Example:* `0.05` | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"`<br>**Read-only** | No |
| exchangeRateMarkUp | double | Calculated exchange rate mark up.<br>*Example:* `0.58` | No |
| ecbExchangeRateInfo | { **"exchangeRate"**: double, **"lastUpdatedDate"**: string } | ECB exchange rates and effective dates. | No |
| fxRateTableIdentifier | string | 5-byte Rate Table ID performing all required multi-currency processing (format 1-alpha, 4-numeric).<br>*Example:* `"a0000"`<br>**Read-only** | No |

#### AlertOutboundCallDetailsV2 Schema

Outbound call details.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorDetails | [ { **"code"**: string, **"reason"**: string } ] | List of error details that occurred during request processing. Includes error codes and messages. | No |
| alertPreferences | { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } |  | No |

#### CurrencyConversion Schema

Currency conversion details. Sets a currency for the control type.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| convertedAmount | number | Transaction amount, converted to the control-type currency using the Visa Exchange Rate.<br>*Example:* `100` | No |
| fromCurrencyCode | string | Indicates the currency that was used to perform the conversion to the cardholder’s control currency.<br>*Example:* `"840"` | No |
| visaExchangeRate | string | The rate used by VisaNet to convert the transaction amount (field 4) to the cardholder billing amount (field 6) including the optional issuer fee (OIF). When a Client participates in multi-currency feature, this field includes the VisaNet rate used to convert the transaction/cardholder billing  amount to the currency of the control-type.<br>*Example:* `"0.05"` | No |
| controlCurrencyCode | string | Currency code that was defined for the control-type.<br>*Example:* `"840"` | No |

#### CustomerProfilePatchRequest-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastName | string | Last name of the cardholder.<br>*Example:* `"Miller"` | Yes |
| firstName | string | First name of the cardholder.<br>*Example:* `"Alex"` | Yes |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | Yes |
| isProfileActive | boolean, <br>**Available values:** true, false | Indicates if customer profile is active. If set to false, alerts cannot be delivered.<br>*Enum:* `true`, `false` | Yes |
| preferredLanguage | string | Preferred language for last mile alerts. Current languages supported are "en-us" (English US) and "es-us"(Spanish US).<br>*Example:* `"en-us"` | Yes |
| defaultAlertsPreferences | [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact. | Yes |

#### AlertNotificationDeliveryCallbackPayload-1 Schema

Outbound alerts notification payload.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| transactionTypes | [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" | Enum for the type of transaction.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | No |
| transactionDetails | { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string } | Details of the transaction. | Yes |
| transactionOutcome | { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } | Outcome of the transaction. | Yes |

#### OverrideableControl-8 Schema

Used to set rules that apply to all transactions performed with this account.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } | When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time. | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } | Provide cardDetails to set up controls and restrict access based on cardholder name or card sequence number. If used, the processor must provide the same transaction data when invoking the decision request and the authorization engine will attempt to use the details to locate a transaction control. If the card data is not matched from the transaction data, the control will not affect the transaction.<br>**Read-only** | No |
| spendLimit | { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer } | Used to track and manage total approved account purchases over a period of time. All amounts are based on the cardholderBillAmount in the authorization request. The actual amount submitted for settlement can differ (e.g. tips, hotel, car rental...). | No |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| alertThreshold | double | Maximum value of an approved purchase for this control type before triggering an alert when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if an alert should be sent.<br>*Example:* `1000` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| filterByCountry | { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] } | Allows cardholders to specify in which countries their card can, or cannot, be used depending on which child attribute is configured. | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| declineThreshold | double | Maximum value of a purchase for this control type before triggering a decline when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if a decline should be triggered.<br>*Example:* `1000` | No |
| isControlEnabled | boolean | Indicates if this control type will be applied during transaction processing. | Yes |
| shouldDeclineAll | boolean | Indicates if VTC will trigger a decline for all transactions related to this control type. Default value will be false. If false, other control settings (e.g. declineThreshold) will be checked. | No |
| transactionLimit | { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer } | Number of transactions to be allowed/approved, after which subsequent transactions will be declined. | No |
| shouldAlertOnDecline | boolean | Indicates if VTC will trigger a decline notification for all transactions matching the associated control type. If false, no alerts will be sent for declined transactions related to this control type. | No |
| shouldTargetSpecificCard | boolean | Indicates if card details are required. Card details will be used to locate a transaction control.<br>**Read-only** | No |
| declineAllNonTokenizeTransactions | boolean | When set to "true," transactions performed with primaryAccountNumber will be declined. Only token-based transactions will continue to process as normal. Used when the physical card is lost or misplaced but the cardholder wants to continue transacting via their mobile phone. | No |

#### NotificationDetailsV2 Schema

The response resource container. Contains notification details found.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| notificationDetails | [ { **"notificationId"**: string, **"notificationStatus"**: string, <br>**Available values:** "SUCCESSFULLY_SENT", "CLIENT_ERROR", "SYSTEM_ERROR", "CONFIRMATION_PENDING", **"outboundCallDetails"**: { **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string } }, **"outBoundAlertsNotificationPayload"**: { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"transactionDetails"**: { **"nameOnCard"**: string, **"MerchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: object, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: string, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "NONE", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } } ] | List of notification details found for this request. | Yes |

#### AlertTransactionOutcomeV2-1 Schema

Outcome of the transaction.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionID | string | Decision ID corresponding to the alerts.<br>*Example:* `"v-304-f1f11166-f3b3-4465-b995-61edb244c178"` | Yes |
| documentID | string | Uniquely identifies the control document that triggered the notification.<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | Yes |
| alertDetails | [ { **"appID"**: string, **"appName"**: string, **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ] | List of alerts triggered for a transaction that should be delivered to the cardholder. If transaction was declined, only a single alert detail will be present. | No |
| transactionLimit | { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer } | Number of transactions to be allowed/approved, after which subsequent transactions will be declined. | No |
| declineResponseCode | string | Response code indicating why the transaction was declined.<br>*Example:* `"50"` | No |
| transactionApproved | string, <br>**Available values:** "APPROVED", "DECLINED" | Indicates if transaction was approved.<br>*Enum:* `"APPROVED"`, `"DECLINED"`<br>*Example:* `"APPROVED"` | Yes |
| decisionResponseTimeStamp | string | Timestamp of when the decision was returned in UTC.<br>*Example:* `"2023-05-25T18:45:55.000Z"` | Yes |

#### CollectionResourceSponsorConfigRuleCategoryCardEnquiryRuleCategoryResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", **"availableControlTypes"**: [ { **"name"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" } ] } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CustomAlertsPayloadSettings Schema

Settings for custom alert payloads.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| accountIdentifierInClear | boolean | Indicates if accountIdentifier should be in clear in the notification response payload. | Yes |
| additionalAttributeIncluded | [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] | Attributes added by the issuer. | No |

#### CardEnquiryRuleCategoryResponse Schema

Control types available for this card.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" | Name of rule category.<br>*Enum:* `"PCT_GLOBAL"`, `"PCT_TRANSACTION"`, `"PCT_MERCHANT"`<br>*Example:* `"PCT_GLOBAL"` | Yes |

#### PointOfServiceInfo Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| terminalType | string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE" | identifies the type of terminal at which the transaction was acquired<br>*Enum:* `"POS_TERMINAL"`, `"ATM"`, `"HOME_TERMINAL"`, `"MOBILE_DEVICE"` | Yes |
| terminalClass | { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" } |  | Yes |
| presentationData | { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean } |  | Yes |
| securityCondition | string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID" | identifies information about how the payment transaction was authenticated<br>*Enum:* `"NO_SECURITY_CONCERN"`, `"SUSPECTED_FRAUD"`, `"IDENTIFICATION_VERIFIED"`, `"SECURE_ELECTRONIC_COMMERCE"`, `"NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT"`, `"NOT_AUTHENTICATED_SECURITY_TRANSACTION"`, `"NON_SECURE_TRANSACTION"`, `"NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT"`, `"CVV_VALIDATED_AND_VALID"`, `"CVV_VALIDATED_AND_INVALID"` | No |
| terminalEntryCapability | string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS" | identifies the form the primary account number was acquired<br>*Enum:* `"UNKNOWN"`, `"MANUAL"`, `"MAG_STRIPE_READ"`, `"BAR_CODE"`, `"OCR"`, `"ICC"`, `"KEY_ENTERED"`, `"FILE"`, `"MICR_READER"`, `"CONTACTLESS"` | Yes |
| primaryAccountNumberEntryMode | string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS" | identifies the way  primary account number was entered<br>*Enum:* `"UNKNOWN"`, `"MANUAL"`, `"MAG_STRIPE_READ"`, `"BAR_CODE"`, `"OCR"`, `"ICC"`, `"KEY_ENTERED"`, `"FILE"`, `"MICR_READER"`, `"CONTACTLESS"` | No |
| personalIdentificationNumberEntryMode | string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" | identifies the way the PIN number was entered<br>*Enum:* `"UNKNOWN"`, `"PIN_ENTRY_CAPABLE"`, `"NO_PIN_ENTRY"`, `"PIN_PAD_INOPERATIVE"` | No |

#### DecoupleTokenRequest-1 Schema

Object indicating if the PAN or token should be decoupled.  Either the primaryAccountNumber or paymentToken field must be set.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| paymentToken | string | Token account number for which the control is to be established.<br>*Example:* `"4000123456789010"` | No |
| shouldDecouple | boolean, <br>**Available values:** false | Indicates if tokens should be liberated from any card control settings placed on the primaryAccountNumber. If set to 'true' on an enrolled paymentToken the token will operate independently of the PAN's card controls. If set to 'true' on a primaryAccountNumber all related token transactions will be ignored by the PAN's card controls.<br>*Enum:* `false` | Yes |
| primaryAccountNumber | string | Primary account number for which the control is to be established.<br>*Example:* `"4000123456789010"` | No |

#### DecisionHistoryResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS" | Status of the request<br>*Enum:* `"AVAILABLE_RECORDS"`, `"NO_RECORDS"` | Yes |
| paginationData | { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer } | Pagination details for this request. | No |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] | List of decision Documents | Yes |

#### SponsorConfigTransactionTypeCardEnquiryTransactionControlResponse Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE" | Status of the rule category or control type (eligible or not eligible).<br>*Enum:* `"ELIGIBLE"`, `"NOT_ELIGIBLE"`<br>*Example:* `"ELIGIBLE"` | Yes |
| availableTransactionTypeRules | [ { **"name"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" }, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ] | Transaction control types available for this card. | Yes |

#### AlertTransactionDetailsV2 Schema

Details of the transaction.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| nameOnCard | string | Cardholder name as encoded on the payment instrument.<br>*Example:* `"Alex Miller"` | No |
| MerchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: object, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string } | Merchant details. | No |
| paymentToken | string | Masked payment token. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | Yes |
| exchangeRateDetails | { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string } | Exchange rate details provided in the notification payload for a cross-currency transaction when Issuer has configured FX Alerts. | No |
| cardholderBillAmount | string | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuer's currency.<br>*Example:* `"0.62"` | Yes |
| primaryAccountNumber | string | Masked primary account number. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| requestReceivedTimeStamp | string | Time, in UTC, the request is received.<br>*Example:* `"2025-08-06 04:05:15"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | No |

#### CollectionResourceTransactionControlReportsResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"responseMessage"**: string, **"controlDocuments"**: [ { **"status"**: string, <br>**Available values:** "ENROLLED", "DEENROLLED", "ADD_CONTROLS", "UPDATE_CONTROLS", "DELETE_CONTROLS", "DELETE_CARD_EXCEPTION", "CARD_EXCEPTION", "DELETE_PAN", "UPDATE_PAN", "BATCH_ADD_CONTROLS", "UPDATE_TOKEN", "DELETE_TOKEN", "SYSTEM_UPDATE", "SYSTEM_CREATE", "SYSTEM_MODIFY", "SYSTEM_DELETE", "ADD_RELATIONSHIP", "UPDATE_RELATIONSHIP", "DELETE_RELATIONSHIP", "ADD_FLEX_RULES", "UPDATE_FLEX_RULES", "DELETE_FLEX_RULES", "DELETE_CARD", "UPDATE_CARD", "ADD_UPDATE_FLEX_RULES", "REPLACE_CARD", **"userId"**: string, **"documentID"**: string, **"createdOnDate"**: string, **"requestedAppID"**: string, **"requestedDocumentID"**: string, **"transactionControlDocument"**: { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } } ] } | Transaction control document being returned. | No |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceOfDecisionResponseType-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### AppConfigurationCallBackSettingsResponseType-1 Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "NOT_CONFIGURED", "CONFIGURED" | Status of callback configuration.<br>*Enum:* `"NOT_CONFIGURED"`, `"CONFIGURED"`<br>*Example:* `"CONFIGURED"` | Yes |
| callBackSettings | { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } | URL posted following card enrollment or de-enrollment. | Yes |

#### CollectionResourceCustomerProfileDocument-13 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"cards"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"tokens"**: [ { **"documentID"**: string, **"portfolioID"**: string, **"paymentToken"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"primaryAccountNumber"**: string } ], **"lastName"**: string, **"firstName"**: string, **"createdOnDate"**: string, **"userIdentifier"**: string, **"isProfileActive"**: boolean, <br>**Available values:** true, false, **"alertsPreferences"**: [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ], **"preferredLanguage"**: string, **"lastUpdateTimeStamp"**: string, **"preferredCountryCode"**: string, **"defaultAlertsPreferences"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### RulesConfiguration Schema

Transaction controls configured on an account.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ruleCategory | string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" | Rule category for the control that triggered the alert/decline.<br>*Enum:* `"PCT_GLOBAL"`, `"PCT_TRANSACTION"`, `"PCT_MERCHANT"` | Yes |
| isAlertsAllowed | boolean | Indicates if alerts are supported (true) or not supported (false) for this control type. | Yes |
| isDeclinedAllowed | boolean | Indicates if declines are supported (true) or not supported (false) for this control type. | No |

#### TypeOverrideableControl-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } |  | No |
| spendLimit | { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer } |  | No |
| controlType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" | Indicates specific control type. Valid transactionControls values begin with: "TCT_", valid merchantControls values begin with: "MCT_". ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |
| alertThreshold | double | Maximum value of an approved purchase for this control type before triggering an alert when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if an alert should be sent.<br>*Example:* `1000` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| filterByCountry | { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] } |  | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } |  | No |
| declineThreshold | double | Maximum value of a purchase for this control type before triggering a decline when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if a decline should be triggered.<br>*Example:* `1000` | No |
| isControlEnabled | boolean | Indicates if this control type will be applied during transaction processing. | Yes |
| shouldDeclineAll | boolean | Indicates if VTC will trigger a decline for all transactions related to this control type. Default value will be false. If false, other control settings (e.g. declineThreshold) will be checked. | No |
| transactionLimit | { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer } |  | No |
| shouldAlertOnDecline | boolean | Indicates if VTC will trigger a decline notification for all transactions matching the associated control type. If false, no alerts will be sent for declined transactions related to this control type. | No |
| declineAllNonTokenizeTransactions | boolean | When set to "true," transactions performed with primaryAccountNumber will be declined. Only token-based transactions will continue to process as normal. Used when the physical card is lost or misplaced but the cardholder wants to continue transacting via their mobile phone. | No |

#### OverrideableControl-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } |  | No |
| spendLimit | { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer } |  | No |
| alertThreshold | double | Maximum value of an approved purchase for this control type before triggering an alert when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if an alert should be sent.<br>*Example:* `1000` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| filterByCountry | { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] } |  | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } |  | No |
| declineThreshold | double | Maximum value of a purchase for this control type before triggering a decline when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if a decline should be triggered.<br>*Example:* `1000` | No |
| isControlEnabled | boolean | Indicates if this control type will be applied during transaction processing. | Yes |
| shouldDeclineAll | boolean | Indicates if VTC will trigger a decline for all transactions related to this control type. Default value will be false. If false, other control settings (e.g. declineThreshold) will be checked. | No |
| transactionLimit | { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer } |  | No |
| shouldAlertOnDecline | boolean | Indicates if VTC will trigger a decline notification for all transactions matching the associated control type. If false, no alerts will be sent for declined transactions related to this control type. | No |
| declineAllNonTokenizeTransactions | boolean | When set to "true," transactions performed with primaryAccountNumber will be declined. Only token-based transactions will continue to process as normal. Used when the physical card is lost or misplaced but the cardholder wants to continue transacting via their mobile phone. | No |

#### CardPrefix Schema

Card Prefix List allowed for the Whitelisted App ID

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardType | string | Type of the Account Funding Source | Yes |
| cardBrand | string | Payment Network/Brand of the BIN or Card Range.<br>*Example:* `"Visa"` | Yes |
| isLeadPAN | boolean | Indicates if the PAN is Lead PAN. | No |
| sponsorBID | string | Identifier assigned to sponsor's business identity.<br>**Read-only** | No |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | No |
| portfolioID | string | Visa-issued identifier for the issuer card prefix. Used when an alert requires different messaging for different segments of a card portfolio. If not configured will default to 001.<br>*Example:* `"003"`<br>**Read-only** | No |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| isVTCAllowed | boolean | Indicates if BINs are allowed to use VTC. | No |
| isFlexAllowed | boolean | Indicates if the Flex feature is allowed. | No |
| prefixEndRange | string | Ending point of a valid range of card prefixes between 4 and 12 digits. | No |
| callBackSettings | { **"payloadVersion"**: string, **"callBackEndpoint"**: string, **"isCallBackDisabled"**: boolean, **"iscallBackEndpointLocal"**: boolean } | URL posted following card enrollment or de-enrollment. | Yes |
| prefixStartRange | string | Starting point of a valid range of card prefixes between 4 and 12 digits. | Yes |
| cardProgramIdentifier | string | BIN or Card Range enabled  by the Sponsor/Issuer.<br>*Example:* `"CONSUMER"` | No |
| prefixRangeIdentifier | string | prefixRangeIdentifier not mandatory field. | No |
| isFlexReportingAllowed | boolean | Indicates if BINs need to generate daily reports. | No |

#### SponsorConfigTransactionTypeCardEnquiryTransactionControlResponse-1 Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE" | Status of the rule category or control type (eligible or not eligible).<br>*Enum:* `"ELIGIBLE"`, `"NOT_ELIGIBLE"`<br>*Example:* `"ELIGIBLE"` | Yes |
| availableTransactionTypeRules | [ { **"name"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" }, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" | Transaction control types available for this card.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"` | Yes |

#### CardEnquiryRuleCategoryResponse-1 Schema

Control types available for this card.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" | Name of rule category.<br>*Enum:* `"PCT_GLOBAL"`, `"PCT_TRANSACTION"`, `"PCT_MERCHANT"`<br>*Example:* `"PCT_GLOBAL"` | Yes |

#### CustomerProfileFacade-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| lastName | string | Last name of the cardholder.<br>*Example:* `"Miller"` | Yes |
| firstName | string | First name of the cardholder.<br>*Example:* `"Alex"` | Yes |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.<br>*Example:* `"USA"` | No |
| portfolioID | string | Visa-issued identifier for the issuer card prefix. Used when an alert requires different messaging for different segments of a card portfolio. If not configured will default to 001.<br>*Example:* `"003"` | No |
| paymentToken | string | Payment token passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| communityCode | string | Default community assigned by API. The default is the sponsor BID description.<br>*Example:* `"123456789"`<br>**Read-only** | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 72 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | Yes |
| preferredLanguage | string | Preferred language for last mile alerts. Current languages supported are "en-us" (English US) and "es-us"(Spanish US).<br>*Example:* `"en-us"` | No |
| primaryAccountNumber | string | Primary account number passed in the request for registration.<br>*Example:* `"4000123456789010"` | No |
| defaultAlertsPreferences | [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contact types that can be used as defaults for any alert. If no alert preference has been defined, the alert will be delivered with default contact. | Yes |

#### CardListDescription Schema

List of disqualifying cards. These cards were not eligible to be added to the group, and will be returned in the response with partial success. HTTP status code will be 207. DisqualifyingCards will not be visible when HTTP status code is 200.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cards | [ string ] | List of disqualifying cards.<br>*Example:* `"4000123456789010"` | Yes |
| description | string | Reason for card disqualification.<br>*Example:* `"These cards are already enrolled with VTC. Set forceEnrollment:true in the request to override existing controls."` | Yes |

#### AccountUpdateResponse Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "SUCCESS" | Account update status.<br>*Enum:* `"SUCCESS"`<br>*Example:* `"SUCCESS"` | Yes |

#### TypeOverrideableControl-8 Schema

List of transaction controls configured for the card.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } | When provided, control will only be triggered when transaction takes place within the provided time range. Time data is stored in UTC: the application must first convert it from the cardholder's local time. | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } | Provide cardDetails to set up controls and restrict access based on cardholder name or card sequence number. If used, the processor must provide the same transaction data when invoking the decision request and the authorization engine will attempt to use the details to locate a transaction control. If the card data is not matched from the transaction data, the control will not affect the transaction.<br>**Read-only** | No |
| spendLimit | { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer } | Used to track and manage total approved account purchases over a period of time. All amounts are based on the cardholderBillAmount in the authorization request. The actual amount submitted for settlement can differ (e.g. tips, hotel, car rental...). | No |
| controlType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" | Indicates specific control type. Valid transactionControls values begin with: "TCT_", valid merchantControls values begin with: "MCT_". ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`<br>*Example:* `"TCT_ATM_WITHDRAWAL"` | Yes |
| currencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the merchant location.<br>*Example:* `"840"` | No |
| alertThreshold | double | Maximum value of an approved purchase for this control type before triggering an alert when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if an alert should be sent.<br>*Example:* `1000` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| filterByCountry | { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] } | Allows cardholders to specify in which countries their card can, or cannot, be used depending on which child attribute is configured. | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| declineThreshold | double | Maximum value of a purchase for this control type before triggering a decline when purchase meets/exceeds limit. During authorization processing, the cardholderBillAmount is used to identify if a decline should be triggered.<br>*Example:* `1000` | No |
| isControlEnabled | boolean | Indicates if this control type will be applied during transaction processing. | Yes |
| shouldDeclineAll | boolean | Indicates if VTC will trigger a decline for all transactions related to this control type. Default value will be false. If false, other control settings (e.g. declineThreshold) will be checked. | No |
| shouldAlertOnDecline | boolean | Indicates if VTC will trigger a decline notification for all transactions matching the associated control type. If false, no alerts will be sent for declined transactions related to this control type. | No |
| shouldTargetSpecificCard | boolean | Indicates if card details are required. Card details will be used to locate a transaction control.<br>**Read-only** | No |
| declineAllNonTokenizeTransactions | boolean | When set to "true," transactions performed with primaryAccountNumber will be declined. Only token-based transactions will continue to process as normal. Used when the physical card is lost or misplaced but the cardholder wants to continue transacting via their mobile phone. | No |

#### SponsorMccGroupRequestResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| customMerchantControlQualifiers | [ { **"updatedBy"**: string, **"isEnabledForVTC"**: boolean, **"lastUpdateTimeStamp"**: string, **"merchantControlType"**: string, **"merchantCategoryCodes"**: [ string ] } ] |  | No |

#### VdpErrorResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseCode | string | Response code | Yes |
| responseMessage | string | Response message | Yes |

#### CardHolderBillingAmount Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| maxAmount | double | Maximum range for the account. | No |
| minAmount | double | Minimum range for the account. | No |

#### UserInformation-2 Schema

Optional object to provide the ability to carry additional information about the user that defined the control

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string | Name of the user who configured the control. Required if userInformation is present.<br>*Example:* `"Alex Miller"` | Yes |
| bankingIdentifier | string | Identifier for the issuer to map the username.<br>*Example:* `"BI"` | No |
| applicationDefinedAttributes | [ string ] | Application attributes defined by the issuer.<br>*Example:* `"APP"` | No |

#### UserInformation-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string | Name of the user who configured the control. Required if userInformation is present.<br>*Example:* `"Alex Miller"` | Yes |
| bankingIdentifier | string | Identifier for the issuer to map the username.<br>*Example:* `"BI"` | No |
| applicationDefinedAttributes | [ string ] | Application attributes defined by the issuer.<br>*Example:* `"APP"` | No |

#### SponsorConfigRuleCategoryCardEnquiryRuleCategoryResponse-1 Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE" | Status of the rule category or control type (eligible or not eligible).<br>*Enum:* `"ELIGIBLE"`, `"NOT_ELIGIBLE"`<br>*Example:* `"ELIGIBLE"` | Yes |
| availableControlTypes | [ { **"name"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" } ] | Control types available for this card. | Yes |

#### WalletServicesAccountInquiryRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documentIDs | [ string ] | List of available transaction control documentIDs where configured rules are required.<br>*Example:* `"[ctc-vd-857a8766-160b-498d-820f-bf4339949c1b]"` | No |
| paymentTokens | [ string ] | List of payment tokens with associated contact details.<br>*Example:* `["4000123456789010","4000123456789011"]` | No |
| primaryAccountNumbers | [ string ] | List of available primary account numbers where configured rules are required.<br>*Example:* `["4000123456789010","4000123456789011"]` | No |

#### CollectionResourceSponsorConfigMerchantTypeCardEnquiryMerchantControlResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", **"availableMerchantTypeRules"**: [ { **"name"**: string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" }, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" ] } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### SponsorConfigMerchantTypeCardEnquiryMerchantControlResponse Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE" | Status of the rule category or control type (eligible or not eligible).<br>*Enum:* `"ELIGIBLE"`, `"NOT_ELIGIBLE"`<br>*Example:* `"ELIGIBLE"` | Yes |
| availableMerchantTypeRules | [ { **"name"**: string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" }, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" ] | List of merchant control types available for this card. | Yes |

#### DecisionRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageType | string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type<br>*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH" | The decision request type.<br>*Enum:* `"RECOMMENDED"`, `"COMPLETE"`, `"ADVICE"`, `"INFORM"`, `"PREAUTH"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string } |  | Yes |
| dateTimeLocal | string | The date and time the transaction originated in the format: mmddhhmmss | Yes |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| pointOfServiceInfo | { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" } |  | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| primaryAccountNumber | string | The card number for which the decision is to be made, must be between 13 and 19 numeric digits<br>*Example:* `"4000123456789010"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-25 18:45:55"` | No |

#### TransactionControlRequestType Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| globalControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | Used to set rules that apply to all transactions performed with this account. | No |
| merchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of merchant controls configured for the card. | No |
| transactionControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of transaction controls configured for the card. | No |
| customMerchantControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] | List of custom merchant controls configured for the card. | No |

#### CollectionResourceSponsorConfigMerchantTypeCardEnquiryMerchantControlResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", **"availableMerchantTypeRules"**: [ { **"name"**: string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" }, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" ], <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO" } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### AlertNotificationDeliveryCallbackPayload-13 Schema

Outbound alerts notification payload.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| transactionTypes | [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" | Enum for the type of transaction.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | No |
| transactionDetails | { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string } | Details of the transaction. | Yes |
| transactionOutcome | { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } | Outcome of the transaction. | Yes |

#### AccountUpdateResponse-1 Schema

The response resource container. Contains information provided in the request body.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "SUCCESS" | Account update status.<br>*Enum:* `"SUCCESS"`<br>*Example:* `"SUCCESS"` | Yes |

#### CollectionResourceOfDecisionUpdateModel Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### AlertTransactionDetailsV2-13 Schema

Details of the transaction.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| nameOnCard | string | Cardholder name as encoded on the payment instrument.<br>*Example:* `"Alex Miller"` | Yes |
| merchantInfo | { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string } | Merchant details. | No |
| paymentToken | string | Masked payment token. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| transactionID | string | Unique transaction ID assigned by processing gateway. If non-Visa processed transaction, transactionID is assigned by the issuer system.<br>*Example:* `"2101000000"` | No |
| userIdentifier | string | Uniquely identifies the cardholder to receive the alert. Should be a GUID, must be unique per enrolling application. Must not contain any PII data. Mandatory for all VTC notifications. Maximum of 50 characters.<br>*Example:* `"b2d1b9cc-fc3f-4a37-b431-ebf04f20a3e9"` | No |
| userInformation | { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] } | Optional object to provide the ability to carry additional information about the user that defined the control | No |
| billerCurrencyCode | string | ISO 8583 three-digit currency classification code identifying the national currency used at the biller's location.<br>*Example:* `"840"` | Yes |
| exchangeRateDetails | { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string } | Exchange rate details provided in the notification payload for a cross-currency transaction when Issuer has configured FX Alerts. | No |
| cardholderBillAmount | number | Total amount to be billed to the cardholder inclusive of any fees assessed. Amount must be in the card issuers currency.<br>*Example:* `100` | Yes |
| primaryAccountNumber | string | Masked primary account number. Only the last 4 digits provided.<br>*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| requestReceivedTimeStamp | string | Time, in UTC, the request is received.<br>*Example:* `"'2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.<br>*Example:* `"1101000000"` | No |

#### CollectionResourceBulkEnrollmentResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, **"disqualifyingCards"**: [ { **"cards"**: [ string ], **"description"**: string } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### EcbExchangeRateInfo Schema

ECB exchange rates and effective dates.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| exchangeRate | double | ECB rate from the ECB table.<br>*Example:* `123.456` | No |
| lastUpdatedDate | string | Timestamp of when the resource was last updated in UTC. Effective from the ECB table (batch date).<br>*Example:* `"2023-05-25T18:45:55.000Z"` | No |

#### CollectionResourceVoid-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | object | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21T04:56:12.551Z"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceVoid-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | object | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceSponsorConfigTransactionTypeCardEnquiryTransactionControlResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", **"availableTransactionTypeRules"**: [ { **"name"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" }, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" } | The response resource container. Contains information provided in the request body. | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-05-21 03:40:32.847"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### WhiteListRuleConfigPUT Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardPrefixes | [ { **"cardType"**: string, **"cardBrand"**: string, **"isLeadPAN"**: boolean, **"sponsorBID"**: string, **"countryCode"**: string, **"portfolioID"**: string, **"currencyCode"**: string, **"isVTCAllowed"**: boolean, **"isFlexAllowed"**: boolean, **"prefixEndRange"**: string, **"prefixStartRange"**: string, **"cardProgramIdentifier"**: string, **"prefixRangeIdentifier"**: string, **"cardPrefixSponsorLevel"**: boolean, **"isFlexReportingAllowed"**: boolean, **"whiteListConfiguration"**: { **"isFxAlertsAllowed"**: boolean, **"isCardGroupAllowed"**: boolean, **"isTimeDelayAllowed"**: boolean, **"rulesConfiguration"**: [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ], **"isSpendLimitAllowed"**: boolean, **"merchantControlTypes"**: [ string, <br>**Available values:** "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"blackListForSpendLimit"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_GAMBLING", "MCT_SPORT_AND_RECREATION", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING" ], **"isMultiCurrencyAllowed"**: boolean, **"isDetokenizationAllowed"**: boolean, **"isFlexMITRoutingEnabled"**: boolean, **"transactionControlTypes"**: [ string, <br>**Available values:** "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CROSS_BORDER", "TCT_ATM_WITHDRAW", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR", "TCT_AFT", "TCT_PURCHASE_RETURN", "TCT_OCT" ], **"isAlertOnReversalAllowed"**: boolean, **"isFilterByCountryAllowed"**: boolean, **"isTokenDecouplingAllowed"**: boolean, **"isLastMileDeliveryAllowed"**: boolean, **"customMerchantControlTypes"**: [ string ], **"customAlertsPayloadSettings"**: { **"accountIdentifierInClear"**: boolean, **"additionalAttributeIncluded"**: [ string, <br>**Available values:** "CARDPREFIX", "ALL_QUALIFYING_ALERTS" ] }, **"isTimeDelayAutoRemovalAllowed"**: boolean } } ] | List of card prefixes enabled for the Whitelisted App ID. | No |
| rulesConfiguration | [ { **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"isAlertsAllowed"**: boolean, **"isDeclinedAllowed"**: boolean } ] | Allowed rule categories configured for this Sponsor ID. | No |
| isSpendLimitAllowed | boolean | isSpendLimitAllowed is dependent on the sponsor whether it allows setting up spend limit control or not | No |
| isMultiCurrencyAllowed | boolean | isMultiCurrencyAllowed flag determines if an sponsor allows multi currency controls. | No |
| isFilterByCountryAllowed | boolean | isFilterByCountryAllowed is dependent on the sponsor whether it allows setting up country enable or disabled list | No |

#### CollectionResourceOfRate-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionID"**: string, **"decisionResponse"**: { **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"decisionResponseTimeStamp"**: string } } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### AlertNotifyDetail-1 Schema

List of notification details found for this request.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| outboundCallDetails | { **"status"**: string, **"message"**: string, **"httpVerb"**: string, **"errorDetails"**: [ { **"code"**: string, **"reason"**: string } ], **"alertPreferences"**: { **"contacts"**: [ { **"status"**: string, **"message"**: string, **"isVerified"**: boolean, **"contactType"**: string, **"contactValue"**: string } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string }, **"httpResponseCode"**: integer } | Outbound call details. | Yes |
| notificationDetailId | string | Unique identifier used to locate a list of notification identifiers.<br>*Example:* `"ctc-vd-45366159-40c2-43fc-914e-7cf7177badfd"` | No |
| outBoundAlertsNotificationPayload | { **"transactionTypes"**: [ string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT" ], <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", **"transactionDetails"**: { **"nameOnCard"**: string, **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"acceptorTaxId"**: string, **"anticipatedAmount"**: number, **"transactionAmount"**: number, **"merchantAcquirerID"**: string, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string, **"cardAcceptorIdentificationCode"**: string }, **"paymentToken"**: string, **"transactionID"**: string, **"userIdentifier"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"billerCurrencyCode"**: string, **"exchangeRateDetails"**: { **"fxStatus"**: string, **"pfxIndicator"**: string, <br>**Available values:** "ELIGIBLE", "NOT_ELIGIBLE", "APPLIED", **"visaExchangeRate"**: double, **"billerCurrencyCode"**: string, **"exchangeRateMarkUp"**: double, **"ecbExchangeRateInfo"**: { **"exchangeRate"**: double, **"lastUpdatedDate"**: string }, **"fxRateTableIdentifier"**: string }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"requestReceivedTimeStamp"**: string, **"retrievalReferenceNumber"**: string }, **"transactionOutcome"**: { **"decisionID"**: string, **"documentID"**: string, **"alertDetails"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string, **"currencyConversion"**: { **"convertedAmount"**: number, **"fromCurrencyCode"**: string, **"visaExchangeRate"**: string, **"controlCurrencyCode"**: string } } ], **"notificationID"**: string, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"declineResponseCode"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"decisionResponseTimeStamp"**: string } } | Outbound alerts notification payload. | Yes |

#### Error Schema

List of error details that occurred during request processing. Includes error codes and messages.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string | HTTP error code. 3xx = Redirection, 4xx = Client Error, 5xx = Server Error.<br>*Example:* `"400"` | No |
| reason | string | Indicates reason for failure or error.<br>*Example:* `"VTA Error"` | No |

#### BulkDecoupleTokenResponse Schema

The response resource container. Contains status of operation and list of tokens to decouple.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "Success", "PartialSuccess", "Failed" | Status of the call: Success, Partial_Success or Failure.<br>*Enum:* `"Success"`, `"PartialSuccess"`, `"Failed"`<br>*Example:* `"Success"` | Yes |
| response | [ { **"index"**: integer, **"reason"**: string, **"documentID"**: string, **"statusCode"**: integer, **"shouldDecouple"**: boolean } ] |  | Yes |

#### TransactionControlReportsDocument Schema

List of transaction control documents.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "ENROLLED", "DEENROLLED", "ADD_CONTROLS", "UPDATE_CONTROLS", "DELETE_CONTROLS", "DELETE_CARD_EXCEPTION", "CARD_EXCEPTION", "DELETE_PAN", "UPDATE_PAN", "BATCH_ADD_CONTROLS", "UPDATE_TOKEN", "DELETE_TOKEN", "SYSTEM_UPDATE", "SYSTEM_CREATE", "SYSTEM_MODIFY", "SYSTEM_DELETE", "ADD_RELATIONSHIP", "UPDATE_RELATIONSHIP", "DELETE_RELATIONSHIP", "ADD_FLEX_RULES", "UPDATE_FLEX_RULES", "DELETE_FLEX_RULES", "DELETE_CARD", "UPDATE_CARD", "ADD_UPDATE_FLEX_RULES", "REPLACE_CARD" | Status of document.<br>*Enum:* `"ENROLLED"`, `"DEENROLLED"`, `"ADD_CONTROLS"`, `"UPDATE_CONTROLS"`, `"DELETE_CONTROLS"`, `"DELETE_CARD_EXCEPTION"`, `"CARD_EXCEPTION"`, `"DELETE_PAN"`, `"UPDATE_PAN"`, `"BATCH_ADD_CONTROLS"`, `"UPDATE_TOKEN"`, `"DELETE_TOKEN"`, `"SYSTEM_UPDATE"`, `"SYSTEM_CREATE"`, `"SYSTEM_MODIFY"`, `"SYSTEM_DELETE"`, `"ADD_RELATIONSHIP"`, `"UPDATE_RELATIONSHIP"`, `"DELETE_RELATIONSHIP"`, `"ADD_FLEX_RULES"`, `"UPDATE_FLEX_RULES"`, `"DELETE_FLEX_RULES"`, `"DELETE_CARD"`, `"UPDATE_CARD"`, `"ADD_UPDATE_FLEX_RULES"`, `"REPLACE_CARD"`<br>*Example:* `"ENROLLED"` | No |
| userId | string | User ID of the person/system invoking the service.<br>*Example:* `"1222"` | No |
| documentID | string | Uniquely identifies the control document that triggered the notification.<br>*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | Yes |
| createdOnDate | string | Timestamp when control was added, in UTC.<br>*Example:* `"2023-03-21 04:56:12.561"` | No |
| requestedAppID | string | Unique ID assigned by VDP to identify a transaction control management application.<br>*Example:* `"vd-b971963f-12d9-4a28-a8dc-80bf9c31"` | No |
| requestedDocumentID | string | System generated ID for the control document bound to the PAN or token.<br>*Example:* `"ctc-vd-b971963f-12d9-4a28-a8dc-80bf9c31e9f6"` | No |
| transactionControlDocument | { **"documentID"**: string, **"currencyCode"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"shouldAlertOnDecline"**: boolean, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"customMerchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"currentPeriodEnd"**: string, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"currencyCode"**: string, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"impulseDelayEnd"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"impulseDelayStart"**: string, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"impulseDelayRemaining"**: string, **"shouldTargetSpecificCard"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } |  | No |

#### AlertPreferences Schema

List of alert preferences for specific alert types.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| contacts | [ { **"status"**: string, **"isVerified"**: boolean, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ] | List of contacts associated with alert preference. | Yes |
| alertType | string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER" | Transaction events supported with generated alerts. ALL is the only control type value supported with DECLINE_BY_ISSUER.<br>*Enum:* `"DECLINE_ALL"`, `"DECLINE_BREACHED_AMT"`, `"ALERT_BREACHED_AMT"`, `"DECLINE_BY_SPEND_LIMIT"`, `"ALERT_BREACHED_SPEND"`, `"DECLINE_BY_ISSUER"`<br>*Example:* `"DECLINE_ALL"` | Yes |
| controlType | string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" | Indicates specific control type. Valid transactionControls values begin with: "TCT_", valid merchantControls values begin with: "MCT_". When alertType is DECLINE_BY_ISSUER, the only valid controlType value is ALL.<br>*Enum:* `"TCT_ATM_WITHDRAW"`, `"TCT_AUTO_PAY"`, `"TCT_BRICK_AND_MORTAR"`, `"TCT_CROSS_BORDER"`, `"TCT_E_COMMERCE"`, `"TCT_CONTACTLESS"`, `"TCT_PURCHASE_RETURN"`, `"TCT_OCT"`, `"MCT_ADULT_ENTERTAINMENT"`, `"MCT_AIRFARE"`, `"MCT_ALCOHOL"`, `"MCT_APPAREL_AND_ACCESSORIES"`, `"MCT_AUTOMOTIVE"`, `"MCT_CAR_RENTAL"`, `"MCT_ELECTRONICS"`, `"MCT_SPORT_AND_RECREATION"`, `"MCT_GAMBLING"`, `"MCT_GAS_AND_PETROLEUM"`, `"MCT_GROCERY"`, `"MCT_HOTEL_AND_LODGING"`, `"MCT_HOUSEHOLD"`, `"MCT_PERSONAL_CARE"`, `"MCT_SMOKE_AND_TOBACCO"`, `"MCT_DINING"`, `"GLOBAL"`, `"ALL"`<br>*Example:* `"TCT_ATM_WITHDRAW"` | Yes |

#### CollectionResourceOfDecisionHistoryResponse-3 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS", **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceOfDecisionHistoryResponse-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS", **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### CollectionResourceOfDecisionHistoryResponse-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string, <br>**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS", **"paginationData"**: { **"lastPage"**: boolean, **"firstPage"**: boolean, **"pageLimit"**: string, **"startIndex"**: string, **"totalCount"**: long, **"totalPages"**: integer, **"recordCount"**: integer }, **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string, <br>**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string, <br>**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string, <br>**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string, <br>**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH", **"merchantInfo"**: { **"city"**: string, **"name"**: string, **"region"**: string, **"postalCode"**: string, **"countryCode"**: string, **"addressLines"**: [ string ], **"currencyCode"**: string, **"transactionAmount"**: number, **"merchantCategoryCode"**: string, **"cardAcceptorTerminalID"**: string }, **"dateTimeLocal"**: string, **"transactionID"**: string, **"processingCode"**: string, **"transactionTypes"**: [ string, <br>**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string, <br>**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string, <br>**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string, <br>**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string, <br>**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string, <br>**Available values:** "NO_SECURITY_CONCERN", "SUSPECTED_FRAUD", "IDENTIFICATION_VERIFIED", "SECURE_ELECTRONIC_COMMERCE", "NOT_AUTHORIZED_AT_3D_SECURE_MERCHANT", "NOT_AUTHENTICATED_SECURITY_TRANSACTION", "NON_SECURE_TRANSACTION", "NOT_AUTHENTICATED_SECURITY_TRANSACTION_SET_MERCHANT", "CVV_VALIDATED_AND_VALID", "CVV_VALIDATED_AND_INVALID", **"terminalEntryCapability"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string, <br>**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"wasProcessorDeclined"**: boolean, **"decisionRequestTimeStamp"**: string, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }, **"decisionResponse"**: { **"shouldAlert"**: boolean, **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string, <br>**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string } ], **"declineRuleDetail"**: { **"ruleType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "NONE", **"alertReason"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_TRANS_LIMIT", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_ISSUER", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "FX_ALERTS", "ALERT_BREACHED_AMT_REVERSAL", **"ruleCategory"**: string, <br>**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT", **"userIdentifier"**: string, **"thresholdAmount"**: double, **"triggeringAppID"**: string, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"controlTargetType"**: string }, **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"declineControlTargetType"**: string, **"decisionResponseTimeStamp"**: string }, **"primaryAccountNumber"**: string, **"transactionControlsnapshot"**: [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"shouldDecouple"**: boolean, **"merchantControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"impulseDelayPeriod"**: string, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ], **"lastUpdateTimeStamp"**: string, **"transactionControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string, <br>**Available values:** "LMT_MONTH", "LMT_WEEK", "LMT_DAY", "LMT_DATE_RANGE", "LMT_RECURRING", **"timeZoneID"**: string, **"endDateTime"**: string, **"startDateTime"**: string, **"alertThreshold"**: double, **"declineThreshold"**: double, **"currentPeriodSpend"**: double, **"recurringCycleTime"**: integer }, **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", **"alertThreshold"**: double, **"userIdentifier"**: string, **"filterByCountry"**: { **"controlEnabledCountryList"**: [ string ], **"controlDisabledCountryList"**: [ string ] }, **"userInformation"**: { **"name"**: string, **"bankingIdentifier"**: string, **"applicationDefinedAttributes"**: [ string ] }, **"declineThreshold"**: double, **"isControlEnabled"**: boolean, **"shouldDeclineAll"**: boolean, **"transactionLimit"**: { **"maxTransactionCount"**: integer, **"currentTransactionCount"**: integer }, **"shouldAlertOnDecline"**: boolean, **"declineAllNonTokenizeTransactions"**: boolean } ] } ] } ] } |  | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.<br>*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.<br>*Example:* `15` | Yes |

#### TransactionLimit-2 Schema

Number of transactions to be allowed/approved, after which subsequent transactions will be declined.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| maxTransactionCount | integer | Number of transactions permitted. After the transaction count is reached, then subsequent transactions are declined. Counts apply to specific processing codes, on Visa processed transactions, and is limited to the Global control type.<br>*Example:* `10` | Yes |
| currentTransactionCount | integer | Total number of transactions approved since the start of this limit. Counts will apply where processing code is present, on Visa processed transactions. currentTransactionCount is limited for use only with the Global control type.<br>*Example:* `10` | No |

#### TransactionLimit-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| maxTransactionCount | integer | Number of transactions permitted. After the transaction count is reached, then subsequent transactions are declined. Counts apply to specific processing codes, on Visa processed transactions, and is limited to the Global control type.<br>*Example:* `10` | Yes |
| currentTransactionCount | integer | Total number of transactions approved since the start of this limit. Counts will apply where processing code is present, on Visa processed transactions. currentTransactionCount is limited for use only with the Global control type.<br>*Example:* `10` | No |

#### AlertPreferencesRequestV2-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| portfolioID | string | Visa-issued identifier for the issuer card prefix. Used when an alert requires different messaging for different segments of a card portfolio. If not configured will default to 001.<br>*Example:* `"003"` | No |
| alertPreferences | [ { **"contacts"**: [ { **"status"**: string, **"isVerified"**: boolean, <br>**Available values:** true, false, **"callingCode"**: string, **"contactType"**: string, **"contactValue"**: string, **"preferredEmailFormat"**: string, <br>**Available values:** "Plain", "RichText", "Html" } ], **"alertType"**: string, <br>**Available values:** "DECLINE_ALL", "DECLINE_BREACHED_AMT", "ALERT_BREACHED_AMT", "DECLINE_BY_SPEND_LIMIT", "ALERT_BREACHED_SPEND", "DECLINE_BY_ISSUER", **"controlType"**: string, <br>**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_RECREATION", "MCT_GAMBLING", "MCT_GAS_AND_PETROLEUM", "MCT_GROCERY", "MCT_HOTEL_AND_LODGING", "MCT_HOUSEHOLD", "MCT_PERSONAL_CARE", "MCT_SMOKE_AND_TOBACCO", "MCT_DINING", "GLOBAL", "ALL" } ] |  | Yes |