Header Parameters

Name	Type	Description	Mandatory (M) , Optional (O)	Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-Code	String	Auth Code is "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 Parameter

Parameter Name	Type	Requirement	Description
contactDetails	Array	Optional	Contact details
contactDetails.name	String	Optional (Mandatory if verifyBene is true )	Name of the recipient
contactDetails.mobile	String	Optional (Mandatory if verifyBene is true )	Mobile number of the recipient
contactDetails.email	String	Optional (Mandatory if verifyBene is true )	Email of the recipient
verifyBene	boolean	Mandatory	It will be true or false. Beneficiary validation will be performed if true; else, no beneficiary validation will be performed.
amount	String	Mandatory	The amount of money to be transferred.
purpose	String	Mandatory	Purpose of the Payout Transactions. It should be either of these, Refund, Cashback, Comission, Incentive , Payout or Greeting
description	String	Mandatory	Description of the Payout transactions
referenceNo	String	Optional	Transaction number for the recipient. By default, it will be NA.
activatedAt	String	Mandatory	The period after which the link ia activated for the recipient.
expiredAt	String	Mandatory	The period after which the payout link expires if not claimed before.
paymentModes	Array	Mandatory	The list of payout modes that the recipient can use to claim the payout. It will be either of these ACCOUNT, VPA, AMAZON, CREDITCARD
sendAlert	boolean	Optional	It will be either true or false. Set it to true if you want to send the notification, and false if you don't.

Sample Request

curl --location 'https://api.instantpay.in/payments/payout/link/create' \
--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 '{
    "contactDetails" : {
        "name" : "Instantpay India Limited",
        "mobile"  : "7428585742",
        "email" : "help@instantpay.in"
    },
    "verifyBene" : true,
    "amount" :"120.112",
    "purpose" : "Refund",
    "description" : " payment",
    "referenceNo" : "", 
    "activatedAt" : "2023-11-20 14:02:00",
    "expiredAt" : "2023-10-03 12:00:23",
     "sendAlert" : true,
    "paymentModes" : [                 
        "ACCOUNT",
        "VPA",
        "AMAZON",
        "CREDITCARD"
    ]
}'

POST /payments/payout/link/create HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825
X-Ipay-Endpoint-Ip: 125.0.0.1
Content-Type: application/json
Content-Length: 508

{
    "contactDetails" : {
        "name" : "Instantpay India Limited",
        "mobile"  : "7428585742",
        "email" : "help@instantpay.in"
    },
    "verifyBene" : true,
    "amount" :"120.112",
    "purpose" : "Refund",
    "description" : "payment",
    "referenceNo" : "", 
    "activatedAt" : "2023-11-20 14:02:00",
    "expiredAt" : "2023-10-03 12:00:23",
     "sendAlert" : true,
    "paymentModes" : [                 
        "ACCOUNT",
        "VPA",
        "AMZON",
        "CREDITCARD"
    ]
}

Response Parameter

Parameter 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

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Link Created Successfully",
    "data": {
        "linkId": "657aa9841b8d3897ff0a84fb",
        "url": "https://instant.pe/LS25FH",
        "status": "ISSUED",
        "contactDetails": {
            "name" : "Instantpay India Limited",
        		"mobile"  : "7428585742",
        		"email" : "help@instantpay.in"
        },
        "amount": 120.11,
        "purpose": "refund",
        "description": "Giving captch payment",
        "referenceNo": "NA",
        "verifyBene": true,
        "paymentModes": [
            "ACCOUNT",
          	"VPA",
        		"AMZON",
        		"CREDITCARD"
        ],
        "orderId": "1231214070644TLWAP",
        "activatedAt": "2023-11-20 14:02:00",
        "expiredAt": "2024-03-13 12:36:44"
    },
    "timestamp": "2023-12-14 12:36:45",
    "ipay_uuid": "h0009ad84ae9-ddca-46ae-b631-b7ecda7b33d4-WmhQCUyFnkmi",
    "orderid": "1231214070644TLWAP",
    "environment": "PRODUCTION",
    "internalCode": null
}

📘
Note :

The status of the Link will be ISSUED, CLAIMED, CANCELLED, PROCESSING and EXPIRED

ISSUED means Link has been successfully issued
CLAIMED means the recipient has successfully claimed the amount
CANCELLED means the link has been cancelled
PROCESSING means the amount is yet to be claimed and currently under process.
EXPIRED means the link is expired.