> For the complete documentation index, see [llms.txt](https://docs.payments.thalescloud.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payments.thalescloud.io/d1-v1-api/es/referencias-de-la-api-d1-v1/operaciones-de-tarjeta/entrante/models.md). # Models ## The cardState object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"cardState":{"description":"The state of the card.","type":"string","enum":["ACTIVE","INACTIVE"]}}}} ``` ## The operationCard object ````json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"operationCard":{"title":"operationCard","type":"object","description":"Operation details related to a specific operationId in GetCardOperation API","required":["operationId","operation","status","startTime","requestorType","requestorId"],"properties":{"operationId":{"$ref":"#/components/schemas/operationId"},"operation":{"type":"string","description":"The operation type.","enum":["ACTIVATE","D1_PAY_ENROLMENT","CLICK_TO_PAY_ENROLMENT","CLICK_TO_PAY_UPDATE","CLICK_TO_PAY_OPTOUT","DELETE","DIGITIZE","DISPLAY","PIN_CHANGE","PIN_DISPLAY","PRODUCE","PUSH","REGISTER","RENEW","REPLACE","RESUME","SUSPEND","UPDATE_ORDER","VERIFY","CARDHOLDER_VERIFICATION"]},"status":{"type":"string","enum":["SUCCESSFUL","PENDING","FAILED"],"description":"Status of the operation"},"startTime":{"$ref":"#/components/schemas/operationStartTime"},"endTime":{"$ref":"#/components/schemas/operationEndTime"},"requestorType":{"type":"string","enum":["ISSUER","USER","TSP","CCI","D1"]},"requestorId":{"type":"string","description":"Identifier of the principal who initiates the operation\n - consumerId if requestorType is USER\n - issuerId if requestorType is ISSUER\n - cci user id if requestorType is CCI\n - D1 if it's an operation automatically triggered by D1 (can be card suspended due to several authorisation with invalid cvv)"},"reason":{"$ref":"#/components/schemas/reason"},"reasonCode":{"type":"string","enum":["USER_DECISION","ISSUER_DECISION","DEVICE_LOST","DEVICE_STOLEN","CARD_LOST","CARD_STOLEN","CARD_BROKEN","DEVICE_FOUND","CARD_FOUND","CARD_EXPIRED","CARD_NOT_RECEIVED","FRAUD","CLOSED_CARD","CLOSED_ACCOUNT"]},"details":{"oneOf":[{"title":"ACTIVATE operation","description":"Container to hold detailed information of ACTIVATE operation","properties":{"sdkType":{"$ref":"#/components/schemas/sdkType"}}},{"title":"D1_PAY_ENROLMENT operation","description":"Container to hole details information of D1 Pay enrolment operation","properties":{"digitalCardId":{"$ref":"#/components/schemas/digitalCardId"},"walletApplicationId":{"$ref":"#/components/schemas/walletApplicationId"}}},{"title":"DIGITIZE operation","description":"Container to hold detailed information regarding the executed operation (DIGITIZE)","properties":{"eligibilityInformation":{"$ref":"#/components/schemas/eligibilityInformation"},"digitizationInformation":{"$ref":"#/components/schemas/digitizationInformation"},"digitalCardId":{"$ref":"#/components/schemas/digitalCardId"},"digitalCardInformation":{"$ref":"#/components/schemas/digitalCardInformation"}}},{"title":"DISPLAY operation","description":"Container to hold detailed information of DISPLAY operation","properties":{"sdkType":{"$ref":"#/components/schemas/sdkType"}}},{"title":"PIN_CHANGE operation","description":"Container to hold detailed information of PIN_CHANGE operation","properties":{"sdkType":{"$ref":"#/components/schemas/sdkType"},"pinType":{"type":"string","enum":["ISO0","3DES_SECCOS"],"description":"The type of PIN which is used for the card."}}},{"title":"PIN_DISPLAY operation","description":"Container to hold detailed information of PIN_DISPLAY operation","properties":{"sdkType":{"$ref":"#/components/schemas/sdkType"}}},{"title":"PRODUCE operation","description":"Container to hold detailed information of PRODUCE operation","properties":{"issuerRequestId":{"$ref":"#/components/schemas/operationId"},"dueDate":{"type":"string","format":"date","description":"The estimated card production date. It uses the format ```YYYY-MM-DD```."}}},{"title":"PUSH operations","description":"Container to hold detailed information of PUSH operations","properties":{"digitalCardRequestorId":{"type":"string","description":"Id of the token requestor to which we will push the card. Also known as TRID on scheme side.","minLength":11,"maxLength":11,"pattern":"[0-9]{11}"},"digitalCardRequestorName":{"type":"string","description":"Name of the token requestor to which we will push the card.","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9 _-]{1,64}"},"program":{"type":"string","description":"Protocol or API that was involded in the PUSH operation.","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9 _-]{1,64}"}}},{"title":"REGISTER, SUSPEND, RESUME, DELETE operations","description":"Container to hold any detailed information regarding the executed operation (REGISTER, SUSPEND, RESUME, RENEW, DELETE)","properties":{"oldState":{"type":"string","enum":["ACTIVE","INACTIVE","DELETED","SUSPENDED"],"description":"Old state of the card"},"newState":{"type":"string","enum":["ACTIVE","INACTIVE","DELETED","SUSPENDED"],"description":"New state of the card"},"consumerState":{"type":"string","deprecated":true,"enum":["ACTIVE","INACTIVE","DELETED"],"description":"The state of the end user (consumer).
**Note**: Consumer state is deprecated, this optional parameter will soon be removed from the response."}}},{"title":"RENEW operation","description":"Container to hold detailed information of RENEW operation","properties":{"oldCardId":{"type":"string","description":"Old id of the card","minLength":1,"maxLength":48,"pattern":"[A-Za-z0-9_-]{1,48}"},"newCardId":{"type":"string","description":"New id of the card","minLength":1,"maxLength":48,"pattern":"[A-Za-z0-9_-]{1,48}"},"oldState":{"type":"string","enum":["ACTIVE","INACTIVE","SUSPENDED"],"description":"Old state of the card"},"newState":{"type":"string","enum":["ACTIVE","INACTIVE","SUSPENDED"],"description":"New state of the card"},"consumerState":{"type":"string","deprecated":true,"enum":["ACTIVE","INACTIVE","DELETED"],"description":"The state of the end user (consumer).
**Note**: Consumer state is deprecated, this optional parameter will soon be removed from the response."}}},{"title":"UPDATE_ORDER operation","description":"Container to hold detailed information of UPDATE_ORDER operation","properties":{"pullType":{"$ref":"#/components/schemas/pullType"}}}],"type":"object"},"errorCode":{"type":"string","description":"External error code"},"error":{"type":"string","description":"Human readable string representing the error, only present in case of operation failure","maxLength":256,"minLength":0}}},"operationId":{"type":"string","description":"Unique identifier of the operation","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9_-]{1,64}"},"operationStartTime":{"type":"string","title":"Operation Start Time","description":"The time the request has been processed.\nFormat ISO 8601 YYYY-MM-DDThh:mm:ssTZD","minLength":1,"maxLength":64},"operationEndTime":{"type":"string","title":"Operation End Time","description":"The time the operation has been completed.\nFormat ISO 8601 YYYY-MM-DDThh:mm:ssTZD\nnote: This is an optional field and might not be returned for synchronous operations.","minLength":1,"maxLength":64},"reason":{"type":"string","title":"reason","pattern":"^[a-zA-Z0-9 ]{1,64}$","description":"The reason why the action is performed.\n\nThis a free text field in case the Issuer wants to send details, that will be returned in the operations list."},"sdkType":{"type":"string","description":"The type of SDK which is used","enum":["APP","WEB","NONE"]},"digitalCardId":{"type":"string","description":"Unique identifier of the digital card.","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9_-]{1,64}"},"walletApplicationId":{"type":"string","description":"Unique Indentifier of wallet application","maxLength":100},"eligibilityInformation":{"type":"object","description":"Provides details about the eligibility check operation","properties":{"cardBIN":{"type":"string","minLength":6,"maxLength":6},"eligible":{"type":"boolean"},"cardProduct":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":256}}}},"required":["cardBIN","eligible"]},"digitizationInformation":{"type":"object","description":"Provides details about the tokenization (digitization) operation whatever the result is (that is, successful, pending or cancelled)","title":"digitizationInformation","required":["digitizationChecks","digitizationResult"],"properties":{"digitizationChecks":{"type":"object","required":["issuerVerifications","decisionEngineVerifications","digitalCardRequestorAssessment"],"properties":{"issuerVerifications":{"$ref":"#/components/schemas/issuerVerifications"},"decisionEngineVerifications":{"$ref":"#/components/schemas/decisionEngineVerifications-2"},"digitalCardRequestorAssessment":{"$ref":"#/components/schemas/digitalCardRequestorAssessment-2"},"verificationCodes":{"type":"array","maxItems":100,"description":"D1 Verification codes generated by the decision engine during rule evaluation. Following values are possible:\n\t \n|value |description| \n|-----------|----------------------------------| \n|ADDRESS-MATCH|Full billing address match (Street Line 1 and ZIP Code and Country code)|\n|ADDRESS-NO_MATCH|Full billing address mismatch (Street Line 1 and ZIP Code and Country code)|\n|ADDRESS-PARTIAL_MATCH|Partial billing address mismatch (Street Line 1 or ZIP Code or Country code)|\n|ADDRESS_COUNTRYCODE-NO_MATCH|Country codes are available but do not match the comparison|\n|ADDRESS_LINE1-NO_MATCH|Address Street Line 1 information are available but do not match the comparison|\n|ADDRESS_LINE2-NO_MATCH|Address Street Line 2 information are available but do not match the comparison|\n|ADDRESS_ZIPCODE-NO_MATCH|ZIP codes are available but do not match the comparison|\n|ISS_LANGUAGE-INVALID|Cardholder device language provided by the issuer is not encoded as a valid language|\n|ISS_LANGUAGE-UNAVAILABLE|Cardholder device language not provided by the issuer|\n|ISS_LOCALIZATION-INVALID|Cardholder country code provided by the issuer is not encoded as a valid language|\n|ISS_LOCALIZATION-UNAVAILABLE|Cardholder country code not provided by the issuer|\n|ISS_PHONE_NUMBER-INVALID|Cardholder phone number provided by the issuer is not recognized as a valid number|\n|ISS_PHONE_NUMBER-UNAVAILABLE|Cardholder phone number not provided by the issuer|\n|ISS_ADDRESS-INVALID|Billing address provided by the Issuer is not valid and/or inaccurate|\n|ISS_ADDRESS-UNAVAILABLE|Billing address not provided by the issuer in GetConsumerInfo API response|\n|LANGUAGE-MATCH|Cardholder device language matches|\n|LANGUAGE-NO_MATCH|Cardholder device language does not match|\n|LOCALIZATION-MATCH|Cardholder localization obtained by resolving data provided in the tokenization request (device coordinates and/or IP Address) matches with customer residency address country code|\n|LOCALIZATION-NO_MATCH|Cardholder localization obtained by resolving data provided in the tokenization request (device coordinates and/or IP Address) do not match with customer residency address country code|\n|LOCALIZATION-PARTIAL_MATCH|One of the country codes obtained by resolving IP address & device location coordinates do not match with customer residency address country code|\n|NAME-MATCH|Cardholder name matches|\n|NAME-NO_MATCH|Cardholder name does not match|\n|NAME-PARTIAL_MATCH|Cardholder name only partially matches|\n|PHONE_NUMBER-MATCH|Cardholder phone number matches|\n|PHONE_NUMBER-NO_MATCH|Cardholder phone number does not match|\n|PHONE_NUMBER-PARTIAL_MATCH|Cardholder phone number suffix matches|\n|TR_ACCOUNT_SCORE-UNAVAILABLE|Account scoring not provided in tokenization request|\n|TR_ADDRESS-INVALID|Billing address provided by the token requester is not valid and/or inaccurate|\n|TR_ADDRESS-UNAVAILABLE|Billing address not provided by the token requester in the tokenization request or one of those fields is missing: Street Line 1 or ZIP Code or Country code|\n|TR_DEVICE_SCORE-UNAVAILABLE|Device scoring not provided in tokenization request|\n|TR_IPADDRESS-UNAVAILABLE|Cardholder device IP Address not provided in the tokenization request|\n|TR_IPADDRESS-INVALID|Cardholder device IP Address provided in the tokenization request cannot be correctly resolved into a country code\n|TR_LANGUAGE-UNAVAILABLE|Cardholder device language not provided in the tokenization request|\n|TR_LANGUAGE-INVALID|Cardholder device language provided in the tokenization request is not encoded as a valid language|\n|TR_LOCALIZATION-UNAVAILABLE|Cardholder device location coordinates not provided in the tokenization request|\n|TR_LOCALIZATION-INVALID|Cardholder device location coordinates provided in the tokenization request cannot be correctly resolved into a valid country|\n|TR_NAME-UNAVAILABLE|Cardholder name not provided in tokenization request|\n|TR_PHONE_NUMBER-UNAVAILABLE|Cardholder phone number not provided in the tokenization request|\n|TR_PHONE_NUMBER-INVALID|Cardholder phone number provided in the tokenization request is not recognized as a valid number|\n|TR_RECOMMENDATION-UNAVAILABLE|Wallet recommendation not provided in tokenization request|","items":{"type":"string"}},"matchedRule":{"type":"object","description":"Decision Engine rule triggerig the final decision.\r\n\r\nApplicable only to Decision Engine Version V2","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the matching rule."},"name":{"type":"string","description":"Name of the matching rule."},"scenario":{"type":"object","description":"The actual matching scenario ","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the matched scenario."},"name":{"type":"string","description":"Name of the matched scenario."}}}}}}},"digitizationResult":{"type":"object","required":["flow"],"properties":{"flow":{"type":"string","description":"Tokenization Decision Engine assessment result.\nFollowing values are possible:\n- RED (DECLINE)\n- GREEN (APPROVE)\n- YELLOW (STEP-UP)","minLength":1,"maxLength":64,"enum":["RED","YELLOW","GREEN"]},"score":{"type":"string","minLength":1,"maxLength":1,"pattern":"[1-5]{1,1}$","description":"This is the final score the decision engine has computed considering all the verifications and the scoring from the requestor and/or TSP.\nScore goes from 1 (low trust) to 5 (high trust)."},"idAndVMethods":{"$ref":"#/components/schemas/idAndVMethods"},"digitizationDecisionTimestamp":{"type":"string","minLength":1,"maxLength":64,"description":"The time when the digitization decision has been sent to the TSP.\nThis parameter can be used by the Issuer to manage the notifications to cardholder in case of PENDING status of digitize operation.\nFormat ISO 8601 YYYY-MM-DDThh:mm:ssTZD\n"}}}}},"issuerVerifications":{"title":"issuerVerifications","type":"object","properties":{"cardIsExpired":{"$ref":"#/components/schemas/result"},"cardIsLostOrStolen":{"$ref":"#/components/schemas/result"},"wrongCVV":{"$ref":"#/components/schemas/result"},"fraudSuspect":{"$ref":"#/components/schemas/result"},"cardIsInvalid":{"$ref":"#/components/schemas/result"}},"required":["cardIsExpired","cardIsLostOrStolen","wrongCVV","fraudSuspect","cardIsInvalid"]},"result":{"title":"result","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}}},"decisionEngineVerifications-2":{"title":"decisionEngineVerifications","type":"object","properties":{"tooManyDigitizationRequests":{"$ref":"#/components/schemas/result"},"tooManyCVVVerificationFailed":{"$ref":"#/components/schemas/result"},"walletPhoneNumberNotMatchingConsumerPhoneNumber":{"$ref":"#/components/schemas/result"},"digitizationCountExceededOnSameFPAN":{"$ref":"#/components/schemas/result"},"digitizationCountExceededOnSameDevice":{"$ref":"#/components/schemas/result"},"cardIsExpired":{"$ref":"#/components/schemas/result"},"cardIsInvalid":{"$ref":"#/components/schemas/result"},"wrongCVV":{"$ref":"#/components/schemas/result"},"CVVNotProvided":{"$ref":"#/components/schemas/CVVNotProvided-2"}},"required":["tooManyDigitizationRequests","tooManyCVVVerificationFailed","walletPhoneNumberNotMatchingConsumerPhoneNumber","digitizationCountExceededOnSameFPAN","digitizationCountExceededOnSameDevice","cardIsExpired","cardIsInvalid","wrongCVV","CVVNotProvided"]},"CVVNotProvided-2":{"title":"CVVNotProvided","type":"object","description":"If CVV has not been provided by the digital card requestor, then D1 verifies if this is incompatible with either the card capture method used or the digital card type requested.","properties":{"incompatibleWithCaptureMethod":{"$ref":"#/components/schemas/captureMethodIncompatible-2"},"incompatibleWithDigitalCardType":{"$ref":"#/components/schemas/digitalCardTypeIncompatible"}},"required":["incompatibleWithCaptureMethod","incompatibleWithDigitalCardType"]},"captureMethodIncompatible-2":{"title":"captureMethodIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}}},"digitalCardTypeIncompatible":{"title":"digitalCardTypeIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}},"description":"If the digital card type required is NOT one of the following:\n- COF (card on file)\n- ECOM (e-Commerce)\n\nthen the absence of CVV is unexpected, the result will be YES"},"digitalCardRequestorAssessment-2":{"title":"digitalCardRequestorAssessment","type":"object","required":["averageScore","deviceScore","recommendation"],"properties":{"averageScore":{"type":"string","description":"Average scoring from the digital card requestor. Following values are possible:\n\nNOT_APPLICABLE (score is based on data from digital card requestor. If the data is not available, average can't be computed).\n1\n2\n3\n4\n5"},"deviceScore":{"type":"string","description":"Following values are possible:\n\nNOT_APPLICABLE (score is based on data from digital card requestor. If the data is not available, score can't be provided).\n1\n2\n3\n4\n5"},"recommendation":{"$ref":"#/components/schemas/walletRecommendation"},"reasonCodesRecommendation":{"type":"string","description":"Reason codes, if any, from digital card requestor.\n\nOtherwise NOT_APPLICABLE","maxLength":64,"deprecated":true},"reasonCodesRecommendationDescription":{"type":"array","description":" This field shall allow to map the Wallet Reason Code Recommendation with a more user friendly description in line with the mapping table defined below:\n\t \n|reasonCode |In case of Yellow flow description| \n|-----------|----------------------------------| \n|01 |User Wallet Account ID too new relative to launch| \n|02 |User Wallet Account ID too new relative to provisioning request| \n|03 |User Wallet Account ID/Card Pair is newer than date threshold| \n|04 |Changes made to account data within date threshold| \n|05 |Suspicious transactions linked to this account.| \n|06 |The Account has not had activity in the last year.| \n|07 |Suspended cards in the secure element|\n|08 |The device was put in lost mode in the last 7 days for longer than the duration threshold| \n|09 |The number of provisioning attempts on this device in 72 hours exceeds the threshold| \n|0A |There have been more than the threshold number of different cards attempted at provisioning to this phone in 24 hours.| \n|0B |The card provisioning request contains a distinct name in excess of the permitted threshold| \n|0C |Device Score is less than 3| \n|0D |Account Score is less than 4| \n|0E |Device provisioning location outside of OEM marketplace store home country| \n|0F |Model rules not available at this time (in cases where back end systems time out).| \n|0G |Orange path flag: Device is considered at high risk for card provisioning | \n|0H |Phone Number Score is less than 3|\n|V1 |Cardholder name does not match the name registered in the wallet|\n|V2 |Wallet account device binding age is below threshold.This threshold is defined by the wallet. Please check with the wallet provider.|\n|VA |A recent account activity was detected. This threshold is defined by the wallet. Please check with the wallet provider.|\n|VC |Number of transactions in the last 12 months below a certain threshold: in the last 12 months a limited number of transactions have been performed. This threshold is defined by the wallet. Please check with the wallet provider. |","uniqueItems":true,"items":{"type":"object"}}}},"walletRecommendation":{"type":"string","description":"Wallet/Digital Card Requestor colour recommended during the card tokenization request\n\nPlease note that in certain situations a recommendation might be not provided by the wallet.","enum":["NOT_APPLICABLE","GREEN","YELLOW","ORANGE","RED"]},"idAndVMethods":{"type":"object","properties":{"supported":{"type":"array","description":"Any value described in the \"**selected**\" field","items":{"type":"string"}},"selected":{"type":"string","minLength":1,"maxLength":64,"description":"The following values are possible:\n- OTP_BY_SMS\n- OTP_BY_EMAIL\n- BANK_APP\n- CUSTOMER_SERVICE\n- 3DS"}}},"digitalCardInformation":{"title":"digitalCardInformation","type":"object","description":"Provides details about the digital card. Only available when digitalCardInfo = true","required":["digitalCardRequestorInformation","digitalCardsDetails"],"properties":{"deviceInformation":{"$ref":"#/components/schemas/deviceInformation"},"digitalCardRequestorInformation":{"title":"digitalCardRequestorInformation","type":"object","description":"Provides details about the digital card requestor.","properties":{"id":{"type":"string","description":"Digital Card requestor identifier. This is provided by the TSP itself.","minLength":11,"maxLength":11},"name":{"type":"string","maxLength":256,"description":"Wallet or Merchant human readable name"},"walletAccountId":{"type":"object","description":"Unique identifier of a wallet user account","additionalProperties":{}},"captureMethod":{"$ref":"#/components/schemas/captureMethod"}}},"digitalCardsDetails":{"type":"array","minItems":1,"maxItems":2,"description":null,"items":{"type":"object","required":["digitalCardId","state"],"properties":{"digitalCardId":{"type":"string","minLength":1,"maxLength":64,"description":"Unique identifier of the token specified by the TSP"},"panSuffix":{"type":"string","minLength":4,"maxLength":4,"description":"Last four digits of the token"},"state":{"$ref":"#/components/schemas/digitalCardState"},"type":{"$ref":"#/components/schemas/tokenType"},"provisioningTime":{"type":"string","maxLength":32,"description":"The provisioning time of the token. Format ISO 8601 YYYY-MM-DDThh:mm:ssTZD"},"isPrimary":{"type":"boolean","description":"Boolean Flag indicating whether the token is primary or auxiliary."},"credentials":{"type":"string","description":"The field is the json (cf http://www.json.org/ ) representation of the DIGITAL card.\nJWE encryption is used to secure the field (please refer to the [Encrypt sensitive data](../../../integrate-the-d1-api/encrypt-sensitive-data) for more details)\nDetails:\n\n{\n\n\"pan\":\"...\",\n\n\"exp\":\"...\"\n\n}\n\n\nThe PAN is Mandatory, up to 19 digits.\n\nThe expiry date in the format MMYY. It is not provided for UPI scheme.","minLength":1,"maxLength":8196}}}}}},"deviceInformation":{"title":"deviceInformation","type":"object","description":"Provides details about the device that has been used for the card tokenization.\nNote that this data is available only if the check eligbility has passed with success.\nData availability dependes on the requestor.","properties":{"deviceId":{"type":"string","minLength":1,"maxLength":128,"description":"Identifier of the token storage."},"digitalCardStorageType":{"type":"string","maxLength":32,"description":"Type of the token storage location. Following values are possible:\n- HCE\n- SPAY_PHONE\n- SPAY_TABLET\n- SPAY_WATCH\n- SPAY_TV\n- IPHONE\n- IWATCH\n- IPAD\n- MAC_BOOK\n- ANDROID_PHONE\n- ANDROID_TABLET\n- ANDROID_WATCH\n- MOBILE_PHONE\n- TABLET\n- WATCH\n- MOBILE_PHONE_OR_TABLET\n- BRACELET\n- PC\n- HOUSEHOLD\n- WEARABLE\n- AUTOMOBILE\n- UNKNOWN"},"manufacturer":{"type":"string","minLength":1,"maxLength":32,"description":"Device manufacturer name"},"brand":{"type":"string","minLength":1,"maxLength":32,"description":"Device brand"},"model":{"type":"string","minLength":1,"maxLength":32,"description":"Device model"},"osVersion":{"type":"string","minLength":1,"maxLength":16,"description":"Device OS version"},"firmwareVersion":{"type":"string","description":"Device firmware version","minLength":1,"maxLength":32},"phoneNumber":{"type":"string","description":"Device phone number","minLength":1,"maxLength":20},"fourLastDigitPhoneNumber":{"type":"string","minLength":1,"maxLength":4},"deviceName":{"type":"string","maxLength":128,"description":"Device name set by the end user"},"deviceParentId":{"type":"string","description":"ID of parent device. Applies to wearable","minLength":1,"maxLength":64},"language":{"type":"string","description":"Language set on the device in ISO 639-3","minLength":1,"maxLength":3},"serialNumber":{"type":"string","minLength":1,"maxLength":64,"description":"Device serial number"},"timeZone":{"type":"string","description":"Device time zone abbreviation. Example: PST, GMT, etc...","minLength":1,"maxLength":32},"timeZoneSetting":{"type":"string","maxLength":32,"description":"Who has set the timezone.\nPossible values:\n- NETWORK_SET\n- CONSUMER_SET"},"simSerialNumber":{"type":"string","description":"Secure Element serial number","minLength":1,"maxLength":24},"IMEI":{"type":"string","minLength":1,"maxLength":32},"networkOperator":{"type":"string","description":"Network operator name.","maxLength":32},"networkType":{"type":"string","description":"Network type. Can be:\n- CELLULAR\n- WIFI","maxLength":16}},"required":["deviceId"]},"captureMethod":{"description":"Method used by the user or the issuer to capture card information to digitize.\n\nDescription:\n- CAMERA: when card information is captured by the on-device camera\n- MANUAL: when the consumer enters the card information manually, through the device keyboard\n- BANK_APP: when the card information is exchanged between the banking App and the Issuer App\n- ON-FILE: when the card information is retrieved by a merchant who has stored the card information\n- READER_MODE: when the card information is retrieved through a NFC interaction between the device and the physical card (applies to VISA and some domestic schemes)\n- TOKEN: when the card information is retrieved through a device-based token. This is applicable only to VISA token for token provisioning use case\n- CHIP_DIP: card information is captured by inserting (dip) the card into a terminal (only VISA)\n- UNKNOWN: the origin of the card information capture is not known ","type":"string","maxLength":64},"digitalCardState":{"type":"string","description":"The state of the digital card (token)\n\nN.B. Tokens in DELETED state are included only if the corresponding issuer onboarding flag (i.e. manageDeletedToken) is set.\n","enum":["ACTIVE","INACTIVE","DELETED","DEPLOYMENT_ONGOING","PENDING_ACTIVATION"],"title":"digitalCardState"},"tokenType":{"type":"string","maxLength":16,"description":"The type of the token. Following values are supported:\n- SE\n- HCE\n- COF\n- ECOM\n- QRC"},"pullType":{"type":"string","description":"The type of operation performed to update card order","enum":["ACCELERATE","ACCELERATE_AND_REDIRECT","CANCEL","REDIRECT"]}}}} ```` ## The operationAllCard object ````json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"operationAllCard":{"title":"operationAllCard","type":"object","description":"Operation details related to a specific operationId in GetAllOperationsByCardId API","required":["operationId","operation","status","startTime","requestorType","requestorId"],"properties":{"operationId":{"$ref":"#/components/schemas/operationId"},"operation":{"type":"string","description":"The operation type.","enum":["ACTIVATE","D1_PAY_ENROLMENT","CLICK_TO_PAY_ENROLMENT","CLICK_TO_PAY_UPDATE","CLICK_TO_PAY_OPTOUT","DELETE","DIGITIZE","DISPLAY","PIN_CHANGE","PIN_DISPLAY","PRODUCE","PUSH","REGISTER","RENEW","REPLACE","RESUME","SUSPEND","UPDATE_ORDER","VERIFY","CARDHOLDER_VERIFICATION"]},"status":{"type":"string","enum":["SUCCESSFUL","PENDING","FAILED"],"description":"Status of the operation"},"startTime":{"$ref":"#/components/schemas/operationStartTime"},"endTime":{"$ref":"#/components/schemas/operationEndTime"},"requestorType":{"type":"string","enum":["ISSUER","USER","TSP","CCI","D1"]},"requestorId":{"type":"string","description":"Identifier of the principal who initiates the operation\n - consumerId if requestorType is USER\n - issuerId if requestorType is ISSUER\n - cci user id if requestorType is CCI\n - D1 if it's an operation automatically triggered by D1 (can be card suspended due to several authorisation with invalid cvv)"},"reason":{"$ref":"#/components/schemas/reason"},"reasonCode":{"type":"string","enum":["USER_DECISION","ISSUER_DECISION","DEVICE_LOST","DEVICE_STOLEN","CARD_LOST","CARD_STOLEN","CARD_BROKEN","DEVICE_FOUND","CARD_FOUND","CARD_EXPIRED","CARD_NOT_RECEIVED","FRAUD","CLOSED_CARD","CLOSED_ACCOUNT"]},"details":{"oneOf":[{"title":"ACTIVATE operation","description":"Container to hold detailed information of ACTIVATE operation","properties":{"sdkType":{"$ref":"#/components/schemas/sdkType"}}},{"title":"D1_PAY_ENROLMENT operation","description":"Container to hole details information of D1 Pay enrolment operation","properties":{"digitalCardId":{"$ref":"#/components/schemas/digitalCardId"},"walletApplicationId":{"$ref":"#/components/schemas/walletApplicationId"}}},{"title":"DIGITIZE operation","description":"Container to hold detailed information regarding the executed operation (DIGITIZE)","properties":{"eligibilityInformation":{"$ref":"#/components/schemas/eligibilityInformation"},"digitizationInformation":{"$ref":"#/components/schemas/digitizationInformation"},"digitalCardId":{"$ref":"#/components/schemas/digitalCardId"}}},{"title":"DISPLAY operation","description":"Container to hold detailed information of DISPLAY operation","properties":{"sdkType":{"$ref":"#/components/schemas/sdkType"}}},{"title":"PIN_CHANGE operation","description":"Container to hold detailed information of PIN_CHANGE operation","properties":{"sdkType":{"$ref":"#/components/schemas/sdkType"},"pinType":{"type":"string","enum":["ISO0","3DES_SECCOS"],"description":"The type of PIN which is used for the card."}}},{"title":"PIN_DISPLAY operation","description":"Container to hold detailed information of PIN_DISPLAY operation","properties":{"sdkType":{"$ref":"#/components/schemas/sdkType"}}},{"title":"PRODUCE operation","description":"Container to hold detailed information of PRODUCE operation","properties":{"issuerRequestId":{"$ref":"#/components/schemas/operationId"},"dueDate":{"type":"string","format":"date","description":"The estimated card production date. It uses the format ```YYYY-MM-DD```."}}},{"title":"PUSH operations","description":"Container to hold detailed information of PUSH operations","properties":{"digitalCardRequestorId":{"type":"string","description":"Id of the token requestor to which we will push the card. Also known as TRID on scheme side.","minLength":11,"maxLength":11,"pattern":"[0-9]{11}"},"digitalCardRequestorName":{"type":"string","description":"Name of the token requestor to which we will push the card.","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9 _-]{1,64}"},"program":{"type":"string","description":"Protocol or API that was involded in the PUSH operation.","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9 _-]{1,64}"}}},{"title":"REGISTER, SUSPEND, RESUME, DELETE operations","description":"Container to hold any detailed information regarding the executed operation (REGISTER, SUSPEND, RESUME, RENEW, DELETE)","properties":{"oldState":{"type":"string","enum":["ACTIVE","INACTIVE","DELETED","SUSPENDED"],"description":"Old state of the card"},"newState":{"type":"string","enum":["ACTIVE","INACTIVE","DELETED","SUSPENDED"],"description":"New state of the card"},"consumerState":{"type":"string","enum":["ACTIVE","INACTIVE","DELETED"],"description":"The state of the end user (consumer).
**Note**: Consumer state is deprecated, this optional parameter will soon be removed from the response."}}},{"title":"RENEW operation","description":"Container to hold detailed information of RENEW operation","properties":{"oldCardId":{"type":"string","description":"Old id of the card","minLength":1,"maxLength":48,"pattern":"[A-Za-z0-9_-]{1,48}"},"newCardId":{"type":"string","description":"New id of the card","minLength":1,"maxLength":48,"pattern":"[A-Za-z0-9_-]{1,48}"},"oldState":{"type":"string","enum":["ACTIVE","INACTIVE","SUSPENDED"],"description":"Old state of the card"},"newState":{"type":"string","enum":["ACTIVE","INACTIVE","SUSPENDED"],"description":"New state of the card"},"consumerState":{"type":"string","enum":["ACTIVE","INACTIVE","DELETED"],"description":"The state of the end user (consumer).
**Note**: Consumer state is deprecated, this optional parameter will soon be removed from the response."}}},{"title":"UPDATE_ORDER operation","description":"Container to hold detailed information of UPDATE_ORDER operation","properties":{"pullType":{"$ref":"#/components/schemas/pullType"}}}],"type":"object"},"errorCode":{"type":"string","description":"External error code"},"error":{"type":"string","description":"Human readable string representing the error, only present in case of operation failure","maxLength":256,"minLength":0}}},"operationId":{"type":"string","description":"Unique identifier of the operation","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9_-]{1,64}"},"operationStartTime":{"type":"string","title":"Operation Start Time","description":"The time the request has been processed.\nFormat ISO 8601 YYYY-MM-DDThh:mm:ssTZD","minLength":1,"maxLength":64},"operationEndTime":{"type":"string","title":"Operation End Time","description":"The time the operation has been completed.\nFormat ISO 8601 YYYY-MM-DDThh:mm:ssTZD\nnote: This is an optional field and might not be returned for synchronous operations.","minLength":1,"maxLength":64},"reason":{"type":"string","title":"reason","pattern":"^[a-zA-Z0-9 ]{1,64}$","description":"The reason why the action is performed.\n\nThis a free text field in case the Issuer wants to send details, that will be returned in the operations list."},"sdkType":{"type":"string","description":"The type of SDK which is used","enum":["APP","WEB","NONE"]},"digitalCardId":{"type":"string","description":"Unique identifier of the digital card.","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9_-]{1,64}"},"walletApplicationId":{"type":"string","description":"Unique Indentifier of wallet application","maxLength":100},"eligibilityInformation":{"type":"object","description":"Provides details about the eligibility check operation","properties":{"cardBIN":{"type":"string","minLength":6,"maxLength":6},"eligible":{"type":"boolean"},"cardProduct":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":256}}}},"required":["cardBIN","eligible"]},"digitizationInformation":{"type":"object","description":"Provides details about the tokenization (digitization) operation whatever the result is (that is, successful, pending or cancelled)","title":"digitizationInformation","required":["digitizationChecks","digitizationResult"],"properties":{"digitizationChecks":{"type":"object","required":["issuerVerifications","decisionEngineVerifications","digitalCardRequestorAssessment"],"properties":{"issuerVerifications":{"$ref":"#/components/schemas/issuerVerifications"},"decisionEngineVerifications":{"$ref":"#/components/schemas/decisionEngineVerifications-2"},"digitalCardRequestorAssessment":{"$ref":"#/components/schemas/digitalCardRequestorAssessment-2"},"verificationCodes":{"type":"array","maxItems":100,"description":"D1 Verification codes generated by the decision engine during rule evaluation. Following values are possible:\n\t \n|value |description| \n|-----------|----------------------------------| \n|ADDRESS-MATCH|Full billing address match (Street Line 1 and ZIP Code and Country code)|\n|ADDRESS-NO_MATCH|Full billing address mismatch (Street Line 1 and ZIP Code and Country code)|\n|ADDRESS-PARTIAL_MATCH|Partial billing address mismatch (Street Line 1 or ZIP Code or Country code)|\n|ADDRESS_COUNTRYCODE-NO_MATCH|Country codes are available but do not match the comparison|\n|ADDRESS_LINE1-NO_MATCH|Address Street Line 1 information are available but do not match the comparison|\n|ADDRESS_LINE2-NO_MATCH|Address Street Line 2 information are available but do not match the comparison|\n|ADDRESS_ZIPCODE-NO_MATCH|ZIP codes are available but do not match the comparison|\n|ISS_LANGUAGE-INVALID|Cardholder device language provided by the issuer is not encoded as a valid language|\n|ISS_LANGUAGE-UNAVAILABLE|Cardholder device language not provided by the issuer|\n|ISS_LOCALIZATION-INVALID|Cardholder country code provided by the issuer is not encoded as a valid language|\n|ISS_LOCALIZATION-UNAVAILABLE|Cardholder country code not provided by the issuer|\n|ISS_PHONE_NUMBER-INVALID|Cardholder phone number provided by the issuer is not recognized as a valid number|\n|ISS_PHONE_NUMBER-UNAVAILABLE|Cardholder phone number not provided by the issuer|\n|ISS_ADDRESS-INVALID|Billing address provided by the Issuer is not valid and/or inaccurate|\n|ISS_ADDRESS-UNAVAILABLE|Billing address not provided by the issuer in GetConsumerInfo API response|\n|LANGUAGE-MATCH|Cardholder device language matches|\n|LANGUAGE-NO_MATCH|Cardholder device language does not match|\n|LOCALIZATION-MATCH|Cardholder localization obtained by resolving data provided in the tokenization request (device coordinates and/or IP Address) matches with customer residency address country code|\n|LOCALIZATION-NO_MATCH|Cardholder localization obtained by resolving data provided in the tokenization request (device coordinates and/or IP Address) do not match with customer residency address country code|\n|LOCALIZATION-PARTIAL_MATCH|One of the country codes obtained by resolving IP address & device location coordinates do not match with customer residency address country code|\n|NAME-MATCH|Cardholder name matches|\n|NAME-NO_MATCH|Cardholder name does not match|\n|NAME-PARTIAL_MATCH|Cardholder name only partially matches|\n|PHONE_NUMBER-MATCH|Cardholder phone number matches|\n|PHONE_NUMBER-NO_MATCH|Cardholder phone number does not match|\n|PHONE_NUMBER-PARTIAL_MATCH|Cardholder phone number suffix matches|\n|TR_ACCOUNT_SCORE-UNAVAILABLE|Account scoring not provided in tokenization request|\n|TR_ADDRESS-INVALID|Billing address provided by the token requester is not valid and/or inaccurate|\n|TR_ADDRESS-UNAVAILABLE|Billing address not provided by the token requester in the tokenization request or one of those fields is missing: Street Line 1 or ZIP Code or Country code|\n|TR_DEVICE_SCORE-UNAVAILABLE|Device scoring not provided in tokenization request|\n|TR_IPADDRESS-UNAVAILABLE|Cardholder device IP Address not provided in the tokenization request|\n|TR_IPADDRESS-INVALID|Cardholder device IP Address provided in the tokenization request cannot be correctly resolved into a country code\n|TR_LANGUAGE-UNAVAILABLE|Cardholder device language not provided in the tokenization request|\n|TR_LANGUAGE-INVALID|Cardholder device language provided in the tokenization request is not encoded as a valid language|\n|TR_LOCALIZATION-UNAVAILABLE|Cardholder device location coordinates not provided in the tokenization request|\n|TR_LOCALIZATION-INVALID|Cardholder device location coordinates provided in the tokenization request cannot be correctly resolved into a valid country|\n|TR_NAME-UNAVAILABLE|Cardholder name not provided in tokenization request|\n|TR_PHONE_NUMBER-UNAVAILABLE|Cardholder phone number not provided in the tokenization request|\n|TR_PHONE_NUMBER-INVALID|Cardholder phone number provided in the tokenization request is not recognized as a valid number|\n|TR_RECOMMENDATION-UNAVAILABLE|Wallet recommendation not provided in tokenization request|","items":{"type":"string"}},"matchedRule":{"type":"object","description":"Decision Engine rule triggerig the final decision.\r\n\r\nApplicable only to Decision Engine Version V2","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the matching rule."},"name":{"type":"string","description":"Name of the matching rule."},"scenario":{"type":"object","description":"The actual matching scenario ","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the matched scenario."},"name":{"type":"string","description":"Name of the matched scenario."}}}}}}},"digitizationResult":{"type":"object","required":["flow"],"properties":{"flow":{"type":"string","description":"Tokenization Decision Engine assessment result.\nFollowing values are possible:\n- RED (DECLINE)\n- GREEN (APPROVE)\n- YELLOW (STEP-UP)","minLength":1,"maxLength":64,"enum":["RED","YELLOW","GREEN"]},"score":{"type":"string","minLength":1,"maxLength":1,"pattern":"[1-5]{1,1}$","description":"This is the final score the decision engine has computed considering all the verifications and the scoring from the requestor and/or TSP.\nScore goes from 1 (low trust) to 5 (high trust)."},"idAndVMethods":{"$ref":"#/components/schemas/idAndVMethods"},"digitizationDecisionTimestamp":{"type":"string","minLength":1,"maxLength":64,"description":"The time when the digitization decision has been sent to the TSP.\nThis parameter can be used by the Issuer to manage the notifications to cardholder in case of PENDING status of digitize operation.\nFormat ISO 8601 YYYY-MM-DDThh:mm:ssTZD\n"}}}}},"issuerVerifications":{"title":"issuerVerifications","type":"object","properties":{"cardIsExpired":{"$ref":"#/components/schemas/result"},"cardIsLostOrStolen":{"$ref":"#/components/schemas/result"},"wrongCVV":{"$ref":"#/components/schemas/result"},"fraudSuspect":{"$ref":"#/components/schemas/result"},"cardIsInvalid":{"$ref":"#/components/schemas/result"}},"required":["cardIsExpired","cardIsLostOrStolen","wrongCVV","fraudSuspect","cardIsInvalid"]},"result":{"title":"result","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}}},"decisionEngineVerifications-2":{"title":"decisionEngineVerifications","type":"object","properties":{"tooManyDigitizationRequests":{"$ref":"#/components/schemas/result"},"tooManyCVVVerificationFailed":{"$ref":"#/components/schemas/result"},"walletPhoneNumberNotMatchingConsumerPhoneNumber":{"$ref":"#/components/schemas/result"},"digitizationCountExceededOnSameFPAN":{"$ref":"#/components/schemas/result"},"digitizationCountExceededOnSameDevice":{"$ref":"#/components/schemas/result"},"cardIsExpired":{"$ref":"#/components/schemas/result"},"cardIsInvalid":{"$ref":"#/components/schemas/result"},"wrongCVV":{"$ref":"#/components/schemas/result"},"CVVNotProvided":{"$ref":"#/components/schemas/CVVNotProvided-2"}},"required":["tooManyDigitizationRequests","tooManyCVVVerificationFailed","walletPhoneNumberNotMatchingConsumerPhoneNumber","digitizationCountExceededOnSameFPAN","digitizationCountExceededOnSameDevice","cardIsExpired","cardIsInvalid","wrongCVV","CVVNotProvided"]},"CVVNotProvided-2":{"title":"CVVNotProvided","type":"object","description":"If CVV has not been provided by the digital card requestor, then D1 verifies if this is incompatible with either the card capture method used or the digital card type requested.","properties":{"incompatibleWithCaptureMethod":{"$ref":"#/components/schemas/captureMethodIncompatible-2"},"incompatibleWithDigitalCardType":{"$ref":"#/components/schemas/digitalCardTypeIncompatible"}},"required":["incompatibleWithCaptureMethod","incompatibleWithDigitalCardType"]},"captureMethodIncompatible-2":{"title":"captureMethodIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}}},"digitalCardTypeIncompatible":{"title":"digitalCardTypeIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}},"description":"If the digital card type required is NOT one of the following:\n- COF (card on file)\n- ECOM (e-Commerce)\n\nthen the absence of CVV is unexpected, the result will be YES"},"digitalCardRequestorAssessment-2":{"title":"digitalCardRequestorAssessment","type":"object","required":["averageScore","deviceScore","recommendation"],"properties":{"averageScore":{"type":"string","description":"Average scoring from the digital card requestor. Following values are possible:\n\nNOT_APPLICABLE (score is based on data from digital card requestor. If the data is not available, average can't be computed).\n1\n2\n3\n4\n5"},"deviceScore":{"type":"string","description":"Following values are possible:\n\nNOT_APPLICABLE (score is based on data from digital card requestor. If the data is not available, score can't be provided).\n1\n2\n3\n4\n5"},"recommendation":{"$ref":"#/components/schemas/walletRecommendation"},"reasonCodesRecommendation":{"type":"string","description":"Reason codes, if any, from digital card requestor.\n\nOtherwise NOT_APPLICABLE","maxLength":64,"deprecated":true},"reasonCodesRecommendationDescription":{"type":"array","description":" This field shall allow to map the Wallet Reason Code Recommendation with a more user friendly description in line with the mapping table defined below:\n\t \n|reasonCode |In case of Yellow flow description| \n|-----------|----------------------------------| \n|01 |User Wallet Account ID too new relative to launch| \n|02 |User Wallet Account ID too new relative to provisioning request| \n|03 |User Wallet Account ID/Card Pair is newer than date threshold| \n|04 |Changes made to account data within date threshold| \n|05 |Suspicious transactions linked to this account.| \n|06 |The Account has not had activity in the last year.| \n|07 |Suspended cards in the secure element|\n|08 |The device was put in lost mode in the last 7 days for longer than the duration threshold| \n|09 |The number of provisioning attempts on this device in 72 hours exceeds the threshold| \n|0A |There have been more than the threshold number of different cards attempted at provisioning to this phone in 24 hours.| \n|0B |The card provisioning request contains a distinct name in excess of the permitted threshold| \n|0C |Device Score is less than 3| \n|0D |Account Score is less than 4| \n|0E |Device provisioning location outside of OEM marketplace store home country| \n|0F |Model rules not available at this time (in cases where back end systems time out).| \n|0G |Orange path flag: Device is considered at high risk for card provisioning | \n|0H |Phone Number Score is less than 3|\n|V1 |Cardholder name does not match the name registered in the wallet|\n|V2 |Wallet account device binding age is below threshold.This threshold is defined by the wallet. Please check with the wallet provider.|\n|VA |A recent account activity was detected. This threshold is defined by the wallet. Please check with the wallet provider.|\n|VC |Number of transactions in the last 12 months below a certain threshold: in the last 12 months a limited number of transactions have been performed. This threshold is defined by the wallet. Please check with the wallet provider. |","uniqueItems":true,"items":{"type":"object"}}}},"walletRecommendation":{"type":"string","description":"Wallet/Digital Card Requestor colour recommended during the card tokenization request\n\nPlease note that in certain situations a recommendation might be not provided by the wallet.","enum":["NOT_APPLICABLE","GREEN","YELLOW","ORANGE","RED"]},"idAndVMethods":{"type":"object","properties":{"supported":{"type":"array","description":"Any value described in the \"**selected**\" field","items":{"type":"string"}},"selected":{"type":"string","minLength":1,"maxLength":64,"description":"The following values are possible:\n- OTP_BY_SMS\n- OTP_BY_EMAIL\n- BANK_APP\n- CUSTOMER_SERVICE\n- 3DS"}}},"pullType":{"type":"string","description":"The type of operation performed to update card order","enum":["ACCELERATE","ACCELERATE_AND_REDIRECT","CANCEL","REDIRECT"]}}}} ```` ## The issuerVerifications object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"issuerVerifications":{"title":"issuerVerifications","type":"object","properties":{"cardIsExpired":{"$ref":"#/components/schemas/result"},"cardIsLostOrStolen":{"$ref":"#/components/schemas/result"},"wrongCVV":{"$ref":"#/components/schemas/result"},"fraudSuspect":{"$ref":"#/components/schemas/result"},"cardIsInvalid":{"$ref":"#/components/schemas/result"}},"required":["cardIsExpired","cardIsLostOrStolen","wrongCVV","fraudSuspect","cardIsInvalid"]},"result":{"title":"result","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}}}}}} ``` ## The decisionEngineVerifications object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"decisionEngineVerifications":{"title":"decisionEngineVerifications","type":"object","properties":{"tooManyDigitizationRequests":{"$ref":"#/components/schemas/result"},"tooManyCVVVerificationFailed":{"$ref":"#/components/schemas/result"},"walletPhoneNumberNotMatchingConsumerPhoneNumber":{"$ref":"#/components/schemas/result"},"digitizationCountExceededOnSameFPAN":{"$ref":"#/components/schemas/result"},"digitizationCountExceededOnSameDevice":{"$ref":"#/components/schemas/result"},"cardIsExpired":{"$ref":"#/components/schemas/result"},"cardIsInvalid":{"$ref":"#/components/schemas/result"},"wrongCVV":{"$ref":"#/components/schemas/result"},"CVVNotProvided":{"$ref":"#/components/schemas/CVVNotProvided"}},"required":["tooManyDigitizationRequests","tooManyCVVVerificationFailed","walletPhoneNumberNotMatchingConsumerPhoneNumber","digitizationCountExceededOnSameFPAN","digitizationCountExceededOnSameDevice","cardIsExpired","cardIsInvalid","wrongCVV","CVVNotProvided"]},"result":{"title":"result","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}}},"CVVNotProvided":{"title":"CVVNotProvided","type":"object","description":"If CVV has not been provided by the digital card requestor, then D1 verifies if this is incompatible with either the card capture method used or the digital card type requested.","properties":{"incompatibleWithCaptureMethod":{"$ref":"#/components/schemas/captureMethodIncompatible"},"incompatibleWithDigitalCardType":{"$ref":"#/components/schemas/digitalCardTypeIncompatible"}},"required":["incompatibleWithCaptureMethod","incompatibleWithDigitalCardType"]},"captureMethodIncompatible":{"title":"captureMethodIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}},"description":"If the capture method of the card details is NOT one of the following:\n- BANK_APP (card details from the Banking App)\n- TOKEN (card details derived by the TSP from an existing digital card)\n- ON-FILE (card details from a card stored on file)\n\nthen the absence of CVV is unexpected, the result will be YES"},"digitalCardTypeIncompatible":{"title":"digitalCardTypeIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}},"description":"If the digital card type required is NOT one of the following:\n- COF (card on file)\n- ECOM (e-Commerce)\n\nthen the absence of CVV is unexpected, the result will be YES"}}}} ``` ## The CVVNotProvided object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"CVVNotProvided":{"title":"CVVNotProvided","type":"object","description":"If CVV has not been provided by the digital card requestor, then D1 verifies if this is incompatible with either the card capture method used or the digital card type requested.","properties":{"incompatibleWithCaptureMethod":{"$ref":"#/components/schemas/captureMethodIncompatible"},"incompatibleWithDigitalCardType":{"$ref":"#/components/schemas/digitalCardTypeIncompatible"}},"required":["incompatibleWithCaptureMethod","incompatibleWithDigitalCardType"]},"captureMethodIncompatible":{"title":"captureMethodIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}},"description":"If the capture method of the card details is NOT one of the following:\n- BANK_APP (card details from the Banking App)\n- TOKEN (card details derived by the TSP from an existing digital card)\n- ON-FILE (card details from a card stored on file)\n\nthen the absence of CVV is unexpected, the result will be YES"},"digitalCardTypeIncompatible":{"title":"digitalCardTypeIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}},"description":"If the digital card type required is NOT one of the following:\n- COF (card on file)\n- ECOM (e-Commerce)\n\nthen the absence of CVV is unexpected, the result will be YES"}}}} ``` ## The digitalCardRequestorAssessment object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"digitalCardRequestorAssessment":{"title":"digitalCardRequestorAssessment","type":"object","required":["averageScore","deviceScore","accountScore","recommendation"],"properties":{"averageScore":{"type":"string","description":"Average scoring from the digital card requestor. Following values are possible:\n\nNOT_APPLICABLE (score is based on data from digital card requestor. If the data is not available, average can't be computed).\n1\n2\n3\n4\n5"},"deviceScore":{"type":"string","description":"Following values are possible:\n\nNOT_APPLICABLE (score is based on data from digital card requestor. If the data is not available, score can't be provided).\n1\n2\n3\n4\n5"},"accountScore":{"type":"string","description":"Wallet Provider account scoring, low values means high risk.\nFollowing values are possible:\n\nNOT_APPLICABLE (score is based on data from digital card requestor. If the data is not available, score can't be provided).\n\n1 2 3 4 5"},"recommendation":{"$ref":"#/components/schemas/walletRecommendation"},"reasonCodesRecommendation":{"type":"string","description":"Reason codes, if any, from digital card requestor.\n\nOtherwise NOT_APPLICABLE","maxLength":64,"deprecated":true},"reasonCodesRecommendationDescription":{"type":"array","description":" This field shall allow to map the Wallet Reason Code Recommendation with a more user friendly description in line with the mapping table defined below:\n\t \n|reasonCode |In case of Yellow flow description| \n|-----------|----------------------------------| \n|01 |User Wallet Account ID too new relative to launch| \n|02 |User Wallet Account ID too new relative to provisioning request| \n|03 |User Wallet Account ID/Card Pair is newer than date threshold| \n|04 |Changes made to account data within date threshold| \n|05 |Suspicious transactions linked to this account.| \n|06 |The Account has not had activity in the last year.| \n|07 |Suspended cards in the secure element|\n|08 |The device was put in lost mode in the last 7 days for longer than the duration threshold| \n|09 |The number of provisioning attempts on this device in 72 hours exceeds the threshold| \n|0A |There have been more than the threshold number of different cards attempted at provisioning to this phone in 24 hours.| \n|0B |The card provisioning request contains a distinct name in excess of the permitted threshold| \n|0C |Device Score is less than 3| \n|0D |Account Score is less than 4| \n|0E |Device provisioning location outside of OEM marketplace store home country| \n|0F |Model rules not available at this time (in cases where back end systems time out).| \n|0G |Orange path flag| \n|0H |Phone Number Score is less than 3|\n|V1 |Card holder name does not match Wallet Name|\n|V2 |Low Account to device binding age|\n|VC |No transactions occurred in the last month|","uniqueItems":true,"items":{"type":"object"}}}},"walletRecommendation":{"type":"string","description":"Wallet/Digital Card Requestor colour recommended during the card tokenization request\n\nPlease note that in certain situations a recommendation might be not provided by the wallet.","enum":["NOT_APPLICABLE","GREEN","YELLOW","ORANGE","RED"]}}}} ``` ## The result object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"result":{"title":"result","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}}}}}} ``` ## The digitalCardTypeIncompatible object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"digitalCardTypeIncompatible":{"title":"digitalCardTypeIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}},"description":"If the digital card type required is NOT one of the following:\n- COF (card on file)\n- ECOM (e-Commerce)\n\nthen the absence of CVV is unexpected, the result will be YES"}}}} ``` ## The captureMethodIncompatible object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"captureMethodIncompatible":{"title":"captureMethodIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}},"description":"If the capture method of the card details is NOT one of the following:\n- BANK_APP (card details from the Banking App)\n- TOKEN (card details derived by the TSP from an existing digital card)\n- ON-FILE (card details from a card stored on file)\n\nthen the absence of CVV is unexpected, the result will be YES"}}}} ``` ## The encryptedDataCriteria object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"encryptedDataCriteria":{"type":"object","title":"encryptedDataCriteria","properties":{"encryptedData":{"type":"string","title":"encryptedCardData","maxLength":8192,"pattern":"^(?:[A-Za-z0-9+\\/]{4})*(?:[A-Za-z0-9+\\/]{2}==|[A-Za-z0-9+\\/]{3}=)?$","description":"To find a specific card from the PAN, the PAN of the card is encrypted using the JWE encryption (please refer to the [Encrypt sensitive data](../../../integrate-the-d1-api/encrypt-sensitive-data) for more details)

Content

Once deciphered, the plaintext contains:\n\t\n|JSON field parameter name|type|description|MOC|Length|\n|-------|-------|-------|-------|-------|\n|pan|String|The pan value.|M|Up to 19|"}},"required":["encryptedData"]}}}} ``` ## The sdkType object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"sdkType":{"type":"string","description":"The type of SDK which is used","enum":["APP","WEB","NONE"]}}}} ``` ## The issuerRequestId object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"issuerRequestId":{"type":"string","description":"Identifier provided by issuer to identify the card production request","$ref":"#/components/schemas/operationId"},"operationId":{"type":"string","description":"Unique identifier of the operation","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9_-]{1,64}"}}}} ``` ## The pullType object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"pullType":{"type":"string","description":"The type of operation performed to update card order","enum":["ACCELERATE","ACCELERATE_AND_REDIRECT","CANCEL","REDIRECT"]}}}} ``` ## The digitalCardInformation object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"digitalCardInformation":{"title":"digitalCardInformation","type":"object","description":"Provides details about the digital card. Only available when digitalCardInfo = true","required":["digitalCardRequestorInformation","digitalCardsDetails"],"properties":{"deviceInformation":{"$ref":"#/components/schemas/deviceInformation"},"digitalCardRequestorInformation":{"title":"digitalCardRequestorInformation","type":"object","description":"Provides details about the digital card requestor.","properties":{"id":{"type":"string","description":"Digital Card requestor identifier. This is provided by the TSP itself.","minLength":11,"maxLength":11},"name":{"type":"string","maxLength":256,"description":"Wallet or Merchant human readable name"},"walletAccountId":{"type":"object","description":"Unique identifier of a wallet user account","additionalProperties":{}},"captureMethod":{"$ref":"#/components/schemas/captureMethod"}}},"digitalCardsDetails":{"type":"array","minItems":1,"maxItems":2,"description":null,"items":{"type":"object","required":["digitalCardId","state"],"properties":{"digitalCardId":{"type":"string","minLength":1,"maxLength":64,"description":"Unique identifier of the token specified by the TSP"},"panSuffix":{"type":"string","minLength":4,"maxLength":4,"description":"Last four digits of the token"},"state":{"$ref":"#/components/schemas/digitalCardState"},"type":{"$ref":"#/components/schemas/tokenType"},"provisioningTime":{"type":"string","maxLength":32,"description":"The provisioning time of the token. Format ISO 8601 YYYY-MM-DDThh:mm:ssTZD"},"isPrimary":{"type":"boolean","description":"Boolean Flag indicating whether the token is primary or auxiliary."},"credentials":{"type":"string","description":"The field is the json (cf http://www.json.org/ ) representation of the DIGITAL card.\nJWE encryption is used to secure the field (please refer to the [Encrypt sensitive data](../../../integrate-the-d1-api/encrypt-sensitive-data) for more details)\nDetails:\n\n{\n\n\"pan\":\"...\",\n\n\"exp\":\"...\"\n\n}\n\n\nThe PAN is Mandatory, up to 19 digits.\n\nThe expiry date in the format MMYY. It is not provided for UPI scheme.","minLength":1,"maxLength":8196}}}}}},"deviceInformation":{"title":"deviceInformation","type":"object","description":"Provides details about the device that has been used for the card tokenization.\nNote that this data is available only if the check eligbility has passed with success.\nData availability dependes on the requestor.","properties":{"deviceId":{"type":"string","minLength":1,"maxLength":128,"description":"Identifier of the token storage."},"digitalCardStorageType":{"type":"string","maxLength":32,"description":"Type of the token storage location. Following values are possible:\n- HCE\n- SPAY_PHONE\n- SPAY_TABLET\n- SPAY_WATCH\n- SPAY_TV\n- IPHONE\n- IWATCH\n- IPAD\n- MAC_BOOK\n- ANDROID_PHONE\n- ANDROID_TABLET\n- ANDROID_WATCH\n- MOBILE_PHONE\n- TABLET\n- WATCH\n- MOBILE_PHONE_OR_TABLET\n- BRACELET\n- PC\n- HOUSEHOLD\n- WEARABLE\n- AUTOMOBILE\n- UNKNOWN"},"manufacturer":{"type":"string","minLength":1,"maxLength":32,"description":"Device manufacturer name"},"brand":{"type":"string","minLength":1,"maxLength":32,"description":"Device brand"},"model":{"type":"string","minLength":1,"maxLength":32,"description":"Device model"},"osVersion":{"type":"string","minLength":1,"maxLength":16,"description":"Device OS version"},"firmwareVersion":{"type":"string","description":"Device firmware version","minLength":1,"maxLength":32},"phoneNumber":{"type":"string","description":"Device phone number","minLength":1,"maxLength":20},"fourLastDigitPhoneNumber":{"type":"string","minLength":1,"maxLength":4},"deviceName":{"type":"string","maxLength":128,"description":"Device name set by the end user"},"deviceParentId":{"type":"string","description":"ID of parent device. Applies to wearable","minLength":1,"maxLength":64},"language":{"type":"string","description":"Language set on the device in ISO 639-3","minLength":1,"maxLength":3},"serialNumber":{"type":"string","minLength":1,"maxLength":64,"description":"Device serial number"},"timeZone":{"type":"string","description":"Device time zone abbreviation. Example: PST, GMT, etc...","minLength":1,"maxLength":32},"timeZoneSetting":{"type":"string","maxLength":32,"description":"Who has set the timezone.\nPossible values:\n- NETWORK_SET\n- CONSUMER_SET"},"simSerialNumber":{"type":"string","description":"Secure Element serial number","minLength":1,"maxLength":24},"IMEI":{"type":"string","minLength":1,"maxLength":32},"networkOperator":{"type":"string","description":"Network operator name.","maxLength":32},"networkType":{"type":"string","description":"Network type. Can be:\n- CELLULAR\n- WIFI","maxLength":16}},"required":["deviceId"]},"captureMethod":{"description":"Method used by the user or the issuer to capture card information to digitize.\n\nDescription:\n- CAMERA: when card information is captured by the on-device camera\n- MANUAL: when the consumer enters the card information manually, through the device keyboard\n- BANK_APP: when the card information is exchanged between the banking App and the Issuer App\n- ON-FILE: when the card information is retrieved by a merchant who has stored the card information\n- READER_MODE: when the card information is retrieved through a NFC interaction between the device and the physical card (applies to VISA and some domestic schemes)\n- TOKEN: when the card information is retrieved through a device-based token. This is applicable only to VISA token for token provisioning use case\n- CHIP_DIP: card information is captured by inserting (dip) the card into a terminal (only VISA)\n- UNKNOWN: the origin of the card information capture is not known ","type":"string","maxLength":64},"digitalCardState":{"type":"string","description":"The state of the digital card (token)\n\nN.B. Tokens in DELETED state are included only if the corresponding issuer onboarding flag (i.e. manageDeletedToken) is set.\n","enum":["ACTIVE","INACTIVE","DELETED","DEPLOYMENT_ONGOING","PENDING_ACTIVATION"],"title":"digitalCardState"},"tokenType":{"type":"string","maxLength":16,"description":"The type of the token. Following values are supported:\n- SE\n- HCE\n- COF\n- ECOM\n- QRC"}}}} ``` ## The issuerId object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"issuerId":{"maxLength":10,"minLength":10,"type":"string"}}}} ``` ## The cardId object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"cardId":{"type":"string","description":"Unique identifier of the card.","minLength":1,"maxLength":48,"pattern":"[A-Za-z0-9_-]{1,48}"}}}} ``` ## The consumerId object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"consumerId":{"type":"string","description":"Unique identifier of the end user. ","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9_-]{1,64}"}}}} ``` ## The accountId object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"accountId":{"type":"string","description":"Unique identifier of the account.","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9_-]{1,64}"}}}} ``` ## The cardProductId object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"cardProductId":{"type":"string","description":"Unique identifier of the type of card (defined during the onboarding of D1)","minLength":1,"maxLength":48,"pattern":"[A-Za-z0-9_-]{1,48}"}}}} ``` ## The threeDSsupport object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"threeDSsupport":{"type":"boolean","description":"Determines if the card supports EMV 3-D Secure (3DS) flows."}}}} ``` ## The cardScheme object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"cardScheme":{"type":"string","description":"The card scheme","enum":["VISA","MASTERCARD","PAGOBANCOMAT","AMEX"]}}}} ``` ## The cardLast4 object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"cardLast4":{"type":"string","pattern":"\\d{4}","description":"Last 4 digits of the PAN"}}}} ``` ## The cardExpiryDate object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"cardExpiryDate":{"type":"string","description":"Expiry date of the card in MMYY format","pattern":"(0[1-9]|1[0-2])\\d{2}"}}}} ``` ## The creationDate object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"creationDate":{"type":"string","title":"Creation date","description":"The time the ressource has been created.\nFormat ISO 8601 YYYY-MM-DDThh:mm:ssTZD","minLength":1,"maxLength":64}}}} ``` ## The lastUpdate object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"lastUpdate":{"type":"string","title":"Last update date","description":"The time the resource has been last updated.\nFormat ISO 8601 YYYY-MM-DDThh:mm:ssTZD","minLength":1,"maxLength":64}}}} ``` ## The digitalCardId object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"digitalCardId":{"type":"string","description":"Unique identifier of the digital card.","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9_-]{1,64}"}}}} ``` ## The digitalCardState object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"digitalCardState":{"type":"string","description":"The state of the digital card (token)\n\nN.B. Tokens in DELETED state are included only if the corresponding issuer onboarding flag (i.e. manageDeletedToken) is set.\n","enum":["ACTIVE","INACTIVE","DELETED","DEPLOYMENT_ONGOING","PENDING_ACTIVATION"],"title":"digitalCardState"}}}} ``` ## The walletRecommendation object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"walletRecommendation":{"type":"string","description":"Wallet/Digital Card Requestor colour recommended during the card tokenization request\n\nPlease note that in certain situations a recommendation might be not provided by the wallet.","enum":["NOT_APPLICABLE","GREEN","YELLOW","ORANGE","RED"]}}}} ``` ## The errorGeneric object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"errorGeneric":{"type":"object","description":"Generic error returned by the APIs.","properties":{"error":{"type":"string","description":"Description of the error.
This field is for troubleshooting purposes only, it can change at any time so MUST NOT be parsed, and is not supposed to be human readable so CANNOT be displayed to end users."}}}}}} ``` ## The reason object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"reason":{"type":"string","title":"reason","pattern":"^[a-zA-Z0-9 ]{1,64}$","description":"The reason why the action is performed.\n\nThis a free text field in case the Issuer wants to send details, that will be returned in the operations list."}}}} ``` ## The operationId object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"operationId":{"type":"string","description":"Unique identifier of the operation","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9_-]{1,64}"}}}} ``` ## The operationStatusSuccessful object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"operationStatusSuccessful":{"title":"operation","type":"object","description":"Operation result information.","properties":{"operationId":{"$ref":"#/components/schemas/operationId"},"status":{"type":"string","description":"Status of the operation","enum":["SUCCESSFUL"]}}},"operationId":{"type":"string","description":"Unique identifier of the operation","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9_-]{1,64}"}}}} ``` ## The errorWithOperationId object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"errorWithOperationId":{"type":"object","description":"Generic error and operationId returned by the APIs.","properties":{"error":{"type":"string","description":"Description of the error.
This field is for troubleshooting purposes only, it can change at any time so MUST NOT be parsed, and is not supposed to be human readable so CANNOT be displayed to end users."},"operationId":{"$ref":"#/components/schemas/operationId"},"status":{"type":"string","description":"Status of the operation","enum":["FAILED"]}}},"operationId":{"type":"string","description":"Unique identifier of the operation","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9_-]{1,64}"}}}} ``` ## The operationStatusFailed object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"operationStatusFailed":{"title":"operation","type":"object","description":"Operation result information.","properties":{"operationId":{"$ref":"#/components/schemas/operationId"},"status":{"type":"string","description":"Status of the operation","enum":["FAILED"]}}},"operationId":{"type":"string","description":"Unique identifier of the operation","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9_-]{1,64}"}}}} ``` ## The operationStartTime object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"operationStartTime":{"type":"string","title":"Operation Start Time","description":"The time the request has been processed.\nFormat ISO 8601 YYYY-MM-DDThh:mm:ssTZD","minLength":1,"maxLength":64}}}} ``` ## The operationEndTime object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"operationEndTime":{"type":"string","title":"Operation End Time","description":"The time the operation has been completed.\nFormat ISO 8601 YYYY-MM-DDThh:mm:ssTZD\nnote: This is an optional field and might not be returned for synchronous operations.","minLength":1,"maxLength":64}}}} ``` ## The walletApplicationId object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"walletApplicationId":{"type":"string","description":"Unique Indentifier of wallet application","maxLength":100}}}} ``` ## The eligibilityInformation object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"eligibilityInformation":{"type":"object","description":"Provides details about the eligibility check operation","properties":{"cardBIN":{"type":"string","minLength":6,"maxLength":6},"eligible":{"type":"boolean"},"cardProduct":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":256}}}},"required":["cardBIN","eligible"]}}}} ``` ## The captureMethodIncompatible-2 object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"captureMethodIncompatible-2":{"title":"captureMethodIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}}}}}} ``` ## The CVVNotProvided-2 object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"CVVNotProvided-2":{"title":"CVVNotProvided","type":"object","description":"If CVV has not been provided by the digital card requestor, then D1 verifies if this is incompatible with either the card capture method used or the digital card type requested.","properties":{"incompatibleWithCaptureMethod":{"$ref":"#/components/schemas/captureMethodIncompatible-2"},"incompatibleWithDigitalCardType":{"$ref":"#/components/schemas/digitalCardTypeIncompatible"}},"required":["incompatibleWithCaptureMethod","incompatibleWithDigitalCardType"]},"captureMethodIncompatible-2":{"title":"captureMethodIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}}},"digitalCardTypeIncompatible":{"title":"digitalCardTypeIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}},"description":"If the digital card type required is NOT one of the following:\n- COF (card on file)\n- ECOM (e-Commerce)\n\nthen the absence of CVV is unexpected, the result will be YES"}}}} ``` ## The decisionEngineVerifications-2 object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"decisionEngineVerifications-2":{"title":"decisionEngineVerifications","type":"object","properties":{"tooManyDigitizationRequests":{"$ref":"#/components/schemas/result"},"tooManyCVVVerificationFailed":{"$ref":"#/components/schemas/result"},"walletPhoneNumberNotMatchingConsumerPhoneNumber":{"$ref":"#/components/schemas/result"},"digitizationCountExceededOnSameFPAN":{"$ref":"#/components/schemas/result"},"digitizationCountExceededOnSameDevice":{"$ref":"#/components/schemas/result"},"cardIsExpired":{"$ref":"#/components/schemas/result"},"cardIsInvalid":{"$ref":"#/components/schemas/result"},"wrongCVV":{"$ref":"#/components/schemas/result"},"CVVNotProvided":{"$ref":"#/components/schemas/CVVNotProvided-2"}},"required":["tooManyDigitizationRequests","tooManyCVVVerificationFailed","walletPhoneNumberNotMatchingConsumerPhoneNumber","digitizationCountExceededOnSameFPAN","digitizationCountExceededOnSameDevice","cardIsExpired","cardIsInvalid","wrongCVV","CVVNotProvided"]},"result":{"title":"result","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}}},"CVVNotProvided-2":{"title":"CVVNotProvided","type":"object","description":"If CVV has not been provided by the digital card requestor, then D1 verifies if this is incompatible with either the card capture method used or the digital card type requested.","properties":{"incompatibleWithCaptureMethod":{"$ref":"#/components/schemas/captureMethodIncompatible-2"},"incompatibleWithDigitalCardType":{"$ref":"#/components/schemas/digitalCardTypeIncompatible"}},"required":["incompatibleWithCaptureMethod","incompatibleWithDigitalCardType"]},"captureMethodIncompatible-2":{"title":"captureMethodIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}}},"digitalCardTypeIncompatible":{"title":"digitalCardTypeIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}},"description":"If the digital card type required is NOT one of the following:\n- COF (card on file)\n- ECOM (e-Commerce)\n\nthen the absence of CVV is unexpected, the result will be YES"}}}} ``` ## The digitalCardRequestorAssessment-2 object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"digitalCardRequestorAssessment-2":{"title":"digitalCardRequestorAssessment","type":"object","required":["averageScore","deviceScore","recommendation"],"properties":{"averageScore":{"type":"string","description":"Average scoring from the digital card requestor. Following values are possible:\n\nNOT_APPLICABLE (score is based on data from digital card requestor. If the data is not available, average can't be computed).\n1\n2\n3\n4\n5"},"deviceScore":{"type":"string","description":"Following values are possible:\n\nNOT_APPLICABLE (score is based on data from digital card requestor. If the data is not available, score can't be provided).\n1\n2\n3\n4\n5"},"recommendation":{"$ref":"#/components/schemas/walletRecommendation"},"reasonCodesRecommendation":{"type":"string","description":"Reason codes, if any, from digital card requestor.\n\nOtherwise NOT_APPLICABLE","maxLength":64,"deprecated":true},"reasonCodesRecommendationDescription":{"type":"array","description":" This field shall allow to map the Wallet Reason Code Recommendation with a more user friendly description in line with the mapping table defined below:\n\t \n|reasonCode |In case of Yellow flow description| \n|-----------|----------------------------------| \n|01 |User Wallet Account ID too new relative to launch| \n|02 |User Wallet Account ID too new relative to provisioning request| \n|03 |User Wallet Account ID/Card Pair is newer than date threshold| \n|04 |Changes made to account data within date threshold| \n|05 |Suspicious transactions linked to this account.| \n|06 |The Account has not had activity in the last year.| \n|07 |Suspended cards in the secure element|\n|08 |The device was put in lost mode in the last 7 days for longer than the duration threshold| \n|09 |The number of provisioning attempts on this device in 72 hours exceeds the threshold| \n|0A |There have been more than the threshold number of different cards attempted at provisioning to this phone in 24 hours.| \n|0B |The card provisioning request contains a distinct name in excess of the permitted threshold| \n|0C |Device Score is less than 3| \n|0D |Account Score is less than 4| \n|0E |Device provisioning location outside of OEM marketplace store home country| \n|0F |Model rules not available at this time (in cases where back end systems time out).| \n|0G |Orange path flag: Device is considered at high risk for card provisioning | \n|0H |Phone Number Score is less than 3|\n|V1 |Cardholder name does not match the name registered in the wallet|\n|V2 |Wallet account device binding age is below threshold.This threshold is defined by the wallet. Please check with the wallet provider.|\n|VA |A recent account activity was detected. This threshold is defined by the wallet. Please check with the wallet provider.|\n|VC |Number of transactions in the last 12 months below a certain threshold: in the last 12 months a limited number of transactions have been performed. This threshold is defined by the wallet. Please check with the wallet provider. |","uniqueItems":true,"items":{"type":"object"}}}},"walletRecommendation":{"type":"string","description":"Wallet/Digital Card Requestor colour recommended during the card tokenization request\n\nPlease note that in certain situations a recommendation might be not provided by the wallet.","enum":["NOT_APPLICABLE","GREEN","YELLOW","ORANGE","RED"]}}}} ``` ## The idAndVMethods object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"idAndVMethods":{"type":"object","properties":{"supported":{"type":"array","description":"Any value described in the \"**selected**\" field","items":{"type":"string"}},"selected":{"type":"string","minLength":1,"maxLength":64,"description":"The following values are possible:\n- OTP_BY_SMS\n- OTP_BY_EMAIL\n- BANK_APP\n- CUSTOMER_SERVICE\n- 3DS"}}}}}} ``` ## The digitizationInformation object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"digitizationInformation":{"type":"object","description":"Provides details about the tokenization (digitization) operation whatever the result is (that is, successful, pending or cancelled)","title":"digitizationInformation","required":["digitizationChecks","digitizationResult"],"properties":{"digitizationChecks":{"type":"object","required":["issuerVerifications","decisionEngineVerifications","digitalCardRequestorAssessment"],"properties":{"issuerVerifications":{"$ref":"#/components/schemas/issuerVerifications"},"decisionEngineVerifications":{"$ref":"#/components/schemas/decisionEngineVerifications-2"},"digitalCardRequestorAssessment":{"$ref":"#/components/schemas/digitalCardRequestorAssessment-2"},"verificationCodes":{"type":"array","maxItems":100,"description":"D1 Verification codes generated by the decision engine during rule evaluation. Following values are possible:\n\t \n|value |description| \n|-----------|----------------------------------| \n|ADDRESS-MATCH|Full billing address match (Street Line 1 and ZIP Code and Country code)|\n|ADDRESS-NO_MATCH|Full billing address mismatch (Street Line 1 and ZIP Code and Country code)|\n|ADDRESS-PARTIAL_MATCH|Partial billing address mismatch (Street Line 1 or ZIP Code or Country code)|\n|ADDRESS_COUNTRYCODE-NO_MATCH|Country codes are available but do not match the comparison|\n|ADDRESS_LINE1-NO_MATCH|Address Street Line 1 information are available but do not match the comparison|\n|ADDRESS_LINE2-NO_MATCH|Address Street Line 2 information are available but do not match the comparison|\n|ADDRESS_ZIPCODE-NO_MATCH|ZIP codes are available but do not match the comparison|\n|ISS_LANGUAGE-INVALID|Cardholder device language provided by the issuer is not encoded as a valid language|\n|ISS_LANGUAGE-UNAVAILABLE|Cardholder device language not provided by the issuer|\n|ISS_LOCALIZATION-INVALID|Cardholder country code provided by the issuer is not encoded as a valid language|\n|ISS_LOCALIZATION-UNAVAILABLE|Cardholder country code not provided by the issuer|\n|ISS_PHONE_NUMBER-INVALID|Cardholder phone number provided by the issuer is not recognized as a valid number|\n|ISS_PHONE_NUMBER-UNAVAILABLE|Cardholder phone number not provided by the issuer|\n|ISS_ADDRESS-INVALID|Billing address provided by the Issuer is not valid and/or inaccurate|\n|ISS_ADDRESS-UNAVAILABLE|Billing address not provided by the issuer in GetConsumerInfo API response|\n|LANGUAGE-MATCH|Cardholder device language matches|\n|LANGUAGE-NO_MATCH|Cardholder device language does not match|\n|LOCALIZATION-MATCH|Cardholder localization obtained by resolving data provided in the tokenization request (device coordinates and/or IP Address) matches with customer residency address country code|\n|LOCALIZATION-NO_MATCH|Cardholder localization obtained by resolving data provided in the tokenization request (device coordinates and/or IP Address) do not match with customer residency address country code|\n|LOCALIZATION-PARTIAL_MATCH|One of the country codes obtained by resolving IP address & device location coordinates do not match with customer residency address country code|\n|NAME-MATCH|Cardholder name matches|\n|NAME-NO_MATCH|Cardholder name does not match|\n|NAME-PARTIAL_MATCH|Cardholder name only partially matches|\n|PHONE_NUMBER-MATCH|Cardholder phone number matches|\n|PHONE_NUMBER-NO_MATCH|Cardholder phone number does not match|\n|PHONE_NUMBER-PARTIAL_MATCH|Cardholder phone number suffix matches|\n|TR_ACCOUNT_SCORE-UNAVAILABLE|Account scoring not provided in tokenization request|\n|TR_ADDRESS-INVALID|Billing address provided by the token requester is not valid and/or inaccurate|\n|TR_ADDRESS-UNAVAILABLE|Billing address not provided by the token requester in the tokenization request or one of those fields is missing: Street Line 1 or ZIP Code or Country code|\n|TR_DEVICE_SCORE-UNAVAILABLE|Device scoring not provided in tokenization request|\n|TR_IPADDRESS-UNAVAILABLE|Cardholder device IP Address not provided in the tokenization request|\n|TR_IPADDRESS-INVALID|Cardholder device IP Address provided in the tokenization request cannot be correctly resolved into a country code\n|TR_LANGUAGE-UNAVAILABLE|Cardholder device language not provided in the tokenization request|\n|TR_LANGUAGE-INVALID|Cardholder device language provided in the tokenization request is not encoded as a valid language|\n|TR_LOCALIZATION-UNAVAILABLE|Cardholder device location coordinates not provided in the tokenization request|\n|TR_LOCALIZATION-INVALID|Cardholder device location coordinates provided in the tokenization request cannot be correctly resolved into a valid country|\n|TR_NAME-UNAVAILABLE|Cardholder name not provided in tokenization request|\n|TR_PHONE_NUMBER-UNAVAILABLE|Cardholder phone number not provided in the tokenization request|\n|TR_PHONE_NUMBER-INVALID|Cardholder phone number provided in the tokenization request is not recognized as a valid number|\n|TR_RECOMMENDATION-UNAVAILABLE|Wallet recommendation not provided in tokenization request|","items":{"type":"string"}},"matchedRule":{"type":"object","description":"Decision Engine rule triggerig the final decision.\r\n\r\nApplicable only to Decision Engine Version V2","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the matching rule."},"name":{"type":"string","description":"Name of the matching rule."},"scenario":{"type":"object","description":"The actual matching scenario ","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the matched scenario."},"name":{"type":"string","description":"Name of the matched scenario."}}}}}}},"digitizationResult":{"type":"object","required":["flow"],"properties":{"flow":{"type":"string","description":"Tokenization Decision Engine assessment result.\nFollowing values are possible:\n- RED (DECLINE)\n- GREEN (APPROVE)\n- YELLOW (STEP-UP)","minLength":1,"maxLength":64,"enum":["RED","YELLOW","GREEN"]},"score":{"type":"string","minLength":1,"maxLength":1,"pattern":"[1-5]{1,1}$","description":"This is the final score the decision engine has computed considering all the verifications and the scoring from the requestor and/or TSP.\nScore goes from 1 (low trust) to 5 (high trust)."},"idAndVMethods":{"$ref":"#/components/schemas/idAndVMethods"},"digitizationDecisionTimestamp":{"type":"string","minLength":1,"maxLength":64,"description":"The time when the digitization decision has been sent to the TSP.\nThis parameter can be used by the Issuer to manage the notifications to cardholder in case of PENDING status of digitize operation.\nFormat ISO 8601 YYYY-MM-DDThh:mm:ssTZD\n"}}}}},"issuerVerifications":{"title":"issuerVerifications","type":"object","properties":{"cardIsExpired":{"$ref":"#/components/schemas/result"},"cardIsLostOrStolen":{"$ref":"#/components/schemas/result"},"wrongCVV":{"$ref":"#/components/schemas/result"},"fraudSuspect":{"$ref":"#/components/schemas/result"},"cardIsInvalid":{"$ref":"#/components/schemas/result"}},"required":["cardIsExpired","cardIsLostOrStolen","wrongCVV","fraudSuspect","cardIsInvalid"]},"result":{"title":"result","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}}},"decisionEngineVerifications-2":{"title":"decisionEngineVerifications","type":"object","properties":{"tooManyDigitizationRequests":{"$ref":"#/components/schemas/result"},"tooManyCVVVerificationFailed":{"$ref":"#/components/schemas/result"},"walletPhoneNumberNotMatchingConsumerPhoneNumber":{"$ref":"#/components/schemas/result"},"digitizationCountExceededOnSameFPAN":{"$ref":"#/components/schemas/result"},"digitizationCountExceededOnSameDevice":{"$ref":"#/components/schemas/result"},"cardIsExpired":{"$ref":"#/components/schemas/result"},"cardIsInvalid":{"$ref":"#/components/schemas/result"},"wrongCVV":{"$ref":"#/components/schemas/result"},"CVVNotProvided":{"$ref":"#/components/schemas/CVVNotProvided-2"}},"required":["tooManyDigitizationRequests","tooManyCVVVerificationFailed","walletPhoneNumberNotMatchingConsumerPhoneNumber","digitizationCountExceededOnSameFPAN","digitizationCountExceededOnSameDevice","cardIsExpired","cardIsInvalid","wrongCVV","CVVNotProvided"]},"CVVNotProvided-2":{"title":"CVVNotProvided","type":"object","description":"If CVV has not been provided by the digital card requestor, then D1 verifies if this is incompatible with either the card capture method used or the digital card type requested.","properties":{"incompatibleWithCaptureMethod":{"$ref":"#/components/schemas/captureMethodIncompatible-2"},"incompatibleWithDigitalCardType":{"$ref":"#/components/schemas/digitalCardTypeIncompatible"}},"required":["incompatibleWithCaptureMethod","incompatibleWithDigitalCardType"]},"captureMethodIncompatible-2":{"title":"captureMethodIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}}},"digitalCardTypeIncompatible":{"title":"digitalCardTypeIncompatible","type":"object","properties":{"result":{"type":"string","enum":["YES","NO","NOT_APPLICABLE"]}},"description":"If the digital card type required is NOT one of the following:\n- COF (card on file)\n- ECOM (e-Commerce)\n\nthen the absence of CVV is unexpected, the result will be YES"},"digitalCardRequestorAssessment-2":{"title":"digitalCardRequestorAssessment","type":"object","required":["averageScore","deviceScore","recommendation"],"properties":{"averageScore":{"type":"string","description":"Average scoring from the digital card requestor. Following values are possible:\n\nNOT_APPLICABLE (score is based on data from digital card requestor. If the data is not available, average can't be computed).\n1\n2\n3\n4\n5"},"deviceScore":{"type":"string","description":"Following values are possible:\n\nNOT_APPLICABLE (score is based on data from digital card requestor. If the data is not available, score can't be provided).\n1\n2\n3\n4\n5"},"recommendation":{"$ref":"#/components/schemas/walletRecommendation"},"reasonCodesRecommendation":{"type":"string","description":"Reason codes, if any, from digital card requestor.\n\nOtherwise NOT_APPLICABLE","maxLength":64,"deprecated":true},"reasonCodesRecommendationDescription":{"type":"array","description":" This field shall allow to map the Wallet Reason Code Recommendation with a more user friendly description in line with the mapping table defined below:\n\t \n|reasonCode |In case of Yellow flow description| \n|-----------|----------------------------------| \n|01 |User Wallet Account ID too new relative to launch| \n|02 |User Wallet Account ID too new relative to provisioning request| \n|03 |User Wallet Account ID/Card Pair is newer than date threshold| \n|04 |Changes made to account data within date threshold| \n|05 |Suspicious transactions linked to this account.| \n|06 |The Account has not had activity in the last year.| \n|07 |Suspended cards in the secure element|\n|08 |The device was put in lost mode in the last 7 days for longer than the duration threshold| \n|09 |The number of provisioning attempts on this device in 72 hours exceeds the threshold| \n|0A |There have been more than the threshold number of different cards attempted at provisioning to this phone in 24 hours.| \n|0B |The card provisioning request contains a distinct name in excess of the permitted threshold| \n|0C |Device Score is less than 3| \n|0D |Account Score is less than 4| \n|0E |Device provisioning location outside of OEM marketplace store home country| \n|0F |Model rules not available at this time (in cases where back end systems time out).| \n|0G |Orange path flag: Device is considered at high risk for card provisioning | \n|0H |Phone Number Score is less than 3|\n|V1 |Cardholder name does not match the name registered in the wallet|\n|V2 |Wallet account device binding age is below threshold.This threshold is defined by the wallet. Please check with the wallet provider.|\n|VA |A recent account activity was detected. This threshold is defined by the wallet. Please check with the wallet provider.|\n|VC |Number of transactions in the last 12 months below a certain threshold: in the last 12 months a limited number of transactions have been performed. This threshold is defined by the wallet. Please check with the wallet provider. |","uniqueItems":true,"items":{"type":"object"}}}},"walletRecommendation":{"type":"string","description":"Wallet/Digital Card Requestor colour recommended during the card tokenization request\n\nPlease note that in certain situations a recommendation might be not provided by the wallet.","enum":["NOT_APPLICABLE","GREEN","YELLOW","ORANGE","RED"]},"idAndVMethods":{"type":"object","properties":{"supported":{"type":"array","description":"Any value described in the \"**selected**\" field","items":{"type":"string"}},"selected":{"type":"string","minLength":1,"maxLength":64,"description":"The following values are possible:\n- OTP_BY_SMS\n- OTP_BY_EMAIL\n- BANK_APP\n- CUSTOMER_SERVICE\n- 3DS"}}}}}} ``` ## The newErrorGeneric object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"newErrorGeneric":{"type":"object","description":"Error object with errorCode & error message.","properties":{"errorCode":{"type":"string","description":"The type of the error"},"error":{"type":"string","description":"Provide more error details if possible.
For example name of the field with invalid format.
This field is for troubleshooting purposes only, it can change at any time so MUST NOT be parsed, and is not supposed to be human readable so CANNOT be displayed to end users."}}}}}} ``` ## The deviceInformation object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"deviceInformation":{"title":"deviceInformation","type":"object","description":"Provides details about the device that has been used for the card tokenization.\nNote that this data is available only if the check eligbility has passed with success.\nData availability dependes on the requestor.","properties":{"deviceId":{"type":"string","minLength":1,"maxLength":128,"description":"Identifier of the token storage."},"digitalCardStorageType":{"type":"string","maxLength":32,"description":"Type of the token storage location. Following values are possible:\n- HCE\n- SPAY_PHONE\n- SPAY_TABLET\n- SPAY_WATCH\n- SPAY_TV\n- IPHONE\n- IWATCH\n- IPAD\n- MAC_BOOK\n- ANDROID_PHONE\n- ANDROID_TABLET\n- ANDROID_WATCH\n- MOBILE_PHONE\n- TABLET\n- WATCH\n- MOBILE_PHONE_OR_TABLET\n- BRACELET\n- PC\n- HOUSEHOLD\n- WEARABLE\n- AUTOMOBILE\n- UNKNOWN"},"manufacturer":{"type":"string","minLength":1,"maxLength":32,"description":"Device manufacturer name"},"brand":{"type":"string","minLength":1,"maxLength":32,"description":"Device brand"},"model":{"type":"string","minLength":1,"maxLength":32,"description":"Device model"},"osVersion":{"type":"string","minLength":1,"maxLength":16,"description":"Device OS version"},"firmwareVersion":{"type":"string","description":"Device firmware version","minLength":1,"maxLength":32},"phoneNumber":{"type":"string","description":"Device phone number","minLength":1,"maxLength":20},"fourLastDigitPhoneNumber":{"type":"string","minLength":1,"maxLength":4},"deviceName":{"type":"string","maxLength":128,"description":"Device name set by the end user"},"deviceParentId":{"type":"string","description":"ID of parent device. Applies to wearable","minLength":1,"maxLength":64},"language":{"type":"string","description":"Language set on the device in ISO 639-3","minLength":1,"maxLength":3},"serialNumber":{"type":"string","minLength":1,"maxLength":64,"description":"Device serial number"},"timeZone":{"type":"string","description":"Device time zone abbreviation. Example: PST, GMT, etc...","minLength":1,"maxLength":32},"timeZoneSetting":{"type":"string","maxLength":32,"description":"Who has set the timezone.\nPossible values:\n- NETWORK_SET\n- CONSUMER_SET"},"simSerialNumber":{"type":"string","description":"Secure Element serial number","minLength":1,"maxLength":24},"IMEI":{"type":"string","minLength":1,"maxLength":32},"networkOperator":{"type":"string","description":"Network operator name.","maxLength":32},"networkType":{"type":"string","description":"Network type. Can be:\n- CELLULAR\n- WIFI","maxLength":16}},"required":["deviceId"]}}}} ``` ## The captureMethod object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"captureMethod":{"description":"Method used by the user or the issuer to capture card information to digitize.\n\nDescription:\n- CAMERA: when card information is captured by the on-device camera\n- MANUAL: when the consumer enters the card information manually, through the device keyboard\n- BANK_APP: when the card information is exchanged between the banking App and the Issuer App\n- ON-FILE: when the card information is retrieved by a merchant who has stored the card information\n- READER_MODE: when the card information is retrieved through a NFC interaction between the device and the physical card (applies to VISA and some domestic schemes)\n- TOKEN: when the card information is retrieved through a device-based token. This is applicable only to VISA token for token provisioning use case\n- CHIP_DIP: card information is captured by inserting (dip) the card into a terminal (only VISA)\n- UNKNOWN: the origin of the card information capture is not known ","type":"string","maxLength":64}}}} ``` ## The tokenType object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"tokenType":{"type":"string","maxLength":16,"description":"The type of the token. Following values are supported:\n- SE\n- HCE\n- COF\n- ECOM\n- QRC"}}}} ``` ## The operationStatusSuccessfulFailed object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"operationStatusSuccessfulFailed":{"type":"string","description":"Status of the operation","enum":["SUCCESSFUL","FAILED"]}}}} ``` ## The appInstanceId object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"appInstanceId":{"description":"Unique identifier of the issuer application instance.","type":"string"}}}} ``` ## The authnType object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"authnType":{"type":"string","enum":["BIOMETRIC","PLATFORM"]}}}} ``` ## The operationError object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"operationError":{"type":"string","description":"Human readable string representing the error, only present in case of operation failure"}}}} ``` ## The 3dsCardOperation object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"3dsCardOperation":{"title":"3-D Secure Operation","type":"object","description":"Details about a 3-D Secure operation.","required":["operationId","operation","status","startTime"],"properties":{"operationId":{"$ref":"#/components/schemas/operationId"},"operation":{"type":"string","description":"The operation type.","enum":["3DS_FRICTIONLESS","3DS_CHALLENGE_OOB","3DS_CHALLENGE_OOB_ISSUER","3DS_CHALLENGE_OTP_SMS"]},"status":{"$ref":"#/components/schemas/operationStatusSuccessfulFailed"},"startTime":{"$ref":"#/components/schemas/operationStartTime"},"consumerId":{"$ref":"#/components/schemas/consumerId"},"details":{"oneOf":[{"title":"3DS_FRICTIONLESS, 3DS_CHALLENGE_OOB, 3DS_CHALLENGE_OTP_SMS operations","properties":{"acsTransactionId":{"description":"The ACS transaction identifier.","type":"string"},"threeDSServerTransId":{"description":"The authentication session identifier from the 3DS server.","type":"string"},"dsTransId":{"description":"The authentication session identifier from the directory server.","type":"string"},"purchase":{"type":"object","properties":{"merchantName":{"description":"The merchant name.","type":"string"},"merchantType":{"description":"The merchant category code.","type":"string","minLength":4,"maxLength":4},"amount":{"description":"The nominal transaction amount value. Value without the decimal operator. Use the currency exponent to display amount with decimal. For example, an display amount of 789.99€ Euro is sent as 78999.","type":"string"},"currencyCode":{"description":"The transaction currency code. Currency code in ISO 4217 alpha code format.","type":"string","minLength":3,"maxLength":3},"merchantId":{"description":"The acquirer merchantId.","type":"string"},"countryCode":{"description":"The merchant country code.","type":"string","minLength":2,"maxLength":2},"merchantUrl":{"description":"The merchant URL.","type":"string","format":"uri"}}},"acquirer":{"type":"object","properties":{"bin":{"type":"string","maxLength":16},"countryCode":{"description":"The merchant country code.","type":"string","minLength":2,"maxLength":2}}},"device":{"type":"object","properties":{"deviceChannel":{"description":"The device channel. '01' is App-based, '02' is Browser, '03' is 3DS Requestor Initiated.","enum":["01","02","03"],"type":"string"},"appInstanceId":{"$ref":"#/components/schemas/appInstanceId"},"authnType":{"$ref":"#/components/schemas/authnType"}}},"eci":{"description":"The Electronic Commerce Indicator.","type":"string"},"authenticationMethod":{"description":"The Authentication method used in case of challenge flow. '02' is SMS OTP, '07' is OOB Biometrics, '09' is OOB Other.'","type":"string","enum":["02","07","09"]},"transStatus":{"description":"Indicates whether a transaction qualifies as an authenticated transaction or account verification.\r\n\r\n|Operation Status|TransStatus Possible Values|TransStatus Description|\r\n|----|----|----|\r\n|SUCCESSFUL|Y|Authentication/account verification is successful|\r\n|FAILED|N|Not authenticated/account not verified; transaction denied|\r\n|FAILED|U|Authentication/account verification could not be performed; technical or other problem|\r\n|FAILED|R|Authentication/account verification rejected|\r\n","type":"string","enum":["Y","N","U","R"]},"transStatusReason":{"description":"Provides information on why the Transaction Status field has the specified value.","type":"string","minLength":2,"maxLength":2},"rba":{"type":"object","properties":{"evaluatedRule":{"type":"array","items":{}},"selectedRule":{"type":"array","items":{}},"appliedExemption":{"type":"array","items":{}}}},"protocolVersion":{"type":"string","description":"Version of the 3DS protocol used for the transaction."}}}],"type":"object"},"error":{"$ref":"#/components/schemas/operationError"}}},"operationId":{"type":"string","description":"Unique identifier of the operation","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9_-]{1,64}"},"operationStatusSuccessfulFailed":{"type":"string","description":"Status of the operation","enum":["SUCCESSFUL","FAILED"]},"operationStartTime":{"type":"string","title":"Operation Start Time","description":"The time the request has been processed.\nFormat ISO 8601 YYYY-MM-DDThh:mm:ssTZD","minLength":1,"maxLength":64},"consumerId":{"type":"string","description":"Unique identifier of the end user. ","minLength":1,"maxLength":64,"pattern":"[A-Za-z0-9_-]{1,64}"},"appInstanceId":{"description":"Unique identifier of the issuer application instance.","type":"string"},"authnType":{"type":"string","enum":["BIOMETRIC","PLATFORM"]},"operationError":{"type":"string","description":"Human readable string representing the error, only present in case of operation failure"}}}} ``` ## The scheme object ```json {"openapi":"3.0.0","info":{"title":"Inbound Card API","version":"1.0"},"components":{"schemas":{"scheme":{"description":"The card scheme","enum":["MASTERCARD","VISA","PAGOBANCOMAT"],"type":"string"}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.payments.thalescloud.io/d1-v1-api/es/referencias-de-la-api-d1-v1/operaciones-de-tarjeta/entrante/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.