UPI QR Cash Withdrawal API
UPI ATM lets an eligible merchant facilitate a customer cash withdrawal through a UPI QR consent flow. Follow the integration sequence below and confirm the final withdrawal result before handing over cash.
Start with the integration guide
Read the UPI ATM Integration Guide for authentication, outlet eligibility, biometric KYC, QR expiry, request fields and status reconciliation.
Integration sequence
| Step | API / action | Result to retain |
|---|---|---|
| 1 | Biometric KYC Status | Required action, reference and capture options. |
| 2 | Biometric KYC, if required | Recheck status until approval is confirmed. |
| 3 | Generate QR | Pay2New order reference, QR string and expiry. |
| 4 | Customer scans and authorizes the QR | Continue checking the existing order. |
| 5 | QR Status | Confirm the final result before cash disbursement. |
Confirm completion before disbursing cash
Generating a QR does not confirm a withdrawal. Inspect the final status using the saved order_id. If the outcome is pending or uncertain, reconcile that order before creating another withdrawal.
Use an active Pay2New outlet with the service enabled. Withdrawal amounts must be positive multiples of 100 rupees.
