Payouts via IMPS
In order to enroll in IMPS digital wallet in India, a request to the Tranzzo API must contain the following parameters:
Parameter | Type | Required | Description |
---|---|---|---|
pos_id | UUID | ✅ | Merchant's identifier (POS_ID ) |
mode | MODE | ✅ | direct |
method | METHOD | ✅ | Payment method (credit ) |
amount | Number | ✅ | Transaction amount |
currency | CURRENCY | ✅ | Transaction currency (ISO_4217) |
order_3ds_bypass | String | ✅ | 3-D Secure flow option |
order_id | String | ✅ | Unique identifier of order |
description | String | ✅ | Payment description |
payway | String | ✅ | imps |
server_url | URL | Webhook notification will be sent to this URL | |
result_url | URL | Customer will be redirected to this URL after payment. | |
customer_fname | String | ✅ | recipient’s first name |
customer_lname | String | ✅ | recipient’s last name |
customer_email | String | ✅ | recipient’s email address |
customer_phone | String | ✅ | recipient’s phone number |
customer_ip | String | ✅ | recipient’s IP |
properties.account_name | String | ✅ | recipient’s IMPS account name |
properties.account_number | String | ✅ | recipient’s IMPS account number |
properties.ifsc | String | ✅ | recipient's Indian Financial System Code |
properties.bank_name | String | ✅ | bank name |
properties.trusted | Boolean | ✅ | whether 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"
}