Dispute
Server-side response object returned directly or within a successful result object from the following requests:
Attributes
amount_disputedDecimalThe decimal value representing the disputed amount.
amount_wonDecimalThe decimal value representing the reversed amount.
case_numberstrThe case number for the dispute.
The chargeback protection level for the dispute.
created_atdatetimeThe date/time the object was created. Returned in UTC.
The settlement currency for the transaction (defaults to “USD”). See the ISO 4217 codes.
evidencemapThe evidence records for the dispute. Either the URL or comments will be populated depending on what type of evidence attachment was uploaded.
commentstrThe body for text evidence.
created_atdatetimeThe date/time the object was created. Returned in UTC.
idstrThe identifier for an evidence record.
sent_to_processor_atdatetimeThe date/time of when the evidence was sent to the processor. Returned in UTC.
urlstrA URL where you can retrieve the dispute evidence.
graphql_idstrThe unique identifier used to identify this dispute in Braintree's GraphQL API.
idstrThe string value representing a specific dispute. Length and format of gateway-generated tokens and IDs may change at any time.
kindstrThe kind of dispute. Possible values:
- CHARGEBACK
- PRE_ARBITRATION
- RETRIEVAL
For more information, see the article on dispute kinds.
The ID of the merchant account used to create the disputed transaction.
The ID of the original dispute, which can be used to access more information about that dispute.
Conversation between the merchant and customer regarding a PayPal retrieval dispute.
messagestrThe body of the message.
send_atdatetimeThe date/time the message was sent. Returned in UTC.
senderstrThe sender of the message.
The pre-dispute program of the dispute.
Additional comments forwarded by the processor.
reasonstrThe reason the dispute was created. Possible values:
- cancelled_recurring_transaction: The cardholder was billed for a recurring charge they canceled or attempted to cancel.
- credit_not_processed: The cardholder was told they were to receive a credit and did not.
- duplicate: The individual charge was submitted more than once.
- fraud: The cardholder is claiming this transaction to be fraudulent.
- general: A generic response was provided by the card-issuing bank.
- invalid_account: Card was expired, had an invalid account number, or had an account number that did not match the card number of the original transaction.
- not_recognized: The cardholder claims they do not recognize/did not participate in this charge.
- product_not_received: The cardholder did not receive (or only partially received) the goods/services they paid for.
- product_unsatisfactory: The cardholder received the goods/services, but the product was defective, different than described, or otherwise did not meet expectations.
- transaction_amount_differs: The cardholder claims the charge the merchant submitted was different than what the cardholder agreed to pay.
reason_codestrThe reason code provided by the processor.
The reason code description based on the reason_code.
received_datedatetimeThe date the dispute was received by the merchant. Returned in UTC.
The string value representing the reference number provided by the processor (if any).
reply_by_datedatetimeThe merchant Reply By date that is referenced in the gateway. Returned in UTC.
statusstrThe status of the dispute. Possible values:
- ACCEPTED
- AUTO_ACCEPTED
- DISPUTED
- EXPIRED
- OPEN
- LOST
- WON
See dispute statuses for more details.
A log of history events containing status changes by date for this dispute.
disbursement_datedatetimeThe date this event was disbursed. Returned in UTC.
effective_datedatetimeThe effective date of the status change. Returned in UTC.
statusstrA log of history events containing status changes by date for this dispute.
timestampdatetimeThe date/time the object was created. Returned in UTC.
transactionmapA transaction object describing the disputed transaction.
amountDecimalThe billing amount of the request.
created_atdatetimeThe date/time the object was created. Returned in UTC.
idstrThe unique identifier for the disputed transaction.
order_idstrThe order ID of the transaction. For PayPal transactions, this field maps to the unique PayPal invoice number in your PayPal business account.
The payment instrument subtype of the transaction (e.g. Visa credit card type for a credit card transaction). This can be useful for merchants tracking which cards they get the most disputes from.
The purchase order number provided at creation of the transaction.
updated_atdatetimeThe date/time the object was last updated. Returned in UTC.