---
title: "/claim/intake/retrieveSummary"
method: POST
path: "/claim/intake/retrieveSummary"
tags: ["Intake"]
---

# /claim/intake/retrieveSummary

`POST /claim/intake/retrieveSummary`

Use this endpoint to retrieve the claim summary before submitting. A `SummaryQuestionnaire` is also returned and should be submitted when calling /claim/intake/submit

Prerequisite API call:
- `/claim/intake/addQuestionnaire`

> 📘 Note
>
> This endpoint may return different data depending on the value of `profile-type`. See <a href="ref:api-reference-profile-type-differences" target="_blank">Profile Type Differences</a> for details.

## Request body

- object
  - `providerId` integer, required — Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: `9999`
  - `transactionId` string, required — Supply a globally unique ID to identify this endpoint request ("transaction"). Pattern: Max 60 characters Example: `"984513-395483653-4483483478"`
  - `ClaimId` string, required — Unique claim ID

## Response `200`

Successful retrieve summary request

- object
  - `CorrespondenceDetails` object
    - `CanIgnoreCorrespondencePreference` boolean — Can the client ignore the correspondence preference?
    - `SelectedChannel` 'Email' | 'Mail' | 'Manual' | 'Secure' — The default customer correspondence channel
    - `ChannelList` object[]
      - `Key` string — Stored value
      - `Value` string — Display value
    - `EmailAddress` string — Customer email address
    - `Address` object
      - `Line1` string — Mailing address line 1
      - `Line2` string — Mailing address line 2
      - `Line3` string — Mailing address line 3
      - `City` string — Mailing address City
      - `State` string — Mailing address 2 character State code
      - `Zip` string — Mailing address zip code (5 digits or 5-4 digites)
      - `Country` string — Mailing address Country code
  - `SummaryContactHeader` string — Summary information about our customer contact method
  - `StatusList` object[]
    - `Type` 'Error' | 'Success' — Status of the request
    - `Message` string — Message about the status
    - `Code` string — Numeric code for the status
  - `SummaryQuestionnaire` object — Questionnaire for the user to provide answers for. PostQuestionnaire is to be presented to the user after they provide answers for Questionnaire
    - `QuestionList` object[] — A List of questions the user can answer. This QuestionList can be nested inside of another Question's AnswerList indicating that these questions should only be displayed if that Answer is selected.
      - `Identifier` string — Question identifier
      - `DisplayText` string — Text to display with the question
      - `DataType` 'String' | 'Decimal' | 'Integer' | 'Date' | 'DateTime' | 'Boolean' | 'List' — This list of question datatypes indicates what the `AnswerValue` can be: * `String` — Text, e.g., `Yes` * `Decimal` — Floating-point decimal, e.g., `14.52` * `Integer` — Integer, e.g., `15` * `Date` — Date with format yyyymmdd, e.g., `20240216` * `DateTime` — Datetime with format yyyyMMdd`T`HHmmss.SSS z, e.g., `20230201T225915.773 GMT` * `Boolean` — Boolean, either `true` or `false` * `List` — Text, where `Identifier` can be provided multiple times. See <a href="doc:creating-an-api-30-dispute#adding-list-answers" target="_blank">Adding `List` answers</a> for examples.
      - `Type` 'YesNo' | 'Date' | 'DateTime' | 'Text' | 'TextMulti' | 'Dropdown' | 'AutoComplete' | 'RadioButtons' | 'Checkboxes' | 'MultiSelect' | 'Decimal' | 'Integer' | 'Currency' | 'RichText' | 'Nothing' | 'Section' | 'Questionnaire' — Question type
      - `Format` 'Caption' | 'Default' | 'Internal' | 'Notification' | 'Warning' — Metadata describing the question format, can be used to optionally provide different visual treatment
      - `IsOptional` boolean — Is this question optional?
      - `AnswerList` object[] — A list of possible answers for a question
        - `Identifier` string — Unique answer identifier
        - `DisplayText` string — Answer text to display
      - `SelectedAnswer` string — The selected answer to this question. This could be a default for an initially loaded questionnaire or a persisted previous answer.
      - `APIDocumentationList` object[] — This is returned for questions of type Section. It provides the implementation details to provide the answer to said question.
        - `ImplementationNotes` string — Description of the connector
        - `Endpoint` string — REST connector endpoint suffix
        - `Method` string — Method for REST connector (always `POST`)
  - `TransactionDetails` object — Details about the selected transaction to display to the user.
    - `SummaryHeader` string — Posted Transaction Details header
    - `SelectedPostedTransactionList` object[]
      - `Amount` string — Amount of transaction
      - `AmountInfo` object
        - `Amount` string — Amount of currency
        - `Exponent` string — Number of decimal places for currency
        - `ISOCodeAlpha` string — 3 character alpha iso code
        - `ISOCodeNumeric` string — numeric iso code
        - `ISOCurrencyName` string — currency name
      - `AuthorizationStatus` 'Pending' | 'Posted' — Authorization status of the transaction
      - `CardNumberEndingIn` string — Last 4 digits of card number
      - `Date` string — Date of transaction in yyyyMMdd formatted string
      - `DebitCredit` 'Debit' | 'Credit' — Debit or Credit
      - `Description` string — Transaction description/Merchant name
      - `PostingDateTime` string — The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `SelectMode` 'Multi' | 'Single' — The selection mode for the transaction. * `Multi` &mdash; Multiple transactions can be selected for this claim type. * `Single` &mdash; Only one transaction can be selected for this claim type.
      - `TransactionDateTime` string — The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `TransactionId` string — ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`
      - `TransactionType` 'ACH' | 'ATMDEP' | 'ATMWD' | 'CardPinless' | 'CardPinned' | 'CHECK' | 'FEE' | 'P2P' | 'WIRE' — Type of the transaction
    - `PendingSummaryHeader` string — Pending Transaction Details header
    - `SelectedPendingTransactionList` object[]
      - `Amount` string — Amount of transaction
      - `AmountInfo` object
        - `Amount` string — Amount of currency
        - `Exponent` string — Number of decimal places for currency
        - `ISOCodeAlpha` string — 3 character alpha iso code
        - `ISOCodeNumeric` string — numeric iso code
        - `ISOCurrencyName` string — currency name
      - `AuthorizationStatus` 'Pending' | 'Posted' — Authorization status of the transaction
      - `CardNumberEndingIn` string — Last 4 digits of card number
      - `Date` string — Date of transaction in yyyyMMdd formatted string
      - `DebitCredit` 'Debit' | 'Credit' — Debit or Credit
      - `Description` string — Transaction description/Merchant name
      - `PostingDateTime` string — The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `SelectMode` 'Multi' | 'Single' — The selection mode for the transaction. * `Multi` &mdash; Multiple transactions can be selected for this claim type. * `Single` &mdash; Only one transaction can be selected for this claim type.
      - `TransactionDateTime` string — The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `TransactionId` string — ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`
      - `TransactionType` 'ACH' | 'ATMDEP' | 'ATMWD' | 'CardPinless' | 'CardPinned' | 'CHECK' | 'FEE' | 'P2P' | 'WIRE' — Type of the transaction
    - `RecurringSummaryHeader` string — Recurring Transaction Details header
    - `SelectedRecurringTransactionList` object[]
      - `Amount` string — Amount of transaction
      - `AmountInfo` object
        - `Amount` string — Amount of currency
        - `Exponent` string — Number of decimal places for currency
        - `ISOCodeAlpha` string — 3 character alpha iso code
        - `ISOCodeNumeric` string — numeric iso code
        - `ISOCurrencyName` string — currency name
      - `AuthorizationStatus` 'Pending' | 'Posted' — Authorization status of the transaction
      - `CardNumberEndingIn` string — Last 4 digits of card number
      - `Date` string — Date of transaction in yyyyMMdd formatted string
      - `DebitCredit` 'Debit' | 'Credit' — Debit or Credit
      - `Description` string — Transaction description/Merchant name
      - `PostingDateTime` string — The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `SelectMode` 'Multi' | 'Single' — The selection mode for the transaction. * `Multi` &mdash; Multiple transactions can be selected for this claim type. * `Single` &mdash; Only one transaction can be selected for this claim type.
      - `TransactionDateTime` string — The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `TransactionId` string — ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`
      - `TransactionType` 'ACH' | 'ATMDEP' | 'ATMWD' | 'CardPinless' | 'CardPinned' | 'CHECK' | 'FEE' | 'P2P' | 'WIRE' — Type of the transaction
    - `DeflectedSummaryHeader` string — Deflected Transaction Details header
    - `DeflectedTransactionList` object[]
      - `Amount` string — Amount of transaction
      - `AmountInfo` object
        - `Amount` string — Amount of currency
        - `Exponent` string — Number of decimal places for currency
        - `ISOCodeAlpha` string — 3 character alpha iso code
        - `ISOCodeNumeric` string — numeric iso code
        - `ISOCurrencyName` string — currency name
      - `AuthorizationStatus` 'Pending' | 'Posted' — Authorization status of the transaction
      - `CardNumberEndingIn` string — Last 4 digits of card number
      - `Date` string — Date of transaction in yyyyMMdd formatted string
      - `DebitCredit` 'Debit' | 'Credit' — Debit or Credit
      - `Description` string — Transaction description/Merchant name
      - `PostingDateTime` string — The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `SelectMode` 'Multi' | 'Single' — The selection mode for the transaction. * `Multi` &mdash; Multiple transactions can be selected for this claim type. * `Single` &mdash; Only one transaction can be selected for this claim type.
      - `TransactionDateTime` string — The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `TransactionId` string — ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`
      - `TransactionType` 'ACH' | 'ATMDEP' | 'ATMWD' | 'CardPinless' | 'CardPinned' | 'CHECK' | 'FEE' | 'P2P' | 'WIRE' — Type of the transaction
  - `rtoken` string, nullable — A system-generated ID used for tracking
  - `StatusCode` integer, nullable — The HTTP response status code

## Other responses

- `400` — Error retrieve summary request
- `500` — Error retrieve summary request

---

[API](https://skmtc.net/galileo-ft/apis/program-api.md) · [All operations](https://skmtc.net/galileo-ft/apis/program-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/galileo-ft/program-api/versions/bcd728f97a18/schema)