UPI - QR Code

UpiQrPayload

Payment Method Identifier

UPI_QR

Description

This method allows you to accept UPI QR payments. There are two options for this method: customers can either scan the UPI QR code using the mobile app that supports UPI or use a deep link to proceed with the payment on their mobile device.

Currency Support

✅ INR only (`Indian Rupee`)

✅ Required Request Fields

Top-Level Fields

Field	Type	Description
`callbackUrl`	String	URL to receive transaction status updates
`successRedirectUrl`	String	URL to redirect the customer after successful payment
`failureRedirectUrl`	String	URL to redirect the customer after failed payment

Billing Details (ApmBillingDetails)

Field	Type	Description
`firstName`	String	Customer’s first name
`lastName`	String	Customer’s last name
`address1`	String	First line of the billing address
`city`	String	City of the billing address
`country`	String	Country code in ISO Alpha-2 format
`postalCode`	String	Postal/ZIP code
`phone`	String	Customer’s phone number
`email`	String	Customer’s email address

Device Information (Device)

Field	Type	Description
`ip`	String	Customer’s IP address

Payload Structure

{
  "paymentMethod": "UPI_QR",
  "paymentType": "BANK_TRANSFER"
}

Fields

Field	Type	Required	Description
`paymentMethod`	Enum	Yes	Must be `"UPI_QR"`
`paymentType`	Enum	Yes	Must be `"BANK_TRANSFER"`

No additional fields are required. All necessary user interaction is handled within the mobile app that supports UPI.

Expected `apmResponseData` (UpiQrResponseData)

{
  "paymentMethod": "UPI_QR",
  "paymentType": "BANK_TRANSFER",
  "redirectUrl": null,
  "iframeUrl": null,
  "providerTransactionId": "189119848",
  "actionType": "QR",
  "qrData": "image/png;base64,iVBORw0KGgoAAAA...1wc8AAAAASUVORK5CYII=",
  "qrDeepLink": "upi://pay?pa=gazefashionhub@yesbank&pn=&m=&tr=5918162144824477&tn=Invoice&am=100.00&cu=INR"
}

Response Fields

Field	Type	Description
`paymentMethod`	Enum	`"UPI_QR"`
`paymentType`	Enum	`"BANK_TRANSFER"`
`redirectUrl`	String (nullable)	always `null` for UPI_QR
`iframeUrl`	String (nullable)	always `null` for UPI_QR
`providerTransactionId`	String (nullable)	Transaction ID from the payment provider
`actionType`	String	always `QR`
`qrData`	String (nullable)	QR code image data (base64) that can be used in image tag, for example `<img src = '$qrData' class="img-fluid" height="200" width="200" alt='QR Code'>`
`qrDeepLink`	String (nullable)	Link that can be opened on a mobile device to forward the customer to the app that supports UPI

UpiQrPayload

Payment Method Identifier

Description

This method allows you to accept UPI QR payments. There are two options for this method: customers can either scan the UPI QR code using the mobile app that supports UPI or use a deep link to proceed with the payment on their mobile device.

Currency Support

✅ INR only (Indian Rupee)

✅ Required Request Fields

Top-Level Fields

Billing Details (ApmBillingDetails)

Device Information (Device)

Payload Structure

Fields

Expected apmResponseData (UpiQrResponseData)

Response Fields

✅ INR only (`Indian Rupee`)

Expected `apmResponseData` (UpiQrResponseData)