Search QR Code - Enkash APIs

Request

Query Params

offset

integer

optional

limit

integer

optional

<= 5000

Header Params

merchantAccessKey

string

optional

Authorization

string

optional

Body Params application/json

qrCodeId

string

optional

Unique QrCodeId provided by us

qrCodeName

string

optional

qrCodeName

amount

number

optional

amount

status

string

optional

status

referenceNumber

string

optional

referenceNumber

Example

{
    "qrCodeId": "string",
    "qrCodeName": "string",
    "amount": 0,
    "status": "string",
    "referenceNumber": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v0/qr-code/search' \
--header 'Content-Type: application/json' \
--data-raw '{
    "qrCodeId": "string",
    "qrCodeName": "string",
    "amount": 0,
    "status": "string",
    "referenceNumber": "string"
}'

Responses

🟢200Success

application/json

Body

response_code

integer <int32>

optional

response_message

string

optional

payload

object (GenericPaginationResponseQrCodeResponse)

required

recordsCount

integer <int64>

required

data

array[object (QrCodeResponse) {17}]

required

Example

{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "recordsCount": 0,
        "data": [
            {
                "qrCodeId": "string",
                "qrName": "string",
                "multipleUse": true,
                "fixedAmount": true,
                "amount": 0,
                "description": "string",
                "expiry": "string",
                "customParams": {
                    "additionalProp1": "string",
                    "additionalProp2": "string",
                    "additionalProp3": "string"
                },
                "status": "ACTIVE",
                "qrCodeBase64": "string",
                "createdOn": "string",
                "modifiedOn": "string",
                "customerName": "string",
                "customerEmail": "string",
                "customerMobile": "string",
                "customerId": "string",
                "referenceNumber": "string"
            }
        ]
    }
}