retrieval
dispute type is received, to prevent a dispute
from being created later.
Name | Type | Description |
---|---|---|
Dispute ID | string | A unique identifier for this dispute event generated by Primer. This is unique to each dispute event - so is not shared across various type and status relating to the same payment. |
Processor dispute ID | string | An identifier for this dispute provided by the processor. This is shared across multiple dispute type and status relating to the same payment. e.g. as an open dispute that is later challenged will share a processorDisputeId . |
Processor | string | The payment processor that you submitted a payment to, and received a dispute notification from. |
Date received | datetime | Date and time at which primer received the processor’s dispute event. Provided as an ISO timestamp in UTC. |
Required response date | datetime | Time by which the merchant must challenge a dispute. This is provided by the processor, where available. |
Type | enum: RETRIEVAL , DISPUTE , PREARBITRATION | The type of dispute event. More information on what the type field represents can be found in our manage disputes guide. |
Order ID | string | Your reference for the sale transaction that the dispute relates to. |
Merchant ID | string | The merchant ID registered at the payment processor used for this dispute. |
Status | enum: OPEN , ACCEPTED , CHALLENGED , EXPIRED , CANCELLED , WON , LOST | To see which statuses are applicable for a dispute type , and how we map status , please see our manage disputes guide. |
Reason code | string | The dispute reason code for a dispute. This will be the same code provided by the card schemes. |
Processor reason | string | The dispute reason provided by the processor. |
Amount | integer | The disputed amount. Note: this is not always the same as the payment amount. This will be displayed in minor units. e.g. for $7, use 700. Some currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use 100. |
Currency code | enum | Currency Code for the disputed amount. The 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars. |