availability

Managing disputes via the API is only available to merchants who can access disputes in the Braintree Control Panel.

Returned directly or within a successful result object from the following requests:

Attributes
amountDisputed String

The decimal value representing the disputed amount.
amountWon String

The decimal value representing the reversed amount.
caseNumber String

The case number for the dispute.
createdAt Date

The date/time the object was created.
currencyIsoCode String

The settlement currency for the transaction (defaults to “USD”). See the ISO 4217 codes.
evidence

The evidence records for the dispute. Either the URL or comments will be populated depending on what type of evidence attachment was uploaded.
comment String

The body for text evidence.
createdAt Date

The date/time the object was created.
id String

The identifier for an evidence record.
sentToProcessorAt Date

The date/time of when the evidence was sent to the processor.
url String

A URL where you can retrieve the dispute evidence.
id String

The string value representing a specific dispute. Length and format of gateway-generated tokens and IDs may change at any time.
kind String

The kind of dispute. Possible values:

  • Chargeback
  • PreArbitration
  • Retrieval

For more information, see the article on dispute kinds.
merchantAccountId String

The ID of the merchant account used to create the disputed transaction.
originalDisputeId String

The ID of the original dispute, which can be used to access more information about that dispute.
processorComments String

Additional comments forwarded by the processor.
reason String

The 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 String

The reason code provided by the processor.
reasonDescription String

The reason code description based on the reason_code.
receivedDate Date

The date the dispute was received by the merchant.
referenceNumber String

The string value representing the reference number provided by the processor (if any).
replyByDate Date

The merchant Reply By date that is referenced in the gateway.
status String

The status of the dispute. Possible values:

  • Accepted
  • Disputed
  • Expired
  • Open
  • Lost
  • Won

See dispute statuses for more details.
statusHistory

A log of history events containing status changes by date for this dispute.
disbursementDate Date

The date this event was disbursed.
effectiveDate Date

The effective date of the status change.
status String

The status of the dispute. Possible values:

  • Accepted
  • Disputed
  • Expired
  • Open
  • Lost
  • Won

See dispute statuses for more details.
timestamp Date

The date/time the object was created.
transaction

A transaction object describing the disputed transaction.
amount String

The billing amount of the request.
createdAt Date

The date/time the object was created.
id String

The unique identifier for the disputed transaction.
orderId String

The order ID of the transaction. For PayPal transactions, this field maps to the unique PayPal invoice number in your PayPal business account.
paymentInstrumentSubtype String

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.
purchaseOrderNumber String

The purchase_order_number provided at creation of the transaction.
updatedAt Date

The date/time the object was last updated.