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.
device mandatory
: object The device details.
ip mandatory
: string The IP address of the device.
geocode mandatory
: 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
description optional
: string Description of the payment.
upi_credentials mandatory
: object ARQC encrypted credential for authorisation.
ARPC
: string Authentication Response Code credential.
payees mandatory
: string Payee details.
fundsource_id mandatory
: string Fundsource id of the payee.
Parameters
entity
: string Name of the entity. Here it is upi.fundsource_lite.
id
: string Unique identifier for the Fundsource Lite entity.
upi_lite_reference_number
: string Reference number for the Lite account, assigned by the originator.
upi_transaction_id
: string Unique UPI transaction identifier.
status
: string Current status of the UPI Lite account. Possible values:
initiatedactivederegistered
upi_lite_credentials
: object ARQC encrypted credential for authorisation.
ARPC
: string Authentication Response Code credential.
fundsource
: object The fundsource for which Lite is enabled.
id
: string Unique identifier of the fundsource.
entity
: string Name of the entity. Here it is fundsource.
type
: string Account type.
customer_name
: string Name of the customer.
masked_account_number
: string Masked version of the customer’s account number.
account_reference_number
: string Reference number assigned to the customer’s account.
ifsc
: string IFSC code of the account.
upi_pin_set
: boolean Indicates whether UPI PIN is already set.
true: UPI PIN is already set.false: UPI PIN is not set.
upi_pin_length
: integer Length of UPI PIN.
otp_length
: integer OTP length used during registration.
atm_pin_length
: integer ATM PIN length of the account.
fundsource_provider
: object Details of the bank.
name
: string Name of the bank.
upi_iin
: string UPI IIN code assigned to the provider by NPCI.
upi_enabled
: boolean Indicates whether UPI is enabled for the provider. Possible values:
true: UPI is enabled.false: UPI is not enabled.
mobile_registration_format
: string Mobile registration format supported.
logo_url
: string URL to the provider’s logo.
upi_lite_allowed
: boolean Indicates whether the UPI Lite is allowed by the bank. Possible values:
true: UPI Lite is allowed.false: UPI Lite is not allowed.
vpas
: object Collection of VPAs for the fundsource.
entity
: string Name of the entity. Here it is collection.
count
: integer Total number of VPA items.
items
: array Array of VPA objects.
mobile
: string Registered mobile number.
address
: string UPI VPA address.
status
: string Status of the VPA. Possible values:
activeinactive
primary
: boolean Indicates where the VPA is primary.
true: VPA is primary.false: VPA is not primary.