PaymentInfo
Type: schema
Description
Common fields in all types of payments.
TypeScript Definition
typescript
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" | "refunded" | "unsettled" | "settled" | "partially_settled" | "manual_review" | "debit_scheduled" | "collection_due" | "initiated";
/** Format: date-time */
payment_date?: string;
payment_reference_number?: string | null;
payment_method?: string | null;
icon_url?: string | null;
/** @description Payment gateway/provider slug for this transaction. */
payment_provider_slug?: string | null;
payment_mode?: string | null;
/** @description Shipment reference the refund is against. Present only on `refund` transactions; `null` for payments. */
shipment_number?: string | null;
/** Format: date-time */
created_at?: string;
/** Format: date-time */
modified_at?: string;
};
/** PaymentMethodPayload */
}OpenAPI Schema
json
{
"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",
"refunded",
"unsettled",
"settled",
"partially_settled",
"manual_review",
"debit_scheduled",
"collection_due",
"initiated"
]
},
"payment_date": {
"type": "string",
"format": "date-time"
},
"payment_reference_number": {
"type": [
"string",
"null"
]
},
"payment_method": {
"type": [
"string",
"null"
]
},
"icon_url": {
"type": [
"string",
"null"
]
},
"payment_provider_slug": {
"description": "Payment gateway/provider slug for this transaction.",
"type": [
"string",
"null"
]
},
"payment_mode": {
"type": [
"string",
"null"
]
},
"shipment_number": {
"description": "Shipment reference the refund is against. Present only on `refund` transactions; `null` for payments.",
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"modified_at": {
"type": "string",
"format": "date-time"
}
}
}Auto-generated from OpenAPI spec and TypeScript definitions