Submit Case

post

https://dispute-api-{corename}.{env}.gpsrv.com/submitCase

👍
Availability
No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.

Use the Submit Case endpoint to finalize a dispute case when the account holder presses a "submit" button on your user interface.

This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. For instructions see the Creating an API 2.0 Dispute guide.

Previous endpoint: Get Case Summary
Next endpoint: Optional. Get Case Confirmation

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
1511-4	Invalid case ID or case ID returned no results
1511-5	Invalid request
1511-6	Error saving case
1511-13	Case ID references a case that is currently locked
1511-14	Invalid request message
1511-15	This case is already resolved with status:
1511-16	This case has been submitted for processing and this action can no longer be performed.

Form Data

apiLogin

string

required

Provider's web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

caseId

string

required

Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "22021000017C"

questionnaire

string

Array of identifier/answerValue pairs from the questionnaire returned by Get Case Summary. Populate this field with answers about updating the contact date. Do not permit the account holder to update the contact date. Answers about contact information should be passed in correspondenceDetails.
Pattern: JSON array
Example: [{"identifier": "<string>", "answerValue": "<string>"}, {"identifier": "<string>", "answerValue": "<string>"}]

correspondenceDetails

string

Populate this field to change contact information just for this case. This value updates the contact information for this case only, not the account holder's existing record. See correspondenceDetails Subfields for valid values.
Pattern: JSON array
Example: '{'selectedChannel': 'Email', 'emailAddress': '[email protected]'}'

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Status codes

default