Hypto Generate QR API

openapi: 3.2.0
info:
  title: Hypto Generate QR API
  version: 1.0.0
  description: Hypto Partner APIs are completely RESTful and all our responses are returned in JSON.
  x-logo:
    url: /docs/assets/images/logo-new.svg
    href: /
servers:
- url: //partners.hypto.in
tags:
- name: Generate_QR
  x-displayName: Generate QR Code
  description: This section explains the steps to generate a QR code using any given UPI ID on web (.js) and android (Java/Kotlin)
paths:
  /JS:
    get:
      tags:
      - Generate_QR
      operationId: JS
      summary: JS
      description: 'Follow the steps to create QR Code in Web,


        Step 1

        Download a qrcode package and import in <head>.

        Note: You must also import jquery to support qrcode.min package


        Step 2

        Construct a DOM and specify id where you need to generate QRCode.

        For Sample, Let id be `''qrcode''`


        Step 3

        Static QR: Enter the upi_id created via api for ''pa'' in payment link `upi://pay?pa=`


        Dynamic QR: Enter the upi_id created via api for ''pa'', amount for ''am'', payer name for ''pn'', note for tn in payment link `upi://pay?pa=&pn=&am=&tn=`.

        Include the given script to generate QRCode in above created DOM.


        Note: The first parameter of QRCode(<id>) requires the id of DOM where the QRCode needs to be generated.


        Step 4

        To update the QRCode, include the updateQR() function in script


        Note: The values of ''pa'', ''pn'', ''am'', ''tn'' must be given your UPI Id, payer name, amount, any message'
      x-code-samples:
      - lang: JS
        source: "//Step1 \n <head> \n\t <script src='/qrcode.min.js'> </script> \n\t <script src='https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js'></script> \n</head> \n\n //Step 2\n <body> \n\t <div id='qrcode'></div> \n </body> \n\n //Step 3\n <script>\n\t var sampleQR = new QRCode('qrcode', { \n\t\t text: ' ',\n\t\twidth: 228,\n\t\theight: 228,\n\t\tcolorDark : '#000000',\n\t\tcolorLight : '#ffffff',\n\t\tcorrectLevel : QRCode.CorrectLevel.H\n\t})\n</script> \n\n //Step 4\n <script> \n\t const updateQR = (upi_id, payer_name, amount, note) => { \n\t\t sampleQR.makeCode('upi://pay?pa=' + upi_id + '&pn=' + payer_name + '&am=' + amount + '&tn=' + note) \n\t} \n </script>"
  /Android:
    get:
      tags:
      - Generate_QR
      operationId: Android
      summary: Android
      description: 'Follow the steps to create QR Code in Android,


        Step 1

        Static QR: Enter the upi_id created via api for ''pa'' in payment link `upi://pay?pa=`


        Dynamic QR: Enter the upi_id created via api for ''pa'', amount for ''am'', payer name for ''pn'', note for tn in payment link `upi://pay?pa=&pn=&am=&tn=`.


        Step 2

        You can use the QRGenerator library from androidmads to generate the QR code for the above payment link.


        Import the library by adding the following code in dependencies of the `build.gradle(app)` file.


        Step 3

        Generate the QR using the code mentioned in Step 3.


        Note: Replace `dimension` value with your required size.


        Step 4

        Invoke UPI apps using Intent


        You can invoke user to directly pay through UPI applications installed in the device'
      x-code-samples:
      - lang: Kotlin
        source: "//Step 1\n val upi_url = 'upi://pay?pa=hyptosamplevpa@yesbank&pn=payer_name&am=100.25&tn=note' \n\n//Step 2\n implementation 'androidmads.library.qrgenearator:QRGenearator:1.0.4' \n\n//Step 3\n val qrgEncoder = QRGEncoder(upi_url, null,QRGContents.Type.TEXT,dimension); \n\t GlideApp.with(context) \n\t .load(qrgEncoder.bitmap) \n\t .into(qrImageView) \n\n//Step 4\n val PAY_REQUEST_CODE = 111 \n\n val intent = Intent(Intent.ACTION_VIEW) \n val uri = Uri.parse(upi_url) \n intent.data = uri \n val chooser = Intent.createChooser(intent, 'Pay with') \n\n if (intent.resolveActivity(packageManager) != null) \n\t startActivityForResult(chooser, PAY_REQUEST_CODE) \n else \n\t showError('No UPI applications installed in this device.'')"
      - lang: Java
        source: "//Step 1\n String upi_url = 'upi://pay?pa=hyptosamplevpa@yesbank&pn=payer_name&am=100.25&tn=note' \n\n//Step 2\n implementation 'androidmads.library.qrgenearator:QRGenearator:1.0.4' \n\n//Step 3\n QRGEncoder qrgEncoder = new QRGEncoder(upi_url, null, QRGContents.Type.Text, dimension); \n\t GlideApp.with(context) \n\t .load(qrgEncoder.getBitmap()) \n\t .into(qrImageView); \n\n//Step 4\n int PAY_REQUEST_CODE = 111; \n\n Intent intent = new Intent(Intent.ACTION_VIEW); \n Uri uri = Uri.parse(upi_url); \n intent.setData(uri); \n Intent chooser = Intent.createChooser(intent, 'Pay with'); \n\n if (intent.resolveActivity(packageManager) != null) \n\t startActivityForResult(chooser, PAY_REQUEST_CODE); \n else \n\t showError('No UPI applications installed in this device.');"
  /Demo:
    get:
      tags:
      - Generate_QR
      operationId: Demo
      summary: Live Demo
      description: 'Name


        UPI ID


        Amount

        Generate QR'
x-tagGroups:
- name: ''
  tags:
  - api_url
  - Payments
  - Banking
- name: UPI
  tags:
  - UPI
  - UPI_Collections
- name: ''
  tags:
  - Status
  - Webhooks
  - Generate_QR