Skip to content

OrderPaymentEvent ​

Type: schema

Description ​

A payment of the order, or a refund of one, as an order's events list it in payments and a payment's own events (payment.created, payment.success, payment.failed and the like) carry it: the order's payment (OrderPayment) and, on a payment, the payment gateway it is made on.

TypeScript Definition ​

typescript
OrderPaymentEvent: {components["schemas"]["OrderPayment"] & {
            /** @description The payment gateway the payment is made on, as the store's payment settings name it, or `loyalty-point` for loyalty points
}

Component References ​

ReferenceResolves To
components["schemas"]["OrderPayment"]OrderPayment

OpenAPI Schema ​

json
{
  "title": "OrderPaymentEvent",
  "description": "A payment of the order, or a refund of one, as an order's events list it in `payments` and a payment's own events (`payment.created`, `payment.success`, `payment.failed` and the like) carry it: the order's payment (`OrderPayment`) and, on a payment, the payment gateway it is made on.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/OrderPaymentEvent",
    "description": "API reference for the OrderPaymentEvent schema"
  },
  "allOf": [
    {
      "$ref": "#/components/schemas/OrderPayment"
    },
    {
      "type": "object",
      "properties": {
        "payment_gateway": {
          "description": "The payment gateway the payment is made on, as the store's payment settings name it, or `loyalty-point` for loyalty points; empty for a payment an admin recorded manually. On every payment (`transaction_type` `payment`); a refund has none.",
          "type": "string"
        }
      }
    }
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: