/claim/list

post

https://{corename}.gft-dispute-api.{env}.gpsrv.com/gft-dispute-api/1.0/claim/list

Use this endpoint to get a list of claims for the provided search parameters

You must pass only one of these fields: customerId, accountNumber, claimId.

Body Params

providerId

int32

required

Your unique provider identifier from SoFi Tech Solutions.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

length between 1 and 60

Supply a globally unique ID to identify this endpoint request ("transaction").
Pattern: Max 60 characters
Example: "984513-395483653-4483483478"

daysToLookBack

number

Days prior to search for claims.
REQUIRED

customerId

string

Customer ID to search for claims for.
Pass the same value as accountNumber. Exactly one of customerId, accountNumber, or claimId is required
Pattern: P{prog_id}|{prn}
Example: P123|123456789012

accountNumber

string

Account number to search for claims for. Exactly one of customerId, accountNumber, or claimId is required.
Pattern: P{prog_id}|{prn}
Example: P123|123456789012

claimId

string

Specific Claim ID to search for

Exactly one of customerId, accountNumber, or claimId is required

Headers

Authorization

string

Defaults to Basic {token}

For {token} insert base64-encoded apiLogin:apiTransKey

profile-type

string

enum

Defaults to agent

Optional param to call Dispute API as a customer-service agent or a cardholder

Allowed:

Responses

Language

URL

Loading…

Response

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

application/json

200Successful claim list request

400Error claim list request

500Error claim list request