# Verify UPI VPA

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /pay/charge/verify-vpa:
    post:
      summary: Verify UPI VPA
      deprecated: false
      description: >+

        :::highlight purple 📌

        Use this API to verify the validity of a UPI Virtual Payment Address
        (VPA). It checks whether the entered VPA exists and is active, helping
        prevent payment failures and ensuring a smooth UPI transaction
        experience.

        :::

      tags:
        - Payment Gateway/APIs - Payment Gateway /Payment
      parameters:
        - name: Authorization
          in: header
          description: Token generated with your Access key and secret key
          required: true
          example: ZJjAg195FnUlR1535
          schema:
            type: string
        - name: merchantAccessKey
          in: header
          description: The access key generated for your account
          required: false
          example: FgRkY5765702145869544866OAXTT
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Request object for verifying a UPI VPA against a specific order.
              properties:
                merchantOrderId:
                  type: string
                  description: Merchant's unique order reference ID.
                  examples:
                    - UAI2300u998897
                merchantIdentifierKey:
                  type: string
                  description: Merchant identifier key issued by EnKash.
                  examples:
                    - UXXDe308Roecb3651
                vpa:
                  type: string
                  description: UPI Virtual Payment Address (VPA) to be verified.
                  examples:
                    - test@ybl
              required:
                - merchantOrderId
                - merchantIdentifierKey
                - vpa
              x-apidog-orders:
                - merchantOrderId
                - merchantIdentifierKey
                - vpa
              examples:
                - merchantOrderId: UAI2300u998897
                  merchantIdentifierKey: UXXDe308Roecb3651
                  vpa: test@ybl
            example:
              merchantOrderId: UAI2300u998897
              merchantIdentifierKey: UXXDe308Roecb3651
              vpa: test@ybl
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  response_code:
                    type: integer
                    description: Application-level status code. 0 indicates success.
                    examples:
                      - 0
                  response_message:
                    type: string
                    description: High-level status description.
                    examples:
                      - Success
                  payload:
                    type: object
                    description: Response payload containing VPA account holder details.
                    properties:
                      name:
                        type: string
                        description: Account holder name associated with the provided VPA.
                        examples:
                          - Test Name
                    required:
                      - name
                    x-apidog-orders:
                      - name
                required:
                  - response_code
                  - response_message
                  - payload
                x-apidog-orders:
                  - response_code
                  - response_message
                  - payload
                examples:
                  - response_code: 0
                    response_message: Success
                    payload:
                      name: Test Name
              example:
                response_code: 0
                response_message: Success
                payload:
                  name: Test Name
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Payment Gateway/APIs - Payment Gateway /Payment
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-16477069-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```