v1

latestOpenAPI 3.0.42026-07-2286621993.2 KB
disputes

Show dispute details

Shows details for a dispute, by ID.<blockquote><strong>Note:</strong> The fields that appear in the response depend on the access. For example, if the merchant requests shows dispute details, the customer's email ID does not appear.</blockquote>

get/v1/customer/disputes/{id}

Path parameters

idstring required

ID of the setup token.

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that shows dispute details.

dispute_idstring

The ID of the dispute.

create_timestring ppaas_date_time_v3

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>

update_timestring ppaas_date_time_v3

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>

reason'MERCHANDISE_OR_SERVICE_NOT_RECEIVED' | 'MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED' | 'UNAUTHORISED' | 'CREDIT_NOT_PROCESSED' | 'DUPLICATE_TRANSACTION' | 'INCORRECT_AMOUNT' | 'PAYMENT_BY_OTHER_MEANS' | 'CANCELED_RECURRING_BILLING' | 'PROBLEM_WITH_REMITTANCE' | 'OTHER'

The reason for the item-level dispute. For information about the required information for each dispute reason and associated evidence type, see <a href="/docs/integration/direct/customer-disputes/integration-guide/#dispute-reasons">dispute reasons</a>.

status'ACTIVE' | 'INACTIVE'

Status of the payment resource.

fee_policyFeePolicy

Policy that determines whether the fee needs to be charged, retained or returned while moving the money as part of dispute process.

external_reason_codestring

The code that identifies the reason for the credit card chargeback. Each card issuer follows their own standards for defining reason type, code, and its format. For more details about the external reason code, see the card issue site. Available for only unbranded transactions.

dispute_life_cycle_stage'INQUIRY' | 'CHARGEBACK' | 'PRE_ARBITRATION' | 'ARBITRATION'

The stage in the dispute lifecycle.

dispute_channel'INTERNAL' | 'EXTERNAL' | 'ALERT'

The channel where the customer created the dispute.

buyer_response_due_datestring ppaas_date_time_v3

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>

seller_response_due_datestring ppaas_date_time_v3

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>