GAgalileo-ft
Intake

/claim/intake/retrieveConfirmation

Use this endpoint to retrieve the confirmation document for a claim.

Prerequisite API call:

  • /claim/intake/submit
post/claim/intake/retrieveConfirmation

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/intake/retrieveConfirmation
  • 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

Unique claim ID

Example request

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

Response

Successful retrieve confirmation request

ConfirmationDocumentStreamstring

Byte stream of the confirmation pdf

ConfirmationMessageMarkupstring

Byte stream of the confirmation message

ConfirmationHeaderstring

Confirmation header

ConfirmationDocumentNamestring

Confirmation document name

rtokenstring nullable

A system-generated ID used for tracking

StatusCodeinteger nullable

The HTTP response status code

Example response

{
  "ConfirmationDocumentStream": "JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+",
  "ConfirmationMessageMarkup": "PHRhYmxlIGNsYXNzPSJxdm9Cb2R5Q29udGVudCI+PHRyPjx0ZD4gPCEtLXF+",
  "ConfirmationHeader": "Confirmation #: 2108240024C",
  "ConfirmationDocumentName": "Confirmation.pdf",
  "StatusList": [
    {
      "Type": "Success",
      "Message": "Success",
      "Code": "200"
    }
  ]
}

Changes

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