Skip to content

OrderPayment ​

Type: schema

Description ​

A payment of the order, or a refund of one (transaction_type). Every payment has the common fields; the method's own fields depend on payment_method: a card's card_number and card_type, netbanking's bank_name, UPI's upi_id, a wallet's wallet_name, a bank transfer's (IMPS, NEFT, RTGS) bank_account_number and bank_name. A payment whose method isn't known yet (payment_method empty or null) or has no fields of its own (e.g. NACH, cash, loyalty points) has only the common fields.

TypeScript Definition ​

typescript
OrderPayment: components["schemas"]["CardPayment"] & components["schemas"]["NetbankingPayment"] & components["schemas"]["UpiPayment"] & components["schemas"]["WalletPayment"] & components["schemas"]["BankTransfer"] & components["schemas"]["NachPayment"]

Component References ​

ReferenceResolves To
components["schemas"]["CardPayment"]CardPayment
components["schemas"]["NetbankingPayment"]NetbankingPayment
components["schemas"]["UpiPayment"]UpiPayment
components["schemas"]["WalletPayment"]WalletPayment
components["schemas"]["BankTransfer"]BankTransfer
components["schemas"]["NachPayment"]NachPayment

OpenAPI Schema ​

json
{
  "description": "A payment of the order, or a refund of one (`transaction_type`). Every payment has the common fields; the method's own fields depend on `payment_method`: a card's `card_number` and `card_type`, netbanking's `bank_name`, UPI's `upi_id`, a wallet's `wallet_name`, a bank transfer's (`IMPS`, `NEFT`, `RTGS`) `bank_account_number` and `bank_name`. A payment whose method isn't known yet (`payment_method` empty or `null`) or has no fields of its own (e.g. `NACH`, cash, loyalty points) has only the common fields.",
  "allOf": [
    {
      "$ref": "#/components/schemas/CardPayment"
    },
    {
      "$ref": "#/components/schemas/NetbankingPayment"
    },
    {
      "$ref": "#/components/schemas/UpiPayment"
    },
    {
      "$ref": "#/components/schemas/WalletPayment"
    },
    {
      "$ref": "#/components/schemas/BankTransfer"
    },
    {
      "$ref": "#/components/schemas/NachPayment"
    }
  ],
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/OrderPayment",
    "description": "API reference for the OrderPayment schema"
  },
  "required": [
    "transaction_type",
    "request_number",
    "amount",
    "payment_status",
    "payment_method",
    "payment_reference_number"
  ],
  "title": "OrderPayment"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: