REreap-global
Disputes

Get dispute details

Changed on

Retrieve detailed information about a single dispute by its ID, including card and transaction details and the dispute status history.

get/disputes/{id}

Request

Path parameters

idstring uuid required

The unique identifier of the dispute

Headers

Accept-Versionstring required

Specifies the API version to use for this request.

Response

Return dispute details

idstring uuid required

The unique identifier of the dispute

transactionIdstring required

The transaction ID

disputeAmountnumber float required

The disputed amount

disputeCurrency'344' | '840' required

The ISO 4217 numeric currency code

disputeReasonstring required

The dispute reason

status'PENDING' | 'RECEIVED' | 'REVIEWING' | 'SUBMITTED' | 'REQUIRE_ACTION' | 'WON' | 'REFUNDED' | 'LOST' | 'DECLINED' | 'CANCELED' required

Current status of the dispute

cardIdstring required

The card ID associated with the dispute

cardLast4string

Last 4 digits of the disputed card. Omitted when unavailable.

cardType'virtual' | 'physical'

Type of the disputed card. Omitted when unavailable.

transactionDatestring

Date of the disputed transaction, as YYYY-MM-DD (UTC). Omitted when unavailable.

transactionNamestring

Merchant name of the disputed transaction. Omitted when unavailable.

source'DocuSign' | 'API' required

How the dispute was created: API for disputes created through the API or the dashboard, DocuSign for disputes submitted through the DocuSign form.

cardholderNamestring nullable

The cardholder full name. Always present in the response; null when not provided or derivable.

cardholderEmailstring email nullable

The cardholder email. Always present in the response; null when not provided or derivable.

contactEmailstring email required

Email address to be informed of the dispute outcome

refundAmountnumber float nullable required

Amount refunded on the dispute. Set only for refunded disputes (status REFUNDED); null otherwise. Always present in the response.

refundCurrencystring nullable required

ISO 4217 numeric currency code of refundAmount, as a string (e.g. "344"). Can differ from disputeCurrency. Set only for refunded disputes (status REFUNDED); null otherwise. Always present in the response.

createdAtstring date-time required

Date the dispute was created

updatedAtstring date-time required

Date the dispute was last updated

Example response

{
  "cardLast4": "4242",
  "cardType": "virtual",
  "transactionDate": "2024-01-10",
  "transactionName": "AMAZON.COM",
  "source": "API",
  "refundAmount": 80,
  "refundCurrency": "840",
  "statusHistory": [
    {
      "status": "RECEIVED",
      "at": "2024-01-11T08:00:00.000Z"
    },
    {
      "status": "SUBMITTED",
      "at": "2024-01-12T09:30:00.000Z"
    },
    {
      "status": "REFUNDED",
      "at": "2024-02-20T14:15:00.000Z"
    }
  ]
}

Changes

  • beb4b8d4eb01Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status