get-payment-status

Method: GET
Path: /orders/{order_number}/payment-status

Tags: Orders

Summary

Retrieve payment status

Description

Retrieve payment status of a paricular order.

Storefront SDK Usage

SDK Method: sdk.order.getPaymentStatus()

Example:

const { data, error } = await sdk.order.getPaymentStatus("ORD-2024-001");

if (error) {
  console.error("Failed to get payment status:", error.message);
} else {
  console.log("Payment status:", data.status);
  console.log("Amount paid:", data.amount_paid);
  console.log("Amount unpaid:", data.amount_unpaid);
  console.log("Retry available:", data.is_retry_available);
}

TypeScript Definition

"get-payment-status": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description order number */
                order_number: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        /** @default order details */
                        readonly message: string;
                        readonly success: boolean;
                        content: {
                            /** @enum {string} */
                            status: "pending" | "success" | "failed" | "partially_paid";
                            /** Format: double */
                            amount_paid: number;
                            /** Format: double */
                            amount_unpaid: number;
                            is_retry_available: boolean;
                        };
                    };
                };
            };
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Parameters

• order_number (path): order number

Responses

200

OK

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "Orders"
  ],
  "operationId": "get-payment-status",
  "summary": "Retrieve payment status",
  "description": "Retrieve payment status of a paricular order.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/get-payment-status",
    "description": "API reference for the get-payment-status operation"
  },
  "parameters": [
    {
      "name": "order_number",
      "in": "path",
      "description": "order number",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success",
              "content"
            ],
            "properties": {
              "message": {
                "type": "string",
                "default": "order details",
                "readOnly": true
              },
              "success": {
                "type": "boolean",
                "readOnly": true
              },
              "content": {
                "properties": {
                  "status": {
                    "type": "string",
                    "enum": [
                      "pending",
                      "success",
                      "failed",
                      "partially_paid"
                    ]
                  },
                  "amount_paid": {
                    "type": "number",
                    "format": "double"
                  },
                  "amount_unpaid": {
                    "type": "number",
                    "format": "double"
                  },
                  "is_retry_available": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "status",
                  "amount_paid",
                  "amount_unpaid",
                  "is_retry_available"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "orders",
  "x-speakeasy-ignore": false,
  "x-speakeasy-name-override": "getPaymentStatus"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions