OrderPaymentInfo
Type: schema
Description
Common fields in all types of payments.
TypeScript Definition
typescript
OrderPaymentInfo: {{
/** @enum {unknown} */
transaction_type?: "payment" | "refund";
request_number?: string;
/** Format: double */
amount?: number;
payment_status?: components["schemas"]["PaymentStatus"];
/** Format: date-time */
payment_date?: string | null;
payment_reference_number?: string | null;
/** @description How it was paid, e.g. `Card`, `Credit Card`, `Debit Card`, `Netbanking`, `UPI`, `Wallet`, `Loyalty Point`, `IMPS`, `NEFT`, `RTGS`, `Cash`, `NACH`. A manual payment carries the method it was requested or recorded with. Empty string when recorded without a method, as on point-of-sale orders; null for refunds and payments not paid yet. */
payment_method?: string | null;
payment_mode?: string;
icon_url?: string | null;
/** Format: date-time */
created_at?: $Read<string>;
/** Format: date-time */
modified_at?: $Read<string>;
};
/** OrderReceiptJsonFormat */
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["PaymentStatus"] | PaymentStatus |
OpenAPI Schema
json
{
"description": "Common fields in all types of payments.",
"type": "object",
"properties": {
"transaction_type": {
"enum": [
"payment",
"refund"
]
},
"request_number": {
"type": "string"
},
"amount": {
"type": "number",
"format": "double"
},
"payment_status": {
"$ref": "#/components/schemas/PaymentStatus"
},
"payment_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"payment_reference_number": {
"type": [
"string",
"null"
]
},
"payment_method": {
"description": "How it was paid, e.g. `Card`, `Credit Card`, `Debit Card`, `Netbanking`, `UPI`, `Wallet`, `Loyalty Point`, `IMPS`, `NEFT`, `RTGS`, `Cash`, `NACH`. A manual payment carries the method it was requested or recorded with. Empty string when recorded without a method, as on point-of-sale orders; null for refunds and payments not paid yet.",
"type": [
"string",
"null"
]
},
"payment_mode": {
"type": "string"
},
"icon_url": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"title": "OrderPaymentInfo",
"x-tags": [
"Orders"
]
}Auto-generated from OpenAPI spec and TypeScript definitions