pos-list-payment-options

Method: GET
Path: /pos/payments/payment-options

Tags: POS

Summary

List all payment options

Description

List all payment options

Pos SDK Usage

SDK Method: pos.listPaymentOptions()

Example:

const { data, error } = await pos.listPaymentOptions();

if (error) {
  console.error("Failed to list payment options:", error.message);
} else {
  console.log("Payment options:", data.payment_options);
}

TypeScript Definition

"pos-list-payment-options": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            payment_options?: ("CASH" | "UPI" | "CARD" | "PG")[];
                        };
                    };
                };
            };
            401: components["responses"]["Unauthorized"];
        };
    };

Component References

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

Responses

200

OK

401

Not authorized for given operation on the Resource

OpenAPI Definition

{
  "tags": [
    "POS"
  ],
  "operationId": "pos-list-payment-options",
  "summary": "List all payment options",
  "description": "List all payment options",
  "parameters": [],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "payment_options": {
                    "type": "array",
                    "items": {
                      "enum": [
                        "CASH",
                        "UPI",
                        "CARD",
                        "PG"
                      ]
                    }
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "pos",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "listPaymentMethods"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions