Skip to main content

payment.dispute.won

Generated from COPE public event contracts. Do not edit this page by hand.
Use this event to restore state after a favorable dispute outcome.

Delivery Contract

FieldValue
EncodingCloudEvents 1.0 structured JSON
DeliveryAt least once
IdempotencyUse the CloudEvents source + id tuple, or COPE idempotency_key when available.
Sourcecope.payment
Subject patterndispute:<identifier>
CategoryDisputes
AvailabilityAvailable in the public webhook reference.
Schema titlepayment.dispute.won v1 payload
Schema IDhttps://schemas.cope.com/events/payment.dispute.won/v1

Payload Fields

FieldRequiredTypeAllowed ValuesDescription
affiliate_codenostring--
affiliate_idnostring--
affiliate_payout_business_uuidnostring--
attributionyes`objectnull`--
attribution_decisionno`objectnull`--
attribution_snapshotnoobject--
businessyesobject--
business_idnostring--
buyeryesobject--
commission_amount_centsnointeger--
commission_input_snapshotnoobject--
currencynostring--
disputeyesobject--
economic_basisnoobject--
event_typeyesconstpayment.dispute.won-
funding_business_uuidnostring--
line_itemsyesarray--
mor_posturenostring--
occurred_atyesstring--
orderyesobject--
order_overview_urlnostring--
order_uuidnostring--
paymentnoobject--
payment_chunk_uuidnostring--
payment_lineagenoobject--
payment_methodyes`objectnull`--
payment_uuidnostring--
policy_snapshotnoobject--
promoyes`objectnull`--
railnostring--
schema_versionyesconst1.2-
source_event_idnostring--
source_event_typenoconstpayment.dispute.won-
totalsyesobject--

Example CloudEvent

{
  "data": {
    "attribution": {},
    "business": {},
    "buyer": {},
    "dispute": {
      "amount_cents": 1000,
      "currency": "EUR",
      "dispute_uuid": "00000000-0000-4000-8000-000000000000",
      "original_payment_uuid": "00000000-0000-4000-8000-000000000000",
      "state": "won"
    },
    "event_type": "payment.dispute.won",
    "line_items": [
      {
        "amounts": {
          "gross_cents": 1000,
          "net_cents": 1000,
          "tax_cents": 1000,
          "tax_percentage": 19
        },
        "is_trial": true,
        "payment_number": 1000,
        "product": {},
        "quantity": 1000
      }
    ],
    "occurred_at": "2026-05-05T12:00:00.000Z",
    "order": {
      "created_at": "2026-05-05T12:00:00.000Z",
      "currency": "EUR",
      "source": "example_source",
      "uuid": "example_uuid"
    },
    "payment_method": {},
    "promo": {},
    "schema_version": "1.2",
    "totals": {
      "product": {
        "gross_cents": 1000,
        "net_cents": 1000,
        "tax_cents": 1000
      },
      "total": {
        "gross_cents": 1000,
        "net_cents": 1000,
        "tax_cents": 1000
      }
    }
  },
  "datacontenttype": "application/json",
  "dataschema": "https://schemas.cope.com/events/payment.dispute.won/v1",
  "id": "payment.dispute.won:example",
  "idempotency_key": "payment.dispute.won:example",
  "source": "cope.payment",
  "specversion": "1.0",
  "subject": "dispute:example",
  "time": "2026-05-05T12:00:00.000Z",
  "type": "payment.dispute.won"
}

Compatibility

Fields may be added within the same major version. Removing or changing the meaning of a documented field requires a new event version.