Payments & Vouchers

Payments

A Payment represents a single charge, refund, or balance movement attached to an Order — the record of money owed, taken, returned, or moved between credit buckets for a given purchase.

Payments are created, listed, charged and refunded against an Order — or, before submission, against a Basket (which is the same underlying record). The operations that manage payments on an order are documented in the Orders section; the basket equivalent, createBasketPayment, only supports voucher payments. To take a card (Stripe or Adyen) payment for a basket or order built through the API, send the customer to a hosted checkout link from createOrderCheckoutLink. This page is the canonical reference for the Payment object's shape — what fields you'll see on a payment.complete webhook, on a list-order-payments response, or on the per-order detail view.

The most-used flow is createOrderPayment (record an intent to pay) → actionChargeOrderPayment (capture the money) → payment.complete webhook (delivery-side confirmation). See Build a basket and check out for the end-to-end walkthrough.

The Payment object

Attributes

  • idobject-idrequired

    The ID of the item to be added.

  • amountintegerrequired

    The amount of the payment, in the lowest denomination

  • capture_methodstringrequirednullable

    At what point the payment amount will be captured

  • chargebacksobject[]optional
  • currencyrequired

    The currency code for the amount

  • details_sourcestringrequirednullable

    How the payment method will be provided

  • failure_reasonstringoptionalnullable

    If present, provides a human-readable explanation for the failure.

  • item_revenuesobject[]requirednullable

    How the payment amount is allocated across the order's items and revenue centres. Null for payments taken before item revenue allocation was enabled — such payments cannot support item-level operations like partial charge to room.

  • order_refstringoptionalnullable
  • paid_atdate-timerequirednullable

    The time and date that the payment was paid.

  • payable_idobject-idrequired
  • payable_typestringrequired
  • processorstringrequired

    The payment processor to be used for the payment

  • processor_dataobjectrequired

    A dictionary of processor-specific data

  • processor_idobject-idrequired
  • processor_typestringrequirednullable
  • refundable_amountnumberrequired

    The amount of the payment that may be refunded.

  • refundsobject[]required
  • statusstringrequired

    The current status of the payment

    Possible values:cancelledexpiredfailedpaidpayment_method_chargedpayment_method_storedpendingready_for_capturerequires_actionunder_review
  • created_atrequired

    The time and date that the payment was created.

{
  "id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "amount": 10000,
  "capture_method": "automatic",
  "chargebacks": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "amount": "string",
      "currency": "GBP",
      "payment_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "processor_data": {},
      "reason": "string",
      "status": "confirmed",
      "created_at": "string"
    }
  ],
  "currency": "GBP",
  "details_source": "pay_by_link",
  "failure_reason": "Suspected fraud",
  "item_revenues": [
    {
      "basket_item_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "revenue_centre": "spa",
      "gross_amount": 1500,
      "net_amount": 1250,
      "refunded_amount": 0,
      "currency": "GBP"
    }
  ],
  "order_ref": "EXT-12345",
  "paid_at": "2020-02-24T12:00:00+01:00",
  "payable_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "payable_type": "string",
  "processor": "stripe",
  "processor_data": {},
  "processor_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "processor_type": "string",
  "refundable_amount": 3500,
  "refunds": [
    "EXT-12345"
  ],
  "status": "cancelled",
  "created_at": "string"
}