post https://api.instantpay.in/payments/payout
Initiate payouts to your Customers, Vendors, and Employees directly from your Bank account. Money can be sent to bank accounts (IMPS / UPI / NEFT / RTGS).
Header Parameters
| Name | Type | Description | Mandatory (M) , Optional (O) | Provided by INSTANTPAY (Y/N) |
|---|---|---|---|---|
| X-Ipay-Auth-Code | String | Auth Code -1 (Fixed) | M | Y |
| X-Ipay-Client-Id | String | Unique Client ID | M | Y |
| X-Ipay-Client-Secret | String | Unique secret key | M | Y |
| X-Ipay-Endpoint-Ip | String | End Customer IP Address | M | N |
Info :
Click Here to know how to get the Credentials.
Request Parameters for Wallets
| Parameter Name | Type | Requirement | Description |
|---|---|---|---|
| payer | Array | Mandatory | payer details |
| payer.bankProfileId | String | Mandatory | It will be 0 |
| payer.accountNumber | String | Mandatory | Mobile Number Registered with Instantpay |
| payee | Array | Mandatory | payee details |
| payee.name | String | Mandatory | Account Holder Name |
| payee.accountNumber | String | Mandatory | Wallet Registered Mobile Number |
| payee.bankIfsc | String | Optional | No input required |
| transferMode | String | Mandatory | Modes can be PAYTM or AMAZON |
| transferAmount | String | Mandatory | Amount to be transferred |
| externalRef | String | Mandatory | Your unique transaction Id |
| latitude | String | Mandatory | End Customer Latitude. |
| longitude | String | Mandatory | End Customer Longitude. |
| Remarks | String | Optional | Payment Remarks |
| alertEmail | String | Optional | Email of the end user. If passing the email, then Instantpay will send the email notification |
| purpose | String | Optional | Purpose of transaction : SALARY REIMBURSEMENT BONUS INCENTIVE CUSTOMER_REFUND OTHERS |
Sample Request for Wallets
curl --location --request POST 'https://api.instantpay.in/payments/payout' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"payer": {
"bankProfileId": "0",
"accountNumber": "7428585742"
},
"payee": {
"name": "Instantpay India Ltd",
"accountNumber": "7428585742",
"bankIfsc": ""
},
"transferMode": "AMAZON",
"transferAmount": "5.00",
"externalRef": "IMPS1",
"latitude": "20.1226",
"longitude": "78.1228",
"remarks": "Wallet Transfer",
"alertEmail": "",
"purpose": ""
}'
POST /payments/payout HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Type: application/json
{
"payer": {
"bankProfileId": "0",
"accountNumber": "7428585742"
},
"payee": {
"name": "Instantpay India Ltd",
"accountNumber": "7428585742",
"bankIfsc": ""
},
"transferMode": "AMAZON",
"transferAmount": "5.00",
"externalRef": "IMPS1",
"latitude": "20.1226",
"longitude": "78.1228",
"remarks": "Wallet Transfer",
"alertEmail": "",
"purpose": ""
}
Response Parameters for Wallets
| Name | Type | Description |
|---|---|---|
| statuscode | String | InstantPay Status Code |
| actcode | String | Action Code |
| status | String | Status message |
| data | Array | Response Data (If Present) |
| timestamp | String | Response time (YYYY-MM-DD HH:II:SS) |
| ipay_uuid | String | Request reference number |
| orderid | String | Transaction Id ( If transaction otherwise it is null ) |
| environment | String | Live/Sandbox |
| internalCode | String | It will be null |
Sample Response for Wallets
{
"statuscode": "TXN",
"actcode": null,
"status": "Transaction Successful",
"data": {
"externalRef": "IMPS1",
"poolReferenceId": "1231214070644TLWAP",
"txnValue": "1000",
"txnReferenceId": "1323896541",
"pool": {
"account": "7428585742",
"openingBal": "5.17",
"mode": "DR",
"amount": "3.46",
"closingBal": "1.71"
},
"payer": {
"account": "7428585742",
"name": "Sample Name"
},
"payee": {
"account": "7428585742",
"name": "Instantpay India Ltd"
}
},
"timestamp": "2021-11-12 16:56:50",
"ipay_uuid": "h00695deb945-3def-42ba-8857-2ff7bac93fe6",
"orderid": "1211112165649WFTYK",
"environment": "LIVE",
}
Note :
1 - Latitude and Longitude must be represented in degrees with 4 digits after decimal.
2- externalRef must be unique and in alpha numeric characters.
3- Remarks should be in alphabet and it can be of maximum 20 characters.
4- Purpose are Case Sensitive.
5- Consider the Transaction as Pending when you get No Response or Timeout Response and then check the status of the transactions through Transaction Status API.