Payments & Vouchers

Refunds

A Refund is a single return of funds against a Payment — the record of money sent back to a customer for a paid-for purchase.

Refunds are always created against a Payment on an Order, so the operations that produce and list them live in the Orders section, alongside the rest of the order lifecycle. This page is the canonical reference for the Refund object's shape — what fields you'll see on a refund.complete webhook, on a list-order-refunds response, or embedded under payments[].refunds[] on an order detail view.

The most-used flow is actionRefundOrderPayment (kick off a refund against a specific payment) → refund.complete webhook (delivery-side confirmation). For partial refunds and refund-eligibility checks, see getOrderRefundableItems.

The Refund object

Attributes

  • idobject-idrequired

    The ID of the refund.

  • payment_idobject-idrequired

    The ID of the payment that was refunded.

  • amountintegerrequired

    The amount of the refund.

  • currencyrequired
  • notesstringoptionalnullable

    Notes that were added against the refund.

  • statusstringrequired

    The current status of the refund.

    Possible values:pendingcompletefailed
  • processor_dataobjectrequired

    A dictionary of processor-specific data.

  • created_atdate-timerequired

    The date and time that the refund was created.

{
  "id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "payment_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "amount": 1,
  "currency": "GBP",
  "notes": "Free-form text from the resource.",
  "status": "pending",
  "processor_data": {},
  "created_at": "2026-01-15T09:30:00+00:00"
}