Sign in

v1

latestOpenAPI 3.1.02026-07-228956435.8 KB
Disputes

List disputes

Lists the disputes of your organization for the live or test mode of the API key used. Returns the most recent disputes first. Use the status, resource_id, since, and until query parameters to filter the list.

get/disputes

Query parameters

statusstring

Filter by dispute status. One of waiting_documentation, in_review, won, lost, expired. Accepts a comma-separated list.

resource_idstring

Filter by the id of the disputed resource (the payment intent).

sincestring

ISO 8601 datetime in UTC that filters disputes created on or after the provided time.

untilstring

ISO 8601 datetime in UTC that filters disputes created on or before the provided time.

Response

List of disputes for the current mode, most recent first.

idstring required

Unique identifier of the dispute.

object'dispute' required

Type of the object. Always dispute.

amountinteger required

Disputed amount, in the currency's smallest unit. CLP has no decimals, so 7005 means 7005 CLP; MXN and USD have cents, so 7005 means 70.05.

created_atstring date-time required

ISO 8601 datetime in UTC when the dispute was created.

currencystring required

ISO 4217 currency code of the disputed amount.

documentation_upload_deadlinestring date-time required

ISO 8601 datetime in UTC for the documentation submission deadline before the dispute is lost by default.

mode'test' | 'live' required

Mode of the object. live objects use real institution data, test objects use fake data for integration testing.

resource_idstring required

Identifier of the disputed resource.

resource_type'payment_intent' required

Type of the disputed resource. Always payment_intent.

status'waiting_documentation' | 'in_review' | 'lost' | 'expired' | 'won' required

Current status of the dispute. One of waiting_documentation, in_review, lost, expired, or won.

updated_atstring date-time required

ISO 8601 datetime in UTC when the dispute was last updated.

Example response

[
  {
    "id": "cb_8anBm9YpVwXzKqL2",
    "amount": 7005,
    "created_at": "2024-01-15T17:04:10.284Z",
    "currency": "CLP",
    "documentation_upload_deadline": "2024-01-22T17:04:10.284Z",
    "documents": [
      {
        "id": "cbd_8anBm9YpVwXzKqL2",
        "content_type": "application/pdf",
        "created_at": "2024-01-16T17:04:10.284Z",
        "dispute_id": "cb_8anBm9YpVwXzKqL2",
        "filename": "evidence.pdf",
        "size": 102400
      }
    ],
    "mode": "live",
    "resource_id": "pi_8anBm9YpVwXzKqL2",
    "status": "waiting_documentation",
    "updated_at": "2024-01-16T17:04:10.284Z"
  }
]