Claim

/claim/details/retrieve

Use this endpoint to get claim details

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

post/claim/details/retrieve

Request

Base URL
{corename}.gft-dispute-api.{env}.gpsrv.com/gft-dispute-api/1.0
URL
{corename}.gft-dispute-api.{env}.gpsrv.com/gft-dispute-api/1.0/claim/details/retrieve
Auth
none declared

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

Example request

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

Response

Successful claim details retrieve request

rtokenstring nullable

A system-generated ID used for tracking

StatusCodeinteger nullable

The HTTP response status code

Example response

{
  "Questionnaire": {
    "QuestionList": [
      {
        "Identifier": "ClaimReason",
        "DisplayText": "Which of the following best describes the reason for your dispute?",
        "DataType": "String",
        "Type": "RadioButtons",
        "Format": "RadioButtons",
        "IsOptional": true,
        "AnswerList": [
          {
            "Identifier": "MerchantDuplicate",
            "DisplayText": "I was charged more than once."
          }
        ],
        "SelectedAnswer": "Yes",
        "APIDocumentationList": [
          {
            "ImplementationNotes": "Get list of similar transactions within search criteria",
            "Endpoint": "/claim/intake/retrieveSimilarTransactions",
            "Method": "post"
          }
        ]
      }
    ]
  },
  "DisputeReasonQuestionnaire": {
    "QuestionList": [
      {
        "Identifier": "ClaimReason",
        "DisplayText": "Which of the following best describes the reason for your dispute?",
        "DataType": "String",
        "Type": "RadioButtons",
        "Format": "RadioButtons",
        "IsOptional": true,
        "AnswerList": [
          {
            "Identifier": "MerchantDuplicate",
            "DisplayText": "I was charged more than once."
          }
        ],
        "SelectedAnswer": "Yes",
        "APIDocumentationList": [
          {
            "ImplementationNotes": "Get list of similar transactions within search criteria",
            "Endpoint": "/claim/intake/retrieveSimilarTransactions",
            "Method": "post"
          }
        ]
      }
    ]
  },
  "QuestionnaireExt": {
    "QuestionList": [
      {
        "Identifier": "ClaimReason",
        "DisplayText": "Which of the following best describes the reason for your dispute?",
        "DataType": "String",
        "Type": "RadioButtons",
        "Format": "RadioButtons",
        "IsOptional": true,
        "AnswerList": [
          {
            "Identifier": "MerchantDuplicate",
            "DisplayText": "I was charged more than once."
          }
        ],
        "SelectedAnswer": "Yes",
        "APIDocumentationList": [
          {
            "ImplementationNotes": "Get list of similar transactions within search criteria",
            "Endpoint": "/claim/intake/retrieveSimilarTransactions",
            "Method": "post"
          }
        ]
      }
    ]
  },
  "StatusList": [
    {
      "Type": "Success",
      "Message": "Success",
      "Code": "200"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.