Get QR Card Details

curl -G https://heimdall.eka.io/external/qr/E0001/getQrCardDetails \
     -H "DICE-APP-ID: {{Company Code}}" \
     -H "X-CLIENT-ID: {{API Client ID}}" \
     -H "X-CLIENT-SECRET: {{API Client Secret}}" \
     --data-urlencode "office=srinivas office new"

{
  "qrCards": [
    {
      "id": 6731,
      "title": "INTEGRATION",
      "description": "test qr card create from integration",
      "employee": {
        "email": "testuser1@yopmail.co",
        "mobile": "1234567898",
        "name": "karanas sharma",
        "code": "E0001",
        "customFields": {
          "hr head": "EMP001",
          "manager": "EMP003",
          "budgeting_user": "yes",
          "budgeted_user": "yes",
          "alternate": "EMP001",
          "manager@1": "E0009"
        }
      },
      "balanceLeft": 100,
      "transferredAmount": 100,
      "initialAmount": 100,
      "officeDetails": {
        "name": "srinivas office new",
        "id": 74549,
        "gstin": "",
        "registeredName": "test",
        "registeredAddress": "test",
        "currency": "INR",
        "tags": {
          "manager@5": "0007"
        }
      },
      "completed": true,
      "validDate": 1726644606395,
      "cardLimit": 100,
      "monthly": false,
      "currentMonth": "Sep"
    },
    {
      "id": 6732,
      "title": "INTEGRATION",
      "description": "test qr card create from integration",
      "employee": {
        "email": "testuser1@yopmail.co",
        "mobile": "1234567898",
        "name": "karanas sharma",
        "code": "E0001",
        "customFields": {
          "hr head": "EMP001",
          "manager": "EMP003",
          "budgeting_user": "yes",
          "budgeted_user": "yes",
          "alternate": "EMP001",
          "manager@1": "E0009"
        }
      },
      "balanceLeft": 100,
      "transferredAmount": 100,
      "initialAmount": 100,
      "officeDetails": {
        "name": "srinivas office new",
        "id": 74549,
        "gstin": "",
        "registeredName": "test",
        "registeredAddress": "test",
        "currency": "INR",
        "tags": {
          "manager@5": "0007"
        }
      },
      "completed": false,
      "validDate": 1726644609543,
      "cardLimit": 100,
      "monthly": false,
      "currentMonth": "Sep"
    }
  ]
}

This endpoint retrieves the details of a QR card based on the provided QR code and office information.

Request Parameters

code (path) : The QR code for the card.
office (query, optional) : The name of the office.

Response

Upon a successful request, the endpoint returns an array of qrCards containing the following details:

id : The unique identifier of the QR card.
title : The title of the card.
description : The description of the card.
employee : Details of the associated employee, including email, mobile, name, code, and custom fields.
balanceLeft : The remaining balance on the card.
transferredAmount : The amount transferred from the card.
initialAmount : The initial amount loaded on the card.
officeDetails : Information about the office, such as name, ID, GSTIN, registered name, registered address, currency, and tags.
completed : Indicates if the card setup is completed.
validDate : The validity date of the card.
cardLimit : The limit of the card.
monthly : Indicates if the card is valid for a month.
currentMonth : The current month for the card.

Path parameters

codestringRequired

Query parameters

officestringOptional

Response headers

request-idstringOptional

Response

qrCardslist of objects

Get QR Card Details

Request Parameters

Response

Path parameters

Headers

Query parameters

Response headers

Response