Dispute

ch:dispute LINK RELATION

Actions

method	description
GET	View dispute
OPTIONS	Retrieve supported HTTP methods

Request parameters

No request parameters.

Profile

A Dispute represents information about a given dispute.

Properties

name	type
id	string
reference	string
amount¹	integer
currency	ISO 4217 3-letter code
partial	boolean
opened_at	ISO 8601 date
due_at	ISO 8601 date
expires_at	ISO 8601 date
status	string
reason_code	string
reason²	string
type³	string

Amount in minor units of given currency (e.g. cents if in Euro).

One of: fraud, unrecognised, product_not_provided, credit_not_processed, duplicate, subscription_cancelled, incorrect_amount_or_currency, general, product_unacceptable.

One of: retrieval_request, 1st_chargeback, 2nd_chargeback.

Link relations

rel	conditional
self	false
ch:transaction	false
ch:account	false
ch:files	false
ch:comments	false
ch:stamps¹	true

Presence depends on status.

Embedded

Additional semantics

This resource supports Stamps. See Stamps for more information.

name	meaning	removable
refuted	Mark the dispute as refuted	false
accepted	Mark the dispute as accepted	false

Example representation

{
  "id": "c6d9153b-32cb-472a-9dc9-553e9c79ea22",
  "reference": "76305919047987300424222",
  "amount": 58704,
  "currency": "DKK",
  "partial": false,
  "opened_at": "2016-02-28",
  "due_at": "2016-03-13",
  "expires_at": "2016-04-10",
  "status": "open",
  "reason_code": "12.6.1",
  "reason": "duplicate",
  "type": "1st_chargeback",
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/disputes/c6d9153b-32cb-472a-9dc9-553e9c79ea22"
    },
    "ch:transaction": {
      "href": "https://merchant.test.clearhaus.com/transactions/a51a3abe-8eee-4a92-b941-e89f18c5bf66"
    },
    "ch:account": {
      "href": "https://merchant.test.clearhaus.com/accounts/f72e20a6-31dc-4c24-9314-4bcc5b8820d4"
    },
    "ch:files": {
      "href": "https://merchant.test.clearhaus.com/disputes/c6d9153b-32cb-472a-9dc9-553e9c79ea22/files{?page,per_page}"
    },
    "ch:comments": {
      "href": "https://merchant.test.clearhaus.com/disputes/c6d9153b-32cb-472a-9dc9-553e9c79ea22/comments{?page,per_page}"
    },
    "ch:stamps": [
      {
        "href": "https://merchant.test.clearhaus.com/disputes/c6d9153b-32cb-472a-9dc9-553e9c79ea22/stamps/refuted",
        "name": "refuted"
      },
      {
        "href": "https://merchant.test.clearhaus.com/disputes/c6d9153b-32cb-472a-9dc9-553e9c79ea22/stamps/accepted",
        "name": "accepted"
      }
    ],
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  },
  "_embedded": {
    "ch:events": [...],
    "ch:account": {...},
    "ch:transaction": {...}
  }
}