Skip to main content

Payouts via IMPS

In order to enroll in IMPS digital wallet in India, a request to the Tranzzo API must contain the following parameters:

ParameterTypeRequiredDescription
pos_idUUIDMerchant's identifier (POS_ID)
modeMODEdirect
methodMETHODPayment method (credit)
amountNumberTransaction amount
currencyCURRENCYTransaction currency (ISO_4217)
order_3ds_bypassString3-D Secure flow option
order_idStringUnique identifier of order
descriptionStringPayment description
paywayStringimps
server_urlURLWebhook notification will be sent to this URL
result_urlURLCustomer will be redirected to this URL after payment.
customer_fnameStringrecipient’s first name
customer_lnameStringrecipient’s last name
customer_emailStringrecipient’s email address
customer_phoneStringrecipient’s phone number
customer_ipStringrecipient’s IP
properties.account_nameStringrecipient’s IMPS account name
properties.account_numberStringrecipient’s IMPS account number
properties.ifscStringrecipient's Indian Financial System Code
properties.bank_nameStringbank name
properties.trustedBooleanwhether the trusted payer

The value of the payway parameter must be imps.

Request example:

{
"pos_id": "'$POS_ID'",
"mode": "direct",
"method": "credit",
"amount": 1,
"payway": "imps",
"currency": "INR",
"order_id": "'$ORDER_ID'",
"description": "Description",
"customer_fname": "John",
"customer_lname": "Doe",
"customer_email": "[email protected]",
"customer_phone": "380991111111",
"customer_ip": "1.2.3.4",
"order_3ds_bypass": "supported",
"properties": {
"account_number": "1234567890",
"account_name": "John Doe",
"ifsc": "SHFD0000",
"bank_name": "Bank of India",
"trusted": true
},
"server_url": "http://callback-stub:9000/consume",
"result_url": "https://example.com/result"
}