{"openapi":"3.1.0","servers":[{"url":"{corename}.gft-dispute-api.{env}.gpsrv.com/gft-dispute-api/1.0/"}],"info":{"version":"25.02","title":"Dispute API 3.0","description":"The following documents the Intake API and Interaction APIs. The Intake API is used to create claims, add reasons, transactions, and details about the claim, and submit the claim to be finalized. The Interaction API is used to view claims, add and view Attachments, Notes, and Transactions to claims, view and resend Correspondence, and request that a case is withdrawn or reopened.

\n\n> 📘 Note\n>\n> When intaking a case, the final step of the process is the `/claim/intake/submit` endpoint. The only endpoint that can be called immediately after submission is the `/claim/intake/retrieveConfirmation` endpoint. The submission queues up the case for initial automation and there is a slight delay (usually seconds) between submission and when the case is available to perform interaction endpoints. If you intend to perform more activity on the case during the intake process it should be done before the `/claim/intake/submit` endpoint.

Format requirements

Formats for specific types are defined within the schema.

General rules:","termsOfService":"","contact":{},"license":{"name":""}},"paths":{"/claim/attachments/add":{"post":{"summary":"/claim/attachments/add","operationId":"postClaimAttachmentsAdd","description":"Use this endpoint to add attachments to an existing claim","parameters":[],"responses":{"200":{"description":"Successful add attachments request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response"}}}}},"400":{"description":"Error add attachment request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"attachmentAddError":{"value":{"StatusList":[{"Type":"Error","Message":"fail, Error adding the attachment"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample add attachment Error Response"},"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error19Example":{"value":{"StatusList":[{"Type":"Error","Message":"Unable to Process request. The ClaimID has not been submitted..","Code":"19"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 19 response"}}}}},"500":{"description":"Error add attachments request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","AttachmentList","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"AttachmentList":{"type":"array","description":"List of attachments to add to the claim","items":{"allOf":[{"type":"object","required":["FileName","Category","Label","DocumentStream"],"properties":{"DocumentStream":{"type":"string","description":"Byte stream of the form PDF being uploaded to satisfy the requirement","examples":["JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"]},"Category":{"type":"string","description":"Attachment category (one of the subset of `ValidAttachmentCategoryList` in the `/claim/documents/retrieveRequirements` response)","examples":["SupportingDocumentation"]},"FileName":{"type":"string","description":"Name of the file being passed in DocumentStream param","examples":["StatementOfDispute.pdf"]},"Label":{"type":"string","description":"User friendly attachment label","examples":["Statement of Dispute"]}}}]}}}}}}},"tags":["Attachments"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/reopenRequest":{"post":{"summary":"/claim/reopenRequest","operationId":"postClaimReopenRequest","description":"Use this endpoint to request a claim to be reopened","parameters":[],"responses":{"200":{"description":"Successful claim reopen request","content":{"application/json":{"schema":{"type":"object","properties":{"ConfirmationHeaderMessage":{"type":"string","description":"header message for customer content","example":"Reopen request message content"},"ConfirmationMessageMarkup":{"type":"string","description":"base64 encoded markup for confirmation letter","example":".sts-customercontent-table { border-collapse:collapse;"},"ConfirmationHeader":{"type":"string","description":"header/title for confirmation","example":"Reopen Request"},"Address":{"allOf":[{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}],"type":"object","description":"optional address details. returned if the selected correspondence\nchannel is mail\n","properties":{"Province":{"type":"string","description":"Mailing address province","example":"Saskatchewan"}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}}}}},"400":{"description":"Error reopening claim","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"reopenErrorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Error occurred while requesting reopen"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Reopen Error Response"},"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error21Example":{"value":{"StatusList":[{"Type":"Error","Message":"A request to reopen this dispute is already in progress.","Code":"21"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 21 response"}}}}},"500":{"description":"Server connection error","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","ReopenReason","TransactionList","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"ReopenReason":{"type":"string","description":"Reasoning for requesting the claim to be reopen","example":"Test reopen reason"},"ReopenNewInformation":{"type":"string","description":"Any new information about the disputes. Optional information the user can choose to provide.","example":"New information about the disputes"},"TransactionList":{"description":"List of transactions to reopen when calling `/claim/reopenRequest`","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}}}}}}},"tags":["Claim"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/withdrawRequest":{"post":{"summary":"/claim/withdrawRequest","operationId":"postClaimWithdrawRequest","description":"Use this endpoint to request a claim to be withdrawn","parameters":[],"responses":{"200":{"description":"Successful claim withdraw request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}},"properties":{"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response"}}}}},"400":{"description":"Error withdrawing claim","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"WithdrawErrorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Withdraw Request Error"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Withdraw Request Error Response"},"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"}}}}},"500":{"description":"Error withdraw claim request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","WithdrawalReason","TransactionList","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2408050075C"},"WithdrawalReason":{"type":"string","description":"Reason for claim to be withdrawn","example":"Test reason for withdrawal"},"TransactionList":{"type":"array","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}},"description":"List of transactions to be withdrawn"}}}}}},"tags":["Claim"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/list":{"post":{"summary":"/claim/list","operationId":"postClaimList","description":"Use this endpoint to get a list of claims for the provided search parameters \n\nYou must pass only one of these fields: `customerId`, `accountNumber`, `claimId`.","parameters":[],"responses":{"200":{"description":"Successful claim list request","content":{"application/json":{"schema":{"type":"object","properties":{"claimListResponse":{"type":"array","items":{"type":"object","properties":{"accountHolder":{"type":"string","description":"Account Holder"},"requiredDocumentCount":{"type":"number","description":"Number of document required on this claim"},"customerContactDate":{"type":"string","format":"Date-Time","description":"Customer Contact Date

Format:yyyyMMdd"},"claimId":{"type":"string","description":"Unique claim ID"},"accountNumber":{"type":"string","description":"Account Number"},"claimStatus":{"type":"string","description":"Status of the Claim, see Status Values"},"createName":{"type":"string","description":"Who created the claim"},"accountType":{"type":"string","description":"Type of account"},"customerId":{"type":"string","description":"Customer ID","example":25945893},"externalCaseId":{"type":"string","description":"Optional ID representing claim identifier external to this dispute system (client internal identifier)"},"isClaimSubmitted":{"type":"boolean","description":"If the claim has been submitted or not"},"totalClaimAmount":{"type":"number","description":"The sum of all disputed transaction amounts"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"claimListResponse":[{"accountHolder":"William James Murray","requiredDocumentCount":0,"customerContactDate":"20271005T000000.000 GMT","claimId":"2110050013C","externalCaseId":"123456789","accountNumber":"4447111111117413","claimStatus":"Open-Execute","createName":"creat or","accountType":"Credit","customerId":"123456789","isClaimSubmitted":"true","totalClaimAmount":150.23}],"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"}}}}}},"400":{"description":"Error claim list request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"ClaimRetrieveErrorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Error Retrieving Claim List"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample retrieve claim list Error Response"},"error1Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid CustomerId","Code":"1"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 1 response"},"error2Example":{"value":{"StatusList":[{"Type":"Error","Message":"CustomerId or AccountNumber returned no claims","Code":"2"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 2 response"},"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error18Example":{"value":{"StatusList":[{"Type":"Error","Message":"AccountNumber is not found","Code":"18"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 18 response"}}}}},"500":{"description":"Error claim list request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"daysToLookBack":{"type":"number","description":"Days prior to search for claims.\nREQUIRED","example":30},"customerId":{"type":"string","description":"Customer ID to search for claims for.\nPass the same value as `accountNumber`. Exactly one of `customerId`, `accountNumber`, or `claimId` is required \nPattern: `P{prog_id}|{prn}`\nExample: `P123|123456789012`","example":"P123|123456789012"},"accountNumber":{"type":"string","description":"Account number to search for claims for. Exactly one of `customerId`, `accountNumber`, or `claimId` is required.\nPattern: `P{prog_id}|{prn}`\nExample: `P123|123456789012`","example":"P123|123456789012"},"claimId":{"type":"string","description":"Specific Claim ID to search for\n\nExactly one of `customerId`, `accountNumber`, or `claimId` is **required**","example":"2503040008C"}},"required":["transactionId","providerId"]}}}},"tags":["Claim"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/details/retrieve":{"post":{"summary":"/claim/details/retrieve","operationId":"postClaimDetailsRetrieve","description":"Use this endpoint to get claim details\n\n> 📘 Note\n>\n> This endpoint may return different data depending on the value of `profile-type`. See Profile Type Differences for details.","parameters":[],"responses":{"200":{"description":"Successful claim details retrieve request","content":{"application/json":{"schema":{"type":"object","properties":{"Questionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"DisputeReasonQuestionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"QuestionnaireExt":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"Questionnaire":{"QuestionList":[{"QuestionList":[{"Type":"Date","Identifier":"CardLSDate","DisplayText":"When did you lose your card?","DataType":"Date","SelectedAnswer":"20270802"},{"QuestionList":[{"Type":"Nothing","Identifier":"","DisplayText":"Where did you lose your card?","DataType":"String"},{"Type":"Dropdown","Identifier":"LostStolenArea","DisplayText":"Area","DataType":"String","SelectedAnswer":"Store"},{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"Text","Identifier":"LostStolenLocation","DisplayText":"Additional details","DataType":"String"}],"Identifier":"Yes","DisplayText":"Yes"},{"Identifier":"No","DisplayText":"No"}],"Identifier":"HasAdditionalDetails","DisplayText":"Do you have additional details about where your card was lost?","DataType":"String","SelectedAnswer":"No"},{"Type":"AutoComplete","AnswerList":[{"QuestionList":[{"Type":"Dropdown","Identifier":"LostStolenState","DisplayText":"State","DataType":"String","SelectedAnswer":"GA"}],"Identifier":"United States of America","DisplayText":"US"}],"Identifier":"LostStolenCountry","DisplayText":"Country","DataType":"String","SelectedAnswer":"United States of America"}],"Type":"Questionnaire","Identifier":"LostStolenLocationQn","DisplayText":"","DataType":"String"},{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"TextMulti","Identifier":"AnythingElseDetails","DisplayText":"Please provide additional details on what else was lost.","DataType":"String"}],"Identifier":"Yes","DisplayText":"Yes"},{"Identifier":"No","DisplayText":"No"}],"Identifier":"AnythingElseInd","DisplayText":"Was anything else lost?","DataType":"String","SelectedAnswer":"No"}],"Type":"Questionnaire","Identifier":"CardLostDetails","DisplayText":"","DataType":"String"}],"Type":"Nothing","Identifier":"","Format":"Caption","DisplayText":"I lost my card.","DataType":"String"},"QuestionnaireExt":{"QuestionList":[{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"TextMulti","Identifier":"AddlInfoDetails","DisplayText":"Please provide any additional information.","DataType":"String"}],"Identifier":"Yes","DisplayText":"Yes"},{"Identifier":"No","DisplayText":"No"}],"Identifier":"AddlInfo","DisplayText":"Do you have any additional information to provide about this dispute?","DataType":"String","SelectedAnswer":"No"}]},"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"}}}}}},"400":{"description":"Error claim details retrieve request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"ClaimRetrieveErrorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Error Retrieving Claim Details"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample retrieve claim details Error Response"},"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"}}}}},"500":{"description":"Error claim details retrieve request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","example":"2503040008C"}}}}}},"tags":["Claim"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/documents/retrieveRequirements":{"post":{"summary":"/claim/documents/retrieveRequirements","operationId":"postRetrieveRequirements","description":"Use this endpoint to retrieve required documentation information about an existing claim","parameters":[],"responses":{"200":{"description":"Successful document requirement retrieval","content":{"application/json":{"schema":{"type":"object","properties":{"DocumentRequirementList":{"type":"array","description":"List of document requirements that must be added to the claim.","items":{"allOf":[{"type":"object","properties":{"TemplateDocumentStream":{"type":"string","description":"Byte stream of the template form pdf","example":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"},"IsSatisified":{"type":"boolean","description":"Has this document requirement been satisfied?","example":false},"Identifier":{"type":"string","description":"Document requirement identifier","example":"StatementOfDispute"},"IsRequired":{"type":"boolean","description":"Is this document required?","example":true},"Label":{"type":"string","description":"A user friendly label of the document requirement","example":"Statement of Dispute"},"ValidAttachmentCategoryList":{"type":"array","items":{"type":"object","properties":{"Key":{"type":"string","description":"Key value, this is what is passed back in with the add document request","example":"SupportingDocumentation"},"Value":{"type":"string","description":"User friendly display value","example":"Supporting Documentation"}}}}}}],"type":"object","properties":{"WasDocumentReceived":{"type":"boolean","description":"was the document received"},"IsDocumentPendingReview":{"type":"boolean","description":"it the document pending review"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"success - with requirements":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"DocumentRequirementList":[{"TemplateDocumentStream":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTc1Cj4+CnN0cmVolJUVPRgo=","IsSatisfied":false,"Identifier":"StatementOfDispute","IsRequired":true,"WasDocumentReceived":true,"IsDocumentPendingReview":true,"Label":"Statement of Dispute","ValidAttachmentCategoryList":[{"Value":"Accountholder","Key":"Accountholder"},{"Value":"Supporting Documentation","Key":"SupportingDocumentation"}]}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response with document requirements"},"success - no requirements":{"value":{"StatusList":[{"Type":"Success","Message":"No documents are required for this case","Code":"201"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response with no document requirements"}}}}},"400":{"description":"Error claim document requirement retrieval request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"}}}}},"500":{"description":"Error claim document requirement details retrieve request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"tags":["Documents"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/documents/add":{"post":{"summary":"/claim/documents/add","operationId":"postClaimDocumentsAdd","description":"Use this endpoint to add a required document to an existing claim","parameters":[],"responses":{"200":{"description":"Successful document add","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}}}}},"400":{"description":"Error claim document add request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"ClaimAddDocumentErrorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Error Adding Document to Claim","summary":"A sample add document Error Response"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"}}}}}},"500":{"description":"Error claim recovery details retrieve request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","example":"2501240026C"},"DocumentRequirementList":{"type":"array","items":{"type":"object","properties":{"DocumentStream":{"type":"string","description":"Document content stream","example":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTc0Cj4+CnN0cmVhbQp42t1YbXPaOBD+jH/FztzdT"},"Identifier":{"type":"string","description":"ID of document requirement to be fulfilled. Identifier is returned in /claim/documents/retrieveRequirements","example":"ProofOfPayment"},"Category":{"type":"string","description":"category of the document","example":"SupportingDocumentation","enum":["Accountholder","Association","Internal","SupportingDocumentation"]},"FileName":{"type":"string","description":"Name of the file being attached","example":"ProofOfPayment.pdf"},"Label":{"type":"string","description":"Label for the document being added","example":"Proof Of Payment"}}}}},"required":["transactionId","providerId"]}}}},"tags":["Documents"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/create":{"post":{"summary":"/claim/intake/create","description":"Use this endpoint to create a new claim in the dispute system.\n\nA claim is a unit of work that will contain one or more specific transaction disputes. The API is called by passing in key information required to create a shell claim.","operationId":"postClaimCreate","parameters":[],"responses":{"200":{"description":"Successful claim initiation request","content":{"application/json":{"schema":{"type":"object","properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"ClaimId":"2108160022C","StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success create response"}}}}},"400":{"description":"Error claim initiation request","content":{"application/json":{"schema":{"type":"object","properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error1Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid CustomerId","Code":"1"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 1 response"},"error2Example":{"value":{"StatusList":[{"Type":"Error","Message":"CustomerId or AccountNumber returned no claims","Code":"2"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 2 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"postRequestError":{"value":{"StatusList":[{"Type":"Error","Message":"Error creating Claim: {message}","Code":"3"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Claim creation error"}}}}},"500":{"description":"Error claim initiation request","content":{"application/json":{"schema":{"type":"object","properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["CustomerId","AccountNumber"],"properties":{"CustomerId":{"type":"string","description":"Customer ID to create the claim for. Pass the same value as `AccountNumber`. \nPattern: `P{prog_id}|{prn}`\nExample: `P123|123456789012`","example":"P123|123456789012"},"AccountNumber":{"type":"string","description":"Account number of the disputed transaction(s). Combine your `prog_id` with the <>.\nPattern: `P{prog_id}|{prn}`\nExample: `P123|123456789012`","example":"P123|123456789012"}}}],"required":["transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"CustomerId":{"type":"string","description":"Customer ID to create the claim for. Pass the same value as `AccountNumber`. \nPattern: `P{prog_id}|{prn}`\nExample: `P123|123456789012`","example":"P123|123456789012"},"AccountNumber":{"type":"string","description":"Account number of the disputed transaction(s). Combine your `prog_id` with the <>.\nPattern: `P{prog_id}|{prn}`\nExample: `P123|123456789012`","example":"P123|123456789012"}}}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/retrieveReasons":{"post":{"summary":"/claim/intake/retrieveReasons","description":"Use this endpoint to retrieve the reason questionnaire for a given claim ID.\n\nThese are questions to display so the user can classify the type and reason for the claim. Because the dispute system now knows the customer account type and user type, it will return the appropriate questions. \n\nThis first question drives the core type of dispute, which is one of the following five:\n\n1. I participated in this transaction, but there is a problem.\n\n2. I did not participate in this transaction, and I did not authorize anyone else to participate in this transaction.\n\n3. I had an issue while using my card at an ATM.\n\n4. There is an issue with a convenience check.\n\n5. There is an issue with a balance transfer.\n\n6. The merchant failed to obtain valid authorization.\n\nThe next set of questions is based on the above answer, and is specific for each. This is a description of the reason for the type of claim.\n\nPrerequisite API calls:\n- `/claim/intake/create`\n\n> 📘 Note\n>\n> This endpoint may return different data depending on the value of `profile-type`. See Profile Type Differences for details.","operationId":"postRetrieveReasons","parameters":[],"responses":{"200":{"description":"Successful retrieve reasons request","content":{"application/json":{"schema":{"type":"object","properties":{"Questionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"Questionnaire":{"QuestionList":[{"Type":"RadioButtons","AnswerList":[{"QuestionList":[{"Type":"RadioButtons","AnswerList":[{"Identifier":"MerchantDuplicate","DisplayText":"I was charged more than once."},{"Identifier":"MerchantNotProvided","DisplayText":"I haven't received merchandise or a service I purchased."},{"Identifier":"MerchantCreditNotIssued","DisplayText":"I cancelled or returned the merchandise or service and have not received the expected credit."},{"Identifier":"MerchandiseServiceIssue","DisplayText":"I am dissatisfied with the merchandise or a service I received."},{"Identifier":"ChargedCreditedIncorrect","DisplayText":"I was charged or credited incorrectly."}],"Identifier":"ClaimReason","DisplayText":"Which of the following best describes the reason for your dispute?","DataType":"String"}],"Identifier":"NonFraud","DisplayText":"I made this purchase, but there is a problem and I need to dispute it."},{"QuestionList":[{"Type":"RadioButtons","AnswerList":[{"Identifier":"CardLost","DisplayText":"I lost my card."},{"Identifier":"CardStolen","DisplayText":"My card was stolen."},{"Identifier":"CardNotReceived","DisplayText":"I did not receive my card."},{"Identifier":"CardSecure","DisplayText":"I didn't make the purchase, but I still have my card."}],"Identifier":"ClaimReason","DisplayText":"Which of the following best describes the reason for your dispute?","DataType":"String"}],"Identifier":"Fraud","DisplayText":"I did not authorize this transaction. I suspect fraud."},{"Identifier":"AuthChargeback","DisplayText":"There is an authorization issue."}],"Identifier":"ClaimReasonType","DisplayText":"Which of the following would you like to report?","DataType":"String"}],"Identifier":"DisputeReasonCard"},"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response"}}}}},"400":{"description":"Error retrieve reasons request","content":{"application/json":{"schema":{"type":"object","properties":{"Questionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error6Example":{"value":{"StatusList":[{"Type":"Error","Message":"Error saving claim: {message}","Code":"6"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 6 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error15Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim is already resolved with status: {message}","Code":"15"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 15 response"},"error16Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim has been submitted for processing and this action can no longer be performed","Code":"16"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 16 response"}}}}},"500":{"description":"Error retrieve reasons request","content":{"application/json":{"schema":{"type":"object","properties":{"Questionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/addClaimReasons":{"post":{"summary":"/claim/intake/addClaimReasons","description":"Use this endpoint to submit answers to the claim type and reason questionnaire received from the `/claim/intake/retrieveReasons` endpoint.\n\nPrerequisite API call:\n- `/claim/intake/create`","operationId":"postClaimReasonsAdd","parameters":[],"responses":{"200":{"description":"Successful add reasons request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response"}}}}},"400":{"description":"Error retrieve reasons request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error7Example":{"value":{"StatusList":[{"Type":"Error","Message":"Case not resumed due to incomplete questionnaire, message: {message}","Code":"7"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 7 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error15Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim is already resolved with status: {message}","Code":"15"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 15 response"},"error16Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim has been submitted for processing and this action can no longer be performed","Code":"16"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 16 response"}}}}},"500":{"description":"Error retrieve reasons request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["Questionnaire"],"properties":{"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}],"required":["ClaimId","Questionnaire","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","examples":["2108160022C"]},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}},"example":{"ClaimId":"2108160022C","Questionnaire":{"QuestionList":[{"Identifier":"ClaimTransType","AnswerValue":"true"},{"Identifier":"ClaimReasonType","AnswerValue":"Fraud"},{"Identifier":"ClaimReason","AnswerValue":"CardSecure"}]},"providerId":9999,"transactionId":"984513-395483653-4483483478"}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/retrieveTransactions":{"post":{"summary":"/claim/intake/retrieveTransactions","description":"Use this endpoint to retrieve transactions that can be selected to add to the claim. Using the customer ID, account number, and submitted claim reasons to retrieve valid transactions.\n\nA default date range is built into the dispute system, so most inputs are optional.\n\nThis API can be called multiple times if ad-hoc searching\nis being performed.\n\nPrerequisite API call: \n- `/claim/intake/addClaimReasons`","operationId":"postRetrieveTransactions","parameters":[],"responses":{"200":{"description":"postRetrieveTransactions","content":{"application/json":{"schema":{"type":"object","properties":{"TransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"TransactionList":[{"AuthorizationStatus":"Pending","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3 (10.1)","Amount":"99.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":99.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270627","PostingDateTime":"20270627T130621.123 GMT","TransactionDateTime":"20270627T130621.123 GMT","SelectMode":"Multi","TransactionId":"5"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"ATMWD","Description":"7-ELEVEN 22177 (CHIP)","Amount":"27.50","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":27.5,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270626","TransactionDateTime":"20270625T130621.123 GMT","PostingDateTime":"20270626T050000.000 GMT","SelectMode":"Multi","TransactionId":"460268821703314"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3 (10.1)","Amount":"30.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270624","TransactionDateTime":"20270623T130621.123 GMT","PostingDateTime":"20270624T050000.000 GMT","SelectMode":"Multi","TransactionId":"5"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"CRUNCH BELLE ISLE (10.3)","Amount":"26.57","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":26.57,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270617","TransactionDateTime":"20270616T130621.123 GMT","PostingDateTime":"20270617T050000.000 GMT","SelectMode":"Multi","TransactionId":"8"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"Chargeback Response E-900000049","Amount":"98.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":98.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270611","TransactionDateTime":"20270610T130621.123 GMT","PostingDateTime":"20270611T050000.000 GMT","SelectMode":"Multi","TransactionId":"13"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM (10.4)","Amount":"39.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":39.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270602","TransactionDateTime":"20270601T130621.123 GMT","PostingDateTime":"20270602T050000.000 GMT","SelectMode":"Multi","TransactionId":"3"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM2","Amount":"39.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":39.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270602","TransactionDateTime":"20270601T130621.123 GMT","PostingDateTime":"20270602T050000.000 GMT","SelectMode":"Multi","TransactionId":"4"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BASECAMP FITNESS (10.1)","Amount":"79.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":79.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270408","TransactionDateTime":"20270407T130621.123 GMT","PostingDateTime":"20270408T050000.000 GMT","SelectMode":"Multi","TransactionId":"2"},{"AuthorizationStatus":"Pending","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3","Amount":"30.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20201123","TransactionDateTime":"20201123T130621.123 GMT","PostingDateTime":"20201123T050000.000 GMT","SelectMode":"Multi","TransactionId":"10"},{"AuthorizationStatus":"Posted","DebitCredit":"Credit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"91.74","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":91.74,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20201115","TransactionDateTime":"20201115T130621.123 GMT","PostingDateTime":"20201115T050000.000 GMT","SelectMode":"Multi","TransactionId":"11"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"91.74","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":91.74,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7411","Date":"20200615","TransactionDateTime":"20200615T130621.123 GMT","PostingDateTime":"20200615T050000.000 GMT","SelectMode":"Multi","TransactionId":"6"},{"AuthorizationStatus":"Posted","DebitCredit":"Credit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"30","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20200615","TransactionDateTime":"20200615T130621.123 GMT","PostingDateTime":"20200615T050000.000 GMT","SelectMode":"Multi","TransactionId":"7"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4) 2","Amount":"91.74","CardNumberEndingIn":"7413","Date":"20200612","TransactionDateTime":"20200611T130621.123 GMT","PostingDateTime":"20200612T050000.000 GMT","SelectMode":"Multi","TransactionId":"12"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response"}}}}},"202":{"description":"Transaction Selection Unavailable

This is a response for claim types that do not support transaction selection. This is configurable by the client, but by default the dispute system will set this to true for ClaimReasons **ATMDepNotPosted, FraudApp, MerchantNonReceiptFunds, NonFraudMissing**.","content":{"application/json":{"schema":{"type":"object","properties":{"TransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Transaction identification is unavailable for this claim.","Code":"202"}],"rtoken":"984513-395483653-4483483478","StatusCode":"202"},"summary":"A sample Success response"}}}}},"203":{"description":"Transaction Selection Optional

This is configurable by the client, but by default the dispute system will set this to true for (Card Claims ClaimReason **ATMDep**) or ClaimReason **ATMDepNotPosted** or (Deposit Claims and ClaimReasonTypes **NonFraud, NonFraudMissing, NonFraudRevoked**) or ClaimReasonTypes **AuthChargeback, FraudAccountIssue**.","content":{"application/json":{"schema":{"type":"object","properties":{"TransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Transaction identification is optional for this claim.","Code":"203"}],"TransactionList":[{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"ATMWD","Description":"7-ELEVEN 22177 (CHIP)","Amount":"27.50","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":27.5,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270626","TransactionId":"460268821703314"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3 (10.1)","Amount":"30.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270624","TransactionId":"5"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"CRUNCH BELLE ISLE (10.3)","Amount":"26.57","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":26.57,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270617","TransactionId":"8"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"Chargeback Response E-900000049","Amount":"98.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":98.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270611","TransactionId":"13"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM (10.4)","Amount":"39.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":39.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270602","TransactionId":"3"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM2","Amount":"39.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":39.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270602","TransactionId":"4"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BASECAMP FITNESS (10.1)","Amount":"79.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":79.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270408","TransactionId":"2"},{"AuthorizationStatus":"Pending","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3","Amount":"30.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20201123","TransactionId":"10"},{"AuthorizationStatus":"Posted","DebitCredit":"Credit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"91.74","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":91.74,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20201115","TransactionId":"11"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"91.74","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":91.74,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7411","Date":"20200615","TransactionId":"6"},{"AuthorizationStatus":"Posted","DebitCredit":"Credit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"30","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20200615","TransactionId":"7"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4) 2","Amount":"91.74","CardNumberEndingIn":"7413","Date":"20200612","TransactionId":"12"}],"rtoken":"984513-395483653-4483483478","StatusCode":"203"},"summary":"A sample Success response"}}}}},"400":{"description":"Error retrieve transactions request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error6Example":{"value":{"StatusList":[{"Type":"Error","Message":"Error saving claim: {message}","Code":"6"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 6 response"},"error8Example":{"value":{"StatusList":[{"Type":"Error","Message":"Problem validating search criteria: {message}","Code":"8"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 8 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error15Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim is already resolved with status: {message}","Code":"15"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 15 response"},"error16Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim has been submitted for processing and this action can no longer be performed","Code":"16"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 16 response"}}}}},"500":{"description":"Error retrieve transactions request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"SearchAccountNumber":{"type":"number","description":"Account number for searching for transactions that are on a different account than the claim.\n\n**Required** only if the user needs to add transactions to the claim that are on a different account than the claim's disputed transactions."},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20200601},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20210812},"SearchAmount":{"type":"string","description":"Transaction amount to search for.\n\n**Required** only if the user is searching for a transaction with a specific amount.","example":2.09},"SearchMerchantName":{"type":"string","description":"Merchant name/Transaction description to search for.\n\n**Required** only if the user is searching for a transaction with a specific merchant","example":"Amazon"}}}],"required":["ClaimId","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}},"example":{"ClaimId":"2108160022C","SearchStartDate":"20270401","SearchEndDate":"20270512","SearchAmount":"2.09","SearchMerchantName":"Amazon","providerId":9999,"transactionId":"984513-395483653-4483483478"}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/addTransactions":{"post":{"summary":"/claim/intake/addTransactions","description":"Use this endpoint to add transactions to a new claim.\n\nMultiple transactions can be added.\n\nPrerequisite API call:\n\n- `/claim/intake/addClaimReasons`\n- `/claim/intake/retrieveTransactions`","operationId":"postClaimTransactionsAdd","parameters":[],"responses":{"200":{"description":"postAddTransactions","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response"}}}}},"400":{"description":"Error add transactions request","content":{"application/json":{"schema":{"type":"object","properties":{"TransactionList":{"type":"array","items":{"type":"object","properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","example":460268821703314},"NonDisputableMessageDetails":{"type":"string","description":"an error associated with a specific transaction","example":"Credits are not disputable for this claim reason"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error6Example":{"value":{"StatusList":[{"Type":"Error","Message":"Error saving claim: {message}","Code":"6"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 6 response"},"error9Example":{"value":{"StatusList":[{"Type":"Error","Message":"Unable to resume flow: {message}","Code":"9"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 9 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error15Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim is already resolved with status: {message}","Code":"15"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 15 response"},"error16Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim has been submitted for processing and this action can no longer be performed","Code":"16"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 16 response"}}}}},"500":{"description":"Error add transactions request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["TransactionList"],"properties":{"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}}}}],"required":["ClaimId","TransactionList","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}},"TransactionSearchStartDate":{"description":"Start date for the search to build the transaction list.","type":"string","format":"Date","example":20241101},"TransactionSearchEndDate":{"description":"End date for the search to build the transaction list.","type":"string","format":"Date","example":20241130}}},"example":{"ClaimId":"2108160022C","TransactionList":[{"TransactionId":"6"},{"TransactionId":"11"}],"TransactionSearchStartDate":"20241101","TransactionSearchEndDate":"20241131","providerId":9999,"transactionId":"984513-395483653-4483483478"}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/retrieveQuestionnaire":{"post":{"summary":"/claim/intake/retrieveQuestionnaire","description":"This API retrieves the questionnaire for a given claim so it can be displayed and acted upon by the intended user interface.\n\nPrerequisite API call:\n- `/claim/intake/addTransactions`\n\n> 📘 Note\n>\n> This endpoint may return different data depending on the value of `profile-type`. See Profile Type Differences for details.","operationId":"postRetrieveQuestionnaire","parameters":[],"responses":{"200":{"description":"Successful retrieve questionnaire request","content":{"application/json":{"schema":{"type":"object","properties":{"Questionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"PostQuestionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"TransactionDetails":{"type":"object","description":"Details about the selected transaction to display to the user.","properties":{"SummaryHeader":{"type":"string","description":"Posted Transaction Details header"},"SelectedPostedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"PendingSummaryHeader":{"type":"string","description":"Pending Transaction Details header"},"SelectedPendingTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"RecurringSummaryHeader":{"type":"string","description":"Recurring Transaction Details header"},"SelectedRecurringTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"DeflectedSummaryHeader":{"type":"string","description":"Deflected Transaction Details header"},"DeflectedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"Questionnaire":{"QuestionList":[{"QuestionList":[{"QuestionList":[{"QuestionList":[{"Type":"YesNo","AnswerList":[{"Identifier":"Yes","DisplayText":"Yes"},{"QuestionList":[{"Type":"Text","Identifier":"CardLocation","DisplayText":"Where is the card usually kept?","DataType":"String"},{"Type":"Text","Identifier":"CardNoPossession","DisplayText":"In what circumstances do you not have the card in your possession?","DataType":"String"}],"Identifier":"No","DisplayText":"No"}],"Identifier":"CardPossessionInd","DisplayText":"Do you always have possession of the card?","DataType":"String"},{"QuestionList":[{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"Text","Identifier":"AuthorizedName","DisplayText":"Who has authorization to use your card?","DataType":"String"}],"Identifier":"Yes","DisplayText":"Yes"},{"Identifier":"No","DisplayText":"No"}],"Identifier":"HasAuthorizedOthers","DisplayText":"Have you ever authorized another person to use your card?","DataType":"String"},{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"Text","Identifier":"SharedPINName","DisplayText":"Who did you share it with?","DataType":"String"}],"Identifier":"Yes","DisplayText":"Yes"},{"Identifier":"No","DisplayText":"No"}],"Identifier":"HasSharedPIN","DisplayText":"Have you ever shared your Personal Identification Number (PIN)?","DataType":"String"},{"QuestionList":[{"QuestionList":[{"Type":"Nothing","Identifier":"","DisplayText":"","DataType":"String"}],"Type":"Questionnaire","Identifier":"BlockAndReissueCard","DisplayText":"","DataType":"String"}],"Type":"Questionnaire","Identifier":"WherePinIsKept","DisplayText":"","DataType":"String"}],"Type":"Questionnaire","Identifier":"vsq1","DisplayText":"","DataType":"String"}],"Type":"Questionnaire","Identifier":"CardPossession","DisplayText":"","DataType":"String"}],"Type":"Section","AnswerList":[{"QuestionList":[{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"Nothing","Identifier":"","DisplayText":"Custom Section","DataType":"String"}],"Identifier":"Yes","DisplayText":"Yes"},{"Identifier":"No","DisplayText":"No"}],"Identifier":"RecognizeDisputedMerchant","DisplayText":"Is it possible that this is a planned, recurring transaction, such as a monthly or yearly subscription?","DataType":"String"}],"Identifier":"RecognizesMerchant","DisplayText":""},{"Identifier":"DoesNotRecognize","DisplayText":""}],"Identifier":"EverDoneBusiness","DisplayText":"Have you ever done business with any of these disputed merchants?","DataType":"String","APIDocumentationList":[{"ImplementationNotes":"If any selected transactions contain merchants that the customer recognizes, they can be identified with this method. In addition the answer to this question should be identified as 'RecognizesMerchant'. If the customer does not recognize any merchants, this question can be answered with 'DoesNotRecognize'.","Endpoint":"/claim/intake/recognizeDisputedTransactions","Method":"post"}]}],"Type":"Nothing","Identifier":"","DisplayText":"“I didn't make the purchase, but I still have my card.”","DataType":"String"}],"Identifier":"FraudCardSecure"},"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"PostQuestionnaire":{"QuestionList":[{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"TextMulti","Identifier":"AddlInfoDetails","DisplayText":"Please provide any additional information","DataType":"String"}],"Identifier":"Yes","DisplayText":"Yes"},{"Identifier":"No","DisplayText":"No"}],"Identifier":"AddlInfo","DisplayText":"Do you have any additional information to provide about this dispute?","DataType":"String"}],"Identifier":"SoFi Tech Solutions_Extensions_PostQns"},"TransactionDetails":{"SummaryHeader":"","SelectedPostedTransactionList":[{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM2","Amount":"39.99","CardNumberEndingIn":"7413","Date":"20270602","TransactionId":"4"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BASECAMP FITNESS (10.1)","Amount":"79.99","CardNumberEndingIn":"7413","Date":"20270408","TransactionId":"2"}]},"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response"}}}}},"400":{"description":"Error retrieve questionnaire request","content":{"application/json":{"schema":{"type":"object","properties":{"Questionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"PostQuestionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"TransactionDetails":{"type":"object","description":"Details about the selected transaction to display to the user.","properties":{"SummaryHeader":{"type":"string","description":"Posted Transaction Details header"},"SelectedPostedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"PendingSummaryHeader":{"type":"string","description":"Pending Transaction Details header"},"SelectedPendingTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"RecurringSummaryHeader":{"type":"string","description":"Recurring Transaction Details header"},"SelectedRecurringTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"DeflectedSummaryHeader":{"type":"string","description":"Deflected Transaction Details header"},"DeflectedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error6Example":{"value":{"StatusList":[{"Type":"Error","Message":"Error saving claim: {message}","Code":"6"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 6 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error15Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim is already resolved with status: {message}","Code":"15"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 15 response"},"error16Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim has been submitted for processing and this action can no longer be performed","Code":"16"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 16 response"}}}}},"500":{"description":"Error retrieve questionnaire request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/retrieveOtherAccounts":{"post":{"summary":"/claim/intake/retrieveOtherAccounts","description":"Use this endpoint to get a list of other accounts for this customer.\n\nMust call `/claim/intake/retrieveQuestionnaire` with a question response indicating in `APIDocumentationList` that this method is required\n\nThis call is required when the claim reason is merchant duplicate and the user has indicated that the duplicate transaction is on a different account than the disputed transaction\n\nPrerequisite API call:\n- `/claim/intake/retrieveQuestionnaire`","operationId":"postRetrieveOtherAccounts","parameters":[],"responses":{"200":{"description":"postRetrieveOtherAccounts","content":{"application/json":{"schema":{"type":"object","properties":{"AccountList":{"type":"array","items":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"Account Number","examples":[5555555555554445]},"Balance":{"type":"string","description":"Balance on the account","examples":[701.12]},"Description":{"type":"string","description":"Account description","examples":["Mastercard Rewards"]},"OpenDate":{"type":"string","description":"Date the account was opened.

Format:yyyyMMdd","examples":[20200701]}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"AccountList":[{"Description":"Mastercard Rewards","OpenDate":"20200701","Balance":702.12,"AccountNumber":"5555555555554444"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"}}}}}},"400":{"description":"Error retrieve other accounts request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error2Example":{"value":{"StatusList":[{"Type":"Error","Message":"CustomerId or AccountNumber returned no claims","Code":"2"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 2 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error6Example":{"value":{"StatusList":[{"Type":"Error","Message":"Error saving claim: {message}","Code":"6"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 6 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error15Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim is already resolved with status: {message}","Code":"15"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 15 response"},"error16Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim has been submitted for processing and this action can no longer be performed","Code":"16"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 16 response"}}}}},"500":{"description":"Error retrieve other accounts request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/retrieveCreditTransactions":{"post":{"summary":"/claim/intake/retrieveCreditTransactions","description":"Use this endpoint to retrieve credit transactions that can be selected to add to the claim. \n\nGets list of credits within date range for claim. Optional search params can also be provided for searching for a specific credit transaction. This call is required when the claim reason is credit not issued and the user has indicated partial credit was issued.\n\nRequires a question response indicating in `APIDocumentationList` that this method is required\n\nPrerequisite API call:\n- `/claim/intake/retrieveQuestionnaire`","operationId":"postRetrieveCreditTransactions","parameters":[],"responses":{"200":{"description":"postRetrieveCreditTransactions","content":{"application/json":{"schema":{"type":"object","properties":{"TransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"TransactionList":[{"AuthorizationStatus":"Pending","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3 (10.1)","Amount":"99.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":99.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270627","PostingDateTime":"20270627T130621.123 GMT","TransactionDateTime":"20270627T130621.123 GMT","SelectMode":"Multi","TransactionId":"5"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"ATMWD","Description":"7-ELEVEN 22177 (CHIP)","Amount":"27.50","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":27.5,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270626","TransactionDateTime":"20270625T130621.123 GMT","PostingDateTime":"20270626T050000.000 GMT","SelectMode":"Multi","TransactionId":"460268821703314"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3 (10.1)","Amount":"30.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270624","TransactionDateTime":"20270623T130621.123 GMT","PostingDateTime":"20270624T050000.000 GMT","SelectMode":"Multi","TransactionId":"5"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"CRUNCH BELLE ISLE (10.3)","Amount":"26.57","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":26.57,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270617","TransactionDateTime":"20270616T130621.123 GMT","PostingDateTime":"20270617T050000.000 GMT","SelectMode":"Multi","TransactionId":"8"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"Chargeback Response E-900000049","Amount":"98.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":98.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270611","TransactionDateTime":"20270610T130621.123 GMT","PostingDateTime":"20270611T050000.000 GMT","SelectMode":"Multi","TransactionId":"13"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM (10.4)","Amount":"39.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":39.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270602","TransactionDateTime":"20270601T130621.123 GMT","PostingDateTime":"20270602T050000.000 GMT","SelectMode":"Multi","TransactionId":"3"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM2","Amount":"39.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":39.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270602","TransactionDateTime":"20270601T130621.123 GMT","PostingDateTime":"20270602T050000.000 GMT","SelectMode":"Multi","TransactionId":"4"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BASECAMP FITNESS (10.1)","Amount":"79.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":79.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270408","TransactionDateTime":"20270407T130621.123 GMT","PostingDateTime":"20270408T050000.000 GMT","SelectMode":"Multi","TransactionId":"2"},{"AuthorizationStatus":"Pending","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3","Amount":"30.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20201123","TransactionDateTime":"20201123T130621.123 GMT","PostingDateTime":"20201123T050000.000 GMT","SelectMode":"Multi","TransactionId":"10"},{"AuthorizationStatus":"Posted","DebitCredit":"Credit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"91.74","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":91.74,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20201115","TransactionDateTime":"20201115T130621.123 GMT","PostingDateTime":"20201115T050000.000 GMT","SelectMode":"Multi","TransactionId":"11"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"91.74","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":91.74,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7411","Date":"20200615","TransactionDateTime":"20200615T130621.123 GMT","PostingDateTime":"20200615T050000.000 GMT","SelectMode":"Multi","TransactionId":"6"},{"AuthorizationStatus":"Posted","DebitCredit":"Credit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"30","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20200615","TransactionDateTime":"20200615T130621.123 GMT","PostingDateTime":"20200615T050000.000 GMT","SelectMode":"Multi","TransactionId":"7"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4) 2","Amount":"91.74","CardNumberEndingIn":"7413","Date":"20200612","TransactionDateTime":"20200611T130621.123 GMT","PostingDateTime":"20200612T050000.000 GMT","SelectMode":"Multi","TransactionId":"12"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response"}}}}},"400":{"description":"Error retrieve credit transactions request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error6Example":{"value":{"StatusList":[{"Type":"Error","Message":"Error saving claim: {message}","Code":"6"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 6 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error15Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim is already resolved with status: {message}","Code":"15"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 15 response"},"error16Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim has been submitted for processing and this action can no longer be performed","Code":"16"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 16 response"}}}}},"500":{"description":"Error retrieve credit transactions request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","examples":[20200601]},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","examples":[20210812]}}}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/retrieveSimilarTransactions":{"post":{"summary":"/claim/intake/retrieveSimilarTransactions","description":"Use this endpoint to get a list of similar transactions within search criteria that can be selected to add to the claim.\n\n`SearchAccountNumber` is **required** if the customer identified that the transaction was on a different account than the claim. Get other valid account numbers by calling `/claim/intake/retrieveOtherAccounts`.\n\nRequires a question response indicating in `APIDocumentationList` that this method is required.\n\nPrerequisite API call:\n- `/claim/intake/retrieveQuestionnaire`","operationId":"postRetrieveSimilarTransactions","parameters":[],"responses":{"200":{"description":"postRetrieveSimilarTransactions","content":{"application/json":{"schema":{"type":"object","properties":{"TransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"TransactionList":[{"AuthorizationStatus":"Pending","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3 (10.1)","Amount":"99.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":99.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270627","PostingDateTime":"20270627T130621.123 GMT","TransactionDateTime":"20270627T130621.123 GMT","SelectMode":"Multi","TransactionId":"5"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"ATMWD","Description":"7-ELEVEN 22177 (CHIP)","Amount":"27.50","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":27.5,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270626","TransactionDateTime":"20270625T130621.123 GMT","PostingDateTime":"20270626T050000.000 GMT","SelectMode":"Multi","TransactionId":"460268821703314"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3 (10.1)","Amount":"30.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270624","TransactionDateTime":"20270623T130621.123 GMT","PostingDateTime":"20270624T050000.000 GMT","SelectMode":"Multi","TransactionId":"5"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"CRUNCH BELLE ISLE (10.3)","Amount":"26.57","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":26.57,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270617","TransactionDateTime":"20270616T130621.123 GMT","PostingDateTime":"20270617T050000.000 GMT","SelectMode":"Multi","TransactionId":"8"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"Chargeback Response E-900000049","Amount":"98.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":98.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270611","TransactionDateTime":"20270610T130621.123 GMT","PostingDateTime":"20270611T050000.000 GMT","SelectMode":"Multi","TransactionId":"13"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM (10.4)","Amount":"39.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":39.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270602","TransactionDateTime":"20270601T130621.123 GMT","PostingDateTime":"20270602T050000.000 GMT","SelectMode":"Multi","TransactionId":"3"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM2","Amount":"39.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":39.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270602","TransactionDateTime":"20270601T130621.123 GMT","PostingDateTime":"20270602T050000.000 GMT","SelectMode":"Multi","TransactionId":"4"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BASECAMP FITNESS (10.1)","Amount":"79.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":79.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270408","TransactionDateTime":"20270407T130621.123 GMT","PostingDateTime":"20270408T050000.000 GMT","SelectMode":"Multi","TransactionId":"2"},{"AuthorizationStatus":"Pending","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3","Amount":"30.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20201123","TransactionDateTime":"20201123T130621.123 GMT","PostingDateTime":"20201123T050000.000 GMT","SelectMode":"Multi","TransactionId":"10"},{"AuthorizationStatus":"Posted","DebitCredit":"Credit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"91.74","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":91.74,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20201115","TransactionDateTime":"20201115T130621.123 GMT","PostingDateTime":"20201115T050000.000 GMT","SelectMode":"Multi","TransactionId":"11"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"91.74","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":91.74,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7411","Date":"20200615","TransactionDateTime":"20200615T130621.123 GMT","PostingDateTime":"20200615T050000.000 GMT","SelectMode":"Multi","TransactionId":"6"},{"AuthorizationStatus":"Posted","DebitCredit":"Credit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"30","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20200615","TransactionDateTime":"20200615T130621.123 GMT","PostingDateTime":"20200615T050000.000 GMT","SelectMode":"Multi","TransactionId":"7"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4) 2","Amount":"91.74","CardNumberEndingIn":"7413","Date":"20200612","TransactionDateTime":"20200611T130621.123 GMT","PostingDateTime":"20200612T050000.000 GMT","SelectMode":"Multi","TransactionId":"12"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response"}}}}},"400":{"description":"Error retrieve similar transactions request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error6Example":{"value":{"StatusList":[{"Type":"Error","Message":"Error saving claim: {message}","Code":"6"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 6 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error15Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim is already resolved with status: {message}","Code":"15"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 15 response"},"error16Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim has been submitted for processing and this action can no longer be performed","Code":"16"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 16 response"}}}}},"500":{"description":"Error retrieve similar transactions request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"SearchAccountNumber":{"type":"string","description":"Account number to search for if different than selected account on claim\n\n**Required** only if the user is searching for a transaction on a different account than the account on the claim."},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20200601},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20210812},"SearchAmount":{"type":"string","description":"Transaction amount to search for.\n\n**Required** only if the user is searching for a transaction with a specific amount.","example":2.09},"SearchMerchantName":{"type":"string","description":"Merchant name/Transaction description to search for.\n\n**Required** only if the user is searching for a transaction with a specific merchant","example":"Amazon"}},"required":["ClaimId","transactionId","providerId"]}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/addSimilarTransactions":{"post":{"summary":"/claim/intake/addSimilarTransactions","description":"Use this endpoint to add selected duplicate transaction to claim.\n\nRequires a question response indicating in `APIDocumentationList` that this method is required\n\nPrerequisite API call:\n- `/claim/intake/retrieveQuestionnaire`","operationId":"postClaimTransactionsAddSimilar","parameters":[],"responses":{"200":{"description":"postClaimTransactionsAddSimilar","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response"}}}}},"400":{"description":"Error add similar transactions request","content":{"application/json":{"schema":{"type":"object","properties":{"TransactionList":{"type":"array","items":{"type":"object","properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","example":460268821703314},"NonDisputableMessageDetails":{"type":"string","description":"an error associated with a specific transaction","example":"Credits are not disputable for this claim reason"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error6Example":{"value":{"StatusList":[{"Type":"Error","Message":"Error saving claim: {message}","Code":"6"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 6 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error15Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim is already resolved with status: {message}","Code":"15"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 15 response"},"error16Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim has been submitted for processing and this action can no longer be performed","Code":"16"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 16 response"}}}}},"500":{"description":"Error add similar transactions request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["TransactionList"],"properties":{"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}}}}],"required":["ClaimId","TransactionList","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}},"TransactionSearchStartDate":{"description":"Start date for the search to build the transaction list.","type":"string","format":"Date","example":20241101},"TransactionSearchEndDate":{"description":"End date for the search to build the transaction list.","type":"string","format":"Date","example":20241130}}},"example":{"ClaimId":"2108160022C","TransactionList":[{"TransactionId":"6"}],"providerId":9999,"transactionId":"984513-395483653-4483483478"}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/addQuestionnaire":{"post":{"summary":"/claim/intake/addQuestionnaire","description":"Use this endpoint to submit user answers to the detailed questionnaire.\n\nPrerequisite API call:\n- `/claim/intake/retrieveQuestionnaire`","operationId":"postClaimQuestionnaireAdd","parameters":[],"responses":{"200":{"description":"Successful add questionnaire request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response"}}}}},"400":{"description":"Error add questionnaire request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error6Example":{"value":{"StatusList":[{"Type":"Error","Message":"Error saving claim: {message}","Code":"6"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 6 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error15Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim is already resolved with status: {message}","Code":"15"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 15 response"},"error16Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim has been submitted for processing and this action can no longer be performed","Code":"16"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 16 response"}}}}},"500":{"description":"Error add questionnaire request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["Questionnaire"],"properties":{"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}],"required":["ClaimId","Questionnaire","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","examples":["2108160022C"]},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}},"example":{"ClaimId":"2108160022C","Questionnaire":{"QuestionList":[{"Identifier":"EverDoneBusiness","AnswerValue":"RecognizesMerchant"},{"Identifier":"RecognizeDisputedMerchant","AnswerValue":"No"},{"Identifier":"CardPossessionInd","AnswerValue":"Yes"},{"Identifier":"HasAuthorizedOthers","AnswerValue":"No"},{"Identifier":"HasSharedPIN","AnswerValue":"No"},{"Identifier":"WherePinKept","AnswerValue":"InMemory"},{"Identifier":"ReissueCard","AnswerValue":"No"},{"Identifier":"AddlInfo","AnswerValue":"Yes"},{"Identifier":"AddlInfoDetails","AnswerValue":"Please please please help me!!"}]},"providerId":9999,"transactionId":"984513-395483653-4483483478"}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/retrieveDocRequirements":{"post":{"summary":"/claim/intake/retrieveDocRequirements","description":"Use this endpoint to retrieve the document requirements for a given claim so it can be displayed and acted upon by the intended user interface.\n\nPrerequisite API call:\n- `/claim/intake/addQuestionnaire`","operationId":"postRetrieveDocRequirements","parameters":[],"responses":{"200":{"description":"Successful retrieve document requirements request","content":{"application/json":{"schema":{"type":"object","properties":{"DocumentRequirementList":{"type":"array","description":"List of document requirements that must be added to the claim.","items":{"type":"object","properties":{"TemplateDocumentStream":{"type":"string","description":"Byte stream of the template form pdf","example":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"},"IsSatisified":{"type":"boolean","description":"Has this document requirement been satisfied?","example":false},"Identifier":{"type":"string","description":"Document requirement identifier","example":"StatementOfDispute"},"IsRequired":{"type":"boolean","description":"Is this document required?","example":true},"Label":{"type":"string","description":"A user friendly label of the document requirement","example":"Statement of Dispute"},"ValidAttachmentCategoryList":{"type":"array","items":{"type":"object","properties":{"Key":{"type":"string","description":"Key value, this is what is passed back in with the add document request","example":"SupportingDocumentation"},"Value":{"type":"string","description":"User friendly display value","example":"Supporting Documentation"}}}}}}},"TransactionDetails":{"type":"object","description":"Details about the selected transaction to display to the user.","properties":{"SummaryHeader":{"type":"string","description":"Posted Transaction Details header"},"SelectedPostedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"PendingSummaryHeader":{"type":"string","description":"Pending Transaction Details header"},"SelectedPendingTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"RecurringSummaryHeader":{"type":"string","description":"Recurring Transaction Details header"},"SelectedRecurringTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"DeflectedSummaryHeader":{"type":"string","description":"Deflected Transaction Details header"},"DeflectedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"success - with requirements":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"DocumentRequirementList":[{"TemplateDocumentStream":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTc1Cj4+CnN0cmVolJUVPRgo=","IsSatisfied":false,"Identifier":"StatementOfDispute","IsRequired":true,"Label":"Statement of Dispute","ValidAttachmentCategoryList":[{"Value":"Accountholder","Key":"Accountholder"},{"Value":"Supporting Documentation","Key":"SupportingDocumentation"}]}],"TransactionDetails":{"SummaryHeader":"","SelectedPostedTransactionList":[{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM2","Amount":"39.99","CardNumberEndingIn":"7413","Date":"20270602","TransactionId":"4"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BASECAMP FITNESS (10.1)","Amount":"79.99","CardNumberEndingIn":"7413","Date":"20270408","TransactionId":"2"}]},"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response with document requirements"},"success - no requirements":{"value":{"StatusList":[{"Type":"Success","Message":"No documents are required for this case","Code":"201"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response with no document requirements"}}}}},"400":{"description":"Error retrieve document requirements request","content":{"application/json":{"schema":{"type":"object","properties":{"DocumentRequirementList":{"type":"array","description":"List of document requirements that must be added to the claim.","items":{"type":"object","properties":{"TemplateDocumentStream":{"type":"string","description":"Byte stream of the template form pdf","example":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"},"IsSatisified":{"type":"boolean","description":"Has this document requirement been satisfied?","example":false},"Identifier":{"type":"string","description":"Document requirement identifier","example":"StatementOfDispute"},"IsRequired":{"type":"boolean","description":"Is this document required?","example":true},"Label":{"type":"string","description":"A user friendly label of the document requirement","example":"Statement of Dispute"},"ValidAttachmentCategoryList":{"type":"array","items":{"type":"object","properties":{"Key":{"type":"string","description":"Key value, this is what is passed back in with the add document request","example":"SupportingDocumentation"},"Value":{"type":"string","description":"User friendly display value","example":"Supporting Documentation"}}}}}}},"TransactionDetails":{"type":"object","description":"Details about the selected transaction to display to the user.","properties":{"SummaryHeader":{"type":"string","description":"Posted Transaction Details header"},"SelectedPostedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"PendingSummaryHeader":{"type":"string","description":"Pending Transaction Details header"},"SelectedPendingTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"RecurringSummaryHeader":{"type":"string","description":"Recurring Transaction Details header"},"SelectedRecurringTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"DeflectedSummaryHeader":{"type":"string","description":"Deflected Transaction Details header"},"DeflectedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"}}}}},"500":{"description":"Error retrieve document requirements request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/addDocuments":{"post":{"summary":"/claim/intake/addDocuments","description":"Use this endpoint to upload the documents to the claim.\n\nPrerequisite API call:\n\n- `/claim/intake/addQuestionnaire`\n- `/claim/intake/retrieveDocRequirements`","operationId":"postClaimIntakeDocumentsAdd","parameters":[],"responses":{"200":{"description":"Successful add documents request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response"}}}}},"400":{"description":"Error add documents request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error6Example":{"value":{"StatusList":[{"Type":"Error","Message":"Error saving claim: {message}","Code":"6"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 6 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error15Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim is already resolved with status: {message}","Code":"15"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 15 response"},"error16Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim has been submitted for processing and this action can no longer be performed","Code":"16"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 16 response"}}}}},"500":{"description":"Error add documents request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","examples":["2108160022C"]},"DocumentRequirementList":{"type":"array","items":{"allOf":[{"type":"object","required":["FileName","Category","Label","DocumentStream"],"properties":{"DocumentStream":{"type":"string","description":"Byte stream of the form PDF being uploaded to satisfy the requirement","examples":["JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"]},"Category":{"type":"string","description":"Attachment category (one of the subset of `ValidAttachmentCategoryList` in the `/claim/documents/retrieveRequirements` response)","examples":["SupportingDocumentation"]},"FileName":{"type":"string","description":"Name of the file being passed in DocumentStream param","examples":["StatementOfDispute.pdf"]},"Label":{"type":"string","description":"User friendly attachment label","examples":["Statement of Dispute"]}}},{"type":"object","properties":{"Identifier":{"type":"string","description":"Document requirement identifier","examples":["StatementOfDispute"]}}}]}}},"required":["transactionId","providerId"]}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/retrieveSummary":{"post":{"summary":"/claim/intake/retrieveSummary","description":"Use this endpoint to retrieve the claim summary before submitting. A `SummaryQuestionnaire` is also returned and should be submitted when calling /claim/intake/submit\n\nPrerequisite API call:\n- `/claim/intake/addQuestionnaire`\n\n> 📘 Note\n>\n> This endpoint may return different data depending on the value of `profile-type`. See Profile Type Differences for details.","operationId":"postRetrieveClaimIntakeSummary","parameters":[],"responses":{"200":{"description":"Successful retrieve summary request","content":{"application/json":{"schema":{"type":"object","properties":{"CorrespondenceDetails":{"type":"object","properties":{"CanIgnoreCorrespondencePreference":{"type":"boolean","description":"Can the client ignore the correspondence preference?","example":false},"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"ChannelList":{"type":"array","items":{"type":"object","properties":{"Key":{"type":"string","description":"Stored value","example":"Email"},"Value":{"type":"string","description":"Display value","example":"Email"}}}},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"SummaryContactHeader":{"type":"string","description":"Summary information about our customer contact method","examples":["If we need to contact you, it will be at this address: TestCustomer@disputeme.info"]},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"SummaryQuestionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"TransactionDetails":{"type":"object","description":"Details about the selected transaction to display to the user.","properties":{"SummaryHeader":{"type":"string","description":"Posted Transaction Details header"},"SelectedPostedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"PendingSummaryHeader":{"type":"string","description":"Pending Transaction Details header"},"SelectedPendingTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"RecurringSummaryHeader":{"type":"string","description":"Recurring Transaction Details header"},"SelectedRecurringTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"DeflectedSummaryHeader":{"type":"string","description":"Deflected Transaction Details header"},"DeflectedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"CorrespondenceDetails":{"CanIgnoreCorrespondencePreference":"false","SelectedChannel":"Email","ChannelList":[{"Value":"Email","Key":"Email"},{"Value":"Mail","Key":"Mail"},{"Value":"Manual","Key":"Manual"}],"EmailAddress":"TestCustomer@disputeme.info"},"SummaryContactHeader":"If we need to contact you, it will be at this address: TestCustomer@disputeme.info","StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"SummaryQuestionnaire":{"QuestionList":[{"QuestionList":[{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"TextMulti","Identifier":"PCOverrideReason","DisplayText":"Please provide a reason:","DataType":"String"}],"Identifier":"true","DisplayText":"Yes"},{"Identifier":"false","DisplayText":"No"}],"Identifier":"WithholdPC","DisplayText":"Withold Provisional Credit?","DataType":"String"},{"QuestionList":[{"QuestionList":[{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"TextMulti","Identifier":"ContactDateOverrideReason","DisplayText":"Please provide a reason:","DataType":"String"},{"Type":"Date","Identifier":"OverrideContactDate","DisplayText":"Enter the new date:","DataType":"Date"},{"Type":"Nothing","Identifier":"","DisplayText":"","DataType":"String"}],"Identifier":"true","DisplayText":"Yes"},{"Identifier":"false","DisplayText":"No"}],"Identifier":"IsContactDateOverridden","DisplayText":"The contact date assigned to the claim is 8/24/21. Would you like to override this date? Note: Changing the date may have regulatory impacts.","DataType":"String"}],"Type":"Questionnaire","Identifier":"ContactDateOverride","DisplayText":"","DataType":"String"}],"Type":"Questionnaire","Identifier":"FCRAClaimDetails","DisplayText":"","DataType":"String"}],"Type":"Questionnaire","Identifier":"ManualPCWithhold","DisplayText":"","DataType":"String"}],"Identifier":"SummaryQuestions"},"TransactionDetails":{"SummaryHeader":"","SelectedPostedTransactionList":[{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM2","Amount":"39.99","CardNumberEndingIn":"7413","Date":"20270602","TransactionId":"4"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BASECAMP FITNESS (10.1)","Amount":"79.99","CardNumberEndingIn":"7413","Date":"20270408","TransactionId":"2"}]},"rtoken":"984513-395483653-4483483478","StatusCode":"200"}}}}}},"400":{"description":"Error retrieve summary request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error6Example":{"value":{"StatusList":[{"Type":"Error","Message":"Error saving claim: {message}","Code":"6"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 6 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"}}}}},"500":{"description":"Error retrieve summary request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/submit":{"post":{"summary":"/claim/intake/submit","description":"Use this endpoint to submit the claim to be finalized and documentation passed back to the requester.\n\n\n\n> 📘 Note\n>\n> When intaking a case, the final step of the process is the `/claim/intake/submit` endpoint. The only endpoint that can be called immediately after submission is the `/claim/intake/retrieveConfirmation` endpoint. The submission queues up the case for initial automation and there is a slight delay (usually seconds) between submission and when the case is available to perform interaction endpoints. If you intend to perform more activity on the case during the intake process it should be done before the `/claim/intake/submit` endpoint.\n\nPrerequisite API:\n- `/claim/intake/addQuestionnaire`","operationId":"postClaimSubmit","parameters":[],"responses":{"200":{"description":"Successful claim submission request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Success response"}}}}},"400":{"description":"Error claim submission request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error6Example":{"value":{"StatusList":[{"Type":"Error","Message":"Error saving claim: {message}","Code":"6"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 6 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error15Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim is already resolved with status: {message}","Code":"15"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 15 response"},"error16Example":{"value":{"StatusList":[{"Type":"Error","Message":"This claim has been submitted for processing and this action can no longer be performed","Code":"16"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 16 response"}}}}},"500":{"description":"Error claim submission request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"CorrespondenceDetails":{"type":"object","properties":{"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}],"required":["ClaimId","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"CorrespondenceDetails":{"type":"object","properties":{"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}},"example":{"ClaimId":"2108160022C","CorrespondenceDetails":{"SelectedChannel":"Mail","Address":{"Line1":"6 ashbridge lane","Line2":"","Line3":"","City":"Linwood","State":"NJ","Zip":"08111","Country":"USA"}},"Questionnaire":{"QuestionList":[{"Identifier":"WithholdPC","AnswerValue":"true"},{"Identifier":"PCOverrideReason","AnswerValue":"Example override reason"}]},"providerId":9999,"transactionId":"984513-395483653-4483483478"}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/retrieveConfirmation":{"post":{"summary":"/claim/intake/retrieveConfirmation","description":"Use this endpoint to retrieve the confirmation document for a claim.\n\nPrerequisite API call:\n \n- `/claim/intake/submit`","operationId":"postRetrieveClaimIntakeConfirmation","parameters":[],"responses":{"200":{"description":"Successful retrieve confirmation request","content":{"application/json":{"schema":{"type":"object","properties":{"ConfirmationDocumentStream":{"type":"string","description":"Byte stream of the confirmation pdf","example":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"},"ConfirmationMessageMarkup":{"type":"string","description":"Byte stream of the confirmation message","examples":["PHRhYmxlIGNsYXNzPSJxdm9Cb2R5Q29udGVudCI+PHRyPjx0ZD4gPCEtLXF+"]},"ConfirmationHeader":{"type":"string","description":"Confirmation header","examples":["Confirmation #: 2108240024C"]},"ConfirmationDocumentName":{"type":"string","description":"Confirmation document name","examples":["Confirmation.pdf"]},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"ConfirmationDocumentStream":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvUVPRgo=","ConfirmationMessageMarkup":"PHRhYmxlIGNsYXNzPSJxdm9Cb2R5Q29udGVudCI+PHRyPjx0ZD4gPCEtLXF2b0JvZHlDb250ZW50=","StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"ConfirmationHeader":"Confirmation #: 2108240024C","ConfirmationDocumentName":"Confirmation.pdf","rtoken":"984513-395483653-4483483478","StatusCode":"200"}}}}}},"400":{"description":"Error retrieve confirmation request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error11Example":{"value":{"StatusList":[{"Type":"Error","Message":"Error generating confirmation document","Code":"11"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 11 response"},"error13Example":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 13 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"}}}}},"500":{"description":"Error retrieve confirmation request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/intake/bulkCreate":{"post":{"summary":"/claim/intake/bulkCreate","description":"Use this endpoint to bulk create one or more claims, completing the entire intake flow. This API request is a combination of all the requests for existing intake services all in one call.\n\n\n\n> 📘 Note\n>\n> Only `AuthChargeback` claims are supported at this time","operationId":"postBulkCreate","parameters":[],"responses":{"200":{"description":"Successful bulk claim creation request","content":{"application/json":{"schema":{"type":"object","properties":{"ClaimList":{"type":"array","description":"List of claim ids.","items":{"type":"object","properties":{"ClaimId":{"type":"string","description":"ClaimId of bulk created claim","example":"2411210115C"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}]},{"ClaimList":[{"ClaimId":"2411210115C"}]}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"},"summary":"A sample Bulk Create Claim Success Response"}}}}},"400":{"description":"Error bulk claim creation request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"}}}}},"500":{"description":"Error bulk claim creation request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimList":{"type":"array","description":"List of claim payloads.","items":{"type":"object","properties":{"Create":{"type":"object","allOf":[{"type":"object","required":["CustomerId","AccountNumber"],"properties":{"CustomerId":{"type":"string","description":"Unique Customer ID to create the claim for","example":123456789},"AccountNumber":{"type":"string","description":"Account number the transaction dispute(s) are to be processed against for the new claim.","example":5555555555554444}}}]},"AddClaimReasons":{"type":"object","allOf":[{"type":"object","required":["Questionnaire"],"properties":{"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}]},"RetrieveTransactions":{"type":"object","allOf":[{"type":"object","properties":{"SearchAccountNumber":{"type":"number","description":"Account number for searching for transactions that are on a different account than the claim.\n\n**Required** only if the user needs to add transactions to the claim that are on a different account than the claim's disputed transactions."},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20200601},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20210812},"SearchAmount":{"type":"string","description":"Transaction amount to search for.\n\n**Required** only if the user is searching for a transaction with a specific amount.","example":2.09},"SearchMerchantName":{"type":"string","description":"Merchant name/Transaction description to search for.\n\n**Required** only if the user is searching for a transaction with a specific merchant","example":"Amazon"}}}]},"AddTransactions":{"type":"object","allOf":[{"type":"object","required":["TransactionList"],"properties":{"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}}}}]},"Submit":{"type":"object","allOf":[{"type":"object","properties":{"CorrespondenceDetails":{"type":"object","properties":{"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}]}}}}}},"example":{"ClaimList":[{"Create":{"AccountNumber":"4447111111117413","CustomerId":"939472005"},"AddClaimReasons":{"Questionnaire":{"QuestionList":[{"AnswerValue":"AuthChargeback","Identifier":"ClaimReasonType"},{"AnswerValue":"InPerson","Identifier":"IntakeChannel"},{"AnswerValue":"No","Identifier":"RespondToFraud"}]}},"RetrieveTransactions":{"SearchAmount":"","SearchEndDate":"20240501","SearchMerchantName":"","SearchStartDate":"20230101"},"AddTransactions":{"TransactionList":[{"TransactionId":"17"},{"TransactionId":"567788988123"}]},"Submit":{"CorrespondenceDetails":{"Address":{"City":"Linwood","Country":"USA","Line1":"6 ashbridge lane","Line2":"","Line3":"","State":"NJ","Zip":"08111"},"EmailAddress":"test@gmail.com","SelectedChannel":"Email"},"Questionnaire":{"QuestionList":[{"AnswerValue":"false","Identifier":"WithholdPC"},{"AnswerValue":"false","Identifier":"IsContactDateOverridden"}]}}}],"providerId":9999,"transactionId":"984513-395483653-4483483478"}}}},"tags":["Intake"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/task/summary":{"post":{"summary":"/task/summary","operationId":"postTaskSummary","description":"Use this endpoint to retrieve a summary count of tasks for the passed-in client","parameters":[],"responses":{"200":{"description":"Successful task summary request","content":{"application/json":{"schema":{"type":"object","properties":{"TaskSummaryList":{"type":"array","items":{"type":"object","properties":{"TaskCount":{"type":"number"},"TaskLabel":{"type":"string"}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"TaskSummaryList":[{"TaskCount":47,"TaskLabel":"Approval Level"},{"TaskCount":13,"TaskLabel":"Execute Accounting"},{"TaskCount":42,"TaskLabel":"Final Investigation"},{"TaskCount":33,"TaskLabel":"Manually Send Letter"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"}}}}}},"400":{"description":"Error task summary request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"}}}}},"500":{"description":"Error task summary request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClientId","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClientId":{"type":"string","example":"Default"}}}}}},"tags":["Tasks"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/task/list":{"post":{"summary":"/task/list","operationId":"postTaskList","description":"Use this endpoint to retrieve tasks for a client or claim","parameters":[],"responses":{"200":{"description":"Successful task list request","content":{"application/json":{"schema":{"type":"object","properties":{"TaskList":{"type":"array","items":{"type":"object","properties":{"ClaimAmount":{"type":"number","description":"Total claim amount","examples":[225.25]},"ClaimAge":{"type":"integer","description":"Age of claims in days","examples":[19]},"NextRecoveryDateTime":{"type":"string","description":"Next Recovery date time","examples":["2023-12-28T05:00:00.000Z"]},"NextRegulatoryDateTime":{"type":"string","description":"Next Regulatory date time","examples":["2024-03-26T09:00:00.000Z"]},"TaskLabel":{"type":"string","description":"label of task","examples":["Process Liability"]},"ClaimCategory":{"type":"string","description":"Claim category","examples":["Fraud"]},"ClaimType":{"type":"string","description":"Claim type","examples":["CardPinless"]},"TaskId":{"type":"string","description":"UUID of task","examples":["b000fe17-e84e-42c4-85c9-5e962ea8bf70"]}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"TaskList":[{"ClaimAmount":520,"ClaimAge":15,"NextRecoveryDateTime":"2023-12-29T05:00:00.000Z","CreateDateTime":"2024-01-08T17:44:05.421Z","TaskLabel":"Execute Accounting Service Failed","ClaimCategory":"Fraud","ClaimType":"CardPinless","TaskId":"b000fe17-e84e-42c4-85c9-5e962ea8bf70"},{"ClaimAmount":520,"ClaimAge":15,"NextRecoveryDateTime":"2023-12-29T05:00:00.000Z","CreateDateTime":"2024-01-08T17:44:04.524Z","TaskLabel":"Execute Accounting Service Failed","ClaimCategory":"Fraud","ClaimType":"CardPinless","TaskId":"b000fe17-e84e-42c4-85c9-5e962ea8bf71"},{"ClaimAmount":520,"ClaimAge":15,"NextRecoveryDateTime":"2023-12-29T05:00:00.000Z","CreateDateTime":"2024-01-08T17:20:13.749Z","TaskLabel":"Process Liability","ClaimCategory":"Fraud","ClaimType":"CardPinless","TaskId":"b000fe17-e84e-42c4-85c9-5e962ea8bf72"},{"ClaimAmount":520,"ClaimAge":15,"NextRecoveryDateTime":"2023-12-29T05:00:00.000Z","CreateDateTime":"2024-01-08T17:20:14.026Z","TaskLabel":"Process Liability","ClaimCategory":"Fraud","ClaimType":"CardPinless","TaskId":"b000fe17-e84e-42c4-85c9-5e962ea8bf73"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"}}}}}},"400":{"description":"Error task list request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"}}}}},"500":{"description":"Error task list request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","oneOf":[{"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2401080016C"}},"required":["ClaimId"]},{"properties":{"ClientId":{"type":"string","description":"ClientId representing client for which tasks are being retrieved","example":"Default"},"TaskLabel":{"type":"string","description":"Label of tasks being retrieved for said client","example":"Process Liability"}},"required":["ClientId","TaskLabel"]}],"required":["transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"PageNum":{"type":"integer","description":"page to retrieve, 1 if not included in request","example":2},"PageSize":{"type":"integer","description":"number of results per page, 1000 if not included in request","example":10},"SortBy":{"type":"string","description":"Field to sort by (ClaimAmount|NextRecoveryDateTime|etc)\n\nCreateDateTime if not included in request","example":"ClaimCategory"},"SortType":{"type":"string","description":"Ascending or Descending sort (ASC|DESC)\n\nASC if not included in request","example":"ASC"}}}}}},"tags":["Tasks"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/task/details/list":{"post":{"summary":"/task/details/list","operationId":"postTaskDetailsList","description":"Use this endpoint to retrieve list of tasks details for a claim","parameters":[],"responses":{"200":{"description":"Successful task details list request","content":{"application/json":{"schema":{"type":"object","properties":{"AvailableActionList":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"string","description":"available action","examples":["Accounting Compete"]}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"TaskDetailList":{"type":"array","items":{"type":"object","properties":{"TaskId":{"type":"string","description":"UUID of task","examples":["b000fe17-e84e-42c4-85c9-5e962ea8bf70"]},"DisputeId":{"type":"string","description":"Dispute Id","examples":["2401080025D"]},"Detail":{"type":"object","description":"Dynamic detail object, depends on task"}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"TaskDetailsList":[{"TaskId":"8da91239-ecdd-47b6-962c-dcf76c6c20c3","DisputeId":"2401080026D","Detail":{"CreditCollection":"AccountHolder","Amount":400,"DebitAccountNumber":"","CreditAccountNumber":"5363140001113137","DebitCollection":"Suspense","Reason":"Provisional Credit"}},{"TaskId":"402b92ee-6896-4ad5-a878-7ceec5e6b3ad","DisputeId":"2401080025D","Detail":{"CreditCollection":"AccountHolder","Amount":120,"DebitAccountNumber":"","CreditAccountNumber":"5363140001113137","DebitCollection":"Suspense","Reason":"Provisional Credit"}}],"AvailableActionList":[{"Value":"Accounting Complete"},{"Value":"No Action"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"}}}}}},"400":{"description":"Error task list details request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"}}}}},"500":{"description":"Error task list request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","TaskLabel","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2401080016C"},"TaskLabel":{"type":"string","description":"Label of tasks being retrieved for said claim","example":"Process Liability"}}}}}},"tags":["Tasks"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/task/action":{"post":{"summary":"/task/action","operationId":"postTaskAction","description":"This resource is used perform an available task action (as identified by the `/task/details/list` endpoint)","parameters":[],"responses":{"200":{"description":"Successful task action request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"}}}}}},"400":{"description":"Error task action request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"}}}}},"500":{"description":"Error task list request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["TaskList","Action","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"Action":{"type":"string","description":"Action to perform","example":"Deny Claim"},"TaskList":{"type":"array","description":"List of Tasks to be actions","items":{"type":"object","required":["TaskId"],"properties":{"TaskId":{"type":"string","description":"Task identifier to be actioned","example":"123e4567-e89b-12d3-a456-426614174000"}}}},"Detail":{"type":"object","description":"When an action requires action specific details, these are passed in the Detail object."}}}}}},"tags":["Tasks"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/transactions/list":{"post":{"summary":"/claim/transactions/list","operationId":"postTransactionsList","description":"Use this endpoint to retrieve a list of transactions for a given existing claim","parameters":[],"responses":{"200":{"description":"Successful transaction list request","content":{"application/json":{"schema":{"type":"object","properties":{"TransactionList":{"type":"array","items":{"type":"object","properties":{"TransactionAmount":{"type":"number","description":"Transaction amount"},"CardLastFourDigits":{"type":"string","description":"Last 4 digits of the card used"},"DisputedAmount":{"type":"number","description":"Disputed amount"},"DisputeId":{"type":"string","description":"Unique ID for the dispute associated with this transaction","examples":["2307190009D"]},"Description":{"type":"string","description":"Transaction description"},"PostingDate":{"type":"string","format":"Date","description":"Transaction posting date

Format:yyyyMMdd"},"PostingDateTime":{"type":"string","format":"Date-Time","description":"Transaction posting date as a Date-Time"},"CurrentStage":{"type":"string","description":"Transaction status, corresponds with stages in case workflow - Status Values","enum":["Enhance","Analyze","Execute","Resolve"]},"LastCommitDate":{"type":"string","format":"Date-Time","description":"Commit Date"},"TransactionId":{"type":"string","description":"Unique Transaction ID"},"DisputeStatus":{"type":"string","description":"Work status of the dispute, see Status Values"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"TransactionList":[{"TransactionAmount":"100.000000000","CardLastFourDigits":"8557","DisputedAmount":"100.000000000","DisputeId":"2307190009D","Description":"SoFi Tech Solutions Bank BRANCH #2145","PostingDate":"20270727","PostingDateTime":"202707272T020235.184 GMT","CurrentStage":"Analyze","LastCommitDate":"20270728T020235.184 GMT","TransactionId":"2","DisputeStatus":"Open-Disposition"}],"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"rtoken":"984513-395483653-4483483478","StatusCode":"200"}}}}}},"400":{"description":"Error transaction list request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"transactionListError":{"value":{"StatusList":[{"Type":"Error","Message":"Error Retrieving Transactions List: {message}"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample failed list transaction error Response"},"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"},"error19Example":{"value":{"StatusList":[{"Type":"Error","Message":"Unable to Process request. The ClaimID has not been submitted..","Code":"19"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 19 response"}}}}},"500":{"description":"Error transaction list request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"ClaimId":{"type":"string","description":"Unique claim ID","example":"2501240026C"}}}}}},"tags":["Disputed Transactions"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]},"/claim/retrieve":{"post":{"summary":"/claim/retrieve","operationId":"postClaimRetrieve","description":"Use this endpoint to retrieve claim details and status","parameters":[],"responses":{"200":{"description":"Successful status retrieve request","content":{"application/json":{"schema":{"type":"object","properties":{"ClaimType":{"type":"string"},"ClaimReason":{"type":"string"},"ClaimReasonType":{"type":"string"},"TotalClaimAmount":{"type":"number"},"IsRegE10Satisfied":{"type":"boolean","description":"Whether the Reg E 10 Business Day provisional credit obligation has been satisfied."},"RegE10":{"type":"string","format":"Date-Time","description":"The deadline by which provisional credit must be granted and the provisional credit letter sent — 10 business days from the contact date (for ATM/debit POS and non-US ATM disputes)."},"RegE10Threshold":{"type":"string","format":"Date-Time","description":"The approaching/warning date for the Reg E 10 milestone, used to trigger early action before the RegE10 deadline."},"IsRegESatisfied":{"type":"boolean","description":"Whether the final Reg E resolution deadline has been satisfied."},"RegEDeadline":{"type":"string","format":"Date-Time","description":"The final Reg E regulatory deadline by which the claim must be resolved (write-off executed and resolution letter sent). 90 days for POS/non-US ATM disputes; 45 days for US ATM and ACH disputes."},"RegEThreshold":{"type":"string","format":"Date-Time","description":"The approaching/warning date for the final Reg E deadline (RegEDeadline), used to trigger action before the deadline is breached."},"IsRegZ30Satisfied":{"type":"boolean","description":"Whether the Reg Z 30-day acknowledgement obligation has been satisfied."},"RegZ30":{"type":"string","format":"Date-Time","description":"The deadline by which an acknowledgement letter must be sent to the cardholder — 30 days from the contact date."},"RegZ30Threshold":{"type":"string","format":"Date-Time","description":"The approaching/warning date for the Reg Z 30 milestone."},"IsRegZPCSatisfied":{"type":"boolean","description":"Whether the Reg Z Withholding Protection provisional credit obligation has been satisfied."},"RegZPC":{"type":"string","format":"Date-Time","description":"The Reg Z Withholding Protection date — the deadline by which provisional credit must be issued to prevent collection on the disputed amount (primarily relevant for cardholders enrolled in autopayment). Set to the earlier of the next autopayment date or statement cycle date, with a minimum of contact date + 3 business days."},"RegZPCThreshold":{"type":"string","format":"Date-Time","description":"The approaching/warning date for the Reg Z PC provisional credit milestone."},"IsRegZ90Satisfied":{"type":"boolean","description":"Whether the Reg Z 90-day resolution obligation has been satisfied."},"RegZ90":{"type":"string","format":"Date-Time","description":"The final Reg Z deadline by which write-off must be executed and a resolution letter sent. Equals the 2nd statement cycle date following the contact date, capped at 90 days. Defaults to 60 days if cycle date is unavailable or the calculated date falls below 60 days."},"RegZ90Threshold":{"type":"string","format":"Date-Time","description":"The approaching/warning date for the Reg Z 90 milestone."},"CustomerDetails":{"type":"object","properties":{"FirstName":{"type":"string"},"MiddleName":{"type":"string"},"LastName":{"type":"string"},"EmailAddress":{"type":"string"},"PhoneNumber":{"type":"string"},"LastAddressChangeDate":{"type":"string","format":"Date-Time"},"CustomerId":{"type":"string"}}},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}},"AccountDetails":{"type":"object","properties":{"Description":{"type":"string"},"AccountNumber":{"type":"string"},"CardDescription":{"type":"string"},"CardNumber":{"type":"string"},"Balance":{"type":"number"},"OpenDate":{"type":"string","format":"Date-Time"},"AccountStatus":{"type":"string"},"LastStatementDate":{"type":"string","format":"Date-Time"}}},"ExternalCaseId":{"type":"string","description":"Optional ID representing claim identifier external to this dispute system (client internal identifier)"},"CustomerContactDate":{"type":"string","format":"Date-Time","description":"Date customer contacted institution about dispute","example":"2024-08-05T16:29:45.350Z"},"CreateName":{"type":"string","description":"userId of the user who created the claim","example":"dispute_api@disputeme.info"},"AccountType":{"type":"string","example":"CreditCard"},"ClaimStatus":{"type":"string","example":"Open-Analyze"},"AccountHolder":{"type":"string","example":"SoFi Tech Solutions User"},"Actions":{"type":"array","description":"Actions that can be taken on the claim","items":{"type":"object","properties":{"Importance":{"type":"string","description":"Importance of the action"},"ActionName":{"type":"string","description":"Action Name"}}}},"HasOutstandingTasks":{"type":"boolean","description":"Does the claim have oustanding workable tasks for interaction api"},"HeaderDisplay":{"type":"string","description":"Text for display"},"Stages":{"type":"array","description":"List of claim stages","items":{"type":"object","properties":{"Status":{"type":"string","description":"Status of this stage"},"Name":{"type":"string","description":"Name of this stage"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"TalkingPoints":{"type":"array","description":"List of claim talking points","items":{"type":"object","properties":{"DisplayText":{"type":"string","description":"Text for display"}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"successExample":{"value":{"ClaimType":"ConvenienceCheck","ClaimReason":"Unauthorized","TotalClaimAmount":50.99,"IsRegE10Satisfied":false,"RegE10":"2025-09-23T22:00:00.000Z","RegE10Threshold":"2025-09-26T22:00:00.000Z","IsRegESatisfied":false,"RegEDeadline":"2025-09-28T22:00:00.000Z","RegEThreshold":"2025-09-23T22:00:00.000Z","IsRegZ30Satisfied":false,"RegZ30":"2025-09-23T22:00:00.000Z","RegZ30Threshold":"2025-09-21T22:00:00.000Z","IsRegZPCSatisfied":false,"RegZPC":"2025-09-23T22:00:00.000Z","RegZPCThreshold":"2025-09-23T22:00:00.000Z","IsRegZ90Satisfied":false,"RegZ90":"2025-09-23T22:00:00.000Z","RegZ90Threshold":"2025-09-23T22:00:00.000Z","CustomerDetails":{"CustomerId":123456789,"FirstName":"John","MiddleName":"J","LastName":"Smith","EmailAddress":"john.smith@disputeme.info","PhoneNumber":"122-345-6789","LastAddressChangeDate":"2023-02-03T22:00:00.000Z"},"AccountDetails":{"Description":"MyChecking Account","AccountNumber":47386789132877656,"CardDescription":"Visa Credit Card","CardNumber":"562139058235","Balance":234.71,"OpenDate":"1997-06-09","AccountStatus":"","LastStatementDate":"2025-01-31"},"CardNumber":"562139058235","ClaimId":"2110050013C","ExternalCaseId":"13tovbv","Actions":[{"Importance":"other","ActionName":"View Communication"}],"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"Stages":[{"Status":"Current","Name":"Received"},{"Status":"Complete","Name":"Investigating"}],"CustomerContactDate":"20220323 GMT","CreateName":"SoFi Tech Solutions User","EmailAddress":"dispute_api@disputeme.info","AccountType":"CreditCard","AccountNumber":"8025307835","RequiredDocumentCount":1,"ClaimStatus":"New","TalkingPoints":[{"DisplayText":"We have created a claim ID, but the process is incomplete"}],"AccountHolder":"SoFi Tech Solutions User","HeaderDisplay":"Transaction Dispute (claimId)","HasOutstandingTasks":true,"Address":{"Zip":"01234","State":"NY","LongAddress":"THE CRIB NYC NY 01234","Country":"United States of America","City":"NYC","Line1":"THE CRIB","Line2":"","Line3":""},"rtoken":"984513-395483653-4483483478","StatusCode":"200"}}}}}},"400":{"description":"Error retrieve status request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"claimRetrievalError":{"value":{"StatusList":[{"Type":"Error","Message":"Error Retrieving Claim Status"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample failed claim retrieval error Response"},"error4Example":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 4 response"},"error5Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 5 response"},"error14Example":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}],"rtoken":"984513-395483653-4483483478","StatusCode":"400"},"summary":"A sample Error 14 response"}}}}},"500":{"description":"Error retrieve status request","content":{"application/json":{"schema":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"rtoken":{"type":"string","nullable":true,"description":"A system-generated ID used for tracking"},"StatusCode":{"type":"integer","nullable":true,"description":"The HTTP response status code"}}},"examples":{"errorExample":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}],"rtoken":"984513-395483653-4483483478","StatusCode":"500"},"summary":"A sample Error 500 response"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["claimId","statusRole","transactionId","providerId"],"properties":{"providerId":{"type":"integer","format":"int32","description":"Your unique provider identifier from SoFi Tech Solutions.\nPattern: Max 10 digits\nExample: `9999`","example":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"Supply a globally unique ID to identify this endpoint request (\"transaction\").\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","example":"984513-395483653-4483483478"},"claimId":{"type":"string","description":"Unique claim ID","example":"2501240026C"},"statusRole":{"type":"string","description":"Status role of the current user","example":"Customer"}}}}}},"tags":["Status"]},"parameters":[{"$ref":"#/components/parameters/AuthorizationHeaderParam"},{"$ref":"#/components/parameters/ProfileTypeHeaderParam"}]}},"components":{"requestBodies":{"postClaimCorrespondenceResendRequest":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","LinkReference"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2408050075C"},"LinkReference":{"type":"string","description":"Unique Reference ID of the correspondence. Can be retrieved using /claim/correspondence/list","example":"DATA-WORKATTACH-NOTE STS-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2408050075C!20250124T180306.386 GMT"}}}}}},"postCustomerRetrieveRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CustomerId"],"properties":{"CustomerId":{"type":"string","description":"The Customer ID for the customer the user wants to retrieve","example":25945893}}}}}},"postTransactionListRequest":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2501240026C"}}}}}},"postStatusRetrieveRequest":{"content":{"application/json":{"schema":{"type":"object","required":["claimId","statusRole"],"properties":{"claimId":{"type":"string","description":"Unique claim ID","example":"2501240026C"},"statusRole":{"type":"string","description":"Status role of the current user","example":"Customer"}}}}}},"postClaimReopenRequestRequest":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","ReopenReason","TransactionList"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"ReopenReason":{"type":"string","description":"Reasoning for requesting the claim to be reopen","example":"Test reopen reason"},"ReopenNewInformation":{"type":"string","description":"Any new information about the disputes. Optional information the user can choose to provide.","example":"New information about the disputes"},"TransactionList":{"description":"List of transactions to reopen when calling `/claim/reopenRequest`","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}}}}}}},"postClaimWithdrawRequestRequest":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","WithdrawalReason","TransactionList"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2408050075C"},"WithdrawalReason":{"type":"string","description":"Reason for claim to be withdrawn","example":"Test reason for withdrawal"},"TransactionList":{"type":"array","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}},"description":"List of transactions to be withdrawn"}}}}}},"postNotesRetrieveRequest":{"content":{"application/json":{"schema":{"type":"object","required":["LinkReference"],"properties":{"LinkReference":{"type":"string","description":"Unique Reference ID of the note. Can be retrieved in /claim/notes/list","example":"DATA-WORKATTACH-NOTE STS-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2408050075C!20250124T180306.386 GMT"}}}}}},"postNotesListRequest":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2501240026C"}}}}}},"postNotesAddRequest":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","Subject","Note"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2501240026C"},"Subject":{"type":"string","description":"Note subject","example":"Example Subject"},"Note":{"type":"string","description":"Note contents","example":"Example Note Contents"},"Visibility":{"type":"string","enum":["ContactCenter","Customer","Fulfillment"],"description":"Visibility setting for the note. If not provided, defaults to client operator access group."}}}}}},"postClaimListRequest":{"content":{"application/json":{"schema":{"type":"object","properties":{"daysToLookBack":{"type":"number","description":"Days prior to search for claims\nDefaults to 30 days. Custom value can be passed in"},"customerId":{"type":"string","description":"Customer ID to search for claims for\n\nExactly one of `customerId`, `accountNumber`, or `claimId` is **required**","example":25945893},"accountNumber":{"type":"string","description":"Account number to search for claims for\n\nExactly one of `customerId`, `accountNumber`, or `claimId` is **required**","example":4123123412341234},"claimId":{"type":"string","description":"Specific Claim ID to search for\n\nExactly one of `customerId`, `accountNumber`, or `claimId` is **required**","example":"2503040008C"}}}}}},"postClaimDetailsRetrieveRequest":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","CorrelationId"],"properties":{"ClaimId":{"type":"string","example":"2503040008C"}}}}}},"postClaimRecoveryDetailsRetrieveRequest":{"content":{"application/json":{"schema":{"type":"object","required":["DisputeId"],"properties":{"DisputeId":{"type":"string","example":"2312130009D"}}}}}},"postClaimDocumentAddRequest":{"content":{"application/json":{"schema":{"type":"object","properties":{"ClaimId":{"type":"string","example":"2501240026C"},"DocumentRequirementList":{"type":"array","items":{"type":"object","properties":{"DocumentStream":{"type":"string","description":"Document content stream","example":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTc0Cj4+CnN0cmVhbQp42t1YbXPaOBD+jH/FztzdT"},"Identifier":{"type":"string","description":"ID of document requirement to be fulfilled. Identifier is returned in /claim/documents/retrieveRequirements","example":"ProofOfPayment"},"Category":{"type":"string","description":"category of the document","example":"SupportingDocumentation","enum":["Accountholder","Association","Internal","SupportingDocumentation"]},"FileName":{"type":"string","description":"Name of the file being attached","example":"ProofOfPayment.pdf"},"Label":{"type":"string","description":"Label for the document being added","example":"Proof Of Payment"}}}}}}}}},"postClaimRetrieveDocRequirementRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"postCorrespondenceRetrieveRequest":{"content":{"application/json":{"schema":{"type":"object","required":["LinkReference"],"properties":{"LinkReference":{"type":"string","description":"Unique Reference ID of the correspondence. Can be retrieved using /claim/correspondence/list","example":"DATA-WORKATTACH-NOTE STS-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2408050075C!20250124T180306.386 GMT"}}}}}},"postCorrespondenceListRequest":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2503210037C"}}}}}},"postAttachmentsAddRequest":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","AttachmentList"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"AttachmentList":{"type":"array","description":"List of attachments to add to the claim","items":{"allOf":[{"type":"object","required":["FileName","Category","Label","DocumentStream"],"properties":{"DocumentStream":{"type":"string","description":"Byte stream of the form PDF being uploaded to satisfy the requirement","examples":["JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"]},"Category":{"type":"string","description":"Attachment category (one of the subset of `ValidAttachmentCategoryList` in the `/claim/documents/retrieveRequirements` response)","examples":["SupportingDocumentation"]},"FileName":{"type":"string","description":"Name of the file being passed in DocumentStream param","examples":["StatementOfDispute.pdf"]},"Label":{"type":"string","description":"User friendly attachment label","examples":["Statement of Dispute"]}}}]}}}}}}},"postAttachmentsListRequest":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"postAttachmentsRetrieveRequest":{"content":{"application/json":{"schema":{"type":"object","required":["LinkReference"],"properties":{"LinkReference":{"type":"string","description":"Unique Reference ID used to retrieve a specific attachment. Can be retrieved in /claim/attachments/list","example":"DATA-WORKATTACH-NOTE STS-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2408050075C!20250124T180306.386 GMT"}}}}}},"postRetrieveAccountsRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId","CustomerId"],"properties":{"CustomerId":{"type":"string","description":"ID of the customer to retrieve accounts for","example":25945893}}}}}},"postRetrieveCustomersRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId"],"properties":{"CustomerId":{"type":"string","description":"ID of the customer to search for. Only required if the user is searching for a specific customer based on ID.","example":123456789},"ClientId":{"type":"string","description":"ID of the Client we want to retrieve customers for. for multi-client systems. Only required if the user is searching for customers for a specific Client.","example":"ABC"},"AccountNumber":{"type":"string","description":"Account Number of the customer to search for. Only required if the user is searching for a specific customer based on their account number.","example":6523456789},"SSNTIN":{"type":"string","description":"The SSN/TIN of the customer to search for. Only required if the user is searching for a specific customer based on their SSIN/TIN.","example":1234567890},"CardNumber":{"type":"string","description":"The Card Number of the customer to search for. Only required if the user is searching for a specific customer based on their card number.","example":5555555555554445},"Name":{"type":"object","description":"The Name of the customer to search for. Only required if the user is searching for a specific customer based on their first name and/or their last name.","properties":{"First":{"type":"string","example":"Jake"},"Last":{"type":"string","example":"Smith"}}},"Address":{"type":"object","description":"The Address of the customer to search for. Only required if the user is searching for a specific customer based on their address.","properties":{"Line1":{"type":"string","example":"3052 Lake Ave."},"City":{"type":"string","example":"Chicago"},"State":{"type":"string","example":"IL"},"Zip":{"type":"string","example":60007}}}}}}}},"postCreateClaimRequest":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["CustomerId","AccountNumber"],"properties":{"CustomerId":{"type":"string","description":"Unique Customer ID to create the claim for","example":123456789},"AccountNumber":{"type":"string","description":"Account number the transaction dispute(s) are to be processed against for the new claim.","example":5555555555554444}}}],"required":["CorrelationId"],"properties":{"CustomerId":{"type":"string","description":"Unique Customer ID to create the claim for","example":123456789},"AccountNumber":{"type":"string","description":"Account number the transaction dispute(s) are to be processed against for the new claim.","example":5555555555554444}}}}}},"postRetrieveReasonsRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"postAddClaimReasonsRequest":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["Questionnaire"],"properties":{"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}],"required":["CorrelationId","ClaimId","Questionnaire"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","examples":["2108160022C"]},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}},"example":{"CorrelationId":"123e4567-e89b-12d3-a456-426614174000","ClaimId":"2108160022C","Questionnaire":{"QuestionList":[{"Identifier":"ClaimTransType","AnswerValue":"true"},{"Identifier":"ClaimReasonType","AnswerValue":"Fraud"},{"Identifier":"ClaimReason","AnswerValue":"CardSecure"}]}}}}},"postRetrieveTransactionsRequest":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"SearchAccountNumber":{"type":"number","description":"Account number for searching for transactions that are on a different account than the claim.\n\n**Required** only if the user needs to add transactions to the claim that are on a different account than the claim's disputed transactions."},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20200601},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20210812},"SearchAmount":{"type":"string","description":"Transaction amount to search for.\n\n**Required** only if the user is searching for a transaction with a specific amount.","example":2.09},"SearchMerchantName":{"type":"string","description":"Merchant name/Transaction description to search for.\n\n**Required** only if the user is searching for a transaction with a specific merchant","example":"Amazon"}}}],"required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}},"example":{"CorrelationId":"123e4567-e89b-12d3-a456-426614174000","ClaimId":"2108160022C","SearchStartDate":"20270401","SearchEndDate":"20270512","SearchAmount":"2.09","SearchMerchantName":"Amazon"}}}},"postClaimTransactionAddRequest":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["TransactionList"],"properties":{"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}}}}],"required":["CorrelationId","ClaimId","TransactionList"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}},"TransactionSearchStartDate":{"description":"Start date for the search to build the transaction list.","type":"string","format":"Date","example":20241101},"TransactionSearchEndDate":{"description":"End date for the search to build the transaction list.","type":"string","format":"Date","example":20241130}}},"example":{"CorrelationId":"123e4567-e89b-12d3-a456-426614174000","ClaimId":"2108160022C","TransactionList":[{"TransactionId":"6"},{"TransactionId":"11"}],"TransactionSearchStartDate":"20241101","TransactionSearchEndDate":"20241131"}}}},"postClaimTransactionDetailsRequest":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","examples":["2108160022C"]},"DisputeId":{"type":"string","description":"Unique dispute ID\n\nREQUIRED if TransactionId is not passed.","examples":["2108160022D"]},"TransactionId":{"type":"string","description":"Unique Transaction ID\n\nREQUIRED if DisputeId is not passed.","examples":[123]}}},"example":{"ClaimId":"2108160022C","TransactionId":"6"}}}},"postAddSimilarTransactionRequest":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["TransactionList"],"properties":{"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}}}}],"required":["CorrelationId","ClaimId","TransactionList"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}},"TransactionSearchStartDate":{"description":"Start date for the search to build the transaction list.","type":"string","format":"Date","example":20241101},"TransactionSearchEndDate":{"description":"End date for the search to build the transaction list.","type":"string","format":"Date","example":20241130}}},"example":{"CorrelationId":"123e4567-e89b-12d3-a456-426614174000","ClaimId":"2108160022C","TransactionList":[{"TransactionId":"6"}]}}}},"postAddCheckDepositsRequest":{"content":{"application/json":{"schema":{"type":"object","required":["ClaimId","CheckDepositList"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"CheckDepositList":{"type":"array","description":"List of check deposits to add to the claim","items":{"type":"object","required":["Amount"],"properties":{"Amount":{"type":"string","description":"Amount of the check","examples":[123.45]},"CheckNumber":{"type":"string","description":"Check number","examples":[123]},"Date":{"type":"string","description":"Date of the check

Format:yyyyMMdd","examples":[20120701]},"From":{"type":"string","description":"Check issuer","examples":["John Doe"]}}}}}},"example":{"CorrelationId":"123e4567-e89b-12d3-a456-426614174000","ClaimId":"2108160022C","CheckDepositList":[{"Amount":"123.45","CheckNumber":"111","Date":"20220712","From":"John Doe"},{"Amount":"9.01","CheckNumber":"112","Date":"20220712","From":"John Doe"}]}}}},"postRetrieveQuestionnaireRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"postRetrieveOtherAccountsRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"postRetrieveCreditTransactionsRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","examples":[20200601]},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","examples":[20210812]}}}}}},"postRetrieveSimilarTransactionsRequest":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","allOf":[{"type":"object","properties":{"SearchAccountNumber":{"type":"number","description":"Account number for searching for transactions that are on a different account than the claim.\n\n**Required** only if the user needs to add transactions to the claim that are on a different account than the claim's disputed transactions."},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20200601},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20210812},"SearchAmount":{"type":"string","description":"Transaction amount to search for.\n\n**Required** only if the user is searching for a transaction with a specific amount.","example":2.09},"SearchMerchantName":{"type":"string","description":"Merchant name/Transaction description to search for.\n\n**Required** only if the user is searching for a transaction with a specific merchant","example":"Amazon"}}}],"required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}},{"type":"object","properties":{"SearchAccountNumber":{"type":"string","description":"Account number to search for if different than selected account on claim\n\n**Required** only if the user is searching for a transaction on a different account than the account on the claim."}}}]}}}},"postAddQuestionnaireRequest":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","required":["Questionnaire"],"properties":{"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}],"required":["CorrelationId","ClaimId","Questionnaire"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","examples":["2108160022C"]},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}},"example":{"CorrelationId":"123e4567-e89b-12d3-a456-426614174001","ClaimId":"2108160022C","Questionnaire":{"QuestionList":[{"Identifier":"EverDoneBusiness","AnswerValue":"RecognizesMerchant"},{"Identifier":"RecognizeDisputedMerchant","AnswerValue":"No"},{"Identifier":"CardPossessionInd","AnswerValue":"Yes"},{"Identifier":"HasAuthorizedOthers","AnswerValue":"No"},{"Identifier":"HasSharedPIN","AnswerValue":"No"},{"Identifier":"WherePinKept","AnswerValue":"InMemory"},{"Identifier":"ReissueCard","AnswerValue":"No"},{"Identifier":"AddlInfo","AnswerValue":"Yes"},{"Identifier":"AddlInfoDetails","AnswerValue":"Please please please help me!!"}]}}}}},"postRetrieveDocRequirementsRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"postAddDocumentsRequest":{"content":{"application/json":{"schema":{"type":"object","properties":{"ClaimId":{"type":"string","description":"Unique claim ID","examples":["2108160022C"]},"DocumentRequirementList":{"type":"array","items":{"allOf":[{"type":"object","required":["FileName","Category","Label","DocumentStream"],"properties":{"DocumentStream":{"type":"string","description":"Byte stream of the form PDF being uploaded to satisfy the requirement","examples":["JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"]},"Category":{"type":"string","description":"Attachment category (one of the subset of `ValidAttachmentCategoryList` in the `/claim/documents/retrieveRequirements` response)","examples":["SupportingDocumentation"]},"FileName":{"type":"string","description":"Name of the file being passed in DocumentStream param","examples":["StatementOfDispute.pdf"]},"Label":{"type":"string","description":"User friendly attachment label","examples":["Statement of Dispute"]}}},{"type":"object","properties":{"Identifier":{"type":"string","description":"Document requirement identifier","examples":["StatementOfDispute"]}}}]}}}}}}},"postRetrieveChannelInfoRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"postVerifyChannelInfoRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId","ClaimId","CorrespondenceChannelList"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","examples":["2108160022C"]},"CorrespondenceChannelList":{"type":"array","description":"List of correspondence channels that the user wants to verify or update.","items":{"oneOf":[{"$ref":"#/components/schemas/CorrespondenceChannelEmailRequest"},{"$ref":"#/components/schemas/CorrespondenceChannelMailRequest"}],"discriminator":{"propertyName":"Name"}}}}},"example":{"CorrelationId":"123e4567-e89b-12d3-a456-426614174000","ClaimId":"2108160022C","CorrespondenceChannelList":[{"IsVerifiedCorrect":false,"Name":"Email","Address":{"EmailAddress":"TestCustomer@disputeme.info"}},{"IsVerifiedCorrect":true,"Name":"Mail"}]}}}},"postRetrieveSummaryRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"postClaimSubmitRequest":{"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"CorrespondenceDetails":{"type":"object","properties":{"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}],"required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"CorrespondenceDetails":{"type":"object","properties":{"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}},"example":{"CorrelationId":"123e4567-e89b-12d3-a456-426614174000","ClaimId":"2108160022C","CorrespondenceDetails":{"SelectedChannel":"Mail","Address":{"Line1":"6 ashbridge lane","Line2":"","Line3":"","City":"Linwood","State":"NJ","Zip":"08111","Country":"USA"}},"Questionnaire":{"QuestionList":[{"Identifier":"WithholdPC","AnswerValue":"true"},{"Identifier":"PCOverrideReason","AnswerValue":"Example override reason"}]}}}}},"postRetrieveConfirmationRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}}}}},"postBulkCreateRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId"],"properties":{"ClaimList":{"type":"array","description":"List of claim payloads.","items":{"type":"object","properties":{"Create":{"type":"object","allOf":[{"type":"object","required":["CustomerId","AccountNumber"],"properties":{"CustomerId":{"type":"string","description":"Unique Customer ID to create the claim for","example":123456789},"AccountNumber":{"type":"string","description":"Account number the transaction dispute(s) are to be processed against for the new claim.","example":5555555555554444}}}]},"AddClaimReasons":{"type":"object","allOf":[{"type":"object","required":["Questionnaire"],"properties":{"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}]},"RetrieveTransactions":{"type":"object","allOf":[{"type":"object","properties":{"SearchAccountNumber":{"type":"number","description":"Account number for searching for transactions that are on a different account than the claim.\n\n**Required** only if the user needs to add transactions to the claim that are on a different account than the claim's disputed transactions."},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20200601},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20210812},"SearchAmount":{"type":"string","description":"Transaction amount to search for.\n\n**Required** only if the user is searching for a transaction with a specific amount.","example":2.09},"SearchMerchantName":{"type":"string","description":"Merchant name/Transaction description to search for.\n\n**Required** only if the user is searching for a transaction with a specific merchant","example":"Amazon"}}}]},"AddTransactions":{"type":"object","allOf":[{"type":"object","required":["TransactionList"],"properties":{"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}}}}]},"Submit":{"type":"object","allOf":[{"type":"object","properties":{"CorrespondenceDetails":{"type":"object","properties":{"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}]}}}}}},"example":{"CorrelationId":"123e4567-e89b-12d3-a456-426614174000","ClaimList":[{"Create":{"AccountNumber":"4447111111117413","CustomerId":"939472005"},"AddClaimReasons":{"Questionnaire":{"QuestionList":[{"AnswerValue":"AuthChargeback","Identifier":"ClaimReasonType"},{"AnswerValue":"InPerson","Identifier":"IntakeChannel"},{"AnswerValue":"No","Identifier":"RespondToFraud"}]}},"RetrieveTransactions":{"SearchAmount":"","SearchEndDate":"20240501","SearchMerchantName":"","SearchStartDate":"20230101"},"AddTransactions":{"TransactionList":[{"TransactionId":"17"},{"TransactionId":"567788988123"}]},"Submit":{"CorrespondenceDetails":{"Address":{"City":"Linwood","Country":"USA","Line1":"6 ashbridge lane","Line2":"","Line3":"","State":"NJ","Zip":"08111"},"EmailAddress":"test@gmail.com","SelectedChannel":"Email"},"Questionnaire":{"QuestionList":[{"AnswerValue":"false","Identifier":"WithholdPC"},{"AnswerValue":"false","Identifier":"IsContactDateOverridden"}]}}}]}}}},"postTaskSummaryRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId","ClientId"],"properties":{"ClientId":{"type":"string","example":"Default"}}}}}},"postTaskListRequest":{"content":{"application/json":{"schema":{"type":"object","oneOf":[{"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2401080016C"}},"required":["ClaimId"]},{"properties":{"ClientId":{"type":"string","description":"ClientId representing client for which tasks are being retrieved","example":"Default"},"TaskLabel":{"type":"string","description":"Label of tasks being retrieved for said client","example":"Process Liability"}},"required":["ClientId","TaskLabel"]}],"required":["CorrelationId"],"properties":{"PageNum":{"type":"integer","description":"page to retrieve, 1 if not included in request","example":2},"PageSize":{"type":"integer","description":"number of results per page, 1000 if not included in request","example":10},"SortBy":{"type":"string","description":"Field to sort by (ClaimAmount|NextRecoveryDateTime|etc)\n\nCreateDateTime if not included in request","example":"ClaimCategory"},"SortType":{"type":"string","description":"Ascending or Descending sort (ASC|DESC)\n\nASC if not included in request","example":"ASC"}}}}}},"postTaskDetailsListRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId","ClaimId","TaskLabel"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2401080016C"},"TaskLabel":{"type":"string","description":"Label of tasks being retrieved for said claim","example":"Process Liability"}}}}}},"postTaskActionRequest":{"content":{"application/json":{"schema":{"type":"object","required":["CorrelationId","TaskList","Action"],"properties":{"Action":{"type":"string","description":"Action to perform","example":"Deny Claim"},"TaskList":{"type":"array","description":"List of Tasks to be actions","items":{"type":"object","required":["TaskId"],"properties":{"TaskId":{"type":"string","description":"Task identifier to be actioned","example":"123e4567-e89b-12d3-a456-426614174000"}}}},"Detail":{"type":"object","description":"When an action requires action specific details, these are passed in the Detail object."}}}}}}},"examples":{"postCustomerRetrieveRequestSuccess":{"value":{"Zip":12345,"StreetAddress":"123 Main St","FirstName":"William","State":"IL","StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"Country":"United States of America","PhoneNumber":"231-555-","LastName":"Murray","City":"Evanston","AccountList":[{"Description":"Checking Account","AccountType":"Deposit","Balance":1000,"AccountNumber":4447111111117413},{"Description":"Visa CreditCard","AccountType":"CreditCard","Balance":8564.74,"AccountNumber":3000763433},{"Description":"Deposit Account","AccountType":"Depsosit","Balance":0,"AccountNumber":4116000199012348}],"EmailAddress":"BigBadBill@disputeme.info"}},"postTaskSummaryRequestSuccess":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"TaskSummaryList":[{"TaskCount":47,"TaskLabel":"Approval Level"},{"TaskCount":13,"TaskLabel":"Execute Accounting"},{"TaskCount":42,"TaskLabel":"Final Investigation"},{"TaskCount":33,"TaskLabel":"Manually Send Letter"}]}},"postTaskListRequestSuccess":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"TaskList":[{"ClaimAmount":520,"ClaimAge":15,"NextRecoveryDateTime":"2023-12-29T05:00:00.000Z","CreateDateTime":"2024-01-08T17:44:05.421Z","TaskLabel":"Execute Accounting Service Failed","ClaimCategory":"Fraud","ClaimType":"CardPinless","TaskId":"b000fe17-e84e-42c4-85c9-5e962ea8bf70"},{"ClaimAmount":520,"ClaimAge":15,"NextRecoveryDateTime":"2023-12-29T05:00:00.000Z","CreateDateTime":"2024-01-08T17:44:04.524Z","TaskLabel":"Execute Accounting Service Failed","ClaimCategory":"Fraud","ClaimType":"CardPinless","TaskId":"b000fe17-e84e-42c4-85c9-5e962ea8bf71"},{"ClaimAmount":520,"ClaimAge":15,"NextRecoveryDateTime":"2023-12-29T05:00:00.000Z","CreateDateTime":"2024-01-08T17:20:13.749Z","TaskLabel":"Process Liability","ClaimCategory":"Fraud","ClaimType":"CardPinless","TaskId":"b000fe17-e84e-42c4-85c9-5e962ea8bf72"},{"ClaimAmount":520,"ClaimAge":15,"NextRecoveryDateTime":"2023-12-29T05:00:00.000Z","CreateDateTime":"2024-01-08T17:20:14.026Z","TaskLabel":"Process Liability","ClaimCategory":"Fraud","ClaimType":"CardPinless","TaskId":"b000fe17-e84e-42c4-85c9-5e962ea8bf73"}]}},"postTaskDetailsListRequestSuccess":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"TaskDetailsList":[{"TaskId":"8da91239-ecdd-47b6-962c-dcf76c6c20c3","DisputeId":"2401080026D","Detail":{"CreditCollection":"AccountHolder","Amount":400,"DebitAccountNumber":"","CreditAccountNumber":"5363140001113137","DebitCollection":"Suspense","Reason":"Provisional Credit"}},{"TaskId":"402b92ee-6896-4ad5-a878-7ceec5e6b3ad","DisputeId":"2401080025D","Detail":{"CreditCollection":"AccountHolder","Amount":120,"DebitAccountNumber":"","CreditAccountNumber":"5363140001113137","DebitCollection":"Suspense","Reason":"Provisional Credit"}}],"AvailableActionList":[{"Value":"Accounting Complete"},{"Value":"No Action"}]}},"postTaskActionSuccess":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}]}},"postTransactionListRequestSuccess":{"value":{"TransactionList":[{"TransactionAmount":"100.000000000","CardLastFourDigits":"8557","DisputedAmount":"100.000000000","DisputeId":"2307190009D","Description":"SoFi Tech Solutions Bank BRANCH #2145","PostingDate":"20270727","PostingDateTime":"202707272T020235.184 GMT","CurrentStage":"Analyze","LastCommitDate":"20270728T020235.184 GMT","TransactionId":"2","DisputeStatus":"Open-Disposition"}],"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}]}},"postStatusRetrieveRequestSuccess":{"value":{"ClaimType":"ConvenienceCheck","ClaimReason":"Unauthorized","TotalClaimAmount":50.99,"IsRegE10Satisfied":false,"RegE10":"2025-09-23T22:00:00.000Z","RegE10Threshold":"2025-09-26T22:00:00.000Z","IsRegESatisfied":false,"RegEDeadline":"2025-09-28T22:00:00.000Z","RegEThreshold":"2025-09-23T22:00:00.000Z","IsRegZ30Satisfied":false,"RegZ30":"2025-09-23T22:00:00.000Z","RegZ30Threshold":"2025-09-21T22:00:00.000Z","IsRegZPCSatisfied":false,"RegZPC":"2025-09-23T22:00:00.000Z","RegZPCThreshold":"2025-09-23T22:00:00.000Z","IsRegZ90Satisfied":false,"RegZ90":"2025-09-23T22:00:00.000Z","RegZ90Threshold":"2025-09-23T22:00:00.000Z","CustomerDetails":{"CustomerId":123456789,"FirstName":"John","MiddleName":"J","LastName":"Smith","EmailAddress":"john.smith@disputeme.info","PhoneNumber":"122-345-6789","LastAddressChangeDate":"2023-02-03T22:00:00.000Z"},"AccountDetails":{"Description":"MyChecking Account","AccountNumber":47386789132877656,"CardDescription":"Visa Credit Card","CardNumber":"562139058235","Balance":234.71,"OpenDate":"1997-06-09","AccountStatus":"","LastStatementDate":"2025-01-31"},"CardNumber":"562139058235","ClaimId":"2110050013C","ExternalCaseId":"13tovbv","Actions":[{"Importance":"other","ActionName":"View Communication"}],"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"Stages":[{"Status":"Current","Name":"Received"},{"Status":"Complete","Name":"Investigating"}],"CustomerContactDate":"20220323 GMT","CreateName":"SoFi Tech Solutions User","EmailAddress":"dispute_api@disputeme.info","AccountType":"CreditCard","AccountNumber":"8025307835","RequiredDocumentCount":1,"ClaimStatus":"New","TalkingPoints":[{"DisplayText":"We have created a claim ID, but the process is incomplete"}],"AccountHolder":"SoFi Tech Solutions User","HeaderDisplay":"Transaction Dispute (claimId)","HasOutstandingTasks":true,"Address":{"Zip":"01234","State":"NY","LongAddress":"THE CRIB NYC NY 01234","Country":"United States of America","City":"NYC","Line1":"THE CRIB","Line2":"","Line3":""}}},"postNotesListRequestSuccess":{"value":{"NotesList":{"LinkReference":"DATA-WORKATTACH-NOTE STS-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2106160003C!","CreateDateTime":"20270618T121038.925 GMT","CreateName":"joe shmoe","Subject":"Test Subject again","Visibility":{"Value":"Contact Center","Key":"ContactCenter"}},"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}]}},"postNotesRetrieveRequestSuccess":{"value":{"Note":"Test Note","Subject":"Test Subject","StatusList":[{"Type":"Success","Message":"Success","Code":"200"}]}},"postClaimListRequestSuccess":{"value":{"claimListResponse":[{"accountHolder":"William James Murray","requiredDocumentCount":0,"customerContactDate":"20271005T000000.000 GMT","claimId":"2110050013C","externalCaseId":"123456789","accountNumber":"4447111111117413","claimStatus":"Open-Execute","createName":"creat or","accountType":"Credit","customerId":"123456789","isClaimSubmitted":"true","totalClaimAmount":150.23}],"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}]}},"postCorrespondenceRetrieveRequestSuccess":{"value":{"EmailStyleMarkup":".sts-customercontent-table { border-collapse:collapse;","Body":"
","LetterType":"Confirmation","SaveDate":"2024-08-27T17:14:28.715Z","Channel":"Email","AttachmentAvailable":false,"From":"Default Client","To":"user@email.com","Subject":"#Secure# Message regarding your claim 2408271849C","StatusList":[{"Type":"Success","Message":"Success","Code":"200"}]}},"postCorrespondenceListRequestSuccess":{"value":{"CorrespondenceList":[{"TransmissionStatus":"Failed","SaveDate":"20270811T172051.195 GMT","ThreadSubject":"Test Subject","LinkReference":"STS-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2108100024C!20270811T172051.157 GMT","Channel":"Email","From":"Default","To":"carson@wentz.com","Document":"Claim Reopen Request Confirmation"}],"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}]}},"postAttachmentsRetrieveRequestSuccess":{"value":{"AttachmentName":"TestFile.pdf","Note":"Test File","DocumentStream":"JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC","StatusList":[{"Type":"Success","Message":"Success","Code":"200"}]}},"postAttachmentsListRequestSuccess":{"value":{"AttachmentsList":[{"Category":"Accountholder","LinkReference":"DATA-WORKATTACH-FILE STS-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2106140039C!20270818T202237.387 GMT","CreateDateTime":"20270818T202237.554 GMT","CreateName":"SoFi Tech Solutions API User","Name":"This is a test file"}],"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}]},"summary":"A sample success attachments list response"},"postCreateClaimRequestSuccess":{"value":{"ClaimId":"2108160022C","StatusList":[{"Type":"Success","Message":"Success","Code":"200"}]},"summary":"A sample Success create response"},"postRetrieveReasonsRequestSuccess":{"value":{"Questionnaire":{"QuestionList":[{"Type":"RadioButtons","AnswerList":[{"QuestionList":[{"Type":"RadioButtons","AnswerList":[{"Identifier":"MerchantDuplicate","DisplayText":"I was charged more than once."},{"Identifier":"MerchantNotProvided","DisplayText":"I haven't received merchandise or a service I purchased."},{"Identifier":"MerchantCreditNotIssued","DisplayText":"I cancelled or returned the merchandise or service and have not received the expected credit."},{"Identifier":"MerchandiseServiceIssue","DisplayText":"I am dissatisfied with the merchandise or a service I received."},{"Identifier":"ChargedCreditedIncorrect","DisplayText":"I was charged or credited incorrectly."}],"Identifier":"ClaimReason","DisplayText":"Which of the following best describes the reason for your dispute?","DataType":"String"}],"Identifier":"NonFraud","DisplayText":"I made this purchase, but there is a problem and I need to dispute it."},{"QuestionList":[{"Type":"RadioButtons","AnswerList":[{"Identifier":"CardLost","DisplayText":"I lost my card."},{"Identifier":"CardStolen","DisplayText":"My card was stolen."},{"Identifier":"CardNotReceived","DisplayText":"I did not receive my card."},{"Identifier":"CardSecure","DisplayText":"I didn't make the purchase, but I still have my card."}],"Identifier":"ClaimReason","DisplayText":"Which of the following best describes the reason for your dispute?","DataType":"String"}],"Identifier":"Fraud","DisplayText":"I did not authorize this transaction. I suspect fraud."},{"Identifier":"AuthChargeback","DisplayText":"There is an authorization issue."}],"Identifier":"ClaimReasonType","DisplayText":"Which of the following would you like to report?","DataType":"String"}],"Identifier":"DisputeReasonCard"},"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}]},"summary":"A sample Success response"},"postRetrieveTransactionsRequestSuccess":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"TransactionList":[{"AuthorizationStatus":"Pending","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3 (10.1)","Amount":"99.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":99.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270627","PostingDateTime":"20270627T130621.123 GMT","TransactionDateTime":"20270627T130621.123 GMT","SelectMode":"Multi","TransactionId":"5"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"ATMWD","Description":"7-ELEVEN 22177 (CHIP)","Amount":"27.50","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":27.5,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270626","TransactionDateTime":"20270625T130621.123 GMT","PostingDateTime":"20270626T050000.000 GMT","SelectMode":"Multi","TransactionId":"460268821703314"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3 (10.1)","Amount":"30.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270624","TransactionDateTime":"20270623T130621.123 GMT","PostingDateTime":"20270624T050000.000 GMT","SelectMode":"Multi","TransactionId":"5"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"CRUNCH BELLE ISLE (10.3)","Amount":"26.57","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":26.57,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270617","TransactionDateTime":"20270616T130621.123 GMT","PostingDateTime":"20270617T050000.000 GMT","SelectMode":"Multi","TransactionId":"8"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"Chargeback Response E-900000049","Amount":"98.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":98.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270611","TransactionDateTime":"20270610T130621.123 GMT","PostingDateTime":"20270611T050000.000 GMT","SelectMode":"Multi","TransactionId":"13"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM (10.4)","Amount":"39.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":39.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270602","TransactionDateTime":"20270601T130621.123 GMT","PostingDateTime":"20270602T050000.000 GMT","SelectMode":"Multi","TransactionId":"3"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM2","Amount":"39.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":39.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270602","TransactionDateTime":"20270601T130621.123 GMT","PostingDateTime":"20270602T050000.000 GMT","SelectMode":"Multi","TransactionId":"4"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BASECAMP FITNESS (10.1)","Amount":"79.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":79.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270408","TransactionDateTime":"20270407T130621.123 GMT","PostingDateTime":"20270408T050000.000 GMT","SelectMode":"Multi","TransactionId":"2"},{"AuthorizationStatus":"Pending","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3","Amount":"30.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20201123","TransactionDateTime":"20201123T130621.123 GMT","PostingDateTime":"20201123T050000.000 GMT","SelectMode":"Multi","TransactionId":"10"},{"AuthorizationStatus":"Posted","DebitCredit":"Credit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"91.74","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":91.74,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20201115","TransactionDateTime":"20201115T130621.123 GMT","PostingDateTime":"20201115T050000.000 GMT","SelectMode":"Multi","TransactionId":"11"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"91.74","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":91.74,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7411","Date":"20200615","TransactionDateTime":"20200615T130621.123 GMT","PostingDateTime":"20200615T050000.000 GMT","SelectMode":"Multi","TransactionId":"6"},{"AuthorizationStatus":"Posted","DebitCredit":"Credit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"30","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20200615","TransactionDateTime":"20200615T130621.123 GMT","PostingDateTime":"20200615T050000.000 GMT","SelectMode":"Multi","TransactionId":"7"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4) 2","Amount":"91.74","CardNumberEndingIn":"7413","Date":"20200612","TransactionDateTime":"20200611T130621.123 GMT","PostingDateTime":"20200612T050000.000 GMT","SelectMode":"Multi","TransactionId":"12"}]},"summary":"A sample Success response"},"postRetrieveTransactionsRequestUnavailableSuccess":{"value":{"StatusList":[{"Type":"Success","Message":"Transaction identification is unavailable for this claim.","Code":"202"}]},"summary":"A sample Success response"},"postRetrieveTransactionsRequestOptionalSuccess":{"value":{"StatusList":[{"Type":"Success","Message":"Transaction identification is optional for this claim.","Code":"203"}],"TransactionList":[{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"ATMWD","Description":"7-ELEVEN 22177 (CHIP)","Amount":"27.50","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":27.5,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270626","TransactionId":"460268821703314"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3 (10.1)","Amount":"30.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270624","TransactionId":"5"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"CRUNCH BELLE ISLE (10.3)","Amount":"26.57","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":26.57,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270617","TransactionId":"8"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"Chargeback Response E-900000049","Amount":"98.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":98.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270611","TransactionId":"13"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM (10.4)","Amount":"39.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":39.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270602","TransactionId":"3"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM2","Amount":"39.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":39.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270602","TransactionId":"4"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BASECAMP FITNESS (10.1)","Amount":"79.99","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":79.99,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20270408","TransactionId":"2"},{"AuthorizationStatus":"Pending","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"LA VICTORIA NO 3","Amount":"30.97","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30.97,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20201123","TransactionId":"10"},{"AuthorizationStatus":"Posted","DebitCredit":"Credit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"91.74","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":91.74,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20201115","TransactionId":"11"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"91.74","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":91.74,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7411","Date":"20200615","TransactionId":"6"},{"AuthorizationStatus":"Posted","DebitCredit":"Credit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4)","Amount":"30","AmountInfo":{"Exponent":2,"ISOCodeNumeric":"840","Amount":30,"ISOCurrencyName":"US Dollar","ISOCodeAlpha":"USD"},"CardNumberEndingIn":"7413","Date":"20200615","TransactionId":"7"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BIODIETSUPPLEMENTS.COM (10.4) 2","Amount":"91.74","CardNumberEndingIn":"7413","Date":"20200612","TransactionId":"12"}]},"summary":"A sample Success response"},"RetrieveClaimDetailsSuccess":{"value":{"Questionnaire":{"QuestionList":[{"QuestionList":[{"Type":"Date","Identifier":"CardLSDate","DisplayText":"When did you lose your card?","DataType":"Date","SelectedAnswer":"20270802"},{"QuestionList":[{"Type":"Nothing","Identifier":"","DisplayText":"Where did you lose your card?","DataType":"String"},{"Type":"Dropdown","Identifier":"LostStolenArea","DisplayText":"Area","DataType":"String","SelectedAnswer":"Store"},{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"Text","Identifier":"LostStolenLocation","DisplayText":"Additional details","DataType":"String"}],"Identifier":"Yes","DisplayText":"Yes"},{"Identifier":"No","DisplayText":"No"}],"Identifier":"HasAdditionalDetails","DisplayText":"Do you have additional details about where your card was lost?","DataType":"String","SelectedAnswer":"No"},{"Type":"AutoComplete","AnswerList":[{"QuestionList":[{"Type":"Dropdown","Identifier":"LostStolenState","DisplayText":"State","DataType":"String","SelectedAnswer":"GA"}],"Identifier":"United States of America","DisplayText":"US"}],"Identifier":"LostStolenCountry","DisplayText":"Country","DataType":"String","SelectedAnswer":"United States of America"}],"Type":"Questionnaire","Identifier":"LostStolenLocationQn","DisplayText":"","DataType":"String"},{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"TextMulti","Identifier":"AnythingElseDetails","DisplayText":"Please provide additional details on what else was lost.","DataType":"String"}],"Identifier":"Yes","DisplayText":"Yes"},{"Identifier":"No","DisplayText":"No"}],"Identifier":"AnythingElseInd","DisplayText":"Was anything else lost?","DataType":"String","SelectedAnswer":"No"}],"Type":"Questionnaire","Identifier":"CardLostDetails","DisplayText":"","DataType":"String"}],"Type":"Nothing","Identifier":"","Format":"Caption","DisplayText":"I lost my card.","DataType":"String"},"QuestionnaireExt":{"QuestionList":[{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"TextMulti","Identifier":"AddlInfoDetails","DisplayText":"Please provide any additional information.","DataType":"String"}],"Identifier":"Yes","DisplayText":"Yes"},{"Identifier":"No","DisplayText":"No"}],"Identifier":"AddlInfo","DisplayText":"Do you have any additional information to provide about this dispute?","DataType":"String","SelectedAnswer":"No"}]},"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}]}},"postRetrieveQuestionnaireRequestSuccess":{"value":{"Questionnaire":{"QuestionList":[{"QuestionList":[{"QuestionList":[{"QuestionList":[{"Type":"YesNo","AnswerList":[{"Identifier":"Yes","DisplayText":"Yes"},{"QuestionList":[{"Type":"Text","Identifier":"CardLocation","DisplayText":"Where is the card usually kept?","DataType":"String"},{"Type":"Text","Identifier":"CardNoPossession","DisplayText":"In what circumstances do you not have the card in your possession?","DataType":"String"}],"Identifier":"No","DisplayText":"No"}],"Identifier":"CardPossessionInd","DisplayText":"Do you always have possession of the card?","DataType":"String"},{"QuestionList":[{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"Text","Identifier":"AuthorizedName","DisplayText":"Who has authorization to use your card?","DataType":"String"}],"Identifier":"Yes","DisplayText":"Yes"},{"Identifier":"No","DisplayText":"No"}],"Identifier":"HasAuthorizedOthers","DisplayText":"Have you ever authorized another person to use your card?","DataType":"String"},{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"Text","Identifier":"SharedPINName","DisplayText":"Who did you share it with?","DataType":"String"}],"Identifier":"Yes","DisplayText":"Yes"},{"Identifier":"No","DisplayText":"No"}],"Identifier":"HasSharedPIN","DisplayText":"Have you ever shared your Personal Identification Number (PIN)?","DataType":"String"},{"QuestionList":[{"QuestionList":[{"Type":"Nothing","Identifier":"","DisplayText":"","DataType":"String"}],"Type":"Questionnaire","Identifier":"BlockAndReissueCard","DisplayText":"","DataType":"String"}],"Type":"Questionnaire","Identifier":"WherePinIsKept","DisplayText":"","DataType":"String"}],"Type":"Questionnaire","Identifier":"vsq1","DisplayText":"","DataType":"String"}],"Type":"Questionnaire","Identifier":"CardPossession","DisplayText":"","DataType":"String"}],"Type":"Section","AnswerList":[{"QuestionList":[{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"Nothing","Identifier":"","DisplayText":"Custom Section","DataType":"String"}],"Identifier":"Yes","DisplayText":"Yes"},{"Identifier":"No","DisplayText":"No"}],"Identifier":"RecognizeDisputedMerchant","DisplayText":"Is it possible that this is a planned, recurring transaction, such as a monthly or yearly subscription?","DataType":"String"}],"Identifier":"RecognizesMerchant","DisplayText":""},{"Identifier":"DoesNotRecognize","DisplayText":""}],"Identifier":"EverDoneBusiness","DisplayText":"Have you ever done business with any of these disputed merchants?","DataType":"String","APIDocumentationList":[{"ImplementationNotes":"If any selected transactions contain merchants that the customer recognizes, they can be identified with this method. In addition the answer to this question should be identified as 'RecognizesMerchant'. If the customer does not recognize any merchants, this question can be answered with 'DoesNotRecognize'.","Endpoint":"/claim/intake/recognizeDisputedTransactions","Method":"post"}]}],"Type":"Nothing","Identifier":"","DisplayText":"“I didn't make the purchase, but I still have my card.”","DataType":"String"}],"Identifier":"FraudCardSecure"},"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"PostQuestionnaire":{"QuestionList":[{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"TextMulti","Identifier":"AddlInfoDetails","DisplayText":"Please provide any additional information","DataType":"String"}],"Identifier":"Yes","DisplayText":"Yes"},{"Identifier":"No","DisplayText":"No"}],"Identifier":"AddlInfo","DisplayText":"Do you have any additional information to provide about this dispute?","DataType":"String"}],"Identifier":"SoFi Tech Solutions_Extensions_PostQns"},"TransactionDetails":{"SummaryHeader":"","SelectedPostedTransactionList":[{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM2","Amount":"39.99","CardNumberEndingIn":"7413","Date":"20270602","TransactionId":"4"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BASECAMP FITNESS (10.1)","Amount":"79.99","CardNumberEndingIn":"7413","Date":"20270408","TransactionId":"2"}]}},"summary":"A sample Success response"},"postRetrieveAccountsRequestSuccess":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"AccountList":[{"Description":"Mastercard Rewards","OpenDate":"20200701","Balance":702.12,"AccountNumber":"5555555555554444"},{"Description":"Mastercard Platinum","OpenDate":"20270701","Balance":1702.23,"AccountNumber":"5555555555554445"}]}},"postRetrieveCustomersRequestSuccess":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"CustomerList":[{"SecondaryPhone":{"Number":""},"Address":{"Zip":"12345","State":"IL","LongAddress":"123 Main St Evanston IL 12345","Country":"United States of America","City":"Evanston","Line1":"123 Main St","Line2":"","Line3":""},"Phone":{"Number":"231-555-1234"},"CustomerId":"939472005","EmailAddress":"BigBadBill@disputeme.info","Name":{"Last":"Murray","Suffix":"","BusinessName":"","FullName":"William James Murray","Prefix":"","First":"William","Middle":"James"}}]}},"postRetrieveOtherAccountRequestSuccess":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"AccountList":[{"Description":"Mastercard Rewards","OpenDate":"20200701","Balance":702.12,"AccountNumber":"5555555555554444"}]}},"postRetrieveDocRequirementsRequestSuccess":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"DocumentRequirementList":[{"TemplateDocumentStream":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTc1Cj4+CnN0cmVolJUVPRgo=","IsSatisfied":false,"Identifier":"StatementOfDispute","IsRequired":true,"Label":"Statement of Dispute","ValidAttachmentCategoryList":[{"Value":"Accountholder","Key":"Accountholder"},{"Value":"Supporting Documentation","Key":"SupportingDocumentation"}]}],"TransactionDetails":{"SummaryHeader":"","SelectedPostedTransactionList":[{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM2","Amount":"39.99","CardNumberEndingIn":"7413","Date":"20270602","TransactionId":"4"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BASECAMP FITNESS (10.1)","Amount":"79.99","CardNumberEndingIn":"7413","Date":"20270408","TransactionId":"2"}]}},"summary":"A sample Success response with document requirements"},"postClaimRetrieveDocRequirementsRequestSuccess":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"DocumentRequirementList":[{"TemplateDocumentStream":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTc1Cj4+CnN0cmVolJUVPRgo=","IsSatisfied":false,"Identifier":"StatementOfDispute","IsRequired":true,"WasDocumentReceived":true,"IsDocumentPendingReview":true,"Label":"Statement of Dispute","ValidAttachmentCategoryList":[{"Value":"Accountholder","Key":"Accountholder"},{"Value":"Supporting Documentation","Key":"SupportingDocumentation"}]}]},"summary":"A sample Success response with document requirements"},"postRetrieveDocRequirementsRequestNoDocsSuccess":{"value":{"StatusList":[{"Type":"Success","Message":"No documents are required for this case","Code":"201"}]},"summary":"A sample Success response with no document requirements"},"postRetrieveChannelInfoRequestSuccess":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"CorrespondenceChannelList":[{"IsEditable":true,"Address":{"EmailAddress":"TestCustomer@disputeme.info"},"Name":"Email"},{"IsEditable":false,"Address":{"Zip":"12345","State":"IL","LongAddress":"123 Main St IL 12345","Attention":"","Country":"United States of America","Line1":"123 Main St","Line2":"","Line3":""},"Name":"Mail"}]},"summary":"A sample Success response with correspondence channel info"},"postRetrieveConfirmationRequestSuccess":{"value":{"ConfirmationDocumentStream":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvUVPRgo=","ConfirmationMessageMarkup":"PHRhYmxlIGNsYXNzPSJxdm9Cb2R5Q29udGVudCI+PHRyPjx0ZD4gPCEtLXF2b0JvZHlDb250ZW50=","StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"ConfirmationHeader":"Confirmation #: 2108240024C","ConfirmationDocumentName":"Confirmation.pdf"}},"postRetrieveSummaryRequestSuccess":{"value":{"CorrespondenceDetails":{"CanIgnoreCorrespondencePreference":"false","SelectedChannel":"Email","ChannelList":[{"Value":"Email","Key":"Email"},{"Value":"Mail","Key":"Mail"},{"Value":"Manual","Key":"Manual"}],"EmailAddress":"TestCustomer@disputeme.info"},"SummaryContactHeader":"If we need to contact you, it will be at this address: TestCustomer@disputeme.info","StatusList":[{"Type":"Success","Message":"Success","Code":"200"}],"SummaryQuestionnaire":{"QuestionList":[{"QuestionList":[{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"TextMulti","Identifier":"PCOverrideReason","DisplayText":"Please provide a reason:","DataType":"String"}],"Identifier":"true","DisplayText":"Yes"},{"Identifier":"false","DisplayText":"No"}],"Identifier":"WithholdPC","DisplayText":"Withold Provisional Credit?","DataType":"String"},{"QuestionList":[{"QuestionList":[{"Type":"YesNo","AnswerList":[{"QuestionList":[{"Type":"TextMulti","Identifier":"ContactDateOverrideReason","DisplayText":"Please provide a reason:","DataType":"String"},{"Type":"Date","Identifier":"OverrideContactDate","DisplayText":"Enter the new date:","DataType":"Date"},{"Type":"Nothing","Identifier":"","DisplayText":"","DataType":"String"}],"Identifier":"true","DisplayText":"Yes"},{"Identifier":"false","DisplayText":"No"}],"Identifier":"IsContactDateOverridden","DisplayText":"The contact date assigned to the claim is 8/24/21. Would you like to override this date? Note: Changing the date may have regulatory impacts.","DataType":"String"}],"Type":"Questionnaire","Identifier":"ContactDateOverride","DisplayText":"","DataType":"String"}],"Type":"Questionnaire","Identifier":"FCRAClaimDetails","DisplayText":"","DataType":"String"}],"Type":"Questionnaire","Identifier":"ManualPCWithhold","DisplayText":"","DataType":"String"}],"Identifier":"SummaryQuestions"},"TransactionDetails":{"SummaryHeader":"","SelectedPostedTransactionList":[{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"123.COM2","Amount":"39.99","CardNumberEndingIn":"7413","Date":"20270602","TransactionId":"4"},{"AuthorizationStatus":"Posted","DebitCredit":"Debit","TransactionType":"CardPinless","Description":"BASECAMP FITNESS (10.1)","Amount":"79.99","CardNumberEndingIn":"7413","Date":"20270408","TransactionId":"2"}]}}},"SuccessStatusList":{"value":{"StatusList":[{"Type":"Success","Message":"Success","Code":"200"}]},"summary":"A sample Success response"},"postRequestError1":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid CustomerId","Code":"1"}]},"summary":"A sample Error 1 response"},"postRequestError2":{"value":{"StatusList":[{"Type":"Error","Message":"CustomerId or AccountNumber returned no claims","Code":"2"}]},"summary":"A sample Error 2 response"},"postRequestError4":{"value":{"StatusList":[{"Type":"Error","Message":"The requested Claim ID is not valid.","Code":"4"}]},"summary":"A sample Error 4 response"},"postRequestError5":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Request: {message}","Code":"5"}]},"summary":"A sample Error 5 response"},"postRequestError6":{"value":{"StatusList":[{"Type":"Error","Message":"Error saving claim: {message}","Code":"6"}]},"summary":"A sample Error 6 response"},"postRequestError7":{"value":{"StatusList":[{"Type":"Error","Message":"Case not resumed due to incomplete questionnaire, message: {message}","Code":"7"}]},"summary":"A sample Error 7 response"},"postRequestError8":{"value":{"StatusList":[{"Type":"Error","Message":"Problem validating search criteria: {message}","Code":"8"}]},"summary":"A sample Error 8 response"},"postRequestError9":{"value":{"StatusList":[{"Type":"Error","Message":"Unable to resume flow: {message}","Code":"9"}]},"summary":"A sample Error 9 response"},"postRequestError10":{"value":{"TranasctionList":[{"NonDisputableMessageDetails":"Credits are not disputable for this claim reason","TransactionId":"11"}],"StatusList":[{"Type":"Error","Message":"Unable to resume flow: {message}","Code":"10"}]},"summary":"A sample Error 10 response"},"postRequestError11":{"value":{"StatusList":[{"Type":"Error","Message":"Error generating confirmation document","Code":"11"}]},"summary":"A sample Error 11 response"},"postRequestError12":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid Document Identifier or Identifier returned no results","Code":"12"}]},"summary":"A sample Error 12 response"},"postRequestError13":{"value":{"StatusList":[{"Type":"Error","Message":"ClaimId references a claim that is currently locked","Code":"13"}]},"summary":"A sample Error 13 response"},"postRequestError14":{"value":{"StatusList":[{"Type":"Error","Message":"Invalid request message","Code":"14"}]},"summary":"A sample Error 14 response"},"postRequestError15":{"value":{"StatusList":[{"Type":"Error","Message":"This claim is already resolved with status: {message}","Code":"15"}]},"summary":"A sample Error 15 response"},"postRequestError16":{"value":{"StatusList":[{"Type":"Error","Message":"This claim has been submitted for processing and this action can no longer be performed","Code":"16"}]},"summary":"A sample Error 16 response"},"postRequestError17":{"value":{"StatusList":[{"Type":"Error","Message":"No customers were found with given search parameters","Code":"17"}]},"summary":"A sample Error 17 response"},"postRequestError18":{"value":{"StatusList":[{"Type":"Error","Message":"AccountNumber is not found","Code":"18"}]},"summary":"A sample Error 18 response"},"postRequestError19":{"value":{"StatusList":[{"Type":"Error","Message":"Unable to Process request. The ClaimID has not been submitted..","Code":"19"}]},"summary":"A sample Error 19 response"},"postRequestError20":{"value":{"StatusList":[{"Type":"Error","Message":"Attachment names must be unique."}]},"summary":"A sample Error 20 response"},"postRequestError21":{"value":{"StatusList":[{"Type":"Error","Message":"A request to reopen this dispute is already in progress.","Code":"21"}]},"summary":"A sample Error 21 response"},"postRequestError22":{"value":{"StatusList":[{"Type":"Error","Message":"A requested transaction id is invalid for this claim.","Code":"22"}]},"summary":"A sample Error 22 response"},"postRequestError23":{"value":{"StatusList":[{"Type":"Error","Message":"A request to withdraw this claim is already present.","Code":"23"}]},"summary":"A sample Error 23 response"},"postRequestError24":{"value":{"StatusList":[{"Type":"Error","Message":"A requested dispute id is invalid for this claim.","Code":"24"}]},"summary":"A sample Error 24 response"},"postRequestError25":{"value":{"StatusList":[{"Type":"Error","Message":"The requested transaction has not completed enrichment. Additional details cannot be retrieved.","Code":"25"}]},"summary":"A sample Error 25 response"},"postRequestError500":{"value":{"StatusList":[{"Type":"Error","Message":"Could not obtain a lock on the claim","Code":"500"}]},"summary":"A sample Error 500 response"}},"schemas":{"AttachmentsAddRequest":{"type":"object","required":["ClaimId","AttachmentList"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"AttachmentList":{"type":"array","description":"List of attachments to add to the claim","items":{"allOf":[{"type":"object","required":["FileName","Category","Label","DocumentStream"],"properties":{"DocumentStream":{"type":"string","description":"Byte stream of the form PDF being uploaded to satisfy the requirement","examples":["JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"]},"Category":{"type":"string","description":"Attachment category (one of the subset of `ValidAttachmentCategoryList` in the `/claim/documents/retrieveRequirements` response)","examples":["SupportingDocumentation"]},"FileName":{"type":"string","description":"Name of the file being passed in DocumentStream param","examples":["StatementOfDispute.pdf"]},"Label":{"type":"string","description":"User friendly attachment label","examples":["Statement of Dispute"]}}}]}}}},"AttachmentsListRequest":{"type":"object","required":["ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}},"AttachmentsListResponse":{"type":"object","properties":{"AttachmentsList":{"type":"array","items":{"type":"object","properties":{"Category":{"type":"string","description":"Attachment category"},"LinkReference":{"type":"string","description":"Unique Reference ID of the attachment. Used when retrieving a specific attachment."},"CreateDateTime":{"type":"string","format":"Date-Time","description":"When the attachment was created"},"CreateName":{"type":"string","description":"Who created the attachment"},"Name":{"type":"string","description":"Name of attachment"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"AttachmentsRetrieveRequest":{"type":"object","required":["LinkReference"],"properties":{"LinkReference":{"type":"string","description":"Unique Reference ID used to retrieve a specific attachment. Can be retrieved in /claim/attachments/list","example":"DATA-WORKATTACH-NOTE STS-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2408050075C!20250124T180306.386 GMT"}}},"AttachmentsRetrieveResponse":{"type":"object","properties":{"AttachmentName":{"type":"string","description":"Name of attachment"},"Note":{"type":"string","description":"Attachment label"},"DocumentStream":{"type":"string","description":"Attachment document stream"},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"ReopenRequestRequest":{"type":"object","required":["ClaimId","ReopenReason","TransactionList"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"ReopenReason":{"type":"string","description":"Reasoning for requesting the claim to be reopen","example":"Test reopen reason"},"ReopenNewInformation":{"type":"string","description":"Any new information about the disputes. Optional information the user can choose to provide.","example":"New information about the disputes"},"TransactionList":{"description":"List of transactions to reopen when calling `/claim/reopenRequest`","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}}}},"ReopenRequestResponse":{"type":"object","properties":{"ConfirmationHeaderMessage":{"type":"string","description":"header message for customer content","example":"Reopen request message content"},"ConfirmationMessageMarkup":{"type":"string","description":"base64 encoded markup for confirmation letter","example":".sts-customercontent-table { border-collapse:collapse;"},"ConfirmationHeader":{"type":"string","description":"header/title for confirmation","example":"Reopen Request"},"Address":{"allOf":[{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}],"type":"object","description":"optional address details. returned if the selected correspondence\nchannel is mail\n","properties":{"Province":{"type":"string","description":"Mailing address province","example":"Saskatchewan"}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"WithdrawRequestRequest":{"type":"object","required":["ClaimId","WithdrawalReason","TransactionList"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2408050075C"},"WithdrawalReason":{"type":"string","description":"Reason for claim to be withdrawn","example":"Test reason for withdrawal"},"TransactionList":{"type":"array","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}},"description":"List of transactions to be withdrawn"}}},"ClaimListRequest":{"type":"object","properties":{"daysToLookBack":{"type":"number","description":"Days prior to search for claims\nDefaults to 30 days. Custom value can be passed in"},"customerId":{"type":"string","description":"Customer ID to search for claims for\n\nExactly one of `customerId`, `accountNumber`, or `claimId` is **required**","example":25945893},"accountNumber":{"type":"string","description":"Account number to search for claims for\n\nExactly one of `customerId`, `accountNumber`, or `claimId` is **required**","example":4123123412341234},"claimId":{"type":"string","description":"Specific Claim ID to search for\n\nExactly one of `customerId`, `accountNumber`, or `claimId` is **required**","example":"2503040008C"}}},"ClaimListResponse":{"type":"object","properties":{"claimListResponse":{"type":"array","items":{"type":"object","properties":{"accountHolder":{"type":"string","description":"Account Holder"},"requiredDocumentCount":{"type":"number","description":"Number of document required on this claim"},"customerContactDate":{"type":"string","format":"Date-Time","description":"Customer Contact Date

Format:yyyyMMdd"},"claimId":{"type":"string","description":"Unique claim ID"},"accountNumber":{"type":"string","description":"Account Number"},"claimStatus":{"type":"string","description":"Status of the Claim, see Status Values"},"createName":{"type":"string","description":"Who created the claim"},"accountType":{"type":"string","description":"Type of account"},"customerId":{"type":"string","description":"Customer ID","example":25945893},"externalCaseId":{"type":"string","description":"Optional ID representing claim identifier external to this dispute system (client internal identifier)"},"isClaimSubmitted":{"type":"boolean","description":"If the claim has been submitted or not"},"totalClaimAmount":{"type":"number","description":"The sum of all disputed transaction amounts"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"ClaimDetailsRetrieveRequest":{"type":"object","required":["ClaimId","CorrelationId"],"properties":{"ClaimId":{"type":"string","example":"2503040008C"}}},"ClaimDetailsRetrieveResponse":{"type":"object","properties":{"Questionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"DisputeReasonQuestionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"QuestionnaireExt":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"ClaimRecoveryDetailsRetrieveRequest":{"type":"object","required":["DisputeId"],"properties":{"DisputeId":{"type":"string","example":"2312130009D"}}},"ClaimRecoveryDetailsRetrieveResponse":{"type":"object","properties":{"recoveryDetailsList":{"type":"array","items":{"type":"object","properties":{"DisputeAmount":{"type":"number","example":24.99},"RecoveryAttempt":{"type":"string","example":"Not Sent"},"RecoveryAssociation":{"type":"string","example":"Ethoca"},"EnteredBy":{"type":"string","example":"John Smith"},"ReasonCode":{"type":"string","example":"Fraud"},"Date":{"type":"string","description":"Format:yyyy-MM-dd","example":"2024-06-24"},"ResponseReceived":{"type":"string","example":"Dispute Accepted - Full"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"CorrespondenceListRequest":{"type":"object","required":["ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2503210037C"}}},"CorrespondenceListResponse":{"type":"object","properties":{"CorrespondenceList":{"type":"array","items":{"type":"object","properties":{"TransmissionStatus":{"type":"string","description":"Transmission Status of the correspondence"},"SaveDate":{"type":"string","format":"Date-Time","description":"Correspondence save date"},"ThreadSubject":{"type":"string","description":"Correspondence subject","example":"Test Subject"},"LinkReference":{"type":"string","description":"Unique Reference ID. Can be used to retrieve specific correspondence","example":"DATA-WORKATTACH-NOTE STS-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2408050075C!20250124T180306.386 GMT"},"Channel":{"type":"string","description":"Correspondence Channel"},"From":{"type":"string","description":"Who the correspondence is from"},"To":{"type":"string","description":"Who the correspondence was sent to"},"Document":{"type":"string","description":"Correspondence Name"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"CorrespondenceRetrieveRequest":{"type":"object","required":["LinkReference"],"properties":{"LinkReference":{"type":"string","description":"Unique Reference ID of the correspondence. Can be retrieved using /claim/correspondence/list","example":"DATA-WORKATTACH-NOTE STS-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2408050075C!20250124T180306.386 GMT"}}},"CorrespondenceRetrieveResponse":{"type":"object","properties":{"LetterType":{"type":"string","description":"Type of letter"},"TransmissionStatus":{"type":"string","description":"Transmission status of the letter"},"SaveDate":{"type":"string","description":"Date the correspondence was saved"},"Channel":{"type":"string","description":"Correspondence channel"},"AttachmentAvailable":{"type":"boolean","description":"Is an attachment available for this correspondence"},"From":{"type":"string","description":"Correspondence from field"},"To":{"type":"string","description":"Correspondence to field"},"EmailStyleMarkup":{"type":"string","description":"Correspondence Markup"},"Body":{"type":"string","description":"Correspondence Body"},"Subject":{"type":"string","description":"Correspondence Subject","example":"Test Subject"},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"CorrespondenceResendRequest":{"type":"object","required":["ClaimId","LinkReference"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2408050075C"},"LinkReference":{"type":"string","description":"Unique Reference ID of the correspondence. Can be retrieved using /claim/correspondence/list","example":"DATA-WORKATTACH-NOTE STS-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2408050075C!20250124T180306.386 GMT"}}},"CustomerRetrieveRequest":{"type":"object","required":["CustomerId"],"properties":{"CustomerId":{"type":"string","description":"The Customer ID for the customer the user wants to retrieve","example":25945893}}},"CustomerRetrieveResponse":{"type":"object","properties":{"FirstName":{"type":"string","description":"Customer's First Name"},"LastName":{"type":"string","description":"Customer's Last Name"},"StreetAddress":{"type":"string","description":"Customer's Street Address"},"City":{"type":"string","description":"Customer's City"},"State":{"type":"string","description":"Customer's State"},"Zip":{"type":"string","description":"Customer's Zip code"},"Country":{"type":"string","description":"Customer's Country"},"EmailAddress":{"type":"string","description":"Customer's Email Address"},"PhoneNumber":{"type":"string","description":"Customer's Phone Number"},"AccountList":{"type":"array","items":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"Customer's Account Number"},"Description":{"type":"string","description":"Account Description"},"AccountType":{"type":"string","description":"Type of Account"},"Balance":{"type":"number","description":"Current Balance of the Account"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"ClaimRetrieveDocumentRequirementRequest":{"type":"object","required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}},"ClaimDocumentRequirementsResponse":{"type":"object","properties":{"DocumentRequirementList":{"type":"array","description":"List of document requirements that must be added to the claim.","items":{"allOf":[{"type":"object","properties":{"TemplateDocumentStream":{"type":"string","description":"Byte stream of the template form pdf","example":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"},"IsSatisified":{"type":"boolean","description":"Has this document requirement been satisfied?","example":false},"Identifier":{"type":"string","description":"Document requirement identifier","example":"StatementOfDispute"},"IsRequired":{"type":"boolean","description":"Is this document required?","example":true},"Label":{"type":"string","description":"A user friendly label of the document requirement","example":"Statement of Dispute"},"ValidAttachmentCategoryList":{"type":"array","items":{"type":"object","properties":{"Key":{"type":"string","description":"Key value, this is what is passed back in with the add document request","example":"SupportingDocumentation"},"Value":{"type":"string","description":"User friendly display value","example":"Supporting Documentation"}}}}}}],"type":"object","properties":{"WasDocumentReceived":{"type":"boolean","description":"was the document received"},"IsDocumentPendingReview":{"type":"boolean","description":"it the document pending review"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"ClaimDocumentAddRequest":{"type":"object","properties":{"ClaimId":{"type":"string","example":"2501240026C"},"DocumentRequirementList":{"type":"array","items":{"type":"object","properties":{"DocumentStream":{"type":"string","description":"Document content stream","example":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTc0Cj4+CnN0cmVhbQp42t1YbXPaOBD+jH/FztzdT"},"Identifier":{"type":"string","description":"ID of document requirement to be fulfilled. Identifier is returned in /claim/documents/retrieveRequirements","example":"ProofOfPayment"},"Category":{"type":"string","description":"category of the document","example":"SupportingDocumentation","enum":["Accountholder","Association","Internal","SupportingDocumentation"]},"FileName":{"type":"string","description":"Name of the file being attached","example":"ProofOfPayment.pdf"},"Label":{"type":"string","description":"Label for the document being added","example":"Proof Of Payment"}}}}}},"ClaimDocumentAddResponse":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"RetrieveCustomersRequest":{"type":"object","required":["CorrelationId"],"properties":{"CustomerId":{"type":"string","description":"ID of the customer to search for. Only required if the user is searching for a specific customer based on ID.","example":123456789},"ClientId":{"type":"string","description":"ID of the Client we want to retrieve customers for. for multi-client systems. Only required if the user is searching for customers for a specific Client.","example":"ABC"},"AccountNumber":{"type":"string","description":"Account Number of the customer to search for. Only required if the user is searching for a specific customer based on their account number.","example":6523456789},"SSNTIN":{"type":"string","description":"The SSN/TIN of the customer to search for. Only required if the user is searching for a specific customer based on their SSIN/TIN.","example":1234567890},"CardNumber":{"type":"string","description":"The Card Number of the customer to search for. Only required if the user is searching for a specific customer based on their card number.","example":5555555555554445},"Name":{"type":"object","description":"The Name of the customer to search for. Only required if the user is searching for a specific customer based on their first name and/or their last name.","properties":{"First":{"type":"string","example":"Jake"},"Last":{"type":"string","example":"Smith"}}},"Address":{"type":"object","description":"The Address of the customer to search for. Only required if the user is searching for a specific customer based on their address.","properties":{"Line1":{"type":"string","example":"3052 Lake Ave."},"City":{"type":"string","example":"Chicago"},"State":{"type":"string","example":"IL"},"Zip":{"type":"string","example":60007}}}}},"RetrieveCustomersResponse":{"type":"object","properties":{"CustomerList":{"type":"array","items":{"type":"object","properties":{"CustomerId":{"type":"string","description":"Unique Customer ID","example":939472005},"Name":{"type":"object","properties":{"Prefix":{"type":"string","description":"Customer's prefix","example":"Mr."},"First":{"type":"string","description":"Customer's first name","example":"John"},"Middle":{"type":"string","description":"Customer's middle name","example":"Eugene"},"Last":{"type":"string","description":"Customer's last name","example":"Doe"},"Suffix":{"type":"string","description":"Customer's suffix","example":"Jr."},"BusinessName":{"type":"string","description":"Customer's Business name (for business entities)","example":"Porkchop Express"},"FullName":{"type":"string","description":"Customer's full name","example":"Mr. John Eugene Doe Jr."}}},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}},"Phone":{"type":"object","properties":{"Number":{"type":"string","description":"Phone number","example":"555-123-1234"}}},"SecondaryPhone":{"type":"object","properties":{"Number":{"type":"string","description":"Phone number","example":"555-123-1234"}}},"EmailAddress":{"type":"string","description":"Customer's email address","example":"TestCustomer@disputeme.info"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"RetrieveAccountsRequest":{"type":"object","required":["CorrelationId","CustomerId"],"properties":{"CustomerId":{"type":"string","description":"ID of the customer to retrieve accounts for","example":25945893}}},"RetrieveAccountsResponse":{"type":"object","properties":{"AccountList":{"type":"array","items":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"Account Number","examples":[5555555555554445]},"Balance":{"type":"string","description":"Balance on the account","examples":[701.12]},"Description":{"type":"string","description":"Account description","examples":["Mastercard Rewards"]},"OpenDate":{"type":"string","description":"Date the account was opened.

Format:yyyyMMdd","examples":[20200701]}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"CommonCreateClaimRequest":{"type":"object","required":["CustomerId","AccountNumber"],"properties":{"CustomerId":{"type":"string","description":"Unique Customer ID to create the claim for","example":123456789},"AccountNumber":{"type":"string","description":"Account number the transaction dispute(s) are to be processed against for the new claim.","example":5555555555554444}}},"CreateClaimRequest":{"type":"object","allOf":[{"type":"object","required":["CustomerId","AccountNumber"],"properties":{"CustomerId":{"type":"string","description":"Unique Customer ID to create the claim for","example":123456789},"AccountNumber":{"type":"string","description":"Account number the transaction dispute(s) are to be processed against for the new claim.","example":5555555555554444}}}],"required":["CorrelationId"],"properties":{"CustomerId":{"type":"string","description":"Unique Customer ID to create the claim for","example":123456789},"AccountNumber":{"type":"string","description":"Account number the transaction dispute(s) are to be processed against for the new claim.","example":5555555555554444}}},"CreateClaimResponse":{"type":"object","properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"BulkCreateClaimRequest":{"type":"object","required":["CorrelationId"],"properties":{"ClaimList":{"type":"array","description":"List of claim payloads.","items":{"type":"object","properties":{"Create":{"type":"object","allOf":[{"type":"object","required":["CustomerId","AccountNumber"],"properties":{"CustomerId":{"type":"string","description":"Unique Customer ID to create the claim for","example":123456789},"AccountNumber":{"type":"string","description":"Account number the transaction dispute(s) are to be processed against for the new claim.","example":5555555555554444}}}]},"AddClaimReasons":{"type":"object","allOf":[{"type":"object","required":["Questionnaire"],"properties":{"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}]},"RetrieveTransactions":{"type":"object","allOf":[{"type":"object","properties":{"SearchAccountNumber":{"type":"number","description":"Account number for searching for transactions that are on a different account than the claim.\n\n**Required** only if the user needs to add transactions to the claim that are on a different account than the claim's disputed transactions."},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20200601},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20210812},"SearchAmount":{"type":"string","description":"Transaction amount to search for.\n\n**Required** only if the user is searching for a transaction with a specific amount.","example":2.09},"SearchMerchantName":{"type":"string","description":"Merchant name/Transaction description to search for.\n\n**Required** only if the user is searching for a transaction with a specific merchant","example":"Amazon"}}}]},"AddTransactions":{"type":"object","allOf":[{"type":"object","required":["TransactionList"],"properties":{"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}}}}]},"Submit":{"type":"object","allOf":[{"type":"object","properties":{"CorrespondenceDetails":{"type":"object","properties":{"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}]}}}}}},"RetrieveQuestionnaireRequest":{"type":"object","required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}},"RetrieveReasonsResponse":{"type":"object","properties":{"Questionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"CommonAddQuestionnaireRequest":{"type":"object","required":["Questionnaire"],"properties":{"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}},"AddQuestionnaireRequest":{"type":"object","allOf":[{"type":"object","required":["Questionnaire"],"properties":{"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}],"required":["CorrelationId","ClaimId","Questionnaire"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","examples":["2108160022C"]},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}},"RetrieveTransactionsBaseRequest":{"type":"object","required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","examples":[20200601]},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","examples":[20210812]}}},"CommonRetrieveTransactionsRequest":{"type":"object","properties":{"SearchAccountNumber":{"type":"number","description":"Account number for searching for transactions that are on a different account than the claim.\n\n**Required** only if the user needs to add transactions to the claim that are on a different account than the claim's disputed transactions."},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20200601},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20210812},"SearchAmount":{"type":"string","description":"Transaction amount to search for.\n\n**Required** only if the user is searching for a transaction with a specific amount.","example":2.09},"SearchMerchantName":{"type":"string","description":"Merchant name/Transaction description to search for.\n\n**Required** only if the user is searching for a transaction with a specific merchant","example":"Amazon"}}},"RetrieveTransactionsRequest":{"type":"object","allOf":[{"type":"object","properties":{"SearchAccountNumber":{"type":"number","description":"Account number for searching for transactions that are on a different account than the claim.\n\n**Required** only if the user needs to add transactions to the claim that are on a different account than the claim's disputed transactions."},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20200601},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20210812},"SearchAmount":{"type":"string","description":"Transaction amount to search for.\n\n**Required** only if the user is searching for a transaction with a specific amount.","example":2.09},"SearchMerchantName":{"type":"string","description":"Merchant name/Transaction description to search for.\n\n**Required** only if the user is searching for a transaction with a specific merchant","example":"Amazon"}}}],"required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}},"RetrieveTransactionsResponse":{"type":"object","properties":{"TransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"CommonAddTransactionsRequest":{"type":"object","required":["TransactionList"],"properties":{"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}}}},"AddTransactionsRequest":{"type":"object","allOf":[{"type":"object","required":["TransactionList"],"properties":{"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}}}}],"required":["CorrelationId","ClaimId","TransactionList"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}},"TransactionSearchStartDate":{"description":"Start date for the search to build the transaction list.","type":"string","format":"Date","example":20241101},"TransactionSearchEndDate":{"description":"End date for the search to build the transaction list.","type":"string","format":"Date","example":20241130}}},"RetrieveQuestionnaireResponse":{"type":"object","properties":{"Questionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"PostQuestionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"TransactionDetails":{"type":"object","description":"Details about the selected transaction to display to the user.","properties":{"SummaryHeader":{"type":"string","description":"Posted Transaction Details header"},"SelectedPostedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"PendingSummaryHeader":{"type":"string","description":"Pending Transaction Details header"},"SelectedPendingTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"RecurringSummaryHeader":{"type":"string","description":"Recurring Transaction Details header"},"SelectedRecurringTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"DeflectedSummaryHeader":{"type":"string","description":"Deflected Transaction Details header"},"DeflectedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"RetrieveSimilarTransactionsRequest":{"allOf":[{"type":"object","allOf":[{"type":"object","properties":{"SearchAccountNumber":{"type":"number","description":"Account number for searching for transactions that are on a different account than the claim.\n\n**Required** only if the user needs to add transactions to the claim that are on a different account than the claim's disputed transactions."},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20200601},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20210812},"SearchAmount":{"type":"string","description":"Transaction amount to search for.\n\n**Required** only if the user is searching for a transaction with a specific amount.","example":2.09},"SearchMerchantName":{"type":"string","description":"Merchant name/Transaction description to search for.\n\n**Required** only if the user is searching for a transaction with a specific merchant","example":"Amazon"}}}],"required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"}}},{"type":"object","properties":{"SearchAccountNumber":{"type":"string","description":"Account number to search for if different than selected account on claim\n\n**Required** only if the user is searching for a transaction on a different account than the account on the claim."}}}]},"RetrieveOtherAccountsResponse":{"type":"object","properties":{"AccountList":{"type":"array","items":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"Account Number","examples":[5555555555554445]},"Balance":{"type":"string","description":"Balance on the account","examples":[701.12]},"Description":{"type":"string","description":"Account description","examples":["Mastercard Rewards"]},"OpenDate":{"type":"string","description":"Date the account was opened.

Format:yyyyMMdd","examples":[20200701]}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"AddCheckDepositsRequest":{"type":"object","required":["ClaimId","CheckDepositList"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"CheckDepositList":{"type":"array","description":"List of check deposits to add to the claim","items":{"type":"object","required":["Amount"],"properties":{"Amount":{"type":"string","description":"Amount of the check","examples":[123.45]},"CheckNumber":{"type":"string","description":"Check number","examples":[123]},"Date":{"type":"string","description":"Date of the check

Format:yyyyMMdd","examples":[20120701]},"From":{"type":"string","description":"Check issuer","examples":["John Doe"]}}}}}},"RetrieveDocRequirementsResponse":{"type":"object","properties":{"DocumentRequirementList":{"type":"array","description":"List of document requirements that must be added to the claim.","items":{"type":"object","properties":{"TemplateDocumentStream":{"type":"string","description":"Byte stream of the template form pdf","example":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"},"IsSatisified":{"type":"boolean","description":"Has this document requirement been satisfied?","example":false},"Identifier":{"type":"string","description":"Document requirement identifier","example":"StatementOfDispute"},"IsRequired":{"type":"boolean","description":"Is this document required?","example":true},"Label":{"type":"string","description":"A user friendly label of the document requirement","example":"Statement of Dispute"},"ValidAttachmentCategoryList":{"type":"array","items":{"type":"object","properties":{"Key":{"type":"string","description":"Key value, this is what is passed back in with the add document request","example":"SupportingDocumentation"},"Value":{"type":"string","description":"User friendly display value","example":"Supporting Documentation"}}}}}}},"TransactionDetails":{"type":"object","description":"Details about the selected transaction to display to the user.","properties":{"SummaryHeader":{"type":"string","description":"Posted Transaction Details header"},"SelectedPostedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"PendingSummaryHeader":{"type":"string","description":"Pending Transaction Details header"},"SelectedPendingTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"RecurringSummaryHeader":{"type":"string","description":"Recurring Transaction Details header"},"SelectedRecurringTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"DeflectedSummaryHeader":{"type":"string","description":"Deflected Transaction Details header"},"DeflectedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"AddDocumentsRequest":{"type":"object","properties":{"ClaimId":{"type":"string","description":"Unique claim ID","examples":["2108160022C"]},"DocumentRequirementList":{"type":"array","items":{"allOf":[{"type":"object","required":["FileName","Category","Label","DocumentStream"],"properties":{"DocumentStream":{"type":"string","description":"Byte stream of the form PDF being uploaded to satisfy the requirement","examples":["JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"]},"Category":{"type":"string","description":"Attachment category (one of the subset of `ValidAttachmentCategoryList` in the `/claim/documents/retrieveRequirements` response)","examples":["SupportingDocumentation"]},"FileName":{"type":"string","description":"Name of the file being passed in DocumentStream param","examples":["StatementOfDispute.pdf"]},"Label":{"type":"string","description":"User friendly attachment label","examples":["Statement of Dispute"]}}},{"type":"object","properties":{"Identifier":{"type":"string","description":"Document requirement identifier","examples":["StatementOfDispute"]}}}]}}}},"RetrieveCorrChannelResponse":{"type":"object","properties":{"CorrespondenceChannelList":{"type":"array","description":"List of customer's correspondence channel information.","items":{"oneOf":[{"$ref":"#/components/schemas/CorrespondenceChannelEmail"},{"$ref":"#/components/schemas/CorrespondenceChannelMail"}],"discriminator":{"propertyName":"Name"}}},"TransactionDetails":{"type":"object","description":"Details about the selected transaction to display to the user.","properties":{"SummaryHeader":{"type":"string","description":"Posted Transaction Details header"},"SelectedPostedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"PendingSummaryHeader":{"type":"string","description":"Pending Transaction Details header"},"SelectedPendingTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"RecurringSummaryHeader":{"type":"string","description":"Recurring Transaction Details header"},"SelectedRecurringTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"DeflectedSummaryHeader":{"type":"string","description":"Deflected Transaction Details header"},"DeflectedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"VerifyChannelInfoRequest":{"type":"object","required":["CorrelationId","ClaimId","CorrespondenceChannelList"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","examples":["2108160022C"]},"CorrespondenceChannelList":{"type":"array","description":"List of correspondence channels that the user wants to verify or update.","items":{"oneOf":[{"$ref":"#/components/schemas/CorrespondenceChannelEmailRequest"},{"$ref":"#/components/schemas/CorrespondenceChannelMailRequest"}],"discriminator":{"propertyName":"Name"}}}}},"RetrieveSummaryResponse":{"type":"object","properties":{"CorrespondenceDetails":{"type":"object","properties":{"CanIgnoreCorrespondencePreference":{"type":"boolean","description":"Can the client ignore the correspondence preference?","example":false},"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"ChannelList":{"type":"array","items":{"type":"object","properties":{"Key":{"type":"string","description":"Stored value","example":"Email"},"Value":{"type":"string","description":"Display value","example":"Email"}}}},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"SummaryContactHeader":{"type":"string","description":"Summary information about our customer contact method","examples":["If we need to contact you, it will be at this address: TestCustomer@disputeme.info"]},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"SummaryQuestionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"TransactionDetails":{"type":"object","description":"Details about the selected transaction to display to the user.","properties":{"SummaryHeader":{"type":"string","description":"Posted Transaction Details header"},"SelectedPostedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"PendingSummaryHeader":{"type":"string","description":"Pending Transaction Details header"},"SelectedPendingTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"RecurringSummaryHeader":{"type":"string","description":"Recurring Transaction Details header"},"SelectedRecurringTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"DeflectedSummaryHeader":{"type":"string","description":"Deflected Transaction Details header"},"DeflectedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}}}}}},"CommonClaimSubmitRequest":{"type":"object","properties":{"CorrespondenceDetails":{"type":"object","properties":{"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}},"ClaimSubmitRequest":{"type":"object","allOf":[{"type":"object","properties":{"CorrespondenceDetails":{"type":"object","properties":{"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}],"required":["CorrelationId","ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2108160022C"},"CorrespondenceDetails":{"type":"object","properties":{"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}},"RetrieveConfirmationResponse":{"type":"object","properties":{"ConfirmationDocumentStream":{"type":"string","description":"Byte stream of the confirmation pdf","example":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"},"ConfirmationMessageMarkup":{"type":"string","description":"Byte stream of the confirmation message","examples":["PHRhYmxlIGNsYXNzPSJxdm9Cb2R5Q29udGVudCI+PHRyPjx0ZD4gPCEtLXF+"]},"ConfirmationHeader":{"type":"string","description":"Confirmation header","examples":["Confirmation #: 2108240024C"]},"ConfirmationDocumentName":{"type":"string","description":"Confirmation document name","examples":["Confirmation.pdf"]},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"NotesAddRequest":{"type":"object","required":["ClaimId","Subject","Note"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2501240026C"},"Subject":{"type":"string","description":"Note subject","example":"Example Subject"},"Note":{"type":"string","description":"Note contents","example":"Example Note Contents"},"Visibility":{"type":"string","enum":["ContactCenter","Customer","Fulfillment"],"description":"Visibility setting for the note. If not provided, defaults to client operator access group."}}},"NotesListRequest":{"type":"object","required":["ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2501240026C"}}},"NotesListResponse":{"type":"object","properties":{"NotesList":{"type":"array","items":{"type":"object","properties":{"LinkReference":{"type":"string","description":"Unique Reference ID of the note. Can be used to retrieve a specific note"},"Note":{"type":"string","description":"Note content"},"CreateDateTime":{"type":"string","format":"Date-Time","description":"Time the note was created"},"CreateName":{"type":"string","description":"Who created the note"},"Subject":{"type":"string","description":"Note Subject","example":"Example Subject"},"Visibility":{"type":"object","properties":{"Key":{"type":"string","example":"Contact Center"},"Value":{"type":"string","example":"ContactCenter"}}}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"NotesRetrieveRequest":{"type":"object","required":["LinkReference"],"properties":{"LinkReference":{"type":"string","description":"Unique Reference ID of the note. Can be retrieved in /claim/notes/list","example":"DATA-WORKATTACH-NOTE STS-FW-FF-WORK-P-FB-CLAIMS-CLAIM 2408050075C!20250124T180306.386 GMT"}}},"NotesRetrieveResponse":{"type":"object","properties":{"Note":{"type":"string","description":"Note contents"},"Subject":{"type":"string","description":"Note subject","example":"Test Subject"},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"TaskSummaryRequest":{"type":"object","required":["CorrelationId","ClientId"],"properties":{"ClientId":{"type":"string","example":"Default"}}},"TaskSummaryResponse":{"type":"object","properties":{"TaskSummaryList":{"type":"array","items":{"type":"object","properties":{"TaskCount":{"type":"number"},"TaskLabel":{"type":"string"}}}}}},"TaskListRequest":{"type":"object","oneOf":[{"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2401080016C"}},"required":["ClaimId"]},{"properties":{"ClientId":{"type":"string","description":"ClientId representing client for which tasks are being retrieved","example":"Default"},"TaskLabel":{"type":"string","description":"Label of tasks being retrieved for said client","example":"Process Liability"}},"required":["ClientId","TaskLabel"]}],"required":["CorrelationId"],"properties":{"PageNum":{"type":"integer","description":"page to retrieve, 1 if not included in request","example":2},"PageSize":{"type":"integer","description":"number of results per page, 1000 if not included in request","example":10},"SortBy":{"type":"string","description":"Field to sort by (ClaimAmount|NextRecoveryDateTime|etc)\n\nCreateDateTime if not included in request","example":"ClaimCategory"},"SortType":{"type":"string","description":"Ascending or Descending sort (ASC|DESC)\n\nASC if not included in request","example":"ASC"}}},"TaskListResponse":{"type":"object","properties":{"TaskList":{"type":"array","items":{"type":"object","properties":{"ClaimAmount":{"type":"number","description":"Total claim amount","examples":[225.25]},"ClaimAge":{"type":"integer","description":"Age of claims in days","examples":[19]},"NextRecoveryDateTime":{"type":"string","description":"Next Recovery date time","examples":["2023-12-28T05:00:00.000Z"]},"NextRegulatoryDateTime":{"type":"string","description":"Next Regulatory date time","examples":["2024-03-26T09:00:00.000Z"]},"TaskLabel":{"type":"string","description":"label of task","examples":["Process Liability"]},"ClaimCategory":{"type":"string","description":"Claim category","examples":["Fraud"]},"ClaimType":{"type":"string","description":"Claim type","examples":["CardPinless"]},"TaskId":{"type":"string","description":"UUID of task","examples":["b000fe17-e84e-42c4-85c9-5e962ea8bf70"]}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"TaskDetailsListRequest":{"type":"object","required":["CorrelationId","ClaimId","TaskLabel"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2401080016C"},"TaskLabel":{"type":"string","description":"Label of tasks being retrieved for said claim","example":"Process Liability"}}},"TaskDetailsListResponse":{"type":"object","properties":{"AvailableActionList":{"type":"array","items":{"type":"object","properties":{"Value":{"type":"string","description":"available action","examples":["Accounting Compete"]}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"TaskDetailList":{"type":"array","items":{"type":"object","properties":{"TaskId":{"type":"string","description":"UUID of task","examples":["b000fe17-e84e-42c4-85c9-5e962ea8bf70"]},"DisputeId":{"type":"string","description":"Dispute Id","examples":["2401080025D"]},"Detail":{"type":"object","description":"Dynamic detail object, depends on task"}}}}}},"TaskActionRequest":{"type":"object","required":["CorrelationId","TaskList","Action"],"properties":{"Action":{"type":"string","description":"Action to perform","example":"Deny Claim"},"TaskList":{"type":"array","description":"List of Tasks to be actions","items":{"type":"object","required":["TaskId"],"properties":{"TaskId":{"type":"string","description":"Task identifier to be actioned","example":"123e4567-e89b-12d3-a456-426614174000"}}}},"Detail":{"type":"object","description":"When an action requires action specific details, these are passed in the Detail object."}}},"TaskActionResponse":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"TransactionListRequest":{"type":"object","required":["ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","example":"2501240026C"}}},"TransactionListResponse":{"type":"object","properties":{"TransactionList":{"type":"array","items":{"type":"object","properties":{"TransactionAmount":{"type":"number","description":"Transaction amount"},"CardLastFourDigits":{"type":"string","description":"Last 4 digits of the card used"},"DisputedAmount":{"type":"number","description":"Disputed amount"},"DisputeId":{"type":"string","description":"Unique ID for the dispute associated with this transaction","examples":["2307190009D"]},"Description":{"type":"string","description":"Transaction description"},"PostingDate":{"type":"string","format":"Date","description":"Transaction posting date

Format:yyyyMMdd"},"PostingDateTime":{"type":"string","format":"Date-Time","description":"Transaction posting date as a Date-Time"},"CurrentStage":{"type":"string","description":"Transaction status, corresponds with stages in case workflow - Status Values","enum":["Enhance","Analyze","Execute","Resolve"]},"LastCommitDate":{"type":"string","format":"Date-Time","description":"Commit Date"},"TransactionId":{"type":"string","description":"Unique Transaction ID"},"DisputeStatus":{"type":"string","description":"Work status of the dispute, see Status Values"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"RetrieveTransactionDetailsRequest":{"type":"object","required":["ClaimId"],"properties":{"ClaimId":{"type":"string","description":"Unique claim ID","examples":["2108160022C"]},"DisputeId":{"type":"string","description":"Unique dispute ID\n\nREQUIRED if TransactionId is not passed.","examples":["2108160022D"]},"TransactionId":{"type":"string","description":"Unique Transaction ID\n\nREQUIRED if DisputeId is not passed.","examples":[123]}}},"ClaimTransactionDetailsResponse":{"type":"object","properties":{"TransactionData":{"type":"object","description":"This property is polymorphic. The properties it returns depends on the transaction type. For example, an ACH transaction will return ACH specific enriched data","example":{"CardNumber":"5487157312799999"}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"StatusRetrieveRequest":{"type":"object","required":["claimId","statusRole"],"properties":{"claimId":{"type":"string","description":"Unique claim ID","example":"2501240026C"},"statusRole":{"type":"string","description":"Status role of the current user","example":"Customer"}}},"StatusRetrieveResponse":{"type":"object","properties":{"ClaimType":{"type":"string"},"ClaimReason":{"type":"string"},"ClaimReasonType":{"type":"string"},"TotalClaimAmount":{"type":"number"},"IsRegE10Satisfied":{"type":"boolean","description":"Whether the Reg E 10 Business Day provisional credit obligation has been satisfied."},"RegE10":{"type":"string","format":"Date-Time","description":"The deadline by which provisional credit must be granted and the provisional credit letter sent — 10 business days from the contact date (for ATM/debit POS and non-US ATM disputes)."},"RegE10Threshold":{"type":"string","format":"Date-Time","description":"The approaching/warning date for the Reg E 10 milestone, used to trigger early action before the RegE10 deadline."},"IsRegESatisfied":{"type":"boolean","description":"Whether the final Reg E resolution deadline has been satisfied."},"RegEDeadline":{"type":"string","format":"Date-Time","description":"The final Reg E regulatory deadline by which the claim must be resolved (write-off executed and resolution letter sent). 90 days for POS/non-US ATM disputes; 45 days for US ATM and ACH disputes."},"RegEThreshold":{"type":"string","format":"Date-Time","description":"The approaching/warning date for the final Reg E deadline (RegEDeadline), used to trigger action before the deadline is breached."},"IsRegZ30Satisfied":{"type":"boolean","description":"Whether the Reg Z 30-day acknowledgement obligation has been satisfied."},"RegZ30":{"type":"string","format":"Date-Time","description":"The deadline by which an acknowledgement letter must be sent to the cardholder — 30 days from the contact date."},"RegZ30Threshold":{"type":"string","format":"Date-Time","description":"The approaching/warning date for the Reg Z 30 milestone."},"IsRegZPCSatisfied":{"type":"boolean","description":"Whether the Reg Z Withholding Protection provisional credit obligation has been satisfied."},"RegZPC":{"type":"string","format":"Date-Time","description":"The Reg Z Withholding Protection date — the deadline by which provisional credit must be issued to prevent collection on the disputed amount (primarily relevant for cardholders enrolled in autopayment). Set to the earlier of the next autopayment date or statement cycle date, with a minimum of contact date + 3 business days."},"RegZPCThreshold":{"type":"string","format":"Date-Time","description":"The approaching/warning date for the Reg Z PC provisional credit milestone."},"IsRegZ90Satisfied":{"type":"boolean","description":"Whether the Reg Z 90-day resolution obligation has been satisfied."},"RegZ90":{"type":"string","format":"Date-Time","description":"The final Reg Z deadline by which write-off must be executed and a resolution letter sent. Equals the 2nd statement cycle date following the contact date, capped at 90 days. Defaults to 60 days if cycle date is unavailable or the calculated date falls below 60 days."},"RegZ90Threshold":{"type":"string","format":"Date-Time","description":"The approaching/warning date for the Reg Z 90 milestone."},"CustomerDetails":{"type":"object","properties":{"FirstName":{"type":"string"},"MiddleName":{"type":"string"},"LastName":{"type":"string"},"EmailAddress":{"type":"string"},"PhoneNumber":{"type":"string"},"LastAddressChangeDate":{"type":"string","format":"Date-Time"},"CustomerId":{"type":"string"}}},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}},"AccountDetails":{"type":"object","properties":{"Description":{"type":"string"},"AccountNumber":{"type":"string"},"CardDescription":{"type":"string"},"CardNumber":{"type":"string"},"Balance":{"type":"number"},"OpenDate":{"type":"string","format":"Date-Time"},"AccountStatus":{"type":"string"},"LastStatementDate":{"type":"string","format":"Date-Time"}}},"ExternalCaseId":{"type":"string","description":"Optional ID representing claim identifier external to this dispute system (client internal identifier)"},"CustomerContactDate":{"type":"string","format":"Date-Time","description":"Date customer contacted institution about dispute","example":"2024-08-05T16:29:45.350Z"},"CreateName":{"type":"string","description":"userId of the user who created the claim","example":"dispute_api@disputeme.info"},"AccountType":{"type":"string","example":"CreditCard"},"ClaimStatus":{"type":"string","example":"Open-Analyze"},"AccountHolder":{"type":"string","example":"SoFi Tech Solutions User"},"Actions":{"type":"array","description":"Actions that can be taken on the claim","items":{"type":"object","properties":{"Importance":{"type":"string","description":"Importance of the action"},"ActionName":{"type":"string","description":"Action Name"}}}},"HasOutstandingTasks":{"type":"boolean","description":"Does the claim have oustanding workable tasks for interaction api"},"HeaderDisplay":{"type":"string","description":"Text for display"},"Stages":{"type":"array","description":"List of claim stages","items":{"type":"object","properties":{"Status":{"type":"string","description":"Status of this stage"},"Name":{"type":"string","description":"Name of this stage"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"TalkingPoints":{"type":"array","description":"List of claim talking points","items":{"type":"object","properties":{"DisplayText":{"type":"string","description":"Text for display"}}}}}},"AttachmentFields":{"type":"object","required":["FileName","Category","Label","DocumentStream"],"properties":{"DocumentStream":{"type":"string","description":"Byte stream of the form PDF being uploaded to satisfy the requirement","examples":["JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"]},"Category":{"type":"string","description":"Attachment category (one of the subset of `ValidAttachmentCategoryList` in the `/claim/documents/retrieveRequirements` response)","examples":["SupportingDocumentation"]},"FileName":{"type":"string","description":"Name of the file being passed in DocumentStream param","examples":["StatementOfDispute.pdf"]},"Label":{"type":"string","description":"User friendly attachment label","examples":["Statement of Dispute"]}}},"AccountList":{"type":"array","items":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"Account Number","examples":[5555555555554445]},"Balance":{"type":"string","description":"Balance on the account","examples":[701.12]},"Description":{"type":"string","description":"Account description","examples":["Mastercard Rewards"]},"OpenDate":{"type":"string","description":"Date the account was opened.

Format:yyyyMMdd","examples":[20200701]}}}},"Account":{"type":"object","properties":{"AccountNumber":{"type":"string","description":"Account Number","examples":[5555555555554445]},"Balance":{"type":"string","description":"Balance on the account","examples":[701.12]},"Description":{"type":"string","description":"Account description","examples":["Mastercard Rewards"]},"OpenDate":{"type":"string","description":"Date the account was opened.

Format:yyyyMMdd","examples":[20200701]}}},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}},"AddTransaction":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}},"AddCheckDeposit":{"type":"object","required":["Amount"],"properties":{"Amount":{"type":"string","description":"Amount of the check","examples":[123.45]},"CheckNumber":{"type":"string","description":"Check number","examples":[123]},"Date":{"type":"string","description":"Date of the check

Format:yyyyMMdd","examples":[20120701]},"From":{"type":"string","description":"Check issuer","examples":["John Doe"]}}},"AddTransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}},"AddCheckDepositList":{"type":"array","description":"List of check deposits to add to the claim","items":{"type":"object","required":["Amount"],"properties":{"Amount":{"type":"string","description":"Amount of the check","examples":[123.45]},"CheckNumber":{"type":"string","description":"Check number","examples":[123]},"Date":{"type":"string","description":"Date of the check

Format:yyyyMMdd","examples":[20120701]},"From":{"type":"string","description":"Check issuer","examples":["John Doe"]}}}},"AddTransactionListResponse":{"type":"array","items":{"type":"object","properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","example":460268821703314},"NonDisputableMessageDetails":{"type":"string","description":"an error associated with a specific transaction","example":"Credits are not disputable for this claim reason"}}}},"AddTransactionResponse":{"type":"object","properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","example":460268821703314},"NonDisputableMessageDetails":{"type":"string","description":"an error associated with a specific transaction","example":"Credits are not disputable for this claim reason"}}},"AddTransactionsResponse":{"type":"object","properties":{"TransactionList":{"type":"array","items":{"type":"object","properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","example":460268821703314},"NonDisputableMessageDetails":{"type":"string","description":"an error associated with a specific transaction","example":"Credits are not disputable for this claim reason"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"Answer":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."},"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."},"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question"},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}}},"APIDocumentation":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}},"AttachmentCategory":{"type":"object","properties":{"Key":{"type":"string","description":"Key value, this is what is passed back in with the add document request","example":"SupportingDocumentation"},"Value":{"type":"string","description":"User friendly display value","example":"Supporting Documentation"}}},"AttachmentCategoryList":{"type":"array","items":{"type":"object","properties":{"Key":{"type":"string","description":"Key value, this is what is passed back in with the add document request","example":"SupportingDocumentation"},"Value":{"type":"string","description":"User friendly display value","example":"Supporting Documentation"}}}},"Channel":{"type":"object","properties":{"Key":{"type":"string","description":"Stored value","example":"Email"},"Value":{"type":"string","description":"Display value","example":"Email"}}},"ChannelList":{"type":"array","items":{"type":"object","properties":{"Key":{"type":"string","description":"Stored value","example":"Email"},"Value":{"type":"string","description":"Display value","example":"Email"}}}},"CorrespondenceChannelEmail":{"allOf":[{"type":"object","properties":{"Name":{"type":"string","description":"Name of the channel","example":"Email","enum":["Email","Mail"]},"IsEditable":{"type":"boolean","description":"Can this channel be modified","example":true}},"discriminator":{"propertyName":"Name"}},{"type":"object"}],"properties":{"Address":{"type":"object","properties":{"EmailAddress":{"type":"string","description":"Email address","example":"TestCustomer@disputeme.info"}}}}},"CorrespondenceChannelEmailRequest":{"allOf":[{"type":"object","properties":{"Name":{"type":"string","description":"Name of the channel","example":"Email","enum":["Email","Mail"]},"IsVerifiedCorrect":{"type":"boolean","description":"Has this channel's details been confirmed to be correct","example":true}},"discriminator":{"propertyName":"Name"}},{"type":"object"}],"properties":{"Address":{"type":"object","properties":{"EmailAddress":{"type":"string","description":"Email address","example":"TestCustomer@disputeme.info"}}}}},"CorrespondenceChannelMail":{"allOf":[{"type":"object","properties":{"Name":{"type":"string","description":"Name of the channel","example":"Email","enum":["Email","Mail"]},"IsEditable":{"type":"boolean","description":"Can this channel be modified","example":true}},"discriminator":{"propertyName":"Name"}},{"type":"object"}],"properties":{"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"CorrespondenceChannelMailRequest":{"allOf":[{"type":"object","properties":{"Name":{"type":"string","description":"Name of the channel","example":"Email","enum":["Email","Mail"]},"IsVerifiedCorrect":{"type":"boolean","description":"Has this channel's details been confirmed to be correct","example":true}},"discriminator":{"propertyName":"Name"}},{"type":"object"}],"properties":{"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"CorrespondenceChannel":{"type":"object","properties":{"Name":{"type":"string","description":"Name of the channel","example":"Email","enum":["Email","Mail"]},"IsEditable":{"type":"boolean","description":"Can this channel be modified","example":true}},"discriminator":{"propertyName":"Name"}},"CorrespondenceChannelList":{"type":"array","description":"List of customer's correspondence channel information.","items":{"oneOf":[{"$ref":"#/components/schemas/CorrespondenceChannelEmail"},{"$ref":"#/components/schemas/CorrespondenceChannelMail"}],"discriminator":{"propertyName":"Name"}}},"CorrespondenceChannelListRequest":{"type":"array","description":"List of correspondence channels that the user wants to verify or update.","items":{"oneOf":[{"$ref":"#/components/schemas/CorrespondenceChannelEmailRequest"},{"$ref":"#/components/schemas/CorrespondenceChannelMailRequest"}],"discriminator":{"propertyName":"Name"}}},"CorrespondenceChannelRequest":{"type":"object","properties":{"Name":{"type":"string","description":"Name of the channel","example":"Email","enum":["Email","Mail"]},"IsVerifiedCorrect":{"type":"boolean","description":"Has this channel's details been confirmed to be correct","example":true}},"discriminator":{"propertyName":"Name"}},"CorrespondenceDetails":{"type":"object","properties":{"CanIgnoreCorrespondencePreference":{"type":"boolean","description":"Can the client ignore the correspondence preference?","example":false},"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"ChannelList":{"type":"array","items":{"type":"object","properties":{"Key":{"type":"string","description":"Stored value","example":"Email"},"Value":{"type":"string","description":"Display value","example":"Email"}}}},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"CorrespondenceDetailsRequest":{"type":"object","properties":{"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"Currency":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"Customer":{"type":"object","properties":{"CustomerId":{"type":"string","description":"Unique Customer ID","example":939472005},"Name":{"type":"object","properties":{"Prefix":{"type":"string","description":"Customer's prefix","example":"Mr."},"First":{"type":"string","description":"Customer's first name","example":"John"},"Middle":{"type":"string","description":"Customer's middle name","example":"Eugene"},"Last":{"type":"string","description":"Customer's last name","example":"Doe"},"Suffix":{"type":"string","description":"Customer's suffix","example":"Jr."},"BusinessName":{"type":"string","description":"Customer's Business name (for business entities)","example":"Porkchop Express"},"FullName":{"type":"string","description":"Customer's full name","example":"Mr. John Eugene Doe Jr."}}},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}},"Phone":{"type":"object","properties":{"Number":{"type":"string","description":"Phone number","example":"555-123-1234"}}},"SecondaryPhone":{"type":"object","properties":{"Number":{"type":"string","description":"Phone number","example":"555-123-1234"}}},"EmailAddress":{"type":"string","description":"Customer's email address","example":"TestCustomer@disputeme.info"}}},"CustomerList":{"type":"array","items":{"type":"object","properties":{"CustomerId":{"type":"string","description":"Unique Customer ID","example":939472005},"Name":{"type":"object","properties":{"Prefix":{"type":"string","description":"Customer's prefix","example":"Mr."},"First":{"type":"string","description":"Customer's first name","example":"John"},"Middle":{"type":"string","description":"Customer's middle name","example":"Eugene"},"Last":{"type":"string","description":"Customer's last name","example":"Doe"},"Suffix":{"type":"string","description":"Customer's suffix","example":"Jr."},"BusinessName":{"type":"string","description":"Customer's Business name (for business entities)","example":"Porkchop Express"},"FullName":{"type":"string","description":"Customer's full name","example":"Mr. John Eugene Doe Jr."}}},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}},"Phone":{"type":"object","properties":{"Number":{"type":"string","description":"Phone number","example":"555-123-1234"}}},"SecondaryPhone":{"type":"object","properties":{"Number":{"type":"string","description":"Phone number","example":"555-123-1234"}}},"EmailAddress":{"type":"string","description":"Customer's email address","example":"TestCustomer@disputeme.info"}}}},"DocumentRequirement":{"type":"object","properties":{"TemplateDocumentStream":{"type":"string","description":"Byte stream of the template form pdf","example":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"},"IsSatisified":{"type":"boolean","description":"Has this document requirement been satisfied?","example":false},"Identifier":{"type":"string","description":"Document requirement identifier","example":"StatementOfDispute"},"IsRequired":{"type":"boolean","description":"Is this document required?","example":true},"Label":{"type":"string","description":"A user friendly label of the document requirement","example":"Statement of Dispute"},"ValidAttachmentCategoryList":{"type":"array","items":{"type":"object","properties":{"Key":{"type":"string","description":"Key value, this is what is passed back in with the add document request","example":"SupportingDocumentation"},"Value":{"type":"string","description":"User friendly display value","example":"Supporting Documentation"}}}}}},"ClaimDocumentRequirement":{"allOf":[{"type":"object","properties":{"TemplateDocumentStream":{"type":"string","description":"Byte stream of the template form pdf","example":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"},"IsSatisified":{"type":"boolean","description":"Has this document requirement been satisfied?","example":false},"Identifier":{"type":"string","description":"Document requirement identifier","example":"StatementOfDispute"},"IsRequired":{"type":"boolean","description":"Is this document required?","example":true},"Label":{"type":"string","description":"A user friendly label of the document requirement","example":"Statement of Dispute"},"ValidAttachmentCategoryList":{"type":"array","items":{"type":"object","properties":{"Key":{"type":"string","description":"Key value, this is what is passed back in with the add document request","example":"SupportingDocumentation"},"Value":{"type":"string","description":"User friendly display value","example":"Supporting Documentation"}}}}}}],"type":"object","properties":{"WasDocumentReceived":{"type":"boolean","description":"was the document received"},"IsDocumentPendingReview":{"type":"boolean","description":"it the document pending review"}}},"BulkCreateClaim":{"type":"object","properties":{"Create":{"type":"object","allOf":[{"type":"object","required":["CustomerId","AccountNumber"],"properties":{"CustomerId":{"type":"string","description":"Unique Customer ID to create the claim for","example":123456789},"AccountNumber":{"type":"string","description":"Account number the transaction dispute(s) are to be processed against for the new claim.","example":5555555555554444}}}]},"AddClaimReasons":{"type":"object","allOf":[{"type":"object","required":["Questionnaire"],"properties":{"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}]},"RetrieveTransactions":{"type":"object","allOf":[{"type":"object","properties":{"SearchAccountNumber":{"type":"number","description":"Account number for searching for transactions that are on a different account than the claim.\n\n**Required** only if the user needs to add transactions to the claim that are on a different account than the claim's disputed transactions."},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20200601},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20210812},"SearchAmount":{"type":"string","description":"Transaction amount to search for.\n\n**Required** only if the user is searching for a transaction with a specific amount.","example":2.09},"SearchMerchantName":{"type":"string","description":"Merchant name/Transaction description to search for.\n\n**Required** only if the user is searching for a transaction with a specific merchant","example":"Amazon"}}}]},"AddTransactions":{"type":"object","allOf":[{"type":"object","required":["TransactionList"],"properties":{"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}}}}]},"Submit":{"type":"object","allOf":[{"type":"object","properties":{"CorrespondenceDetails":{"type":"object","properties":{"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}]}}},"BulkClaimRequestList":{"type":"array","description":"List of claim payloads.","items":{"type":"object","properties":{"Create":{"type":"object","allOf":[{"type":"object","required":["CustomerId","AccountNumber"],"properties":{"CustomerId":{"type":"string","description":"Unique Customer ID to create the claim for","example":123456789},"AccountNumber":{"type":"string","description":"Account number the transaction dispute(s) are to be processed against for the new claim.","example":5555555555554444}}}]},"AddClaimReasons":{"type":"object","allOf":[{"type":"object","required":["Questionnaire"],"properties":{"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}]},"RetrieveTransactions":{"type":"object","allOf":[{"type":"object","properties":{"SearchAccountNumber":{"type":"number","description":"Account number for searching for transactions that are on a different account than the claim.\n\n**Required** only if the user needs to add transactions to the claim that are on a different account than the claim's disputed transactions."},"SearchStartDate":{"type":"string","description":"Search start date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20200601},"SearchEndDate":{"type":"string","description":"Search end date for date range search.\n\n**Required** only if the user is searching for transactions within a certain date range\n\nFormat: yyyyMMdd","example":20210812},"SearchAmount":{"type":"string","description":"Transaction amount to search for.\n\n**Required** only if the user is searching for a transaction with a specific amount.","example":2.09},"SearchMerchantName":{"type":"string","description":"Merchant name/Transaction description to search for.\n\n**Required** only if the user is searching for a transaction with a specific merchant","example":"Amazon"}}}]},"AddTransactions":{"type":"object","allOf":[{"type":"object","required":["TransactionList"],"properties":{"TransactionList":{"type":"array","description":"List of transactions to add to the claim.","items":{"type":"object","required":["TransactionId"],"properties":{"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]}}}}}}]},"Submit":{"type":"object","allOf":[{"type":"object","properties":{"CorrespondenceDetails":{"type":"object","properties":{"SelectedChannel":{"type":"string","description":"The default customer correspondence channel","example":"Email","enum":["Email","Mail","Manual","Secure"]},"EmailAddress":{"type":"string","description":"Customer email address","example":"TestCustomer@disputeme.info"},"Address":{"type":"object","properties":{"Line1":{"type":"string","description":"Mailing address line 1","examples":["6 Ashbridge Lane"]},"Line2":{"type":"string","description":"Mailing address line 2","examples":["Suite 1"]},"Line3":{"type":"string","description":"Mailing address line 3","examples":["Atlanta, GA. 30033"]},"City":{"type":"string","description":"Mailing address City","examples":["Linwood"]},"State":{"type":"string","description":"Mailing address 2 character State code","examples":["NJ"]},"Zip":{"type":"string","description":"Mailing address zip code (5 digits or 5-4 digites)","examples":["12345-4567"]},"Country":{"type":"string","description":"Mailing address Country code","examples":["USA"]}}}}},"Questionnaire":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}}}}]}}}},"BulkClaimResponseList":{"type":"array","description":"List of claim ids.","items":{"type":"object","properties":{"ClaimId":{"type":"string","description":"ClaimId of bulk created claim","example":"2411210115C"}}}},"BulkCreateClaimResponse":{"type":"object","properties":{"ClaimList":{"type":"array","description":"List of claim ids.","items":{"type":"object","properties":{"ClaimId":{"type":"string","description":"ClaimId of bulk created claim","example":"2411210115C"}}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"ClaimDocumentRequirementList":{"type":"array","description":"List of document requirements that must be added to the claim.","items":{"allOf":[{"type":"object","properties":{"TemplateDocumentStream":{"type":"string","description":"Byte stream of the template form pdf","example":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"},"IsSatisified":{"type":"boolean","description":"Has this document requirement been satisfied?","example":false},"Identifier":{"type":"string","description":"Document requirement identifier","example":"StatementOfDispute"},"IsRequired":{"type":"boolean","description":"Is this document required?","example":true},"Label":{"type":"string","description":"A user friendly label of the document requirement","example":"Statement of Dispute"},"ValidAttachmentCategoryList":{"type":"array","items":{"type":"object","properties":{"Key":{"type":"string","description":"Key value, this is what is passed back in with the add document request","example":"SupportingDocumentation"},"Value":{"type":"string","description":"User friendly display value","example":"Supporting Documentation"}}}}}}],"type":"object","properties":{"WasDocumentReceived":{"type":"boolean","description":"was the document received"},"IsDocumentPendingReview":{"type":"boolean","description":"it the document pending review"}}}},"DocumentRequirementList":{"type":"array","description":"List of document requirements that must be added to the claim.","items":{"type":"object","properties":{"TemplateDocumentStream":{"type":"string","description":"Byte stream of the template form pdf","example":"JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+"},"IsSatisified":{"type":"boolean","description":"Has this document requirement been satisfied?","example":false},"Identifier":{"type":"string","description":"Document requirement identifier","example":"StatementOfDispute"},"IsRequired":{"type":"boolean","description":"Is this document required?","example":true},"Label":{"type":"string","description":"A user friendly label of the document requirement","example":"Statement of Dispute"},"ValidAttachmentCategoryList":{"type":"array","items":{"type":"object","properties":{"Key":{"type":"string","description":"Key value, this is what is passed back in with the add document request","example":"SupportingDocumentation"},"Value":{"type":"string","description":"User friendly display value","example":"Supporting Documentation"}}}}}}},"EmailAddress":{"type":"object","properties":{"EmailAddress":{"type":"string","description":"Email address","example":"TestCustomer@disputeme.info"}}},"Name":{"type":"object","properties":{"Prefix":{"type":"string","description":"Customer's prefix","example":"Mr."},"First":{"type":"string","description":"Customer's first name","example":"John"},"Middle":{"type":"string","description":"Customer's middle name","example":"Eugene"},"Last":{"type":"string","description":"Customer's last name","example":"Doe"},"Suffix":{"type":"string","description":"Customer's suffix","example":"Jr."},"BusinessName":{"type":"string","description":"Customer's Business name (for business entities)","example":"Porkchop Express"},"FullName":{"type":"string","description":"Customer's full name","example":"Mr. John Eugene Doe Jr."}}},"Phone":{"type":"object","properties":{"Number":{"type":"string","description":"Phone number","example":"555-123-1234"}}},"Question":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."},"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."},"QuestionList":{"type":"array","description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."},"QuestionListRequest":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}},"QuestionnaireRequest":{"type":"object","description":"Questionnaire to submit","properties":{"QuestionList":{"type":"array","description":"A list of answers to submit","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}}}}},"Questionnaire":{"type":"object","description":"Questionnaire for the user to provide answers for.\n\nPostQuestionnaire is to be presented to the user after they provide answers for Questionnaire","properties":{"QuestionList":{"type":"array","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"DisplayText":{"type":"string","description":"Text to display with the question","example":"Which of the following best describes the reason for your dispute?"},"DataType":{"type":"string","example":"String","enum":["String","Decimal","Integer","Date","DateTime","Boolean","List"],"description":"This list of question datatypes indicates what the `AnswerValue` can be:\n\n * `String` — Text, e.g., `Yes`\n * `Decimal` — Floating-point decimal, e.g., `14.52`\n * `Integer` — Integer, e.g., `15`\n * `Date` — Date with format yyyymmdd, e.g., `20240216`\n * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT`\n * `Boolean` — Boolean, either `true` or `false`\n * `List` — Text, where `Identifier` can be provided multiple times. See Adding `List` answers for examples.\n"},"Type":{"type":"string","description":"Question type","example":"RadioButtons","enum":["YesNo","Date","DateTime","Text","TextMulti","Dropdown","AutoComplete","RadioButtons","Checkboxes","MultiSelect","Decimal","Integer","Currency","RichText","Nothing","Section","Questionnaire"]},"Format":{"type":"string","description":"Metadata describing the question format, can be used to optionally provide different visual treatment","example":"RadioButtons","enum":["Caption","Default","Internal","Notification","Warning"]},"IsOptional":{"type":"boolean","description":"Is this question optional?","example":true},"AnswerList":{"type":"array","description":"A list of possible answers for a question","items":{"type":"object","properties":{"Identifier":{"type":"string","description":"Unique answer identifier","example":"MerchantDuplicate"},"DisplayText":{"type":"string","description":"Answer text to display","example":"I was charged more than once."}}}},"SelectedAnswer":{"type":"string","description":"The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.","example":"Yes"},"APIDocumentationList":{"type":"array","description":"This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.","items":{"type":"object","properties":{"ImplementationNotes":{"type":"string","description":"Description of the connector","example":"Get list of similar transactions within search criteria"},"Endpoint":{"type":"string","description":"REST connector endpoint suffix","example":"/claim/intake/retrieveSimilarTransactions"},"Method":{"type":"string","description":"Method for REST connector (always `POST`)","example":"post"}}}}}},"description":"A List of questions the user can answer.\n\nThis QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected."}}},"QuestionRequest":{"type":"object","properties":{"Identifier":{"type":"string","description":"Question identifier","example":"ClaimReason"},"AnswerValue":{"type":"string","description":"User's Answer to this question","example":"CardSecure"}}},"Status":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}},"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}},"StatusListResponse":{"type":"object","properties":{"StatusList":{"type":"array","items":{"type":"object","properties":{"Type":{"type":"string","description":"Status of the request","examples":["Success"],"enum":["Error","Success"]},"Message":{"type":"string","description":"Message about the status","examples":["Success"]},"Code":{"type":"string","description":"Numeric code for the status","examples":["200"]}}}}}},"SummaryTransactionDetails":{"type":"object","description":"Details about the selected transaction to display to the user.","properties":{"SummaryHeader":{"type":"string","description":"Posted Transaction Details header"},"SelectedPostedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"PendingSummaryHeader":{"type":"string","description":"Pending Transaction Details header"},"SelectedPendingTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"RecurringSummaryHeader":{"type":"string","description":"Recurring Transaction Details header"},"SelectedRecurringTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}},"DeflectedSummaryHeader":{"type":"string","description":"Deflected Transaction Details header"},"DeflectedTransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}}}},"Transaction":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}},"TransactionList":{"type":"array","items":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of transaction","examples":[27.5]},"AmountInfo":{"type":"object","properties":{"Amount":{"type":"string","description":"Amount of currency","example":27.5},"Exponent":{"type":"string","description":"Number of decimal places for currency","example":2},"ISOCodeAlpha":{"type":"string","description":"3 character alpha iso code","example":"USD"},"ISOCodeNumeric":{"type":"string","description":"numeric iso code","example":840},"ISOCurrencyName":{"type":"string","description":"currency name","example":"US Dollar"}}},"AuthorizationStatus":{"type":"string","description":"Authorization status of the transaction","examples":["Posted"],"enum":["Pending","Posted"]},"CardNumberEndingIn":{"type":"string","description":"Last 4 digits of card number","examples":[7413]},"Date":{"type":"string","description":"Date of transaction in yyyyMMdd formatted string","examples":[20210626]},"DebitCredit":{"type":"string","description":"Debit or Credit","examples":["Debit"],"enum":["Debit","Credit"]},"Description":{"type":"string","description":"Transaction description/Merchant name","examples":["7-ELEVEN 22177 (CHIP)"]},"PostingDateTime":{"type":"string","description":"The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GMT"]},"SelectMode":{"type":"string","description":"The selection mode for the transaction. \n* `Multi` — Multiple transactions can be selected for this claim type.\n* `Single` — Only one transaction can be selected for this claim type.","enum":["Multi","Single"]},"TransactionDateTime":{"type":"string","description":"The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z","examples":["20230201T225915.773 GM"]},"TransactionId":{"type":"string","description":"ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`","examples":[460268821703314]},"TransactionType":{"type":"string","description":"Type of the transaction","examples":["CardPinless"],"enum":["ACH","ATMDEP","ATMWD","CardPinless","CardPinned","CHECK","FEE","P2P","WIRE"]}}}}},"parameters":{"AuthorizationHeaderParam":{"name":"Authorization","in":"header","description":"For `{token}` insert base64-encoded `apiLogin:apiTransKey`","schema":{"type":"string","default":"Basic {token}"}},"ProfileTypeHeaderParam":{"name":"profile-type","in":"header","description":"Optional param to call Dispute API as a customer-service agent or a cardholder","schema":{"type":"string","enum":["agent","cardholder"],"default":"agent"}}}},"tags":[{"name":"SoFi Tech SolutionsAPI"}],"externalDocs":{"url":"","description":""},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}