Dispute
Server-side response object returned directly or within a successful result object from the following requests:
Attributes
amountDisputed
StringThe decimal value representing the disputed amount.
amountWon
StringThe decimal value representing the reversed amount.
caseNumber
stringThe case number for the dispute.
The chargeback protection level for the dispute.
createdAt
DateTimeThe date/time the object was created. Returned in UTC.
currencyIsoCode
stringThe settlement currency for the transaction (defaults to “USD”). See the ISO 4217 codes.
evidence
mapThe evidence records for the dispute. Either the URL or comments will be populated depending on what type of evidence attachment was uploaded.
comment
stringThe body for text evidence.
createdAt
DateTimeThe date/time the object was created. Returned in UTC.
id
stringThe identifier for an evidence record.
sentToProcessorAt
DateTimeThe date/time of when the evidence was sent to the processor. Returned in UTC.
url
stringA URL where you can retrieve the dispute evidence.
graphQLId
stringThe unique identifier used to identify this dispute in Braintree's GraphQL API.
id
stringThe string value representing a specific dispute. Length and format of gateway-generated tokens and IDs may change at any time.
kind
stringThe kind of dispute. Possible values:
- CHARGEBACK
- PRE_ARBITRATION
- RETRIEVAL
For more information, see the article on dispute kinds.
merchantAccountId
stringThe ID of the merchant account used to create the disputed transaction.
originalDisputeId
stringThe 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.
message
stringThe body of the message.
sendAt
DateTimeThe date/time the message was sent. Returned in UTC.
sender
stringThe sender of the message.
preDisputeProgram
stringThe pre-dispute program of the dispute.
processorComments
stringAdditional comments forwarded by the processor.
reason
stringThe 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.
reasonCode
stringThe reason code provided by the processor.
reasonDescription
stringThe reason code description based on the reason_code.
receivedDate
DateTimeThe date the dispute was received by the merchant. Returned in UTC.
referenceNumber
stringThe string value representing the reference number provided by the processor (if any).
replyByDate
DateTimeThe merchant Reply By date that is referenced in the gateway. Returned in UTC.
status
stringThe 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.
disbursementDate
DateTimeThe date this event was disbursed. Returned in UTC.
effectiveDate
DateTimeThe effective date of the status change. Returned in UTC.
status
stringA log of history events containing status changes by date for this dispute.
timestamp
DateTimeThe date/time the object was created. Returned in UTC.
transaction
mapA transaction object describing the disputed transaction.
amount
StringThe billing amount of the request.
createdAt
DateTimeThe date/time the object was created. Returned in UTC.
id
stringThe unique identifier for the disputed transaction.
orderId
stringThe order ID of the transaction. For PayPal transactions, this field maps to the unique PayPal invoice number in your PayPal business account.
paymentInstrumentSubtype
stringThe 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.
purchaseOrderNumber
stringThe purchase order number provided at creation of the transaction.
updatedAt
DateTimeThe date/time the object was last updated. Returned in UTC.