openapi: 3.2.0 info: title: 1.0 Risk API version: '1.0' servers: - url: risk-{corename}.{env}.gpsrv.com/ tags: - name: Risk 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: - `features`— 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`. - `rule_execution`— 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. - `supplementary_action`— 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`). ' 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. See About the Payment Risk Platform 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. Pattern: Max 50 characters Example: `"AbC123-9999"`' examples: - '"AbC123-9999"' title: Apilogin type: string apiTransKey: description: 'Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`' examples: - '"4sb62fh6w4h7w34g"' title: Apitranskey type: string providerId: description: 'Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10-digit numeric string Example: `"9999"`' examples: - '"9999"' title: Providerid type: string transactionId: description: 'Supply a globally unique ID to identify this endpoint request ("transaction"). A UUID is preferred. Pattern: Max 60 characters Example: `"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. Pattern: Up to 50 characters Example: `"EPRP-test-1231231:1"`' examples: - '"EPRP-test-1231231:1"' title: Riskserviceid type: string eventType: description: 'Specifies the type of the transaction event. Pattern: `Debit` Example: `"Debit"`' examples: - '"Debit"' const: debit enum: - debit title: EventType type: string eventTs: description: 'Timestamp for when the transaction event occurred in our system time. May be the same timestamp as `authTs`. Pattern: YYYY-MM-DD hh:mm:ss Example: `"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. Pattern: Up to 20 characters Example: `"p54789641"`' examples: - '"p54789641"' title: Personid type: string accountId: description: 'Unique identifier of your customer account with which the related event is associated. Pattern: Up to 20 characters Example: `"a125483"`' examples: - '"a125483"' title: Accountid type: string cardId: description: 'An identifier of the card with which the related event is associated. Pattern: Up to 20 characters Example: `"card_123"`' examples: - '"card_123"' title: Cardid type: string authId: description: 'Internal card authorization identifier associated with card transaction event. Pattern: Up to 4 characters Example: `"8989"`' examples: - '"8989"' title: Authid type: string authTs: description: 'Authorization timestamp. Can specify any timezone. Pattern: YYYY-MM-DD hh:mm:ss Example: `"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. Pattern: Integer or decimal amount Example: `''200.00''`' examples: - '''200.00''' title: Acctopentobuy type: number acctCity: description: 'Cardholder’s city. Pattern: Up to 30 characters: letters, spaces, hyphen and period Example: `"Salt Lake City"`' examples: - '"Salt Lake City"' title: Acctcity type: string acctState: description: 'Cardholder’s state or province for non-U.S. countries. Pattern: Up to 60 characters Example: `"Washington"`' examples: - '"Washington"' title: Acctstate type: string acctZip: description: 'Cardholder’s postal code: U.S. ZIP code or local postal code. Pattern: 5–20 characters Example: `"98101"`' examples: - '"98101"' title: Acctzip type: string acctCountry: description: 'Cardholder’s two-digit country code. See the IBAN Alpha-2 codes for details. Pattern: Up to 2 characters Example: `"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). Pattern: YYYY-MM-DD hh:mm:ss Example: `"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. Pattern: YYYY-MM-DD hh:mm:ss Example: `"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. Pattern: Up to 10 characters Example: `"Active"`' examples: - '"Active"' title: Cardstatus type: string cardCredLim: description: 'Credit limit of the cardholder’s account as whole or decimal amount. Pattern: Integer or decimal number Example: `''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. Pattern: `true` or `false` Example: ``True``' examples: - '`True`' title: Merchantassertsauthenticationattempted type: boolean transactionCity: description: 'Merchant''s city. Pattern: Up to 60 characters Example: `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. Pattern: 5–20 characters Example: `"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. Pattern: `true` or `false` Example: ``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. Pattern: `true` or `false` Example: ``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. Pattern: `true` or `false` Example: ``True``' examples: - '`True`' title: Isdomestic type: boolean merchantDesc: description: 'Card acceptor name/location. See Data element 43 of the ISO message. Pattern: Up to 50 characters Example: `"ROSS"`' examples: - '"ROSS"' title: Merchantdesc type: string merchantId: description: 'Card acceptor identification code. See Data element 42 of the ISO message. Pattern: Up to 15 characters Example: `"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. Pattern: Up to 20 characters Example: `"Visa"`' examples: - '"Visa"' title: Networkname type: string requestedAmount: description: 'The requested amount. Pattern: Integer or decimal amount Example: `''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. Pattern: `true` or `false` Example: ``True``' examples: - '`True`' title: Iscontactless type: boolean isMagStripeRead: description: 'Whether the card’s magnetic stripe was swiped. `True` is yes. Pattern: `true` or `false` Example: ``True``' examples: - '`True`' title: Ismagstriperead type: boolean isRecurring: description: 'Whether the transaction is a recurring bill payment.`True` is for a recurring bill payment. Pattern: `true` or `false` Example: ``True``' examples: - '`True`' title: Isrecurring type: boolean isTransactionEmv: description: 'Whether the transaction used an EMV chip.`True` for when an EMV chip was used. Pattern: `true` or `false` Example: ``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. Pattern: `true` or `false` Example: ``True``' examples: - '`True`' title: Threedsecureindicator type: boolean acquirerInstitutionIdCode: description: 'Acquiring institution identification code. See Data element 32 of the ISO message. Pattern: Up to 6 characters Example: `"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. Pattern: Up to 4 characters Example: `"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. Pattern: Up to 4 characters Example: `"0180"`' examples: - '"0180"' title: Messagetypeindicator type: string posEntryModeFull: description: 'Point of service (POS) entry mode code. See Data element 22 of the ISO message. Pattern: Up to 2 characters Example: `"05"`' examples: - '"05"' title: Posentrymodefull type: string transTypeCode: description: 'Cardholder transaction type code. See Data element 3 subfield 1 of the ISO message. Pattern: Up to 2 characters Example: `"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. Pattern: Up to 1 character Example: `"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. Pattern: Up to 1 character Example: `"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). Pattern: Up to 1 character Example: `"N"`' examples: - '"N"' title: Pin type: string riskCode: description: 'Risk code sent by card network. Pattern: Up to 3 characters Example: `"675"`' examples: - '"675"' title: Riskcode type: string transactionCountry: description: 'Two character identifier for the country where the transaction was performed. Pattern: Up to 2 characters Example: `"US"`' examples: - '"US"' title: Transactioncountry type: string transactionState: description: 'State where the transaction was performed. Pattern: Up to 20 characters Example: `"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. Pattern: Up to 20 characters Example: `"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. Pattern: Up to 4 digits Example: `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. Pattern: 2-digit string from 01 to 99 Example: `"15"`' examples: - '"15"' title: Accountattackintelligencescore type: string acctStatus: description: 'Status of the account. Pattern: Up to 15 characters Example: `"Active"`' examples: - '"Active"' title: Acctstatus type: string acctActive: description: 'Whether the account is active. `True` for when the account is active. Pattern: `true` or `false` Example: ``True``' examples: - '`True`' title: Acctactive type: boolean cardholderAppDate: description: 'Date-time the cardholder applied for an account. Pattern: YYYY-MM-DD hh:mm:ss Example: `"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. Pattern: YYYY-MM-DD hh:mm:ss Example: `"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. Pattern: `true` or `false` Example: ``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. Pattern: `true` or `false` Example: ``True``' examples: - '`True`' title: Ismerchantauthassertionsvalidated type: boolean aavIndicator: description: 'Indicates whether the AAV was authenticated or if an authentication attempt was made. Pattern: `Y` or `N` Example: `''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. Pattern: Up to 3 characters Example: `"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. Pattern: `true` or `false` Example: ``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. Pattern: `true` or `false` Example: ``True``' examples: - '`True`' title: Merchantassertsauthenticated type: boolean emvCvn: description: 'Cryptogram version number for the EMV transaction. Pattern: Up to 2 characters Example: `"20"`' examples: - '"20"' title: Emvcvn type: string emvCvr: description: 'Card verification results for the EMV transaction. Pattern: Up to 12 characters Example: `"a00120400400"`' examples: - '"a00120400400"' title: Emvcvr type: string emvDki: description: 'Derivative Key Index (DKI) for the EMV transaction. See Data element 55 for 9F10 value. Pattern: Up to 2 characters Example: `"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. Pattern: Up to 60 characters Example: `"dtype_123"`' examples: - '"dtype_123"' title: Provisioningdevicetype type: string provisioningDeviceLanguage: description: 'Three letter code for `device_language` at the provisioning time. See ISO 639.2 standards. Pattern: Up to 3 characters Example: `"eng"`' examples: - '"eng"' title: Provisioningdevicelanguage type: string provisioningDeviceId: description: 'Device ID at the time of provisioning. Pattern: Up to 60 characters Example: `"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. Pattern: Up to 12 characters Example: `"+18888888888"`' examples: - '"+18888888888"' title: Provisioningdevicenumber type: string provisioningLocation: description: 'Latitude and longitude with 2 digits of precision. Pattern: Up to 20 characters Example: `"+37.78/-122.43"`' examples: - '"+37.78/-122.43"' title: Provisioninglocation type: string provisioningDeviceIp: description: 'IP address of the device at the provisioning time. Pattern: Up to 60 characters Example: `"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. Pattern: Up to 2 characters Example: `"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. Pattern: Up to 2 characters Example: `"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. Pattern: Up to 2 characters Example: `"02"`' examples: - '"02"' title: Provisioningpansource type: string provisioningAccountEmailAddr: description: 'Account email address at the time of provisioning. Pattern: Up to 60 characters Example: `"someemail@gmail.com"`' examples: - '"someemail@gmail.com"' title: Provisioningaccountemailaddr type: string provisioningCorrelationId: description: '`correlation_id` at the time of provisioning. Pattern: Up to 20 characters Example: `"D0000000000000"`' examples: - '"D0000000000000"' title: Provisioningcorrelationid type: string provisioningPaymentAppInstanceId: description: '`payment_app_instance_id` at the time of provisioning. Pattern: Up to 60 characters Example: `"98HAKDSFNQ84R8109R412IU3NRKABSF230"`' examples: - '"98HAKDSFNQ84R8109R412IU3NRKABSF230"' title: Provisioningpaymentappinstanceid type: string provisioningCardholderName: description: 'Cardholder name at the time of provisioning. Pattern: Up to 60 characters Example: `"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. Pattern: Up to 1 character Example: `"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. Pattern: Up to 60 characters Example: `"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. Pattern: Up to 20 characters Example: `"00088C"`' examples: - '"00088C"' title: Provisioningtokenizationrecommendationreasoncode type: string provisioningActiveTokens: description: '`active_tokens` at the time of provisioning. Pattern: Up to 2 characters Example: `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. Pattern: Up to 1 character Example: `"C"`' examples: - '"C"' title: Provisioningtokentype type: string provisioningConsumerIdentifier: description: '`consumer_identifier` at the time of provisioning. Pattern: Up to 60 characters Example: `"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. Pattern: `true` or `false` Example: ``True``' examples: - '`True`' title: Ispartialauthsupported type: boolean isCardEmv: description: 'Whether the card is EMV capable. `True` if card is EMV enabled. Pattern: `true` or `false` Example: ``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. Pattern: `true` or `false` Example: ``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. Pattern: `true` or `false` Example: ``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). Pattern: `true` or `false` Example: ``True``' examples: - '`True`' title: Isincrementalauth type: boolean isTerminalEmv: description: 'Whether the terminal is EMV capable. `True` when EMV is enabled. Pattern: `true` or `false` Example: ``True``' examples: - '`True`' title: Isterminalemv type: boolean avsRequested: description: 'Whether AVS was requested. `True` when requested. Pattern: `true` or `false` Example: ``True``' examples: - '`True`' title: Avsrequested type: boolean currencyCodeBilling: description: 'Currency Code, Cardholder billing. See Data element 51 of the ISO message. Pattern: Up to 3 characters Example: `"371"`' examples: - '"371"' title: Currencycodebilling type: string currencyCodeTransaction: description: 'Currency Code, Transaction. See Data element 49 of the ISO message. Pattern: Up to 3 characters Example: `"304"`' examples: - '"304"' title: Currencycodetransaction type: string merchantTerminalId: description: 'Card Acceptor Terminal Identification Code. See Data element 41 of the ISO message. Pattern: Up to 8 characters Example: `"05940594"`' examples: - '"05940594"' title: Merchantterminalid type: string posConditionCode: description: '_Visa only_. SMS POS Condition. See Data element 25 of the ISO message. Pattern: Up to 2 characters Example: `"89"`' examples: - '"89"' title: Posconditioncode type: string posData: description: '_Mastercard only_. POS Data. See Data element 61 of the ISO message. Pattern: Up to 30 characters Example: `00000000030000040000012039410324`' examples: - 00000000030000040000012039410324 title: Posdata type: string isHighRisk: description: 'Flag to indicate whether card is high risk. Pattern: `true` or `false` Example: ``True``' examples: - '`True`' title: Ishighrisk type: boolean arqc: description: 'A cryptogram that is generated by the chip on a card during a chip transaction and sent to SoFi Tech Solutions to validate that the source of the transaction is legitimate. Pattern: Up to 1 character Example: `N`' examples: - N title: Arqc type: string cvv1Status: description: 'Indicates status of CVV1. Accepted values: ''Y'' - Verified, ''N'' - Failed, ''None'' - No CVV1 Passed. Pattern: Up to 4 characters Example: `''Y''`' examples: - '''Y''' title: Cvv1Status type: string cvv2Status: description: 'Indicates status of CVV2. Accepted values: ''Y'' - Verified, ''N'' - Failed, ''None'' - No CVV2 Passed. Pattern: Up to 4 characters Example: `''N''`' examples: - '''N''' title: Cvv2Status type: string cvv3Status: description: 'Indicates status of CVV3. Accepted values: ''Y'' - Verified, ''N'' - Failed, ''None'' - No CVV3 Passed. Pattern: Up to 4 characters Example: `''N''`' examples: - '''N''' title: Cvv3Status type: string offlinePinStatus: description: 'Indicates the status of the offline pin. Accepted values: ''Y'' - Verified, ''N'' - Failed, ''E'' - Offline Pin Try Count Exceeded, ''P'' - Failed or tries exceeded, but within risk parameters, ''None'' - No Offline PIN verification performed. Pattern: Up to 4 characters Example: `''N''`' examples: - '''N''' title: Offlinepinstatus type: string cashbackAmount: description: 'Cashback amount that was requested. Pattern: Integer or decimal amount Example: `354`' examples: - '354' title: Cashbackamount type: number level1: description: 'Hierarchy level 1 of your program. Pattern: `Consumer` Example: `level 1`' examples: - level 1 title: Level1 type: string level2: description: 'Hierarchy level 2 of your program. Pattern: Up to 60 characters Example: `Division - HSA`' examples: - Division - HSA title: Level2 type: string level3: description: 'Hierarchy level 3 of your program. Pattern: Up to 60 characters Example: `Client`' examples: - Client title: Level3 type: string level4: description: 'Hierarchy level 4 of your program. Pattern: Up to 60 characters Example: `SoFi Tech Solutions`' examples: - SoFi Tech Solutions title: Level4 type: string level5: description: 'Hierarchy level 5 of your program. Pattern: Up to 60 characters Example: `Cohort`' examples: - Cohort title: Level5 type: string level6: description: 'Hierarchy level 6 of your program. Pattern: Up to 60 characters Example: `Group`' examples: - Group title: Level6 type: string level7: description: 'Hierarchy level 7 of your program. Pattern: Up to 60 characters Example: `Account ID`' examples: - Account ID title: Level7 type: string level8: description: 'Hierarchy level 8 of your program. Pattern: Up to 60 characters Example: `level 8`' examples: - level 8 title: Level8 type: string level9: description: 'Hierarchy level 9 of your program. Pattern: Up to 60 characters Example: `Card ID`' examples: - Card ID title: Level9 type: string level10: description: 'Hierarchy level 10 of your program. Pattern: Up to 60 characters Example: `Card Type`' examples: - Card Type title: Level10 type: string customField1: description: 'Optional custom field containing additional data elements to send to SoFi Tech Solutions. Pattern: Up to 60 characters Example: `"field1val"`' examples: - '"field1val"' title: Customfield1 type: string customField2: description: 'Optional custom field containing additional data elements to send to SoFi Tech Solutions. Pattern: Up to 60 characters Example: `"field2val"`' examples: - '"field2val"' title: Customfield2 type: string customField3: description: 'Optional custom field containing additional data elements to send to SoFi Tech Solutions. Pattern: Up to 60 characters Example: `"field3val"`' examples: - '"field3val"' title: Customfield3 type: string customField4: description: 'Optional custom field containing additional data elements to send to SoFi Tech Solutions. Pattern: Up to 60 characters Example: `"field4val"`' examples: - '"field4val"' title: Customfield4 type: string customField5: description: 'Optional custom field containing additional data elements to send to SoFi Tech Solutions. Pattern: Up to 60 characters Example: `"field5val"`' examples: - '"field5val"' title: Customfield5 type: string required: - transactionId - riskServiceId - eventType - eventTs - personId - networkName - apiLogin - apiTransKey - providerId title: DebitFraudExternalRequest type: object operationId: risk_post_prp-1-0-getcardtransactionfraud /prp/1.0/getInstantVerification: 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: properties: risk_service_id: description: Unique identifier provided by SoFi Tech Solutions during the implementation to obtain client configuration details title: Risk Service Id type: string transaction_id: description: Unique provider-generated ID to identify this API call title: Transaction Id type: string event_type: description: 'Specifies the type of the event. Returns:' enum: - acct_vrfy - ach - wire - rtp - fednow title: GiveEventType type: string event_subtype: description: 'Specifies the subtype of the event: * `incoming_debit` * `outgoing_credit` * `incoming_credit` * `outgoing_debit` ' title: Event Subtype type: string event_id: description: System-generated universal unique identifier of the event title: Event Id type: string event_ts: description: Event timestamp format: date-time title: Event Ts type: string account_id: description: SoFi Tech Solutions UUID that identifies the customer account associated with the related event title: Account Id type: string person_id: description: Unique identifier of the customer associated with the event title: Person Id type: string account_uuid: description: SoFi Tech Solutions UUID that identifies the account which the related event is associated with title: Account Uuid type: string person_uuid: description: SoFi Tech Solutions UUID that identifies the account holder associated with the event title: Person Uuid type: string overall_risk_level: default: '' description: 'Determines the fraud risk of the ACH transaction. Below is the recommended actions for you to take: * `very_high` — Cancel the transaction and the bank link * `high`— Challenge the account holder and queue for review * `medium` — Approve the bank account, allow the transaction, and/or challenge the customer * `low` — Approve the bank account and allow the transaction * `''''` — Data enrichment layer is not configured to be called ' title: Overall Risk Level type: string reason_cd: description: List of reason codes. See Instant Verification Reason Codes for valid values. items: type: string title: Reason Cd type: array identity: description: Identity risk signals properties: risk_score: default: -1 description: Returns `0` — Reserved for a future use case, or `-1.0` — Identity risk score is not configured to be called title: Risk Score type: number risk_level: default: '' description: 'Risk level of the customer. Below is the recommended actions for you to take: * `very_high` — Cancel the transaction and the bank link * `high` — Challenge the account holder and queue for review * `medium` — Approve the bank account, allow the transaction, and/or challenge the customer * `low` — Approve the bank account and allow the transaction * `''''` — Data enrichment layer is not configured to be called ' title: Risk Level type: string title: IdentityResponse type: object account: description: Account risk signals properties: risk_level: description: Risk level of the transaction. Returns `high`, `medium`, or `low` title: Risk Level type: string aml_risk_level: description: Anti-money laundering (AML) risk level. Returns `high`, `medium`, or `low` title: Aml Risk Level type: string bank_risk_level: description: Bank risk level. Returns `high`, `medium`, or `low` title: Bank Risk Level type: string ach_risk_level: description: ACH transaction risk level. Returns `high`, `medium`, or `low` title: Ach Risk Level type: string nsf_risk_level: description: Risk level of non-sufficient funds (NSF). Returns `high`, `medium`, or `low` title: Nsf Risk Level type: string nsf_risk_score: description: Normalized risk score for non-sufficient funds (NSF). This is a number between 0 and 99, with 99 being the highest risk. For example, a score of 95 means the transaction is riskier than 95% of the other transactions title: Nsf Risk Score type: number ach_risk_score: description: Normalized risk score for ACH transactions ranging from 0–99 title: Ach Risk Score type: number title: AccountResponse type: object rules_results: anyOf: - properties: subtenant_data: anyOf: - type: object - type: 'null' description: 'Consists of multiple components provide details on PRP''s performance and your fraud policy: * `features`— contains data for specific features you choose to return as a record of specific transaction metrics that are utilized in your fraud rule policy and to measure your cardholder behavior. For each feature returned you will receive the `feature_name`, `feature_value`, and data type. * `rule_execution`— contains all rules triggered within your fraud policy and the associated data that is confirgued in PRP for that rule. Includes `rule_id`, `rule_score`, `rule_name`, rule action, and supplementary actions. If you configure an action to update a data source or to take an action, the associated data is specific to that rule. * `supplementary_action`— contains data on actions and next steps that PRP takes based on your fraud policy configuration. If you configure an action to update a data source or to take an action, the associated data is in this object in a consolidated view. ' title: Subtenant Data galileo_data: anyOf: - 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 - type: 'null' description: A structure that contains transaction information from PRP title: RulesResults type: object - type: 'null' description: Details about the transaction event required: - risk_service_id - event_type - event_id - event_ts - account_id - person_id - account_uuid - person_uuid title: GiveResponseData type: object required: - status_code - status title: GiveExternalReply type: object examples: response: value: "{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"errors\": [\n \"string\"\n ],\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"processing_time\": 0.916,\n \"echo\": {\n \"transaction_id\": \"RSNU68AN366U7I1UT8JQ\",\n \"provider_timestamp\": \"2024-06-24T20:41:13.661Z\",\n \"provider_transaction_id\": \"\"\n },\n \"system_timestamp\": \"1972-06-04T12:30:45\",\n \"response_data\": {\n \"risk_service_id\": \"EPRP-test-1231231:1\",\n \"transaction_id\": \"RSNU68AN366U7I1UT8JQ\",\n \"event_type\": \"acct_vrfy\",\n \"event_subtype\": \"h125483\",\n \"event_id\": \"123456\",\n \"event_ts\": \"2024-06-24T20:41:13.661\",\n \"account_id\": \"a125483\",\n \"person_id\": \"p54789641\",\n \"account_uuid\": \"string\",\n \"person_uuid\": \"ba91fc99e158505ddff930217c7828be6658aee1d3925a05d8dbe00ed80023d4\",\n \"overall_risk_level\": \"medium\",\n \"reason_cd\": [\n \"BVOV\"\n ],\n \"identity\": {\n \"risk_score\": 0,\n \"risk_level\": \"medium\"\n },\n \"account\": {\n \"risk_level\": \"medium\",\n \"aml_risk_level\": \"medium\",\n \"bank_risk_level\": \"high\",\n \"ach_risk_level\": \"low\",\n \"nsf_risk_level\": \"medium\",\n \"nsf_risk_score\": 0,\n \"ach_risk_score\": 0\n }\n }\n }\n " description: '' description: 'Use the Get Instant Verification endpoint to validate the ownership and authenticity of an account. This endpoint returns risk levels, account existence, and associated metadata to help determine if an account is valid and if its owner is correctly identified. It provides detailed risk assessments for multiple use cases associated with an external bank account validation, such as > transactions, wire transactions, risk checks before account linking, and potential > mitigation. See About the Instant Verification Engine for more details.' summary: Get Instant Verification tags: - Risk requestBody: content: application/x-www-form-urlencoded: schema: properties: apiLogin: description: 'Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: `"AbC123-9999"`' examples: - '"AbC123-9999"' maxLength: 50 minLength: 1 title: Apilogin type: string apiTransKey: description: 'Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`' examples: - '"4sb62fh6w4h7w34g"' maxLength: 15 minLength: 1 title: Apitranskey type: string providerId: description: 'Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10-digit numeric string Example: `"9999"`' examples: - '"9999"' maxLength: 10 minLength: 1 title: Providerid type: string transactionId: description: 'Supply a globally unique ID to identify this endpoint request ("transaction"). A UUID is preferred. Pattern: Max 60 characters Example: `"9845dk-39fdk3fj3-4483483478"`' examples: - '"9845dk-39fdk3fj3-4483483478"' maxLength: 60 minLength: 1 title: Transactionid type: string eventTs: description: 'Timestamp for when an event occurred. Pattern: YYYY-MM-DD hh:mm:ss Example: `2020-10-28 13:00:24`' examples: - '2020-10-28 13:00:24' format: date-time title: Eventts type: string eventType: description: 'Specifies the type of an event. Pattern: `acct_vrfy` Example: `"acct_vrfy"`' examples: - '"acct_vrfy"' enum: - acct_vrfy - ach - wire - rtp - fednow title: GiveEventType type: string eventSubtype: description: 'Subtype of event. Pattern: `incoming_debit`, `outgoing_debit`, `incoming_credit`, or `outgoing_credit` Example: `"outgoing_credit"`' examples: - '"outgoing_credit"' title: Eventsubtype type: string instantVerify: default: true description: 'Whether or not an event should have instant verification applied. Pattern: `true` or `false` Example: `True`' examples: - 'True' title: Instantverify type: boolean accountId: description: 'SoFi Tech Solutions UUID that identifies the customer account associated with the related event. Pattern: 1–120 characters Example: `"a125483"`' examples: - '"a125483"' maxLength: 120 minLength: 1 title: Accountid type: string personId: description: 'Unique identifier of the customer associated with the event. Pattern: 1–120 characters Example: `"p54789641"`' examples: - '"p54789641"' maxLength: 120 minLength: 1 title: Personid type: string requestTs: description: 'Timestamp of the account holder''s request. Pattern: YYYY-MM-DD hh:mm:ss Example: `2020-10-28 13:00:24`' examples: - '2020-10-28 13:00:24' format: date-time title: Requestts type: string businessName: description: 'Business name of a business account. When `acctType: business` this field is required. Pattern: 1–120 characters Example: `"Acme Financial"`' examples: - '"Acme Financial"' maxLength: 120 minLength: 1 title: Businessname type: string firstName: description: 'Account holder''s first name. When `acctType: personal` this field is required. Pattern: 1–60 characters Example: `"Ed"`' examples: - '"Ed"' maxLength: 60 minLength: 1 title: Firstname type: string middleName: description: 'Account holder''s middle name. Pattern: 1–60 characters Example: `"W"`' examples: - '"W"' maxLength: 60 minLength: 1 title: Middlename type: string lastName: description: 'Account holder''s last name. When `acctType: personal` this field is required. Pattern: 1–60 characters Example: `"Smith"`' examples: - '"Smith"' maxLength: 60 minLength: 1 title: Lastname type: string acctNo: description: 'Account holder''s account number. Pattern: 5–17 digits Example: `"123456789"`' examples: - '"123456789"' pattern: ^\d{5,17}$ title: Acctno type: string rtNo: description: 'Routing number of the account holder''s bank account. Pattern: 9 digits Example: `124001545`' examples: - '124001545' pattern: ^\d{9}$ title: Rtno type: string riskServiceId: description: 'Unique identifier provided by SoFi Tech Solutions during implementation to obtain client PRP configuration details. Pattern: Up to 50 characters Example: `"EPRP-test-1231231:1"`' examples: - '"EPRP-test-1231231:1"' maxLength: 50 minLength: 1 title: Riskserviceid type: string dob: description: 'Account holder''s date of birth. Pattern: YYYY-MM-DD Example: `2024-01-01`' examples: - '2024-01-01' pattern: ^\d{4}-\d{2}-\d{2}$ title: Dob type: string addr1: description: 'Account holder''s first address line. Cannot be a P.O. Box. Pattern: 1–60 characters Example: `"33 Maple Street"`' examples: - '"33 Maple Street"' maxLength: 60 minLength: 1 title: Addr1 type: string addr2: description: 'Account holder''s second address line. Pattern: 1–60 characters Example: `"APT 5520"`' examples: - '"APT 5520"' maxLength: 60 minLength: 1 title: Addr2 type: string city: description: 'Account holder''s city. Pattern: 1–60 characters Example: `"Salt Lake City"`' examples: - '"Salt Lake City"' maxLength: 60 minLength: 1 title: City type: string state: description: 'Account holder''s state or province abbreviation. Pattern: 2 character state or province abbreviation Example: `"UT"`' examples: - '"UT"' pattern: ^[A-Z]{2}$ title: State type: string zip: description: 'Account holder''s postal code (ZIP code). Pattern: Up to 5 digits Example: `84121`' examples: - '84121' pattern: ^\d{5}$ title: Zip type: string phoneNo: description: 'Phone number of bank account holder in E.164 format. Pattern: 1–15 digits Example: `+11234567890`' examples: - '+11234567890' pattern: ^\+\d{1,15}$ title: Phoneno type: string emailAddr: description: 'Account holder''s email address. Pattern: 3–255 characters Example: `user@example.com`' examples: - user@example.com maxLength: 255 minLength: 1 title: Emailaddr type: string acctType: default: personal description: 'Type of bank account. Pattern: `personal`, `business`, or `other` Example: `"personal"`' examples: - '"personal"' enum: - personal - business - other title: AccountType type: string ctryCd: description: 'Account holder''s 2-letter ISO 3166-1 country code. Pattern: 2 uppercase letters (ISO 3166-1) Example: `"US"`' examples: - '"US"' const: US enum: - US title: CountryCode type: string personCreatedTs: description: 'Timestamp when the customer profile was created. Pattern: YYYY-MM-DD hh:mm:ss Example: `2020-10-28 13:00:24`' examples: - '2020-10-28 13:00:24' format: date-time title: Personcreatedts type: string idDocNo: description: 'Account holder''s SSN or Tax ID. Pattern: 9 digits Example: `123456789`' examples: - '123456789' pattern: ^\d{9}$ title: Iddocno type: string idDocType: description: 'Type of identification provided by the account holder. Pattern: `ssn`, `itin`, or `ein` Example: `"ssn"`' examples: - '"ssn"' enum: - ssn - itin - ein title: IdDocType type: string currCd: default: USD description: '3-letter ISO-4217 currency code. Default: USD. Pattern: 3 uppercase letters (ISO 4217) Example: `USD`' examples: - USD const: USD enum: - USD title: CurrencyCode type: string acctSubtype: description: 'Account subtype of bank account holder. Pattern: `checking` or `savings` Example: `"checking"`' examples: - '"checking"' enum: - checking - saving title: AccountSubtype type: string transAmt: description: 'The transaction amount in the currency of the account. Pattern: 1–10 digits with 2 decimal places Example: `10000.00`' examples: - '10000.00' title: Transamt type: number partnerId: description: 'System-generated partner identifier. Pattern: Up to 10-digit numeric string Example: `"9999"`' examples: - '"9999"' maxLength: 10 minLength: 1 title: Partnerid type: string progId: description: 'System-generated program identifier. Pattern: Up to 10-digit numeric string Example: `"9999"`' examples: - '"9999"' maxLength: 10 minLength: 1 title: Progid type: string prodId: description: 'System-generated product identifier. Pattern: Up to 10-digit numeric string Example: `"9999"`' examples: - '"9999"' maxLength: 10 minLength: 1 title: Prodid type: string balanceAmt: description: 'Balance of account. Pattern: 1–10 digits with 2 decimal places Example: `450.12`' examples: - '450.12' title: Balanceamt type: number balanceAsOfTs: description: 'Timestamp balance was calculated at. Pattern: YYYY-MM-DD hh:mm:ss Example: `"2020-10-28 13:00:24"`' examples: - '"2020-10-28 13:00:24"' format: date-time title: Balanceasofts type: string balanceReasonCd: description: 'Balance reason code. Pattern: `success`, `timeout`, `not available`, or `other` Example: `"success"`' examples: - '"success"' title: Balancereasoncd type: string required: - transactionId - eventTs - eventType - accountId - personId - requestTs - acctNo - rtNo - riskServiceId - apiLogin - apiTransKey - providerId title: GiveExternalRequest type: object operationId: risk_post_prp-1-0-getinstantverification /prp/1.0/getMoneyMovementFraud: 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: properties: event_id: description: System-generated universal unique identifier for the event nullable: true title: Event Id type: string rules_results: description: <> rules execution results for the transaction event properties: subtenant_data: anyOf: - type: object - type: 'null' description: 'Consists of multiple components provide details on PRP''s performance and your fraud policy: * `features`— contains data for specific features you choose to return as a record of specific transaction metrics that are utilized in your fraud rule policy and to measure your cardholder behavior. For each feature returned you will receive the `feature_name`, `feature_value`, and data type. * `rule_execution`— contains all rules triggered within your fraud policy and the associated data that is confirgued in PRP for that rule. Includes `rule_id`, `rule_score`, `rule_name`, rule action, and supplementary actions. If you configure an action to update a data source or to take an action, the associated data is specific to that rule. * `supplementary_action`— contains data on actions and next steps that PRP takes based on your fraud policy configuration. If you configure an action to update a data source or to take an action, the associated data is in this object in a consolidated view. ' title: Subtenant Data galileo_data: anyOf: - 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 - type: 'null' description: A structure that contains transaction information from PRP title: RulesResults type: object title: MMExternalProperties type: object required: - status_code - status title: MMFraudExternalReply type: object description: '' description: Use the Get Money Movement Fraud endpoint to evaluate the risk associated with specific money-movement transactions and account linking to understand if a customer 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. summary: Get Money Movement Fraud tags: - Risk security: - gft-internal-service-auth: - read requestBody: content: application/x-www-form-urlencoded: schema: properties: riskServiceId: description: 'Identifier created by the Risk Squad. A fixed value for each client Pattern: EPRP prefix followed by colon-separated identifiers Example: `EPRP:505:401:8385`' examples: - EPRP:505:401:8385 title: Riskserviceid type: string apiLogin: description: 'Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: `"AbC123-9999"`' examples: - '"AbC123-9999"' title: Apilogin type: string apiTransKey: description: 'Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`' examples: - '"4sb62fh6w4h7w34g"' title: Apitranskey type: string providerId: description: 'Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10-digit numeric string Example: `"9999"`' examples: - '"9999"' title: Providerid type: string transactionId: description: 'Supply a globally unique ID to identify this endpoint request ("transaction"). A UUID is preferred. Pattern: Max 60 characters Example: `"9845dk-39fdk3fj3-4483483478"`' examples: - '"9845dk-39fdk3fj3-4483483478"' title: Transactionid type: string eventType: description: 'Event type. Pattern: `acct_vrfy`, `ach`, `wire`, `rtp`, `fednow`, `aft`, or `oct` Example: `acct_vrfy`' examples: - acct_vrfy enum: - acct_vrfy - ach - wire - rtp - fednow - aft - oct title: MMFraudEventType type: string eventSubtype: description: 'Event subtype. Pattern: `finicity`, `incoming_debit`, `incoming_credit`, `outgoing_debit`, or `outgoing_credit` Example: `finicity`' examples: - finicity enum: - finicity - incoming_debit - incoming_credit - outgoing_debit - outgoing_credit title: MMFraudEventSubtype type: string eventId: description: 'Map `trans_id` to `event_id` Pattern: One or more digits Example: `2356109249`' examples: - '2356109249' title: Eventid type: string eventTs: description: 'Map `trans_ts` to `event_ts` Pattern: YYYY-MM-DD HH:MM:SS Example: `2025-05-26 01:00:00`' examples: - '2025-05-26 01:00:00' format: date-time title: Eventts type: string partnerId: description: 'A unique partner identifier from SoFi Tech Solutions. Pattern: One or more digits Example: `505`' examples: - '505' title: Partnerid type: string progId: description: 'A unique program identifier from SoFi Tech Solutions. Pattern: One or more digits Example: `9009`' examples: - '9009' title: Progid type: string prodId: description: 'A unique product identifier from SoFi Tech Solutions. Pattern: One or more digits Example: `1234`' examples: - '1234' title: Prodid type: string pmtRefNo: description: 'Payment reference number Pattern: 12 digits Example: `999101012345`' examples: - '999101012345' title: Pmtrefno type: string xid: description: 'Transaction XID Pattern: One or more digits Example: `1234`' examples: - '1234' title: Xid type: string balId: description: 'Balance ID or `galileo_account_number` Pattern: One or more digits Example: `4321`' examples: - '4321' title: Balid type: string appDate: description: 'Timestamp for when this application was submitted Pattern: YYYY-MM-DD HH:MM:SS Example: `2025-04-18 00:00:00`' examples: - '2025-04-18 00:00:00' format: date-time title: Appdate type: string instantVerify: description: 'Whether to run <>. Pattern: `true` or `false` Example: `TRUE`' examples: - 'TRUE' title: Instantverify type: boolean counterpartyPanCardNo: description: 'Counterparty <> for <> or <> use cases Pattern: 16 digits Example: `1234567890123456`' examples: - '1234567890123456' title: Counterpartypancardno type: string counterpartyAcctNo: description: 'Counterparty account number Pattern: 5–17 digits Example: `841523654`' examples: - '841523654' title: Counterpartyacctno type: string counterpartyAcctType: description: 'Counterparty account type Pattern: `personal`, `business`, or `other` Example: `personal`' examples: - personal title: Counterpartyaccttype type: string counterpartyAcctSubtype: description: 'Counterparty account subtype Pattern: `checking` or `savings` Example: `checking`' examples: - checking title: Counterpartyacctsubtype type: string counterpartyRtNo: description: 'Counterparty bank routing number Pattern: 9 digits Example: `021000021`' examples: - '021000021' title: Counterpartyrtno type: string counterpartyBalAmount: description: 'Latest available balance of the counterparty account Pattern: Integer or decimal number Example: `250.15`' examples: - '250.15' title: Counterpartybalamount type: number counterpartyBalanceTs: description: 'Timestamp for when `counterpartyBalAmount` was captured Pattern: YYYY-MM-DD HH:MM:SS Example: `2025-04-18 7:39:30`' examples: - '2025-04-18 7:39:30' format: date-time title: Counterpartybalancets type: string counterpartyIdDocType: description: 'Counterparty account holder ID type: `ssn`, `itin` or `ein` Pattern: `ssn`, `itin`, or `ein` Example: `ssn`' examples: - ssn title: Counterpartyiddoctype type: string counterpartyIdDocNo: description: 'Counterparty account holder SSN or tax ID Pattern: 9 digits Example: `123456789`' examples: - '123456789' title: Counterpartyiddocno type: string counterpartyFirstName: description: 'Counterparty account holder first name Pattern: Letter followed by letters, spaces, apostrophes, periods, or hyphens Example: `John`' examples: - John title: Counterpartyfirstname type: string counterpartyMiddleName: description: 'Counterparty account holder middle name Pattern: Letter followed by letters, spaces, apostrophes, periods, or hyphens Example: `James`' examples: - James title: Counterpartymiddlename type: string counterpartyLastName: description: 'Counterparty account holder last name Pattern: Letter followed by letters, spaces, apostrophes, periods, or hyphens Example: `Doe`' examples: - Doe title: Counterpartylastname type: string counterpartyBusinessName: description: 'Counterparty bank business name when `counterpartyAcctType: business`. Pattern: Non-empty text Example: `John Inc`' examples: - John Inc title: Counterpartybusinessname type: string counterpartyDob: description: 'Counterparty account holder date of birth Pattern: One or more digits Example: `29221`' examples: - '29221' title: Counterpartydob type: string counterpartyAddr1: description: 'Counterparty account holder address line 1 Pattern: 1–60 characters Example: `1417 N Rue St.`' examples: - 1417 N Rue St. title: Counterpartyaddr1 type: string counterpartyAddr2: description: 'Counterparty account holder address line 2 Pattern: 1–60 characters Example: `APT 5520`' examples: - APT 5520 title: Counterpartyaddr2 type: string counterpartyCity: description: 'City of the counterparty account holder Pattern: Non-empty text Example: `Saint Charles`' examples: - Saint Charles title: Counterpartycity type: string counterpartyState: description: 'State of the counterparty account holder Pattern: 2 uppercase letters Example: `MO`' examples: - MO title: Counterpartystate type: string counterpartyZip: description: 'ZIP or postal code of the counterparty account holder Pattern: 5–20 characters Example: `63301`' examples: - '63301' title: Counterpartyzip type: string counterpartyCtryCd: description: 'Two-letter country code of the counterparty account holder Pattern: 2 uppercase letters (ISO 3166-1) Example: `US`' examples: - US title: Counterpartyctrycd type: string counterpartyBillingAddr1: description: 'Counterparty account holder billing address line 1 Pattern: 1–60 characters Example: `1417 n. rue st.`' examples: - 1417 n. rue st. title: Counterpartybillingaddr1 type: string counterpartyBillingAddr2: description: 'Counterparty account holder billing address line 2 Pattern: 1–60 characters Example: `APT 5520`' examples: - APT 5520 title: Counterpartybillingaddr2 type: string counterpartyBillingCity: description: 'Billing city of the counterparty account holder Pattern: Non-empty text Example: `saint charles`' examples: - saint charles title: Counterpartybillingcity type: string counterpartyBillingState: description: 'Billing state of the counterparty account holder Pattern: 2 uppercase letters Example: `MO`' examples: - MO title: Counterpartybillingstate type: string counterpartyBillingZip: description: 'Billing ZIP or postal code of the counterparty account holder Pattern: 5–20 characters Example: `63301`' examples: - '63301' title: Counterpartybillingzip type: string counterpartyBillingCtryCd: description: 'Two-letter billing country code of the counterparty account holder Pattern: 2 uppercase letters (ISO 3166-1) Example: `US`' examples: - US title: Counterpartybillingctrycd type: string counterpartyMobilePhoneNo: description: 'Counterparty account holder mobile phone number Pattern: E.164 US format: +1 followed by 10 digits Example: `+11234567890`' examples: - '+11234567890' title: Counterpartymobilephoneno type: string counterpartyHomePhoneNo: description: 'Counterparty account holder home phone number Pattern: E.164 US format: +1 followed by 10 digits Example: `+11234567890`' examples: - '+11234567890' title: Counterpartyhomephoneno type: string counterpartyEmailAddr: description: 'Counterparty account holder email address Pattern: Email address Example: `jdoe@example.com`' examples: - jdoe@example.com title: Counterpartyemailaddr type: string counterpartyIpAddr: description: 'Counterparty account holder IP address Pattern: IPv4 address (four dot-separated number groups) Example: `172.16.10.20`' examples: - 172.16.10.20 title: Counterpartyipaddr type: string counterpartyNameMatchScore: description: 'Counterparty name match score from Finicity Pattern: 0–1 decimal Example: `0.9`' examples: - '0.9' title: Counterpartynamematchscore type: number counterpartyPhoneMatchInd: description: 'Counterparty phone number match indicator from Finicity Pattern: `true` or `false` Example: `False`' examples: - 'False' title: Counterpartyphonematchind type: boolean counterpartyZipMatchInd: description: 'Counterparty ZIP code match indicator from Finicity Pattern: `true` or `false` Example: `True`' examples: - 'True' title: Counterpartyzipmatchind type: boolean counterpartyEmailMatchInd: description: 'Counterparty email address match indicator from Finicity Pattern: `true` or `false` Example: `True`' examples: - 'True' title: Counterpartyemailmatchind type: boolean customerPanCardNo: description: 'Customer PAN for AFT or OCT use cases Pattern: 16 digits Example: `1234567890123456`' examples: - '1234567890123456' title: Customerpancardno type: string customerAcctNo: description: 'Customer account number (<>) Pattern: 5–17 digits Example: `999101523654`' examples: - '999101523654' title: Customeracctno type: string customerAcctType: description: 'Customer account type Pattern: `personal`, `business`, or `other` Example: `personal`' examples: - personal title: Customeraccttype type: string customerAcctSubtype: description: 'Customer account subtype Pattern: `checking` or `savings` Example: `checking`' examples: - checking title: Customeracctsubtype type: string customerRtNo: description: 'Customer bank routing number Pattern: 9 digits Example: `210000221`' examples: - '210000221' title: Customerrtno type: string customerBalAmount: description: 'Latest available balance of the customer account Pattern: Integer or decimal number Example: `250.15`' examples: - '250.15' title: Customerbalamount type: number customerBalanceTs: description: 'Timestamp for when `customerBalAmount` was captured. Pattern: YYYY-MM-DD HH:MM:SS Example: `2025-04-18 7:39:30`' examples: - '2025-04-18 7:39:30' format: date-time title: Customerbalancets type: string customerIdDocType: description: 'Customer account holder ID type Pattern: `ssn`, `itin`, or `ein` Example: `ssn`' examples: - ssn title: Customeriddoctype type: string customerIdDocNo: description: 'Customer account holder SSN or tax ID Pattern: 9 digits Example: `123456789`' examples: - '123456789' title: Customeriddocno type: string customerFirstName: description: 'Customer account holder first name Pattern: Letter followed by letters, spaces, apostrophes, periods, or hyphens Example: `John`' examples: - John title: Customerfirstname type: string customerMiddleName: description: 'Customer account holder middle name Pattern: Letter followed by letters, spaces, apostrophes, periods, or hyphens Example: `Arnold`' examples: - Arnold title: Customermiddlename type: string customerLastName: description: 'Customer account holder last name Pattern: Letter followed by letters, spaces, apostrophes, periods, or hyphens Example: `Doe`' examples: - Doe title: Customerlastname type: string customerBusinessName: description: 'Customer bank business name when `customerAcctType: business` Pattern: Non-empty text Example: `John Inc`' examples: - John Inc title: Customerbusinessname type: string customerDob: description: 'Customer account holder date of birth Pattern: One or more digits Example: `29221`' examples: - '29221' title: Customerdob type: string customerAddr1: description: 'Customer account holder address line 1 Pattern: 1–60 characters Example: `1417 N Rue St.`' examples: - 1417 N Rue St. title: Customeraddr1 type: string customerAddr2: description: 'Customer account holder address line 2 Pattern: 1–60 characters Example: `APT 5520`' examples: - APT 5520 title: Customeraddr2 type: string customerCity: description: 'City of the customer account holder Pattern: Non-empty text Example: `Saint Charles`' examples: - Saint Charles title: Customercity type: string customerState: description: 'State of the customer account holder Pattern: 2 uppercase letters Example: `MO`' examples: - MO title: Customerstate type: string customerZip: description: 'ZIP or postal code of the customer account holder Pattern: 5–20 characters Example: `63301`' examples: - '63301' title: Customerzip type: string customerCtryCd: description: 'Two-letter country code of the customer account holder Pattern: 2 uppercase letters (ISO 3166-1) Example: `US`' examples: - US title: Customerctrycd type: string customerBillingAddr1: description: 'Customer billing address line 1 (AFT/OCT use cases) Pattern: 1–60 characters Example: `1417 n. rue st.`' examples: - 1417 n. rue st. title: Customerbillingaddr1 type: string customerBillingAddr2: description: 'Customer billing address line 2 (AFT/OCT use cases) Pattern: 1–60 characters Example: `APT 5520`' examples: - APT 5520 title: Customerbillingaddr2 type: string customerBillingCity: description: 'Customer billing city (AFT/OCT use cases) Pattern: Non-empty text Example: `saint charles`' examples: - saint charles title: Customerbillingcity type: string customerBillingState: description: 'Customer billing state (AFT/OCT use cases) Pattern: 2 uppercase letters Example: `MO`' examples: - MO title: Customerbillingstate type: string customerBillingZip: description: 'Customer billing ZIP (AFT/OCT use cases) Pattern: 5–20 characters Example: `63301`' examples: - '63301' title: Customerbillingzip type: string customerBillingCtryCd: description: 'Two-letter billing country code of the customer (AFT/OCT use cases) Pattern: 2 uppercase letters (ISO 3166-1) Example: `US`' examples: - US title: Customerbillingctrycd type: string customerMobilePhoneNo: description: 'Customer account holder mobile phone number Pattern: E.164 US format: +1 followed by 10 digits Example: `+11234567890`' examples: - '+11234567890' title: Customermobilephoneno type: string customerHomePhoneNo: description: 'Customer account holder home phone number Pattern: E.164 US format: +1 followed by 10 digits Example: `+11234567890`' examples: - '+11234567890' title: Customerhomephoneno type: string customerEmailAddr: description: 'Customer account holder email address Pattern: Email address Example: `jdoe@example.com`' examples: - jdoe@example.com title: Customeremailaddr type: string customerIpAddr: description: 'Customer IP address Pattern: IPv4 address (four dot-separated number groups) Example: `192.168.10.20`' examples: - 192.168.10.20 title: Customeripaddr type: string sequenceNumber: description: 'Sequence number Pattern: Integer, optional leading minus sign Example: `20250500000000000000000000000000000`' examples: - '20250500000000000000000000000000000' title: Sequencenumber type: integer requestTs: description: 'Map `in_ts` to `request_ts` Pattern: YYYY-MM-DD HH:MM:SS Example: `2025-05-27 13:46:37`' examples: - '2025-05-27 13:46:37' format: date-time title: Requestts type: string procTs: description: 'Processing timestamp Pattern: YYYY-MM-DD HH:MM:SS Example: `2025-05-27 13:46:45`' examples: - '2025-05-27 13:46:45' format: date-time title: Procts type: string effectiveDt: description: 'Effective date Pattern: YYYY-MM-DD HH:MM:SS Example: `2025-05-28 00:00:00`' examples: - '2025-05-28 00:00:00' format: date-time title: Effectivedt type: string origRec: description: 'Original record Pattern: Non-empty text Example: `ST`' examples: - ST title: Origrec type: string batchHdr: description: 'Batch header Pattern: Non-empty text Example: `5200Wyndham 134233889 WEBP2P 250528250528 1096001010000003`' examples: - 5200Wyndham 134233889 WEBP2P 250528250528 1096001010000003 title: Batchhdr type: string transAmt: description: 'Transaction amount (map `amt` to `trans_amt`) Pattern: Integer or decimal number Example: `300.14`' examples: - '300.14' title: Transamt type: number currCd: description: '3-letter currency code Pattern: 3 uppercase letters (ISO 4217) Example: `USD`' examples: - USD title: Currcd type: string transCode: description: 'Transaction code Pattern: One or more digits Example: `37`' examples: - '37' title: Transcode type: string transType: description: 'Transaction type Pattern: Non-empty text Example: `AC`' examples: - AC title: Transtype type: string status: description: 'Status Pattern: Non-empty text Example: `P`' examples: - P title: Status type: string statusDesc: description: 'Status description Pattern: Non-empty text Example: `Processed`' examples: - Processed title: Statusdesc type: string feeFlag: description: 'Fee flag Pattern: Any text, including empty Example: `true`' examples: - 'true' title: Feeflag type: string feeAmt: description: 'Fee amount Pattern: Integer or decimal number Example: `1.50`' examples: - '1.50' title: Feeamt type: number loadType: description: 'Load type Pattern: Non-empty text Example: `M`' examples: - M title: Loadtype type: string origTrace: description: 'Original trace Pattern: One or more digits Example: `96001015089930`' examples: - '96001015089930' title: Origtrace type: string retCodeDishon: description: 'Return code dishonor Pattern: Any text, including empty' examples: [] title: Retcodedishon type: string chgCode: description: 'Change code Pattern: Any text, including empty' examples: [] title: Chgcode type: string chgTs: description: 'Change timestamp Pattern: YYYY-MM-DD HH:MM:SS, or empty' examples: [] format: date-time title: Chgts type: string destId: description: 'Destination ID Pattern: One or more digits Example: `531`' examples: - '531' title: Destid type: string destInstName: description: 'Destination institution name Pattern: Non-empty text Example: `Sunrise_Bank_Wyndham_AC`' examples: - Sunrise_Bank_Wyndham_AC title: Destinstname type: string destInstId: description: 'Destination institution ID Pattern: 9 digits Example: `271081528`' examples: - '271081528' title: Destinstid type: string destAcctType: description: 'Destination account type Pattern: Non-empty text Example: `S`' examples: - S title: Destaccttype type: string destFilename: description: 'Destination filename Pattern: Non-empty text Example: `ACHs250527A531`' examples: - ACHs250527A531 title: Destfilename type: string sourceId: description: 'Source ID Pattern: One or more digits Example: `531`' examples: - '531' title: Sourceid type: string sourceInstName: description: 'Source institution name Pattern: Non-empty text Example: `galileo:wyndham`' examples: - galileo:wyndham title: Sourceinstname type: string sourceInstCat: description: 'Source institution category Pattern: Non-empty text Example: `OTH`' examples: - OTH title: Sourceinstcat type: string sourceInstId: description: 'Source institution ID Pattern: One or more digits Example: `96001013`' examples: - '96001013' title: Sourceinstid type: string sourceTrace: description: 'Source trace Pattern: One or more digits Example: `21000025074388`' examples: - '21000025074388' title: Sourcetrace type: string sourceFilename: description: 'Source filename Pattern: Non-empty text Example: `wyndham`' examples: - wyndham title: Sourcefilename type: string destRetFilename: description: 'Destination return filename Pattern: Any text, including empty' examples: [] title: Destretfilename type: string destRetTs: description: 'Destination return timestamp Pattern: YYYY-MM-DD HH:MM:SS Example: `2025-03-07 10:20:28`' examples: - '2025-03-07 10:20:28' format: date-time title: Destretts type: string destRetTrace: description: 'Destination return trace Pattern: Any text, including empty' examples: [] title: Destrettrace type: string returnCode: description: 'Return code (required for certain `eventSubtype`s) Pattern: `R` followed by 2 digits Example: `R01`' examples: - R01 title: Returncode type: string returnTs: description: 'Return timestamp (required for certain `eventSubtype`s) Pattern: YYYY-MM-DD HH:MM:SS Example: `2025-05-29 07:24:36`' examples: - '2025-05-29 07:24:36' format: date-time title: Returnts type: string sourceRetFilename: description: 'Source return filename Pattern: Non-empty text Example: `ACH.366.250411.A`' examples: - ACH.366.250411.A title: Sourceretfilename type: string sourceRetTs: description: 'Source return timestamp Pattern: YYYY-MM-DD HH:MM:SS Example: `2025-04-11 11:45:50`' examples: - '2025-04-11 11:45:50' format: date-time title: Sourceretts type: string sourceRetTrace: description: 'Source return trace Pattern: One or more digits Example: `103113352137688`' examples: - '103113352137688' title: Sourcerettrace type: string origRetTrace: description: 'Original return trace Pattern: One or more digits Example: `125109013780198`' examples: - '125109013780198' title: Origrettrace type: string retStlDate: description: 'Return settlement date Pattern: YYYY-MM-DD HH:MM:SS Example: `2025-01-17 00:00:00`' examples: - '2025-01-17 00:00:00' format: date-time title: Retstldate type: string origRetCode: description: 'Original return code Pattern: One or more digits Example: `01`' examples: - '01' title: Origretcode type: string addNo: description: 'Additional number Pattern: One or more digits Example: `0`' examples: - '0' title: Addno type: string disbType: description: 'Disbursement type Pattern: One or more digits Example: `0`' examples: - '0' title: Disbtype type: string retryCount: description: 'Retry count Pattern: Integer, optional leading minus sign Example: `-1`' examples: - '-1' title: Retrycount type: integer retryTs: description: 'Retry timestamp Pattern: YYYY-MM-DD HH:MM:SS Example: `2025-02-19 00:22:13`' examples: - '2025-02-19 00:22:13' format: date-time title: Retryts type: string batchCat: description: 'Batch category Pattern: One or more digits Example: `9009`' examples: - '9009' title: Batchcat type: string revId: description: 'Revision ID Pattern: Any text, including empty' examples: [] title: Revid type: string sameDay: description: 'Same-day indicator Pattern: `Y` or `N` Example: `N`' examples: - N title: Sameday type: string origName: description: 'Original name Pattern: Non-empty text Example: `HEALTH CARE SERV`' examples: - HEALTH CARE SERV title: Origname type: string govOrig: description: 'Government origin indicator Pattern: `Y` or `N` Example: `Y`' examples: - Y title: Govorig type: string reviewFlag: description: 'Review flag Pattern: `Y` or `N` Example: `Y`' examples: - Y title: Reviewflag type: string reviewReason: description: 'Review reason Pattern: Non-empty text Example: `potential R17 return`' examples: - potential R17 return title: Reviewreason type: string blocksIdUsed: description: 'Blocks ID used Pattern: One or more digits Example: `0`' examples: - '0' title: Blocksidused type: string identNumber: description: 'Identification number Pattern: One or more digits Example: `692101336968`' examples: - '692101336968' title: Identnumber type: string lastEnqueuedTs: description: 'Last-enqueued timestamp Pattern: YYYY-MM-DD HH:MM:SS Example: `2025-06-02 03:28:33`' examples: - '2025-06-02 03:28:33' format: date-time title: Lastenqueuedts type: string rowInsertOrigin: description: 'Row insert origin Pattern: Non-empty text Example: `aue1`' examples: - aue1 title: Rowinsertorigin type: string rowUpdateOrigin: description: 'Row update origin Pattern: Non-empty text Example: `aue1`' examples: - aue1 title: Rowupdateorigin type: string dscr: description: 'Description Pattern: Non-empty text Example: `Bill Payment - Check`' examples: - Bill Payment - Check title: Dscr type: string secCode: description: '<> code Pattern: 3 uppercase letters Example: `WEB`' examples: - WEB title: Seccode type: string companyName: description: 'Company name Pattern: Non-empty text Example: `Nuttige LLC`' examples: - Nuttige LLC title: Companyname type: string ofacStatus: description: '<> status Pattern: Any text, including empty' examples: [] title: Ofacstatus type: string required: - riskServiceId - transactionId - eventType - eventTs - partnerId - progId - prodId - pmtRefNo - balId - instantVerify - apiLogin - apiTransKey - providerId title: MMFraudExternalRequest type: object operationId: risk_post_prp-1-0-getmoneymovementfraud components: securitySchemes: gft-internal-service-auth: scheme: bearer bearerFormat: JWT type: http x-gft-scopes: read: Grant read-only access write: Grant read-write access x-readme: explorer-enabled: true proxy-enabled: true