Lithic API Documentation | Disputes V2

Disputes V2

disputes_v2

Methods

List Disputes -> CursorPage<

DisputeV2

get/v2/disputes

Returns a paginated list of disputes.

query Parameters

account_token: string

Optional

(format: uuid)

Filter by account token.

begin: string

Optional

(format: date-time)

RFC 3339 timestamp for filtering by created date, inclusive.

card_token: string

Optional

(format: uuid)

Filter by card token.

disputed_transaction_token: string

Optional

(format: uuid)

Filter by the token of the transaction being disputed. Corresponds with transaction_series.related_transaction_token in the Dispute.

end: string

Optional

(format: date-time)

RFC 3339 timestamp for filtering by created date, inclusive.

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)

Number of items to return.

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<

DisputeV2

Array of dispute objects

has_more: boolean

Whether there are more results available

Request example

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

200Example

{
  "data": [
    {
      "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "card_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "case_id": "case_id",
      "created": "2019-12-27T18:11:19.117Z",
      "currency": "USD",
      "disposition": "WON",
      "events": [
        {
          "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "created": "2019-12-27T18:11:19.117Z",
          "data": {
            "action": "OPENED",
            "amount": 0,
            "disposition": "WON",
            "reason": "reason",
            "stage": "CLAIM",
            "type": "WORKFLOW"
          },
          "type": "WORKFLOW"
        }
      ],
      "liability_allocation": {
        "denied_amount": 0,
        "original_amount": 0,
        "recovered_amount": 0,
        "remaining_amount": 0,
        "written_off_amount": 0
      },
      "merchant": {
        "acceptor_id": "333301802529120",
        "acquiring_institution_id": "191231",
        "city": "NEW YORK",
        "country": "USA",
        "descriptor": "COFFEE SHOP",
        "mcc": "5812",
        "state": "NY"
      },
      "network": "VISA",
      "status": "OPEN",
      "transaction_series": {
        "related_transaction_event_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "related_transaction_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "type": "DISPUTE"
      },
      "updated": "2019-12-27T18:11:19.117Z"
    }
  ],
  "has_more": true
}

Retrieve A Dispute ->

DisputeV2

get/v2/disputes/{dispute_token}

Retrieves a specific dispute by its token.

Domain types

DisputeV2 = { token, account_token, card_token, 11 more... }

The Dispute object tracks the progression of a dispute throughout its lifecycle.