Request
Curl
Response
Success
Parameters
upi_transaction_id mandatory
: string Unique UPI transaction id.
reference_id optional
: string Merchant reference id.
upi_initiation_mode optional
: enum Indicates the 2-digit code defined by NPCI. Possible values:
00: Default - When no specific code is assigned or for general default scenarios.01: QR Code - For making payments by scanning a standard QR code.02: Secure QR Code - For payments that require additional security with QR codes.03: Bharat QR Code - For interoperable payments across various payment networks using Bharat QR.04: Intent - For payments initiated by an intent from an application or browser.05: Secure Intent - For payments initiated by a secure intent from an app or browser.06: NFC (Near Field Communication) - For contactless payments using NFC technology.07: BLE (Bluetooth) - For payments made through Bluetooth Low Energy technology.08: UHF (Ultra High Frequency) - For payments made using UHF technology, typically for toll payments.09: Aadhaar - For payments authenticated using an Aadhaar number and biometric verification.10: SDK (Software Development Kit) - For payments initiated through an SDK embedded in an app.11: UPI-Mandate - For setting up recurring payments or mandates using UPI.12: FIR (Foreign Inward Remittance) - For receiving remittances from foreign countries.13: QR Mandate - For setting up recurring payments using a QR code.14: BBPS - For making bill payments through the Bharat Bill Payment System.
upi_purpose_code optional
: enum The 2-digit code defined by NPCI present in the intent URL or QR codes. Possible values:
01: SEBI02: AMC03: Travel04: Hospitality05: Hospital06: Telecom07: Insurance08: Education09: Gifting10: BBPS11: Global UPI12: Metro ATM QR13: Non-metro ATM QR14: Standing Instruction15: Corporate disbursement
purpose mandatory
: string The purpose of the payout.
device optional
: object The device details.
ip
: string The IP address of the device.
geocode
: string The location coordinates of the device. For example, 12.9667,77.5667.
currency mandatory
: string The currency in which the payment should be made by the customer. For example, INR.
amount mandatory
: integer The amount to be paid by the customer in currency subunits. For example, if the amount is 100, enter 10000
type mandatory
: string Type of transaction. Should be pay.
description optional
: string Description of the transaction.
payer mandatory
: string Payer details.
vpa mandatory
: string Payer’s VPA.
fundsource_id mandatory
: string Fundsource id of payer.
upi_credentials mandatory
: object MPIN and ARQC encrypted credentials.
payees mandatory
: string Payee details.
fundsource_lite_id mandatory
: string Fundsource Lite id of the payee.
Parameters
entity
: string Name of entity. Here it is, upi.payment.
upi_transaction_id
: string UPI transaction id generated.
reference_id
: string Merchant reference id.
upi_customer_reference_number
: string Customer Reference number at NPCI.
upi_reference_url
: string URL for the payment reference.
upi_reference_category
: string UPI Reference Category Code.
upi_initiation_mode
: enum Indicates the 2-digit code defined by NPCI. Possible values:
00: Default - When no specific code is assigned or for general default scenarios.01: QR Code - For making payments by scanning a standard QR code.02: Secure QR Code - For payments that require additional security with QR codes.03: Bharat QR Code - For interoperable payments across various payment networks using Bharat QR.04: Intent - For payments initiated by an intent from an application or browser.05: Secure Intent - For payments initiated by a secure intent from an app or browser.06: NFC (Near Field Communication) - For contactless payments using NFC technology.07: BLE (Bluetooth) - For payments made through Bluetooth Low Energy technology.08: UHF (Ultra High Frequency) - For payments made using UHF technology, typically for toll payments.09: Aadhaar - For payments authenticated using an Aadhaar number and biometric verification.10: SDK (Software Development Kit) - For payments initiated through an SDK embedded in an app.11: UPI-Mandate - For setting up recurring payments or mandates using UPI.12: FIR (Foreign Inward Remittance) - For receiving remittances from foreign countries.13: QR Mandate - For setting up recurring payments using a QR code.14: BBPS - For making bill payments through the Bharat Bill Payment System.
upi_purpose_code
: enum The 2-digit code defined by NPCI present in the intent URL or QR codes. Possible values:
01: SEBI02: AMC03: Travel04: Hospitality05: Hospital06: Telecom07: Insurance08: Education09: Gifting10: BBPS11: Global UPI12: Metro ATM QR13: Non-metro ATM QR14: Standing Instruction15: Corporate disbursement
currency
: string Currency for transaction (INR).
amount
: string Transaction amount in paisa.
type
: string Transaction type.
description
: string Payment description.
payer
: object Payer details.
vpa
: string Payer’s VPA.
fundsource
: object Payer’s bank fundsource.
ifsc
: string Payer’s IFSC code.
masked_account_number
: string Masked account number.
payees
: array List of payee objects.
fundsource_lite
: string Indicates the Lite details.
id
: string Fundsource Lite id.
upi_lite_reference_number
: string Reference number of Lite.
upi_lite_credentials
: string Contains encrypted ARPC proof.
ARPC
: string Authentication Response Code credential.
status
: string Transaction status. Possible values:
createdpendingsuccessfailed
created_at
: integer UNIX timestamp at which the payment was created.
updated_at
: integer UNIX timestamp at which the payment was updated.