Page Comparison

This guide explains how to use the Intake API to create claims, add reasons, transactions, and details about the claim, and submit the claim to be finalized.

...

• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/retrieveCustomers to get a list of CustomerIds and other customer details
• The /claim/intake/retrieveCustomers endpoint also returns Name, EmailAddress, Phone, Address, and SecondaryPhone
• CustomerId is required when creating a new claim and can be used to retrieve accounts

...

• If needed, follow Choosing a Customer to get a valid CustomerId
• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/retrieveAccounts to get a list of AccountNumbers and other account details
• The /claim/intake/retrieveAccounts endpoint takes in CustomerId as a parameter and the response will only return accounts for the passed in CustomerId
• Description, OpenDate, and Balance are also returned 
• AccountNumber is required when creating a new claim

...

• If needed, follow Choosing a Customer and Choosing an Account to get a valid CustomerId and AccountNumber
• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/create to create a new claim
• The /claim/intake/create endpoint takes in CustomerId and AccountNumber as parameters and the claim will be created for the passed in IDs
• ClaimId is returned

...

• After Creating A Claim, use the endpoint, www.example.com/QFDAPI/v1/claim/intake/retrieveReasons with a valid ClaimId to get the reason questionnaire for the claim
• The returned questionnaire contains questions to display so the user can classify the type and reason for the claim. The API returns appropriate questions for that given claim
• Using the returned questionnaire, a QuestionList of the users answered questions can be built to sent to /claim/intake/addClaimReasons. See Swaggerhub Documentation
• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/addClaimReasons to submit the built QuestionList
• After submitting the users answers, the next step in the intake process is Retrieving and Adding Transactions

...

• After Creating A Claim, Retrieving and Adding Claim Reasons, and Retrieving and Adding Transactions
• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/retrieveQuestionnaire to get a list of questions for the user to answer
  • The questionnaire structure is the same as the in the endpoint used in Retrieving and Adding Claim Reasons
• Using the returned questionnaire, a QuestionList of the users answered questions can be built to sent to /claim/intake/addQuestionnaire. See Swaggerhub Documentation
  • Some claim types return a question that contains an APIDocumentationList. If present, the defined endpoints must be called before calling /claim/intake/addQuestionnaire. See Swaggerhub Documentation
• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/addQuestionnaire to submit the built QuestionList
• After submitting the users answers, the next step in the intake process is Retrieving and Completing Document Requirements

...

• If /claim/intake/retrieveOtherAccounts and /claim/intake/retrieveSimilarTransactions and /claim/intake/addSimilarTransactions are defined as endpoints in the APIDocumentationList when retrieving the questionnaire, then they must be called before /claim/intake/addQuestionnaire
• These endpoints are required when the claim reason is merchant duplicate and the user has indicated that the duplicate transaction is on a different account as than the disputed transaction
• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/retrieveOtherAccounts to get a list of other accounts for the customer
• The /claim/intake/retrieveOtherAccounts endpoint takes returns accounts for the claim's customer. The response includes an AccountList of AccountNumbers and other account details
• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/retrieveSimilarTransactions and provide a SearchAccountNumber to retrieve a list of transactions the user can select select from the other account.
• The /claim/intake/retrieveSimilarTransactions endpoint returns a TransactionList  of TransactionIds and other transaction details
• The /claim/intake/retrieveSimilarTransactions takes in optional parameters SearchStartDate, SearchEndDate, SearchAmount, SearchMerchantName to search for specific transactions
• Use the endpoint, www.example.com/QFDAPI/v1/claim/intake/addSimilarTransactions to add the transactions to the claim
• The /claim/intake/addSimilarTransactions endpoint takes in a TransactionList of TransactionIds from the above retrieveSimilarTransactions endpoint response

Anchor
RetrievingCompletingDocRequirements RetrievingCompletingDocRequirements

Retrieving and Completing Document Requirements

...