Disputeanchor

availability

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

Server-side response object returned directly or within a successful result object from the following requests:
Attributes
amountDisputedString

The decimal value representing the disputed amount.

amountWonString

The decimal value representing the reversed amount.

caseNumberstring

The case number for the dispute.

chargebackProtectionLevelstring

The chargeback protection level for the dispute.

createdAtDateTime

The date/time the object was created. Returned in UTC.

currencyIsoCodestring

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

evidencemap

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

commentstring

The body for text evidence.

createdAtDateTime

The date/time the object was created. Returned in UTC.

idstring

The identifier for an evidence record.

sentToProcessorAtDateTime

The date/time of when the evidence was sent to the processor. Returned in UTC.

urlstring

A URL where you can retrieve the dispute evidence.

graphQLIdstring

The unique identifier used to identify this dispute in Braintree's GraphQL API.

idstring

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

kindstring

The kind of dispute. Possible values:

  • CHARGEBACK
  • PRE_ARBITRATION
  • RETRIEVAL

For more information, see the article on dispute kinds.

merchantAccountIdstring

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

originalDisputeIdstring

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

paypalMessagesmap

Conversation between the merchant and customer regarding a PayPal retrieval dispute.

messagestring

The body of the message.

sendAtDateTime

The date/time the message was sent. Returned in UTC.

senderstring

The sender of the message.

preDisputeProgramstring

The pre-dispute program of the dispute.

processorCommentsstring

Additional comments forwarded by the processor.

reasonstring

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.

reasonCodestring

The reason code provided by the processor.

reasonDescriptionstring

The reason code description based on the reason_code.

receivedDateDateTime

The date the dispute was received by the merchant. Returned in UTC.

referenceNumberstring

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

replyByDateDateTime

The merchant Reply By date that is referenced in the gateway. Returned in UTC.

statusstring

The status of the dispute. Possible values:

  • ACCEPTED
  • AUTO_ACCEPTED
  • DISPUTED
  • EXPIRED
  • OPEN
  • LOST
  • WON

See dispute statuses for more details.

statusHistorymap

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

disbursementDateDateTime

The date this event was disbursed. Returned in UTC.

effectiveDateDateTime

The effective date of the status change. Returned in UTC.

statusstring

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

timestampDateTime

The date/time the object was created. Returned in UTC.

transactionmap

A transaction object describing the disputed transaction.

amountString

The billing amount of the request.

createdAtDateTime

The date/time the object was created. Returned in UTC.

idstring

The unique identifier for the disputed transaction.

orderIdstring

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

paymentInstrumentSubtypestring

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.

purchaseOrderNumberstring

The purchase order number provided at creation of the transaction.

updatedAtDateTime

The date/time the object was last updated. Returned in UTC.