Sign in

v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
Intake

/claim/intake/retrieveCreditTransactions

Use this endpoint to retrieve credit transactions that can be selected to add to the claim.

Gets 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.

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

Prerequisite API call:

  • /claim/intake/retrieveQuestionnaire
post/claim/intake/retrieveCreditTransactions

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

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

Example request

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

Response

postRetrieveCreditTransactions

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"
      }
    }
  ]
}