Skip to main content
GET
/
v1
/
disputes
/
{id}
Retrieve a dispute
curl --request GET \
  --url https://api.yorlet.com/v1/disputes/{id} \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "created": 123,
  "object": "dispute",
  "amount": 123,
  "balance_transaction": {
    "id": "<string>",
    "created": 123,
    "object": "balance_transaction",
    "amount": 123,
    "available_on": 123,
    "currency": "<string>",
    "description": "<string>",
    "fee": 123,
    "fee_details": [
      {
        "amount": 123,
        "description": "<string>",
        "tax": 123,
        "tax_percent": 123,
        "type": "<string>"
      }
    ],
    "net": 123,
    "payout": "<string>",
    "source": "<string>",
    "source_object": "<string>",
    "account": "<string>",
    "deleted": false
  },
  "currency": "<string>",
  "customer": {
    "id": "<string>",
    "created": 123,
    "object": "customer",
    "address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "country": "<string>",
      "postal_code": "<string>",
      "state": "<string>"
    },
    "default_payment_method": "<string>",
    "delinquent": true,
    "description": "<string>",
    "email": "[email protected]",
    "invoice_prefix": "<string>",
    "invoicing": {
      "arrears_emails": true,
      "email_cc": [
        "[email protected]"
      ],
      "email_to": "[email protected]"
    },
    "legal": {
      "dob": {
        "day": 16,
        "month": 6.5,
        "year": 5949.5
      },
      "first_name": "<string>",
      "last_name": "<string>"
    },
    "name": "<string>",
    "phone": "<string>",
    "radar": {
      "message": "<string>",
      "reason": "<string>",
      "risk_level": "<string>"
    },
    "account": "<string>",
    "deleted": false,
    "metadata": {}
  },
  "description": "<string>",
  "evidence": {
    "customer_communication": "<string>",
    "product_description": "<string>",
    "refund_policy": "<string>",
    "refund_policy_disclosure": "<string>",
    "refund_refusal_explanation": "<string>",
    "service_date": 123,
    "service_documentation": "<string>",
    "uncategorized_text": "<string>"
  },
  "evidence_details": {
    "due_by": 123,
    "has_evidence": true,
    "past_due": true,
    "submission_count": 123
  },
  "evidence_submitted": true,
  "invoice": "<string>",
  "reason": "<string>",
  "resolved": true,
  "status": "<string>",
  "transaction": "<string>",
  "account": "<string>",
  "deleted": false
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Path Parameters

​
id
string
required

The id identifier.

Response

200 - application/json

Returns the retrieved dispute.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
dispute
​
amount
integer
required

Disputed amount, in the smallest currency unit (e.g. cents).

​
balance_transaction
required

The balance transaction associated with the dispute.

​
currency
string
required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

​
customer
required

The customer the dispute is for.

​
description
string | null
required

An arbitrary string attached to the object. Often useful for displaying to users.

​
evidence
object
required

The evidence collected for the dispute.

​
evidence_details
object
required

Information about the dispute evidence, including the response deadline.

​
evidence_submitted
boolean
required

Whether the collected evidence has been submitted for review.

​
invoice
string | null
required

ID of the invoice associated with this dispute.

​
reason
string | null
required

The reason the dispute was raised.

​
resolved
boolean
required

Whether the dispute has been resolved.

​
status
string
required

Current status of the dispute.

​
transaction
string | null
required

ID of the transaction associated with this dispute.

​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.