PaymentInfo

Type: schema

Description

Common fields in all types of payments.

TypeScript Definition

PaymentInfo: {{
            /** @enum {string} */
            transaction_type?: "payment" | "refund";
            request_number?: string;
            /** Format: double */
            amount?: number;
            /** @enum {string} */
            payment_status?: "pending" | "success" | "failed" | "partially_paid" | "refund_initiated";
            /** Format: date-time */
            payment_date?: string;
            payment_reference_number?: string | null;
            payment_method?: string | null;
            icon_url?: string | null;
        };
        /** PaymentMethodPayload */
}

OpenAPI Schema

{
  "title": "PaymentInfo",
  "description": "Common fields in all types of payments.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/PaymentInfo",
    "description": "API reference for the PaymentInfo schema"
  },
  "properties": {
    "transaction_type": {
      "type": "string",
      "enum": [
        "payment",
        "refund"
      ]
    },
    "request_number": {
      "type": "string"
    },
    "amount": {
      "type": "number",
      "format": "double"
    },
    "payment_status": {
      "type": "string",
      "enum": [
        "pending",
        "success",
        "failed",
        "partially_paid",
        "refund_initiated"
      ]
    },
    "payment_date": {
      "type": "string",
      "format": "date-time"
    },
    "payment_reference_number": {
      "type": [
        "string",
        "null"
      ]
    },
    "payment_method": {
      "type": [
        "string",
        "null"
      ]
    },
    "icon_url": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions