UPI VPA

Initiate seamless payouts to your customers, vendors, and employees directly from your bank account using UPI VPA. Simplify your financial operations with instant, secure, and hassle-free transactions, ensuring timely disbursements with just a few clicks.

Whether it's managing payroll, vendor settlements, or customer refunds, our UPI-powered solution integrates effortlessly with your existing banking system, enabling you to handle bulk payouts efficiently.

Say goodbye to manual processes and paperwork, and enjoy fast, reliable, and transparent payments that keep your business running smoothly.

Header Parameters

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code -1 (Fixed)MY
X-Ipay-Client-IdStringUnique Client IDMY
X-Ipay-Client-SecretStringUnique secret keyMY
X-Ipay-Endpoint-IpStringEnd Customer IP AddressMN

Request Parameters

Parameter Name

Type

Requirement

Description

payer

Array

Mandatory

Payer details

payer.bankProfileId

String

Mandatory

Unique Bank Profile Id

payer.accountNumber

String

Mandatory

Instantpay registered mobile number

payee

Array

Mandatory

Payee details

payee.name

String

Mandatory

Account Holder Name

payee.accountNumber

String

Mandatory

Account Number of End User

payee.bankIfsc

String

Optional

IFS Code

transfer

Array

Mandatory

Transfer details

transferMode

String

Mandatory

Mode Will Be UPI

transferAmount

String

Mandatory

Amount to be transferred

externalRef

String

Mandatory

Your unique transaction Id

latitude

String

Mandatory

End User Latitude.

longitude

String

Mandatory

End User Longitude.

Remarks

String

Optional

Payment Remarks

alertEmail

String

Optional

Email Id of 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

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": "ipay.105964@icici",
        "bankIfsc": ""
    },
    "transferMode": "UPI",
    "transferAmount": "5.00",
    "externalRef": "IMPS1",
    "latitude": "20.1226",
    "longitude": "78.1228",
    "remarks": "UPI Payment",
    "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": "ipay.105964@icici",
        "bankIfsc": ""
    },
    "transferMode": "UPI",
    "transferAmount": "5.00",
    "externalRef": "IMPS1",
    "latitude": "20.1226",
    "longitude": "78.1228",
    "remarks": "UPI Payment",
    "alertEmail": "",
    "purpose": ""
}

Response Parameters

Parameter NameTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus message
dataArrayResponse Data (If Present)
timestampStringResponse time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive/Sandbox
internalCodeStringIt will be null

Sample Response

{
    "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": "ipay.105964@icici",
            "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.

📘

Info :

Click Here to know how to get the Credentials.

Language
Click Try It! to start a request and see the response here!