Appearance

verify-vpa ​

Method: GET
Path: /payments/verify-vpa

Tags: Payments

Summary ​

Verify VPA

Description ​

The Virtual Payment Address or VPA is a unique ID given to an individual using the Unified Payment Interface (UPI) service to send or receive money. In the case of UPI collect VPA is the mandatory param and merchants are always advised to check if the VPA is valid or not. Validating the VPA will help in reducing the failure rate due to incorrect vpa.

Storefront SDK Usage ​

SDK Method: sdk.payments.verifyVpa()

Example:

typescript
const { data, error } = await sdk.payments.verifyVpa({
  vpa: "user@upi"
});

if (error) {
  console.error("Failed to verify VPA:", error.message);
} else {
  console.log("VPA:", data.vpa);
  console.log("Status:", data.status);

  if (data.status === "VALID") {
    console.log("VPA is valid and can be used for UPI payments");
  } else {
    console.log("VPA is invalid, please check and try again");
  }
}

TypeScript Definition ​

typescript
"verify-vpa": {
        parameters: {
            query?: {
                /** @description The Virtual Payment Address or VPA is a unique ID given to an individual using the Unified Payment Interface (UPI) service. */
                vpa?: string;
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            vpa?: string;
                            status?: string;
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References ​

ReferenceResolves To
components["responses"]["BadRequest"]BadRequest
components["responses"]["Unauthorized"]Unauthorized
components["responses"]["NotFound"]NotFound

Parameters ​

  • vpa (query): The Virtual Payment Address or VPA is a unique ID given to an individual using the Unified Payment Interface (UPI) service.

Responses ​

200 ​

OK

400 ​

Bad request

401 ​

Not authorized for given operation on the Resource

404 ​

Requested resource not found

OpenAPI Definition ​

json
{
  "tags": [
    "Payments"
  ],
  "operationId": "verify-vpa",
  "summary": "Verify VPA",
  "description": "The Virtual Payment Address or VPA is a unique ID given to an individual using the Unified Payment Interface (UPI) service to send or receive money. In the case of UPI collect VPA is the mandatory param and merchants are always advised to check if the VPA is valid or not.\nValidating the VPA will help in reducing the failure rate due to incorrect vpa. ",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/verify-vpa",
    "description": "API reference for the verify-vpa operation"
  },
  "parameters": [
    {
      "name": "vpa",
      "in": "query",
      "description": "The Virtual Payment Address or VPA is a unique ID given to an individual using the Unified Payment Interface (UPI) service.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "vpa": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "payments",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "verifyVpa"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: