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
getAmountDisputed()BigDecimal

The decimal value representing the disputed amount.

getAmountWon()BigDecimal

The decimal value representing the reversed amount.

getCaseNumber()string

The case number for the dispute.

getChargebackProtectionLevel()string

The chargeback protection level for the dispute.

getCreatedAt()Calendar

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

getCurrencyIsoCode()string

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

getEvidence()map

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

getComment()string

The body for text evidence.

getCreatedAt()Calendar

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

getId()string

The identifier for an evidence record.

getSentToProcessorAt()Calendar

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

getUrl()string

A URL where you can retrieve the dispute evidence.

getGraphQLId()string

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

getId()string

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

getKind()string

The kind of dispute. Possible values:

  • CHARGEBACK
  • PRE_ARBITRATION
  • RETRIEVAL

For more information, see the article on dispute kinds.

getMerchantAccountId()string

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

getOriginalDisputeId()string

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

getPaypalMessages()map

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

getMessage()string

The body of the message.

getSendAt()Calendar

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

getSender()string

The sender of the message.

getPreDisputeProgram()string

The pre-dispute program of the dispute.

getProcessorComments()string

Additional comments forwarded by the processor.

getReason()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.

getReasonCode()string

The reason code provided by the processor.

getReasonDescription()string

The reason code description based on the reason_code.

getReceivedDate()Calendar

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

getReferenceNumber()string

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

getReplyByDate()Calendar

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

getStatus()string

The status of the dispute. Possible values:

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

See dispute statuses for more details.

getStatusHistory()map

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

getDisbursementDate()Calendar

The date this event was disbursed. Returned in UTC.

getEffectiveDate()Calendar

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

getStatus()string

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

getTimestamp()Calendar

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

getTransaction()map

A transaction object describing the disputed transaction.

getAmount()BigDecimal

The billing amount of the request.

getCreatedAt()Calendar

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

getId()string

The unique identifier for the disputed transaction.

getOrderId()string

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

getPaymentInstrumentSubtype()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.

getPurchaseOrderNumber()string

The purchase order number provided at creation of the transaction.

getUpdatedAt()Calendar

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