Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Qr Code
  • Payment Gateway Overview
  • Payment Gateway Sign Up
  • Payment Methods
  • Supported Integrations
  • Payment Gateway APIs
  • Web Integration
  • Server to Server Integration
  • Test Card Details
  • Authorization
    • About Authorization
    • Get Authorization Token
      POST
  • Orders
    • About Order
    • Create Order
      POST
    • Get Order Status
      GET
    • Get BNPL Payment Modes
      GET
    • Get Dynamic QR Code
      GET
    • UPI Intent Links
      GET
    • Get UPI Transaction Status
      GET
  • Payments
    • About Payment
    • Submit Payment Detail
      POST
    • Get Transaction Status
      GET
    • Validate OTP
      POST
    • Resend OTP
      GET
    • Payment Notify Request
      POST
  • Refunds
    • About Refund
    • Refund
  • Settlements
    • About Settlement
    • Settlement Reporting
    • Get Settlement Payout By ID
    • Search Settlement Payouts
  • Split Settlements
    • About Split Settlements
    • Create Split Settlement Account
    • Update Split Settlement Account
    • Get All Split Settlement Account
    • Deactivate Split Settlement Account
    • Activate Split Settlement Account
    • Submit Payment with Split Details
    • Edit/Deferred Split Settlement
  • E-Commerce Plugins
  • Payment Links
  • Payment Button
  • Qr Code
    • Create Qr Code
      POST
    • Get QR Code
      GET
    • Search QR Code
      POST
    • createCustomer
      POST
    • searchCustomer
      POST
    • Cancel QR Code
      PATCH
  • UPI Mandate
    • Create UPI Mandate
    • Update UPI Mandate
    • Revoke UPI Mandate
    • Get UPI Mandate
    • UPI mandate create callback
    • Mandate Pre-debit Notification
    • Execute mandate debit
    • Mandate Debit callback
  1. Qr Code

Cancel QR Code

Developing
PATCH
/api/v0/qr-code/{qrCodeId}/cancel
API to cancel the QrCode, once a qrCode is cancel, no payment will be accepted after that.

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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH '/api/v0/qr-code//cancel' \
--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 2024-10-10 08:31:41
Previous
searchCustomer
Next
Create UPI Mandate
Built with