Sign in

v1

latestOpenAPI 3.0.02026-07-262561105.1 KB
Disputes API

List disputes

Returns a paginated list of disputes.

get/disputes

Query parameters

limitinteger

Maximum number of disputes to return.

created_afterstring

Cursor for forward pagination (return results after this dispute ID).

created_beforestring

Cursor for backward pagination (return results before this dispute ID).

resolved_afterstring

Return results with a resolved date after this date. Format must be ISO 8601: YYYY-MM-DDTHH:MM:SS.

resolved_beforestring

Return results with a resolved date before this date. Format must be ISO 8601: YYYY-MM-DDTHH:MM:SS.

status'action_required_merchant' | 'no_merchant_action_needed' | 'closed_customer_favor' | 'closed_merchant_favor' | 'closed_customer_partial_favor'

Filter disputes by status.

dispute_reason'cancellation_or_return_not_processed' | 'incorrect_amount' | 'product_not_received' | 'product_unacceptable' | 'cancellation_not_processed' | 'return_not_processed'

Enum for dispute reason values.

Filter disputes by dispute reason.

merchant_idstring

Filter disputes by merchant ID. Required parameter for Partner based API calls.

page_numberstring

Page to return. Set to 1 by default.

Response

Success

tokenstring

Example response

{
  "disputes": [
    {
      "created": "2024-03-02T14:29:07Z",
      "currency": "USD",
      "dispute_amount": 1000,
      "id": "dispute_123",
      "merchant_id": "merchant_id:sandbox:1234",
      "status": "action_required_merchant",
      "transaction_id": "AB1D-E2GH"
    }
  ],
  "page_info": {
    "has_next": true
  }
}