Lithic API Documentation | Disputes › List Dispute Evidences

Disputes

disputes

Methods

List Disputes -> CursorPage<

Dispute

get/v1/disputes

List disputes.

query Parameters

begin: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.

end: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.

ending_before: string

Optional

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

page_size: number

Optional

(maximum: 100, minimum: 1, default: 50)

Page size (for pagination).

starting_after: string

Optional

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

status:

Optional

List disputes of a specific status.

"ARBITRATION"

"CASE_CLOSED"

"CASE_WON"

"NEW"

"PENDING_CUSTOMER"

"PREARBITRATION"

"REPRESENTMENT"

"SUBMITTED"

transaction_tokens: Array<string>

Optional

Transaction tokens to filter by.

Response fields

data: Array<

Dispute

has_more: boolean

More data exists.

Request example

curl https://api.lithic.com/v1/disputes \
    -H "Authorization: $LITHIC_API_KEY"

200Example

{
  "data": [
    {
      "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "amount": 0,
      "arbitration_date": "2019-12-27T18:11:19.117Z",
      "created": "2019-12-27T18:11:19.117Z",
      "customer_filed_date": "2019-12-27T18:11:19.117Z",
      "customer_note": "customer_note",
      "network_claim_ids": [
        "string"
      ],
      "network_filed_date": "2019-12-27T18:11:19.117Z",
      "network_reason_code": "network_reason_code",
      "prearbitration_date": "2019-12-27T18:11:19.117Z",
      "primary_claim_id": "primary_claim_id",
      "reason": "ATM_CASH_MISDISPENSE",
      "representment_date": "2019-12-27T18:11:19.117Z",
      "resolution_date": "2019-12-27T18:11:19.117Z",
      "resolution_note": "resolution_note",
      "resolution_reason": "CASE_LOST",
      "status": "ARBITRATION",
      "transaction_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    }
  ],
  "has_more": true
}

Initiate Dispute ->

Dispute

post/v1/disputes

Initiate a dispute.

Get Dispute ->

Dispute

get/v1/disputes/{dispute_token}

Get dispute.

Withdraw Dispute ->

Dispute

delete/v1/disputes/{dispute_token}

Withdraw dispute.

Update Dispute ->

Dispute

patch/v1/disputes/{dispute_token}

Update dispute. Can only be modified if status is NEW.

List Dispute Evidences -> CursorPage<

DisputeEvidence

get/v1/disputes/{dispute_token}/evidences

List evidence metadata for a dispute.

path Parameters

dispute_token: string

(format: uuid)

query Parameters

begin: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.

end: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.

ending_before: string

Optional

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

page_size: number

Optional

(maximum: 100, minimum: 1, default: 50)

Page size (for pagination).

starting_after: string

Optional

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

Response fields

data: Array<

DisputeEvidence

has_more: boolean

More data exists.

Request example

curl https://api.lithic.com/v1/disputes/$DISPUTE_TOKEN/evidences \
    -H "Authorization: $LITHIC_API_KEY"

200Example

{
  "data": [
    {
      "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created": "2019-12-27T18:11:19.117Z",
      "dispute_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "upload_status": "DELETED",
      "download_url": "download_url",
      "filename": "filename",
      "upload_url": "upload_url"
    }
  ],
  "has_more": true
}

Initiate Dispute Evidence Upload ->

DisputeEvidence

post/v1/disputes/{dispute_token}/evidences

Use this endpoint to upload evidences for the dispute. It will return a URL to upload your documents to. The URL will expire in 30 minutes.

Uploaded documents must either be a jpg, png or pdf file, and each must be less than 5 GiB.

Get Dispute Evidence ->

DisputeEvidence

get/v1/disputes/{dispute_token}/evidences/{evidence_token}

Get a dispute's evidence metadata.

Withdraw Dispute Evidence ->

DisputeEvidence

delete/v1/disputes/{dispute_token}/evidences/{evidence_token}

Soft delete evidence for a dispute. Evidence will not be reviewed or submitted by Lithic after it is withdrawn.

Domain types

Dispute = { token, amount, arbitration_date, 15 more... }

Dispute.

DisputeEvidence = { token, created, dispute_token, 4 more... }

Dispute evidence.