Skip to main content

​
payment.refund.created

Generated from COPE public event contracts. Do not edit this page by hand.
Use this event to reconcile returned funds and update order or entitlement state.

​
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 patternrefund:<identifier>
CategoryPayments
AvailabilityAvailable in the public webhook reference.
Schema titlepayment.refund.created v1 payload
Schema IDhttps://schemas.cope.com/events/payment.refund.created/v1

​
Payload Fields

FieldRequiredTypeAllowed ValuesDescription
additional_recipientsnoarray-Optional additional recipient email addresses configured for this notification category. Each recipient receives an individually addressed copy. The list is capped at 5 addresses.
affiliate_codenostring--
affiliate_idnostring--
businessyesobject--
buyeryesobject--
commission_amount_centsnointeger--
commission_idnostring--
currencynostring--
event_typeyesconstpayment.refund.created-
first_click_refno`stringnull`-Raw, unvalidated affiliate reference captured from the inbound ?aff= parameter. It is not a resolved or validated affiliate ID; COPE resolves and validates attribution downstream.
line_itemsyesarray--
occurred_atyesstring--
orderyesobject--
order_overview_urlnostring--
original_observation_idnostring--
paymentnoobject--
payment_methodyes`objectnull`--
phone_offer_idno`stringnull`-Phone offer identifier associated with the original sale, if any. Raw attribution signal only.
promoyes`objectnull`--
promo_codeno`stringnull`-Promo code applied to the original sale, if any. Raw attribution signal only.
railnostring--
reversal_observation_idnostring--
schema_versionyesconst1.4-
seller_vat_infono`objectnull`-Seller identity used for invoicing when the creator is the VAT-liable party. Null when COPE is the VAT-liable party.
source_event_idnostring--
source_event_typenoconstpayment.refund.created-
totalsyesobject--
vat_modenostringcope_vat, creator_vatWhich party is liable for VAT on the original sale being refunded: COPE (cope_vat) or the creator (creator_vat).
vat_responsibilitynostringcope, creatorWhich party remits VAT to the tax authority.

​
Example CloudEvent

{
  "data": {
    "business": {},
    "buyer": {},
    "event_type": "payment.refund.created",
    "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"
    },
    "payment_method": {},
    "promo": {},
    "schema_version": "1.4",
    "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.refund.created/v1",
  "id": "payment.refund.created:example",
  "idempotency_key": "payment.refund.created:example",
  "source": "cope.payment",
  "specversion": "1.0",
  "subject": "refund:example",
  "time": "2026-05-05T12:00:00.000Z",
  "type": "payment.refund.created"
}

​
Compatibility

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