# Visa Flex Credential
Visa is launching Visa Flex Credential (VFC) to enable acquirers, issuers, and merchants to provide cardholders the ability to access multiple funding options through a single Visa credential.
Every Visa Flex Credential is identified as a primary credential and can be linked to one or more secondary credentials.
## 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.
NOTE: 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,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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 }
|
### [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,
**Available values:** "COMPLETE", **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }
|
### [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 }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"status"**: string,
**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,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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 }
|
### [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,
**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,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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 }
|
### [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,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"wasProcessorDeclined"**: boolean, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"decisionID"**: string, **"decisionResponse"**: { **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string,
**Available values:** "CARD_NOT_ENROLLED", **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"decisionResponseTimeStamp"**: string } }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }
|
### [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 }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"status"**: string,
**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND", **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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 }
|
### [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,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" }, **"cardholderBillAmount"**: number, **"primaryAccountNumber"**: string, **"wasProcessorDeclined"**: boolean, **"retrievalReferenceNumber"**: string, **"decisionRequestTimeStampInMs"**: string }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK | **application/json**: { **"resource"**: { **"decisionID"**: string, **"decisionResponse"**: { **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string,
**Available values:** "CARD_NOT_ENROLLED", **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"decisionResponseTimeStamp"**: string } }, **"receivedTimestamp"**: string, **"processingTimeinMs"**: long }
|
---
### Schemas
#### BalanceInfo Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| sign | string,
**Available values:** "C", "D" | The sign for balance amount, either positive (C) or negative (D).
*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 |
#### PreEvalDecisionRequest-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } | | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } | | No |
| messageType | string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type
*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string,
**Available values:** "PREEVAL" | The decision request type.
*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.
*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string,
**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.
*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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.
*Example:* `100` | Yes |
| primaryAccountNumber | string | The card number for which the decision is to be made, must be between 13 and 19 numeric digits
*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.
*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.
*Example:* `"2023-05-25 18:45:55"` | No |
#### FilterByCountry Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| controlEnabledCountryList | [ string ] | List of countries where this control will be applied. Uppercase ISO 3166 3-letter country code.
*Example:* `"[USA]"` | No |
| controlDisabledCountryList | [ string ] | List of countries where this control will not be applied. Uppercase ISO 3166 3-letter country code.
*Example:* `"[USA]"` | No |
#### 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.
*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| decisionUpdate | { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } | | Yes |
| decisionRequest | { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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.
*Example:* `"xxxx-xxxx-xxxx-9010"` | Yes |
| transactionControlsnapshot | [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } | | No |
| spendLimit | { **"type"**: string,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*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"`
*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.
*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.
*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.
*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.
*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 |
#### CardDetail Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| nameOnCard | string | Cardholder name as encoded on the payment instrument.
*Example:* `"Alex Miller"` | No |
| sequenceOnCard | string | Card sequence number as encoded on the payment instrument.
*Example:* `"003"` | 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.
*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| decisionUpdate | { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } | | Yes |
| decisionRequest | { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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.
*Example:* `"xxxx-xxxx-xxxx-9010"` | Yes |
| transactionControlsnapshot | [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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 |
#### 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.
*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
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**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.
*Enum:* `"LMT_MONTH"`, `"LMT_WEEK"`, `"LMT_DAY"`, `"LMT_DATE_RANGE"`, `"LMT_RECURRING"`
*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.
*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.
*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.
*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.
*Example:* `1000` | No |
| declineThreshold | double | Maximum total value of approved purchases within the time period before triggering a decline.
*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.
*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.
*Example:* `366` | 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,
**Available values:** "CARD_NOT_ENROLLED" | This field provides more information on the disposition of the response
*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
*Example:* `"2022-05-25 18:45:55"` | Yes |
#### TransactionLimit 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.
*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.
*Example:* `10` | No |
#### CollectionResourceOfGetDecisionDocument-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string,
**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,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | Yes |
#### PointOfServiceInfo Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| terminalType | string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE" | identifies the type of terminal at which the transaction was acquired
*Enum:* `"POS_TERMINAL"`, `"ATM"`, `"HOME_TERMINAL"`, `"MOBILE_DEVICE"` | Yes |
| terminalClass | { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" } | | Yes |
| presentationData | { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean } | | Yes |
| securityCondition | string,
**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
*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,
**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
*Enum:* `"UNKNOWN"`, `"MANUAL"`, `"MAG_STRIPE_READ"`, `"BAR_CODE"`, `"OCR"`, `"ICC"`, `"KEY_ENTERED"`, `"FILE"`, `"MICR_READER"`, `"CONTACTLESS"` | Yes |
| primaryAccountNumberEntryMode | string,
**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
*Enum:* `"UNKNOWN"`, `"MANUAL"`, `"MAG_STRIPE_READ"`, `"BAR_CODE"`, `"OCR"`, `"ICC"`, `"KEY_ENTERED"`, `"FILE"`, `"MICR_READER"`, `"CONTACTLESS"` | No |
| personalIdentificationNumberEntryMode | string,
**Available values:** "UNKNOWN", "PIN_ENTRY_CAPABLE", "NO_PIN_ENTRY", "PIN_PAD_INOPERATIVE" | identifies the way the PIN number was entered
*Enum:* `"UNKNOWN"`, `"PIN_ENTRY_CAPABLE"`, `"NO_PIN_ENTRY"`, `"PIN_PAD_INOPERATIVE"` | No |
#### OverrideableControl Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } | | No |
| spendLimit | { **"type"**: string,
**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.
*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.
*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.
*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 |
#### CollectionResourceOfGetDecisionDocument-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string,
**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND", **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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 |
#### PreEvalDecisionRequest Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } | | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } | | No |
| messageType | string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type
*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string,
**Available values:** "PREEVAL" | The decision request type.
*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.
*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string,
**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.
*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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.
*Example:* `100` | Yes |
| primaryAccountNumber | string | The card number for which the decision is to be made, must be between 13 and 19 numeric digits
*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.
*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.
*Example:* `"2023-05-25 18:45:55"` | No |
#### DecisionHistoryResponse Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string,
**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS" | Status of the request
*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,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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 |
#### DecisionRequestBody-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } | | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } | | No |
| messageType | string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type
*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string,
**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH" | The decision request type.
*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.
*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string,
**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.
*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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.
*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.
*Example:* `"2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.
*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.
*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 |
#### TransactionControlDocument Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| documentID | string | System-generated ID for the control document bound to the account identifier (primaryAccountNumber/paymentToken).
*Example:* `"ctc-vd-857a8766-160b-498d-820f-bf4339949c1b"` | No |
| createdOnDate | string | Timestamp when control was added, in UTC
*Example:* `"2023-03-21 04:56:12.561"` | No |
| globalControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*Example:* `"2023-03-21 04:56:20"` | No |
| transactionControls | [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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 |
#### DecisionRequestBody-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } | | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } | | No |
| messageType | string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type
*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string,
**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM" | The decision request type.
*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.
*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string,
**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.
*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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.
*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.
*Example:* `"2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.
*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.
*Example:* `"2023-05-25 18:45:55"` | No |
#### CollectionResourceOfDecisionResponseType-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } | | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | Yes |
#### TimeRange 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.
*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.
*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.
*Example:* `"UTC"` | 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.
*Example:* `"45678"` | No |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.
*Example:* `"1101000000"` | Yes |
#### 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 |
#### PresentationData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| howPresented | string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT" | Identifies how the transaction entered the payment system
*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 |
#### 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.
*Example:* `"50"` | Yes |
| startIndex | string | Page start location. Must be numeric.
*Example:* `"1"` | Yes |
| totalCount | long | Total number of decisions available.
*Example:* `10` | Yes |
| totalPages | integer | Total number of pages for the result set, based on pageLimit provided.
*Example:* `1` | Yes |
| recordCount | integer | Total number of decisions returned in the response.
*Example:* `1` | Yes |
#### 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 |
#### DecisionRequestBody Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } | | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } | | No |
| messageType | string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type
*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string,
**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH" | The decision request type.
*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.
*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string,
**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.
*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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.
*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.
*Example:* `"2023-05-25 18:45:55"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.
*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.
*Example:* `"2023-05-25 18:45:55"` | No |
#### GetDecisionDocument Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string,
**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND" | Status of the request
*Enum:* `"SUCCESS"`, `"RESOURCE_NOT_FOUND"` | Yes |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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 |
#### CardHolderBillingAmount Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| maxAmount | double | Maximum range for the account. | No |
| minAmount | double | Minimum range for the account. | No |
#### UserInformation Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| name | string | Name of the user who configured the control. Required if userInformation is present.
*Example:* `"Alex Miller"` | Yes |
| bankingIdentifier | string | Identifier for the issuer to map the username.
*Example:* `"BI"` | No |
| applicationDefinedAttributes | [ string ] | Application attributes defined by the issuer.
*Example:* `"APP"` | No |
#### TerminalClass Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| isAttended | boolean | Defines whether card accepting device is attended by a person | Yes |
| howOperated | string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE" | Defines how the card accepting device was operated
*Enum:* `"CUSTOMER_OPERATED"`, `"CARD_ACCEPTOR_OPERATED"`, `"ADMINISTRATIVE"` | Yes |
| deviceLocation | string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" | Defines the location of the card accepting device
*Enum:* `"ON_PREMISE"`, `"OFF_PREMISE"`, `"ELECTRONIC_COMMERCE"` | Yes |
#### DecisionRequest Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageType | string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type
*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string,
**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM", "PREAUTH" | The decision request type.
*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.
*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| pointOfServiceInfo | { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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.
*Example:* `100` | Yes |
| primaryAccountNumber | string | The card number for which the decision is to be made, must be between 13 and 19 numeric digits
*Example:* `"4000123456789010"` | Yes |
| retrievalReferenceNumber | string | Retrieval reference number assigned by the card acceptor.
*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.
*Example:* `"2023-05-25 18:45:55"` | No |
#### 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.
*Example:* `"xxxx-xxxx-xxxx-9010"` | No |
| decisionUpdate | { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } | | Yes |
| decisionRequest | { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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.
*Example:* `"xxxx-xxxx-xxxx-9010"` | Yes |
| transactionControlsnapshot | [ { **"documentID"**: string, **"createdOnDate"**: string, **"globalControls"**: [ { **"timeRange"**: { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string }, **"spendLimit"**: { **"type"**: string,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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 |
#### CollectionResourceOfDecisionUpdateModel Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } | | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | Yes |
#### DecisionHistoryResponse-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string,
**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS" | Status of the request
*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,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND" | Status of the request
*Enum:* `"SUCCESS"`, `"RESOURCE_NOT_FOUND"` | Yes |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*Example:* `"50"` | Yes |
| startIndex | string | Page start location. Must be numeric.
*Example:* `"1"` | Yes |
#### GetDecisionDocument-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string,
**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND" | Status of the request
*Enum:* `"SUCCESS"`, `"RESOURCE_NOT_FOUND"` | Yes |
| decisionDocument | [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**Available values:** "AVAILABLE_RECORDS", "NO_RECORDS" | Status of the request
*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,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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 |
#### DecisionUpdateRequest Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionType | string,
**Available values:** "COMPLETE" | The decision request type
*Enum:* `"COMPLETE"` | Yes |
| transactionApproved | string,
**Available values:** "APPROVED", "DECLINED" | The decision for the completed transaction
*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 |
#### CollectionResourceOfDecisionDocument Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | Yes |
#### 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,
**Available values:** "CARD_NOT_ENROLLED" | This field provides more information on the disposition of the response
*Enum:* `"CARD_NOT_ENROLLED"` | No |
| alertsRuleDetail | [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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.
*Example:* `"CARD_LEVEL"` | No |
| decisionResponseTimeStamp | string | This value will be set automatically when the decision response is sent. Value is in UTC time
*Example:* `"2022-05-25 18:45:55"` | Yes |
#### CollectionResourceOfGetDecisionDocument Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string,
**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,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | Yes |
#### CollectionResourceOfRate-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionID"**: string, **"decisionResponse"**: { **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string,
**Available values:** "CARD_NOT_ENROLLED", **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"decisionResponseTimeStamp"**: string } } | | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | Yes |
#### CollectionResourceOfDecisionResponseType Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionID"**: string, **"decisionResponse"**: { **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string,
**Available values:** "CARD_NOT_ENROLLED", **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"decisionResponseTimeStamp"**: string } } | | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | Yes |
#### DecisionResponseType Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionID | string | Unique ID assigned to this decision request | Yes |
| decisionResponse | { **"shouldDecline"**: boolean, **"declineRuleType"**: string, **"responseMessage"**: string,
**Available values:** "CARD_NOT_ENROLLED", **"declineRuleCategory"**: string, **"declineThresholdAmount"**: double, **"decisionResponseTimeStamp"**: string } | | No |
#### DecisionRequest-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fxInfo | { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean } | | No |
| cardDetail | { **"nameOnCard"**: string, **"sequenceOnCard"**: string } | | No |
| messageType | string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420" | ISO message type
*Enum:* `"0100"`, `"0120"`, `"0200"`, `"0220"`, `"0400"`, `"0420"` | Yes |
| decisionType | string,
**Available values:** "RECOMMENDED", "COMPLETE", "ADVICE", "INFORM" | The decision request type.
*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.
*Example:* `"2101000000"` | No |
| processingCode | string | ISO processing code must be numeric, must be 6 positions | Yes |
| transactionTypes | [ string,
**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.
*Example:* `"840"` | No |
| pointOfServiceInfo | { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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.
*Example:* `100` | Yes |
| primaryAccountNumber | string | The card number for which the decision is to be made, must be between 13 and 19 numeric digits
*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.
*Example:* `"1101000000"` | Yes |
| decisionRequestTimeStampInMs | string | Time, in UTC, the request is received.
*Example:* `"2023-05-25 18:45:55"` | No |
#### CollectionResourceOfDecisionHistoryResponse-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string,
**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,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | Yes |
#### CollectionResourceOfDecisionHistoryResponse-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string,
**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,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | 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.
*Example:* `0.05` | No |
| crossCurrencyIndicator | boolean | Indicates if this transaction is cross currency or not. | No |
#### MerchantInfo Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| city | string | City where the merchant is located.
*Example:* `"San Francisco"` | No |
| name | string | Name of the merchant's business.
*Example:* `"Alex Miller Bakery"` | No |
| region | string | Two or three letter state or region code.
*Example:* `"US"` | No |
| postalCode | string | Five to nine digit postal/zip code for the merchant.
*Example:* `"94105"` | No |
| countryCode | string | Three letter ISO ALPHA-3 country code for the merchant location.
*Example:* `"USA"` | Yes |
| addressLines | [ string ] | Address of the merchant.
*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.
*Example:* `"840"` | Yes |
| transactionAmount | number | Total transaction amount in local merchant currency.
*Example:* `200` | No |
| merchantCategoryCode | string | ISO 8583 four-digit merchant classification code identifying the merchant by their business line.
*Example:* `"5542"` | Yes |
| cardAcceptorTerminalID | string | Terminal ID of the card acceptor.
*Example:* `"45678"` | No |
#### ExpirationDate Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| mm | string | Value in mm format | Yes |
| yy | string | Value in yy format | Yes |
#### TypeOverrideableControl Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| timeRange | { **"endTime"**: string, **"startTime"**: string, **"timeZoneID"**: string } | | No |
| spendLimit | { **"type"**: string,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*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"`
*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.
*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.
*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.
*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 |
#### CollectionResourceOfDecisionDocument-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | Yes |
#### CollectionResourceOfDecisionDocument-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | Yes |
#### CollectionResourceOfDecisionUpdateModel-3 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string,
**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND", **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | Yes |
#### DecisionUpdateModel Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| decisionType | string,
**Available values:** "COMPLETE" | The decision request type
*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,
**Available values:** "APPROVED", "DECLINED" | The decision for the completed transaction
*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 |
#### CollectionResourceOfDecisionUpdateModel-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string,
**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND", **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | Yes |
#### CollectionResourceOfDecisionUpdateModel-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"status"**: string,
**Available values:** "SUCCESS", "RESOURCE_NOT_FOUND", **"decisionDocument"**: [ { **"decisionID"**: string, **"paymentToken"**: string, **"decisionUpdate"**: { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean }, **"decisionRequest"**: { **"fxInfo"**: { **"visaExchangeRate"**: double, **"crossCurrencyIndicator"**: boolean }, **"cardDetail"**: { **"nameOnCard"**: string, **"sequenceOnCard"**: string }, **"messageType"**: string,
**Available values:** "0100", "0120", "0200", "0220", "0400", "0420", **"decisionType"**: string,
**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,
**Available values:** "TCT_OCT", "TCT_PURCHASE_RETURN", "TCT_AUTO_PAY", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_BRICK_AND_MORTAR" ], **"billerCurrencyCode"**: string, **"pointOfServiceInfo"**: { **"terminalType"**: string,
**Available values:** "POS_TERMINAL", "ATM", "HOME_TERMINAL", "MOBILE_DEVICE", **"terminalClass"**: { **"isAttended"**: boolean, **"howOperated"**: string,
**Available values:** "CUSTOMER_OPERATED", "CARD_ACCEPTOR_OPERATED", "ADMINISTRATIVE", **"deviceLocation"**: string,
**Available values:** "ON_PREMISE", "OFF_PREMISE", "ELECTRONIC_COMMERCE" }, **"presentationData"**: { **"howPresented"**: string,
**Available values:** "CUSTOMER_PRESENT", "CUSTOMER_NOT_PRESENT", "MAIL_PHONE_ORDER", "RECURRING_TRANSACTION", "INSTALLMENT_PAYMENT", **"isCardPresent"**: boolean }, **"securityCondition"**: string,
**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,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"primaryAccountNumberEntryMode"**: string,
**Available values:** "UNKNOWN", "MANUAL", "MAG_STRIPE_READ", "BAR_CODE", "OCR", "ICC", "KEY_ENTERED", "FILE", "MICR_READER", "CONTACTLESS", **"personalIdentificationNumberEntryMode"**: string,
**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,
**Available values:** "CARD_NOT_ENROLLED", **"alertsRuleDetail"**: [ { **"ruleType"**: string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**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,
**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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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,
**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,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | Yes |
#### RuleDetail Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ruleType | string,
**Available values:** "TCT_ATM_WITHDRAW", "TCT_AUTO_PAY", "TCT_BRICK_AND_MORTAR", "TCT_CROSS_BORDER", "TCT_E_COMMERCE", "TCT_CONTACTLESS", "TCT_PURCHASE_RETURN", "TCT_OCT", "MCT_ADULT_ENTERTAINMENT", "MCT_AIRFARE", "MCT_ALCOHOL", "MCT_APPAREL_AND_ACCESSORIES", "MCT_AUTOMOTIVE", "MCT_CAR_RENTAL", "MCT_ELECTRONICS", "MCT_SPORT_AND_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.
*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"`
*Example:* `"TCT_ATM_WITHDRAW"` | Yes |
| alertReason | string,
**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.
*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"`
*Example:* `"DECLINE_TRANS_LIMIT"` | No |
| ruleCategory | string,
**Available values:** "PCT_GLOBAL", "PCT_TRANSACTION", "PCT_MERCHANT" | Rule category for the control that triggered the alert/decline.
*Enum:* `"PCT_GLOBAL"`, `"PCT_TRANSACTION"`, `"PCT_MERCHANT"`
*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.
*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.
*Example:* `1000` | No |
| triggeringAppID | string | App ID for the control that triggered the alert.
*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.
*Example:* `"CARD_LEVEL"` | No |
#### CollectionResourceOfDecisionHistoryResponse Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resource | { **"decisionType"**: string,
**Available values:** "COMPLETE", **"lastUpdateTimeStamp"**: string, **"transactionApproved"**: string,
**Available values:** "APPROVED", "DECLINED", **"isDeclineResultOfTransactionControl"**: boolean } | | Yes |
| receivedTimestamp | string | Time, in UTC, the request is received.
*Example:* `"2023-03-21 04:56:12.551"` | Yes |
| processingTimeinMs | long | Processing time in milliseconds.
*Example:* `15` | Yes |