Cancel UPI QR

Developing

PATCH

/api/v0/qr-code/{qrCodeId}/cancel

📌

Use this API to cancel an existing UPI QR code by its unique ID. Once a QR code is cancelled, no payments will be accepted through it, ensuring that outdated or invalid payment requests are securely deactivated.

Request

Path Params

qrCodeId

string

required

unique qrCodeId provided by us in create qrCode API

Header Params

merchantAccessKey

string

optional

Authorization

string

optional

Body Params application/json

object {0}

Example

{}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/api/v0/qr-code//cancel' \
--header 'merchantAccessKey;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Responses

🟢200Success

application/json

Body

response_code

integer <int32>

optional

response_message

string

optional

payload

object (QrCodeResponse)

optional

qrCodeId

string

optional

Unique QrCode Id generated at our end

qrName

string

optional

multipleUse

boolean

optional

fixedAmount

boolean

optional

amount

number

optional

description

string

optional

expiry

string

optional

customParams

object

optional

status

enum<string>

optional

QrCode status

Allowed values:

ACTIVECANCELLED

qrCodeBase64

string

optional

Base64Image of the QrCode

createdOn

string

optional

DateTime of the QrCode created

modifiedOn

string

optional

DateTime of the QrCode modified

customerName

string

optional

customerEmail

string

optional

customerMobile

string

optional

customerId

string

optional

referenceNumber

string

optional

Example

{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "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"
    }
}

Modified at 2025-07-05 12:23:03

Search Customer

UPI Autopay