Wallets

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

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

📘

Info :

Click Here to know how to get the Credentials.

Request Parameters for Wallets

Parameter NameTypeRequirementDescription
payerArrayMandatorypayer details
payer.bankProfileIdStringMandatoryIt will be 0
payer.accountNumberStringMandatoryMobile Number Registered with Instantpay
payeeArrayMandatorypayee details
payee.nameStringMandatoryAccount Holder Name
payee.accountNumberStringMandatoryWallet Registered Mobile Number
payee.bankIfscStringOptionalNo input required
transferMode StringMandatoryModes can be PAYTM or AMAZON
transferAmount StringMandatoryAmount to be transferred
externalRef StringMandatoryYour unique transaction Id
latitude StringMandatoryEnd Customer Latitude.
longitude StringMandatoryEnd Customer Longitude.
RemarksStringOptionalPayment Remarks
alertEmail StringOptionalEmail of the end user. If passing the email, then Instantpay will send the email notification
purposeStringOptionalPurpose 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

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 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.

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