Sign in

v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
Intake

/claim/intake/retrieveSimilarTransactions

Use this endpoint to get a list of similar transactions within search criteria that can be selected to add to the claim.

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.

Requires a question response indicating in APIDocumentationList that this method is required.

Prerequisite API call:

  • /claim/intake/retrieveQuestionnaire
post/claim/intake/retrieveSimilarTransactions

Request body

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Pattern: Max 60 characters Example: "984513-395483653-4483483478"

ClaimIdstring required

Unique claim ID

SearchAccountNumberstring

Account number to search for if different than selected account on claim

Required only if the user is searching for a transaction on a different account than the account on the claim.

SearchStartDatestring

Search start date for date range search.

Required only if the user is searching for transactions within a certain date range

Format: yyyyMMdd

SearchEndDatestring

Search end date for date range search.

Required only if the user is searching for transactions within a certain date range

Format: yyyyMMdd

SearchAmountstring

Transaction amount to search for.

Required only if the user is searching for a transaction with a specific amount.

SearchMerchantNamestring

Merchant name/Transaction description to search for.

Required only if the user is searching for a transaction with a specific merchant

Example request

{
  "providerId": 9999,
  "transactionId": "984513-395483653-4483483478",
  "ClaimId": "2108160022C",
  "SearchMerchantName": "Amazon"
}

Response

postRetrieveSimilarTransactions

rtokenstring nullable

A system-generated ID used for tracking

StatusCodeinteger nullable

The HTTP response status code

Example response

{
  "TransactionList": [
    {
      "AmountInfo": {
        "ISOCodeAlpha": "USD",
        "ISOCurrencyName": "US Dollar"
      }
    }
  ]
}