# UPI Intent Links

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /pay/checkout/upi-detail/{orderId}:
    get:
      summary: UPI Intent Links
      deprecated: false
      description: >-

        :::highlight purple 📌

        Use this API to generate UPI Intent Links for initiating payments via
        supported UPI apps. The link opens a UPI-enabled application with
        pre-filled transaction details, enabling users to complete payments
        quickly and securely.

        :::
      operationId: upiIntentLinkDetail
      tags:
        - Payment Gateway/APIs - Payment Gateway /Order
      parameters:
        - name: orderId
          in: path
          description: EnKash orderId, received in response of create order API
          required: true
          example: ''
          schema:
            type: string
      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: UPI intent URLs for supported UPI applications.
                    properties:
                      gpay:
                        type: string
                        description: Google Pay UPI intent URL.
                        examples:
                          - gpay://upi/pay?pa=merchant@upi&am=5.00
                      phonepe:
                        type: string
                        description: PhonePe UPI intent URL.
                        examples:
                          - phonepe://pay?pa=merchant@upi&am=5.00
                      paytm:
                        type: string
                        description: Paytm UPI intent URL.
                        examples:
                          - paytmmp://pay?pa=merchant@upi&am=5.00
                      upi:
                        type: string
                        description: >-
                          Generic UPI intent URL that can be opened by any UPI
                          application.
                        examples:
                          - upi://pay?pa=merchant@upi&am=5.00
                      transactionId:
                        type: string
                        description: Unique transaction identifier generated by EnKash.
                        examples:
                          - EK1781259050118Lhhvw
                    required:
                      - gpay
                      - phonepe
                      - paytm
                      - upi
                      - transactionId
                    x-apidog-orders:
                      - gpay
                      - phonepe
                      - paytm
                      - upi
                      - transactionId
                required:
                  - response_code
                  - response_message
                  - payload
                x-apidog-orders:
                  - response_code
                  - response_message
                  - payload
                examples:
                  - response_code: 0
                    response_message: Success
                    payload:
                      gpay: >-
                        gpay://upi/pay?mode=04&pa=nehun6aghr.oly@kotakpay&cu=INR&ver=01&purpose=00&mc=7399&qrMedium=06&tn=CREATE+ORDER&am=5.00&tr=EK1781259050118Lhhvw&tid=KJP5b4f56f1c91540be823e9cd0b2ba6ede&pn=NEHAT+TECH+SOLUTIONS+PRIVATE+LIMITED
                      phonepe: >-
                        phonepe://pay?mode=04&pa=nehun6aghr.oly@kotakpay&cu=INR&ver=01&purpose=00&mc=7399&qrMedium=06&tn=CREATE+ORDER&am=5.00&tr=EK1781259050118Lhhvw&tid=KJP5b4f56f1c91540be823e9cd0b2ba6ede&pn=NEHAT+TECH+SOLUTIONS+PRIVATE+LIMITED
                      paytm: >-
                        paytmmp://pay?mode=04&pa=nehun6aghr.oly@kotakpay&cu=INR&ver=01&purpose=00&mc=7399&qrMedium=06&tn=CREATE+ORDER&am=5.00&tr=EK1781259050118Lhhvw&tid=KJP5b4f56f1c91540be823e9cd0b2ba6ede&pn=NEHAT+TECH+SOLUTIONS+PRIVATE+LIMITED
                      upi: >-
                        upi://pay?mode=04&pa=nehun6aghr.oly@kotakpay&cu=INR&ver=01&purpose=00&mc=7399&qrMedium=06&tn=CREATE+ORDER&am=5.00&tr=EK1781259050118Lhhvw&tid=KJP5b4f56f1c91540be823e9cd0b2ba6ede&pn=NEHAT+TECH+SOLUTIONS+PRIVATE+LIMITED
                      transactionId: EK1781259050118Lhhvw
              example:
                response_code: 0
                response_message: Success
                payload:
                  gpay: >-
                    gpay://upi/pay?mode=04&pa=nehun6aghr.oly@kotakpay&cu=INR&ver=01&purpose=00&mc=7399&qrMedium=06&tn=CREATE+ORDER&am=5.00&tr=EK1781259050118Lhhvw&tid=KJP5b4f56f1c91540be823e9cd0b2ba6ede&pn=NEHAT+TECH+SOLUTIONS+PRIVATE+LIMITED
                  phonepe: >-
                    phonepe://pay?mode=04&pa=nehun6aghr.oly@kotakpay&cu=INR&ver=01&purpose=00&mc=7399&qrMedium=06&tn=CREATE+ORDER&am=5.00&tr=EK1781259050118Lhhvw&tid=KJP5b4f56f1c91540be823e9cd0b2ba6ede&pn=NEHAT+TECH+SOLUTIONS+PRIVATE+LIMITED
                  paytm: >-
                    paytmmp://pay?mode=04&pa=nehun6aghr.oly@kotakpay&cu=INR&ver=01&purpose=00&mc=7399&qrMedium=06&tn=CREATE+ORDER&am=5.00&tr=EK1781259050118Lhhvw&tid=KJP5b4f56f1c91540be823e9cd0b2ba6ede&pn=NEHAT+TECH+SOLUTIONS+PRIVATE+LIMITED
                  upi: >-
                    upi://pay?mode=04&pa=nehun6aghr.oly@kotakpay&cu=INR&ver=01&purpose=00&mc=7399&qrMedium=06&tn=CREATE+ORDER&am=5.00&tr=EK1781259050118Lhhvw&tid=KJP5b4f56f1c91540be823e9cd0b2ba6ede&pn=NEHAT+TECH+SOLUTIONS+PRIVATE+LIMITED
                  transactionId: EK1781259050118Lhhvw
          headers: {}
          x-apidog-name: OK
        '504':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
              example: |-
                <html>
                <head><title>504 Gateway Time-out</title></head>
                <body>
                <center><h1>504 Gateway Time-out</h1></center>
                </body>
                </html>
          headers: {}
          x-apidog-name: Bad Gateway
      security: []
      x-apidog-folder: Payment Gateway/APIs - Payment Gateway /Order
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-8990257-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```