Dispute

A dispute is a type of accounting record representing disagreements between customers and merchants on a particular payment. Disputes are also often referred to as chargebacks.

  • amount
    Type: number · Amount
    required
  • currencyCode
    Type: string · Currencycode
    required
  • date
    Type: string · DateFormat: date
    required

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • status
    Type: string · DisputeStatusenum
    required
    values
    • pending
    • won
    • lost
  • customFields
    Type: object · CustomFieldsnullable

    The additional fields related to an accounting record. Custom fields are used to attach custom metadata to the objects to ingest into the system. Custom fields can be any valid JSON object.

    • propertyName
      Type: anything
  • description
    Type: string · Descriptionnullable
  • exchangeRates
    Type: array object[] | null · Exchangeratesnullable
    • currencyCode
      Type: string · Currencycode
      required
    • rate
      Type: number · Rate
      required
  • initiatedDate
    Type: string · InitiateddateFormat: datenullable

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • resolvedDate
    Type: string · ResolveddateFormat: datenullable

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21