Intake

/claim/intake/create

Use this endpoint to create a new claim in the dispute system.

A claim is a unit of work that will contain one or more specific transaction disputes. The API is called by passing in key information required to create a shell claim.

post/claim/intake/create

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/create
Auth
none declared

Request body

CustomerIdstring required

Customer ID to create the claim for. Pass the same value as AccountNumber. Pattern: P{prog_id}|{prn} Example: P123|123456789012

AccountNumberstring required

Account number of the disputed transaction(s). Combine your prog_id with the <glossary:PRN>. Pattern: P{prog_id}|{prn} Example: P123|123456789012

Example request

{
  "CustomerId": "P123|123456789012",
  "AccountNumber": "P123|123456789012"
}

Response

Successful claim initiation request

ClaimIdstring

Unique claim ID

rtokenstring nullable

A system-generated ID used for tracking

StatusCodeinteger nullable

The HTTP response status code

Example response

{
  "ClaimId": "2108160022C",
  "StatusList": [
    {
      "Type": "Success",
      "Message": "Success",
      "Code": "200"
    }
  ]
}

Changes

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