SoFi Tech Solutions Risk API 1.0

{"openapi":"3.1.0","info":{"title":"Risk API 1.0","version":"1.0"},"paths":{"/prp/1.0/getCardTransactionFraud":{"post":{"parameters":[],"responses":{"default":{"content":{"application/json":{"schema":{"properties":{"status_code":{"description":"The response status code. May return a string for some statuses.","title":"Status Code","type":"integer"},"status":{"description":"The condition of a process or response","title":"Status","type":"string"},"errors":{"description":"A list of errors generated while the request was processed","items":{"type":"string"},"title":"Errors","type":"array"},"rtoken":{"description":"A system-generated ID used for tracking","nullable":true,"title":"Rtoken","type":"string"},"processing_time":{"default":0,"description":"The time elapsed in processing the request","nullable":true,"title":"Processing Time","type":"number"},"echo":{"default":{},"description":"A structure that contains transaction ID information","nullable":true,"properties":{"transaction_id":{"description":"An ID that represents an API transaction","title":"Transaction Id","type":"string"},"provider_timestamp":{"description":"Store a related timestamp for reporting and troubleshooting purposes","format":"date-time","title":"Provider Timestamp","type":"string"},"provider_transaction_id":{"description":"Secondary transaction identifier (generated by a provider)","title":"Provider Transaction Id","type":"string"}},"title":"Echo","type":"object"},"system_timestamp":{"description":"A system generated timestamp","format":"date-time","nullable":true,"title":"System Timestamp","type":"string"},"response_data":{"description":"A structure for the response data. It can be empty but usually will contain information.","properties":{"person_uuid":{"description":"System-generated UUID of the account holder associated with the transaction event","title":"Person Uuid","type":"string"},"success_msg":{"description":"Details about the transaction event","properties":{"subtenant_data":{"description":"Consists of multiple components provide details on PRP's performance and your fraud policy:\n- `features`&mdash; Contains data for specific features that you choose to return as a record of specific transaction metrics, utilized in your fraud rule policy and to measure your cardholder behavior. For each feature returned, you receive the feature name in `feature_name`, the feature value in `feature_value`, and data type in `feature_type`.\n- `rule_execution`&mdash; Contains all rules triggered within your fraud policy and the associated data that is configured in PRP for that rule. Includes `rule_id`, `rule_name`, `rule_action`, and other helpful information.\n- `supplementary_action`&mdash; Contains data on additional actions, excluding the primary action of running fraud rules. For example, sending the transaction to the review queue (`action = REVIEW QUEUE`).\n\n","nullable":true,"title":"Subtenant Data","type":"object"},"event_id":{"description":"Unique identifier of the transaction event","nullable":true,"title":"Event Id","type":"string"},"galileo_data":{"description":"A structure that contains transaction information from PRP","properties":{"reject":{"description":"Whether a transaction is recommended to be rejected by PRP. Returns `true` if rejected.","title":"Reject","type":"boolean"},"freeze":{"description":"Whether the account was frozen. Returns `true` if frozen.","title":"Freeze","type":"boolean"},"notes":{"description":"Notes provided associated with the fraud rules of a transaction event","items":{"type":"string"},"title":"Notes","type":"array"},"rules_denied":{"description":"Specifies fraud rules concerning the transaction event that triggered a denied message","items":{"type":"string"},"title":"Rules Denied","type":"array"},"rules_warned":{"description":"Specifies fraud rules concerning the transaction event that triggered a denied message","items":{"type":"string"},"title":"Rules Warned","type":"array"},"actions":{"description":"List of PRP specific data","items":{"properties":{"fn_name":{"description":"Name of the rule from PRP","title":"Fn Name","type":"string"},"fn_result":{"description":"Result of the results of the rule from PRP","title":"Fn Result","type":"string"},"fn_note":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of risky acitivity associated with the rule trigger from PRP","title":"Fn Note"},"freeze":{"description":"Whether the fraud rule that was triggered contains a freeze flag. Returns `true` if the freeze flag is triggered.","title":"Freeze","type":"boolean"}},"required":["fn_name","fn_result","freeze"],"title":"ActionMsg","type":"object"},"title":"Actions","type":"array"}},"required":["reject","freeze"],"title":"SuccessFraudDetectionMessage","type":"object"}},"required":["galileo_data"],"title":"DebitFraudExternalSuccessReply","type":"object"},"card_uuid":{"description":"System-generated UUID that identifies the card of the account holder","nullable":true,"title":"Card Uuid","type":"string"},"account_uuid":{"description":"System-generated UUID that identifies the account of the account holder","nullable":true,"title":"Account Uuid","type":"string"}},"required":["person_uuid","success_msg"],"title":"ResponseData","type":"object"}},"required":["status_code","status"],"title":"DebitFraudExternalReply","type":"object"},"examples":{"response":{"value":"{\n  \"status_code\": 0,\n  \"status\": \"Success\",\n  \"processing_time\": 0.310,\n  \"response_data\": {\n    \"person_uuid\": \"ba91fc99e158505ddff930217c7828be6658aee1d3925a05d8dbe00ed80023d4\",\n    \"success_msg\": {\n      \"galileo_data\": {\n        \"reject\": false,\n        \"freeze\": false,\n        \"notes\": [\n          \"Rule GalileoGlobalTenantRule triggered warning on card ending in 3459.\"\n        ],\n        \"rules_denied\": [],\n        \"rules_warned\": [\"GalileoGlobalTenantRule:WARN\"],\n        \"actions\": [\n          {\n            \"fn_name\": \"GalileoGlobalTenantRule\",\n            \"fn_result\": \"WARN_NOTE\",\n            \"fn_note\": \"Rule GalileoGlobalTenantRule triggered warning on card ending None.\",\n            \"freeze\": false\n          }\n        ]\n      },\n      \"subtenant_data\": {\n        \"features\": [\n          {\n            \"feature_type\": \"string\",\n            \"feature_name\": \"galileo_client_name\",\n            \"feature_value\": \"\"\n          }\n        ],\n        \"supplementary_actions\": [\n          { \"action_data\": \"CloseTest\", \"action\": \"CLOSE_CASE\" },\n          {\n            \"action_data\": \"Transaction_Fraud_Rule\",\n            \"action\": \"REVIEW QUEUE\"\n          },\n          { \"action_data\": \"CloseTest\", \"action\": \"CLOSE_CASE\" },\n          {\n            \"action_data\": \"Transaction_Fraud_Rule\",\n            \"action\": \"REVIEW QUEUE\"\n          }\n        ],\n        \"rule_execution\": [\n          {\n            \"rule_id\": 71.0,\n            \"rule_score\": null,\n            \"rule_name\": \"RiskLevel1Trigger\",\n            \"RULE_ACTION\": \"DENY\",\n            \"rule_decision\": \"RULE_ACTION\",\n            \"rule_supp_actions\": [\n              { \"action_data\": \"CloseTest\", \"action\": \"CLOSE_CASE\" },\n              {\n                \"action_data\": \"Transaction_Fraud_Rule\",\n                \"action\": \"REVIEW QUEUE\"\n              }\n            ]\n          },\n          {\n            \"rule_id\": 75.0,\n            \"rule_score\": null,\n            \"rule_name\": \"RiskLevel2Trigger\",\n            \"RULE_ACTION\": \"DENY_FREEZE\",\n            \"rule_decision\": \"RULE_ACTION\",\n            \"rule_supp_actions\": [\n              { \"action_data\": \"CloseTest\", \"action\": \"CLOSE_CASE\" },\n              {\n                \"action_data\": \"Transaction_Fraud_Rule\",\n                \"action\": \"REVIEW QUEUE\"\n              }\n            ]\n          }\n        ],\n        \"autoDecision\": \"RULE_ACTION\"\n      },\n      \"event_id\": \"4e183695-9a1e-4382-b252-2c3bf53ffabc\"\n    },\n    \"card_uuid\": \"11009f23344bb9cc5607af3b6cc8xxcfyngq6f06154ea3dbd6ffac07e05bfdfa\",\n    \"account_uuid\": \"1ab1ffdb959a9be7ffeb022f864e48ba0ed6fafca971c57c2208f3df0kq234g7\"\n  },\n  \"echo\": {\n    \"provider_transaction_id\": \"\",\n    \"provider_timestamp\": null,\n    \"transaction_id\": \"aa-0603\"\n  },\n  \"system_timestamp\": \"2024-06-04 08:57:42\",\n  \"rtoken\": \"64dbe77b-993a-4c07-a03a-4a3e761020bf\",\n  \"errors\": []\n}"}}}},"description":""}},"description":"Use the Get Card Transaction Fraud endpoint to evaluate the risk associated with specific card transactions and understand if a transaction is fraudulent, then take appropriate action based on predefined criteria. This endpoint provides detailed fraud detection insights, including rules triggered, actions taken, and supplementary fraud prevention decisions. \n\n\nSee <a href=\"doc:about-payment-risk-platform\" target=\"_blank\">About the Payment Risk Platform</a> for more details.","summary":"Get Card Transaction Fraud","tags":["Risk"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"apiLogin":{"description":"Web service username, as provided by SoFi Tech Solutions.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","examples":["\"AbC123-9999\""],"title":"Apilogin","type":"string"},"apiTransKey":{"description":"Web service password, as provided by SoFi Tech Solutions.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","examples":["\"4sb62fh6w4h7w34g\""],"title":"Apitranskey","type":"string"},"providerId":{"description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10-digit numeric string\nExample: `\"9999\"`","examples":["\"9999\""],"title":"Providerid","type":"string"},"transactionId":{"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\"). A UUID is preferred.\nPattern: Max 60 characters\nExample: `\"9845dk-39fdk3fj3-4483483478\"`","examples":["\"9845dk-39fdk3fj3-4483483478\""],"title":"Transactionid","type":"string"},"riskServiceId":{"description":"Unique identifier provided by SoFi Tech Solutions during implementation to obtain client PRP configuration details.\nPattern: Up to 50 characters\nExample: `\"EPRP-test-1231231:1\"`","examples":["\"EPRP-test-1231231:1\""],"title":"Riskserviceid","type":"string"},"eventType":{"description":"Specifies the type of the transaction event.\nPattern: `Debit`\nExample: `\"Debit\"`","examples":["\"Debit\""],"const":"debit","enum":["debit"],"title":"EventType","type":"string"},"eventTs":{"description":"Timestamp for when the transaction event occurred in <a href=\"ref:system-time\" target=\"_blank\">our system time</a>. May be the same timestamp as `authTs`.\nPattern: YYYY-MM-DD hh:mm:ss\nExample: `\"2020-10-28 00:00:24\"`","examples":["\"2020-10-28 00:00:24\""],"format":"date-time","title":"Eventts","type":"string"},"personId":{"description":"Unique identifier of the account holder/customer associated with the event.\nPattern: Up to 20 characters\nExample: `\"p54789641\"`","examples":["\"p54789641\""],"title":"Personid","type":"string"},"accountId":{"description":"Unique identifier of your customer account with which the related event is associated.\nPattern: Up to 20 characters\nExample: `\"a125483\"`","examples":["\"a125483\""],"title":"Accountid","type":"string"},"cardId":{"description":"An identifier of the card with which the related event is associated.\nPattern: Up to 20 characters\nExample: `\"card_123\"`","examples":["\"card_123\""],"title":"Cardid","type":"string"},"authId":{"description":"Internal card authorization identifier associated with card transaction event.\nPattern: Up to 4 characters\nExample: `\"8989\"`","examples":["\"8989\""],"title":"Authid","type":"string"},"authTs":{"description":"Authorization timestamp. Can specify any timezone.\nPattern: YYYY-MM-DD hh:mm:ss\nExample: `\"2024-01-23T04:56:07.000+00:00\"`","examples":["\"2024-01-23T04:56:07.000+00:00\""],"format":"date-time","title":"Authts","type":"string"},"acctOpenToBuy":{"description":"The cardholder's available funds, also known as open to buy. Amount is checked during authorization validation to confirm the cardholder has sufficient funds to perform a transaction.\nPattern: Integer or decimal amount\nExample: `'200.00'`","examples":["'200.00'"],"title":"Acctopentobuy","type":"number"},"acctCity":{"description":"Cardholder’s city.\nPattern: Up to 30 characters: letters, spaces, hyphen and period\nExample: `\"Salt Lake City\"`","examples":["\"Salt Lake City\""],"title":"Acctcity","type":"string"},"acctState":{"description":"Cardholder’s state or province for non-U.S. countries.\nPattern: Up to 60 characters\nExample: `\"Washington\"`","examples":["\"Washington\""],"title":"Acctstate","type":"string"},"acctZip":{"description":"Cardholder’s postal code: U.S. ZIP code or local postal code.\nPattern: 5–20 characters\nExample: `\"98101\"`","examples":["\"98101\""],"title":"Acctzip","type":"string"},"acctCountry":{"description":"Cardholder’s two-digit country code. See the IBAN Alpha-2 codes for details.\nPattern: Up to 2 characters\nExample: `\"US\"`","examples":["\"US\""],"title":"Acctcountry","type":"string"},"acctStartDate":{"description":"Start date-time for the account was marked ready to use (e.g. account open or account funded date).\nPattern: YYYY-MM-DD hh:mm:ss\nExample: `\"2020-10-12T10:45:21.000+00:00\"`","examples":["\"2020-10-12T10:45:21.000+00:00\""],"format":"date-time","title":"Acctstartdate","type":"string"},"cardActivateDate":{"description":"Date-time for when the card was activated.\nPattern: YYYY-MM-DD hh:mm:ss\nExample: `\"2020-10-10T08:12:35.000+00:00\"`","examples":["\"2020-10-10T08:12:35.000+00:00\""],"format":"date-time","title":"Cardactivatedate","type":"string"},"cardStatus":{"description":"Status for the card.\nPattern: Up to 10 characters\nExample: `\"Active\"`","examples":["\"Active\""],"title":"Cardstatus","type":"string"},"cardCredLim":{"description":"Credit limit of the cardholder’s account as whole or decimal amount.\nPattern: Integer or decimal number\nExample: `'1000'`","examples":["'1000'"],"title":"Cardcredlim","type":"number"},"merchantAssertsAuthenticationAttempted":{"description":"Specifies whether the merchant/acquirer attempted to authenticate the buyer using 3-D Secure. `True` if attempted, `False` if the merchant/acquirer did not attempt.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Merchantassertsauthenticationattempted","type":"boolean"},"transactionCity":{"description":"Merchant's city.\nPattern: Up to 60 characters\nExample: `Seattle`","examples":["Seattle"],"title":"Transactioncity","type":"string"},"transactionZip":{"description":"Postal code (US zip code or local postal code) where the transaction or event was performed.\nPattern: 5–20 characters\nExample: `\"98102\"`","examples":["\"98102\""],"title":"Transactionzip","type":"string"},"isCardNotPresent":{"description":"Whether a card was present during a transaction or event. `True` is card-not-present; `False` is card-present.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Iscardnotpresent","type":"boolean"},"isCardholderNotPresent":{"description":"Whether a card was present during a transaction or event. `True` is card-not-present; `False` is card-present.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Iscardholdernotpresent","type":"boolean"},"isDomestic":{"description":"Whether this is a domestic transaction. `True` is a domestic transaction; `False` for an international transaction. Definition of domestic at the discretion of the client.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Isdomestic","type":"boolean"},"merchantDesc":{"description":"Card acceptor name/location. See Data element 43 of the ISO message.\nPattern: Up to 50 characters\nExample: `\"ROSS\"`","examples":["\"ROSS\""],"title":"Merchantdesc","type":"string"},"merchantId":{"description":"Card acceptor identification code. See Data element 42 of the ISO message.\nPattern: Up to 15 characters\nExample: `\"Ross_1234\"`","examples":["\"Ross_1234\""],"title":"Merchantid","type":"string"},"networkName":{"description":"The card network. Acceptable values are: Visa, Mastercard, Discover, American Express, JCB, UnionPay, Accel, Star, Allpoint.\nPattern: Up to 20 characters\nExample: `\"Visa\"`","examples":["\"Visa\""],"title":"Networkname","type":"string"},"requestedAmount":{"description":"The requested amount.\nPattern: Integer or decimal amount\nExample: `'85'`","examples":["'85'"],"title":"Requestedamount","type":"number"},"isContactless":{"description":"Whether this is a transaction is contactless. `True` is a contactless transaction. Definition of contactless is at the discretion of the client.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Iscontactless","type":"boolean"},"isMagStripeRead":{"description":"Whether the card’s magnetic stripe was swiped. `True` is yes.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Ismagstriperead","type":"boolean"},"isRecurring":{"description":"Whether the transaction is a recurring bill payment.`True` is for a recurring bill payment.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Isrecurring","type":"boolean"},"isTransactionEmv":{"description":"Whether the transaction used an EMV chip.`True` for when an EMV chip was used.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Istransactionemv","type":"boolean"},"threedsecureIndicator":{"description":"Whether the transaction is 3-D Secure. `True` if the transaction was authenticated using 3-D Secure.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Threedsecureindicator","type":"boolean"},"acquirerInstitutionIdCode":{"description":"Acquiring institution identification code. See Data element 32 of the ISO message.\nPattern: Up to 6 characters\nExample: `\"INST_12\"`","examples":["\"INST_12\""],"title":"Acquirerinstitutionidcode","type":"string"},"mcc":{"description":"Merchant category code, also known as the MCC. This indicates the type of merchant at the point of sale, such as supermarket, auto supply, etc. Codes are defined in the ISO 18245. See Data element 18 of the ISO message.\nPattern: Up to 4 characters\nExample: `\"6011\"`","examples":["\"6011\""],"title":"Mcc","type":"string"},"messageTypeIndicator":{"description":"Message type indicator for the authorization message being sent by the card network.See Data element 22 of the ISO message.\nPattern: Up to 4 characters\nExample: `\"0180\"`","examples":["\"0180\""],"title":"Messagetypeindicator","type":"string"},"posEntryModeFull":{"description":"Point of service (POS) entry mode code. See Data element 22 of the ISO message.\nPattern: Up to 2 characters\nExample: `\"05\"`","examples":["\"05\""],"title":"Posentrymodefull","type":"string"},"transTypeCode":{"description":"Cardholder transaction type code. See Data element 3 subfield 1 of the ISO message.\nPattern: Up to 2 characters\nExample: `\"01\"`","examples":["\"01\""],"title":"Transtypecode","type":"string"},"aav":{"description":"Result from validating the 3-D Secure Accountholder authentication value. Accepted values: 'Y'- Validated, 'F' - Failed, 'N' - Not present.\nPattern: Up to 1 character\nExample: `\"Y\"`","examples":["\"Y\""],"title":"Aav","type":"string"},"avs":{"description":"Result from validating the 3-D Secure Accountholder authentication value. Accepted values: 'Y'- Validated, 'F' - Failed, 'N' - Not present.\nPattern: Up to 1 character\nExample: `\"Y\"`","examples":["\"Y\""],"title":"Avs","type":"string"},"pin":{"description":"Indicates the status of the pin. Accepted values: 'Y' - Validated, 'F' - Failed, 'N' - Not present, 'L' - Locked, 'M' - PIN not set, 'B' - Blocked).\nPattern: Up to 1 character\nExample: `\"N\"`","examples":["\"N\""],"title":"Pin","type":"string"},"riskCode":{"description":"Risk code sent by card network.\nPattern: Up to 3 characters\nExample: `\"675\"`","examples":["\"675\""],"title":"Riskcode","type":"string"},"transactionCountry":{"description":"Two character identifier for the country where the transaction was performed.\nPattern: Up to 2 characters\nExample: `\"US\"`","examples":["\"US\""],"title":"Transactioncountry","type":"string"},"transactionState":{"description":"State where the transaction was performed.\nPattern: Up to 20 characters\nExample: `\"Washington\"`","examples":["\"Washington\""],"title":"Transactionstate","type":"string"},"transactionStateFull":{"description":"Full province name where transaction occurred. This is only for international transactions. Leave empty for US based transactions.\nPattern: Up to 20 characters\nExample: `\"Ontario\"`","examples":["\"Ontario\""],"title":"Transactionstatefull","type":"string"},"riskScore":{"description":"Visa Advanced Authorization (VAA) risk score ranging from 0 to 99 or Mastercard Decision Intelligence (DI) score ranging from 0 to 999.\nPattern: Up to 4 digits\nExample: `56`","examples":["56"],"title":"Riskscore","type":"integer"},"accountAttackIntelligenceScore":{"description":"The account attack intelligence score provided by Visa. Range: 01–99. Higher values indicate higher risk. Returns \"None\" if not populated in the ISO message.\nPattern: 2-digit string from 01 to 99\nExample: `\"15\"`","examples":["\"15\""],"title":"Accountattackintelligencescore","type":"string"},"acctStatus":{"description":"Status of the account.\nPattern: Up to 15 characters\nExample: `\"Active\"`","examples":["\"Active\""],"title":"Acctstatus","type":"string"},"acctActive":{"description":"Whether the account is active. `True` for when the account is active.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Acctactive","type":"boolean"},"cardholderAppDate":{"description":"Date-time the cardholder applied for an account.\nPattern: YYYY-MM-DD hh:mm:ss\nExample: `\"2020-10-10T08:12:35.000+00:00\"`","examples":["\"2020-10-10T08:12:35.000+00:00\""],"format":"date-time","title":"Cardholderappdate","type":"string"},"pinFailDate":{"description":"Date of last PIN failure.\nPattern: YYYY-MM-DD hh:mm:ss\nExample: `\"2023-05-10T02:48:38.000+00:00\"`","examples":["\"2023-05-10T02:48:38.000+00:00\""],"format":"date-time","title":"Pinfaildate","type":"string"},"isEcommerce":{"description":"Whether this was an ecommerce transaction. `True` is for ecommerce transactions.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Isecommerce","type":"boolean"},"isMerchantAuthAssertionsValidated":{"description":"Whether the AAV card value was validated and passed validation. `True` when the AVV card is validated and passed.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Ismerchantauthassertionsvalidated","type":"boolean"},"aavIndicator":{"description":"Indicates whether the AAV was authenticated or if an authentication attempt was made.\nPattern: `Y` or `N`\nExample: `'Y'`","examples":["'Y'"],"title":"Aavindicator","type":"string"},"rawEci":{"description":"The ECI sent in the transaction message. This is specific to the card network. Possible values include: `05` (Visa), `212` (MasterCard), `5` (Discover), etc. See Data element 48 Sub Element 42.\nPattern: Up to 3 characters\nExample: `\"05\"`","examples":["\"05\""],"title":"Raweci","type":"string"},"merchantAssertsDataProtection":{"description":"`True` if the merchant/acquirer asserts that the communication channel between the buyer and the merchant is encrypted (e.g. with TLS/HTTPS). `False` if the merchant/acquirer makes no guarantee about the security of the communication channel with the buyer (e.g. uses HTTP). Proceed with caution when this field is `False`. A malicious third party could have compromised the transaction.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Merchantassertsdataprotection","type":"boolean"},"merchantAssertsAuthenticated":{"description":"Whether the merchant authenticated the buyer with 3-D Secure. `True` if the  merchant/acquirer asserts that it authenticated the buyer using 3-D Secure and obtained a valid CAVV/AAV from the card network or SoFi Tech Solutions. `False` if the merchant/acquirer makes no assertion whether the buyer is fully authenticated using 3-D Secure.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Merchantassertsauthenticated","type":"boolean"},"emvCvn":{"description":"Cryptogram version number for the EMV transaction.\nPattern: Up to 2 characters\nExample: `\"20\"`","examples":["\"20\""],"title":"Emvcvn","type":"string"},"emvCvr":{"description":"Card verification results for the EMV transaction.\nPattern: Up to 12 characters\nExample: `\"a00120400400\"`","examples":["\"a00120400400\""],"title":"Emvcvr","type":"string"},"emvDki":{"description":"Derivative Key Index (DKI) for the EMV transaction. See Data element 55 for 9F10 value.\nPattern: Up to 2 characters\nExample: `\"65\"`","examples":["\"65\""],"title":"Emvdki","type":"string"},"provisioningDeviceType":{"description":"_Visa only_. Type of device used at the provisioning time from ISO8583. See Data element 125.\nPattern: Up to 60 characters\nExample: `\"dtype_123\"`","examples":["\"dtype_123\""],"title":"Provisioningdevicetype","type":"string"},"provisioningDeviceLanguage":{"description":"Three letter code for `device_language` at the provisioning time. See <a href='https://www.loc.gov/standards/iso639-2/php/English_list.php'>ISO 639.2 standards</a>.\nPattern: Up to 3 characters\nExample: `\"eng\"`","examples":["\"eng\""],"title":"Provisioningdevicelanguage","type":"string"},"provisioningDeviceId":{"description":"Device ID at the time of provisioning.\nPattern: Up to 60 characters\nExample: `\"108998A103804F45740927FF9984ML91J43R\"`","examples":["\"108998A103804F45740927FF9984ML91J43R\""],"title":"Provisioningdeviceid","type":"string"},"provisioningDeviceNumber":{"description":"Device phone number at the provisioning time when applicable. See Data element 125 for Visa or DE 124 for Mastercard.\nPattern: Up to 12 characters\nExample: `\"+18888888888\"`","examples":["\"+18888888888\""],"title":"Provisioningdevicenumber","type":"string"},"provisioningLocation":{"description":"Latitude and longitude with 2 digits of precision.\nPattern: Up to 20 characters\nExample: `\"+37.78/-122.43\"`","examples":["\"+37.78/-122.43\""],"title":"Provisioninglocation","type":"string"},"provisioningDeviceIp":{"description":"IP address of the device at the provisioning time.\nPattern: Up to 60 characters\nExample: `\"12.45.65.123\"`","examples":["\"12.45.65.123\""],"title":"Provisioningdeviceip","type":"string"},"provisioningDeviceScore":{"description":"Wallet device score at the provisioning time. See Data element 125 for Visa or DE 124 for Mastercard.\nPattern: Up to 2 characters\nExample: `\"78\"`","examples":["\"78\""],"title":"Provisioningdevicescore","type":"string"},"provisioningAccountScore":{"description":"Account score at the provisioning time. See Data element 125 for Visa or DE 124 for Mastercard.\nPattern: Up to 2 characters\nExample: `\"5\"`","examples":["\"5\""],"title":"Provisioningaccountscore","type":"string"},"provisioningPanSource":{"description":"Identifies the method which the cardholder is attempting to tokenize a primary account number. See Data element 125 for Visa or DE 124 for Mastercard.\nPattern: Up to 2 characters\nExample: `\"02\"`","examples":["\"02\""],"title":"Provisioningpansource","type":"string"},"provisioningAccountEmailAddr":{"description":"Account email address at the time of provisioning.\nPattern: Up to 60 characters\nExample: `\"someemail@gmail.com\"`","examples":["\"someemail@gmail.com\""],"title":"Provisioningaccountemailaddr","type":"string"},"provisioningCorrelationId":{"description":"`correlation_id` at the time of provisioning.\nPattern: Up to 20 characters\nExample: `\"D0000000000000\"`","examples":["\"D0000000000000\""],"title":"Provisioningcorrelationid","type":"string"},"provisioningPaymentAppInstanceId":{"description":"`payment_app_instance_id` at the time of provisioning.\nPattern: Up to 60 characters\nExample: `\"98HAKDSFNQ84R8109R412IU3NRKABSF230\"`","examples":["\"98HAKDSFNQ84R8109R412IU3NRKABSF230\""],"title":"Provisioningpaymentappinstanceid","type":"string"},"provisioningCardholderName":{"description":"Cardholder name at the time of provisioning.\nPattern: Up to 60 characters\nExample: `\"Sam Smith\"`","examples":["\"Sam Smith\""],"title":"Provisioningcardholdername","type":"string"},"provisioningTokenizationRecommendation":{"description":"Tokenization decision suggested by the wallet provider. See Data element 125 for Visa or DE 124 for Mastercard.\nPattern: Up to 1 character\nExample: `\"2\"`","examples":["\"2\""],"title":"Provisioningtokenizationrecommendation","type":"string"},"provisioningTokenizationRecommendationStandardVer":{"description":"The version of the standards the wallet provider is using to determine the suggested tokenization recommendation. See Data element 125 for Visa or DE 124 for Mastercard.\nPattern: Up to 60 characters\nExample: `\"tokenstdvar_345\"`","examples":["\"tokenstdvar_345\""],"title":"Provisioningtokenizationrecommendationstandardver","type":"string"},"provisioningTokenizationRecommendationReasonCode":{"description":"Indicates the specific reason the wallet provider is suggesting the tokenization recommendation. See Data element 125 for Visa or DE 124 for Mastercard.\nPattern: Up to 20 characters\nExample: `\"00088C\"`","examples":["\"00088C\""],"title":"Provisioningtokenizationrecommendationreasoncode","type":"string"},"provisioningActiveTokens":{"description":"`active_tokens` at the time of provisioning.\nPattern: Up to 2 characters\nExample: `22`","examples":["22"],"title":"Provisioningactivetokens","type":"string"},"provisioningTokenType":{"description":"_Mastercard only_. Contains a value indicating the type of requested token. See DE 124 for Mastercard.\nPattern: Up to 1 character\nExample: `\"C\"`","examples":["\"C\""],"title":"Provisioningtokentype","type":"string"},"provisioningConsumerIdentifier":{"description":"`consumer_identifier` at the time of provisioning.\nPattern: Up to 60 characters\nExample: `\"cid_777\"`","examples":["\"cid_777\""],"title":"Provisioningconsumeridentifier","type":"string"},"isPartialAuthSupported":{"description":"Whether the account supports partial authorizations. `True` for an account that supports partial authorization.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Ispartialauthsupported","type":"boolean"},"isCardEmv":{"description":"Whether the card is EMV capable. `True` if card is EMV enabled.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Iscardemv","type":"boolean"},"isEmvFallback":{"description":"Whether the transaction is when a card product is EMV and the terminal where the transaction is performed is EMV enabled but the transaction is non-EMV.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Isemvfallback","type":"boolean"},"isFinalCompletion":{"description":"Whether it is the last preauthorization after multiple preauths that are tied together have been performed and acts as a complete advice/authorization.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Isfinalcompletion","type":"boolean"},"isIncrementalAuth":{"description":"Whether it is part of an incremental authorization tied to other purchases that will settle at the same time (e.g. multiple purchases from a mini-fridge in a hotel).\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Isincrementalauth","type":"boolean"},"isTerminalEmv":{"description":"Whether the terminal is EMV capable. `True` when EMV is enabled.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Isterminalemv","type":"boolean"},"avsRequested":{"description":"Whether AVS was requested. `True` when requested.\nPattern: `true` or `false`\nExample: ``True``","examples":["`True`"],"title":"Avsrequested","type":"boolean"},"currencyCodeBilling":{"description":"Currency Code, Cardholder billing. See Data element 51 of the ISO message.\nPattern: Up to 3 characters\nExample: `\"371\"`","examples":["\"371\""],"title":"Currencycodebilling","type":"string"},"currencyCodeTransaction":{"description":"Currency Code, Transaction. See Data element 49 of the ISO message.\nPattern: Up to 3 characters\nE

# --- truncated at 32 KB (115 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sofi-technologies/refs/heads/main/openapi/sofi-technologies-risk-api-1-0-openapi.json