You can use data from the Disputes endpoints to calculate key metrics, such as the number of chargebacks.

Overview

A customer may file a payment dispute with their bank or other card issuer when they're unsatisfied with their purchase or believe they have been charged incorrectly. For example:

  • They didn't receive an order.
  • The product they received was different to the commerce store's description.
  • They've been the victim of online fraud.

From the Disputes endpoints you can retrieve:

  • A list of all the disputes for a commerce company:
    GET /companies/{companyId}/connections/{connectionId}/data/commerce-disputes.
  • The details of an individual dispute:
    GET /companies/{companyId}/connections/{connectionId}/data/commerce-disputes/{disputeId}.

Data model

Field

Type

Decription

id

string

Identifier for the dispute, unique to the company.

disputedTransactions

array
See transactionSourceRef

Transactions linked to the dispute.

totalAmount

decimal

Total transaction amount that is under dispute.

currency

string
See currency

Currency of the disputed transaction.

status

string

Current status of the dispute, either:

  • Unknown

  • ChargeRefunded - The seller decided not to challenge the dispute and refunded the customer.

  • EvidenceRequired - The initial state of a dispute. If the seller decides to challenge the dispute, they must submit evidence before the due date.

  • Processing - The seller missed the deadline for submitting evidence and the card issuer has begun to process the dispute.

  • InquiryProcessing - Submitted evidence is being processed by the card issuer.

  • InquiryEvidenceRequired - More evidence is required to determine a dispute.

  • WaitingThirdParty - Evidence is required from a third party.

  • Won - The seller wins the dispute and the disputed amount is released to their account.

  • Lost - The seller loses the dispute.

  • Accepted - The seller accepts that they have lost the dispute and refunds the customer.

  • InquiryClosed - The inquiry is complete.

reason

string

Reason for the dispute.

dueDate

string
See date

Date when the next action in the dispute resolution is due.

createdDate

string
See date

Date on which the dispute was recorded in the commerce or point of sale platform.

modifiedDate

string
See date

Date the dispute was last updated in the Codat system.

sourceModifiedDate

string
See date

Date the customer details were last changed in the commerce or point of sale platform.

Example data

{
      "id": "string",
      "disputedTransactions": [
        {
          "id": "string",
          "type": "Unknown"
        }
      ],
      "totalAmount": 0,
      "currency": "string",
      "status": "Unknown",
      "reason": "string",
      "dueDate": "2021-04-21T10:29:12.144Z",
      "createdDate": "2021-04-21T10:29:12.144Z",
      "modifiedDate": "2021-04-21T10:29:12.144Z",
      "sourceModifiedDate": "2021-04-21T10:29:12.144Z"
    }

Did this page help you?