Create Link

Generate a unique payout link for easy payment disbursement without collecting bank details.

Header Parameters

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code is "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 Parameter

Parameter NameTypeRequirementDescription
contactDetailsArrayOptionalContact details
contactDetails.nameStringOptional (Mandatory if verifyBene is true )Name of the recipient
contactDetails.mobileStringOptional (Mandatory if verifyBene is true )Mobile number of the recipient
contactDetails.emailStringOptional (Mandatory if verifyBene is true )Email of the recipient
verifyBenebooleanMandatoryIt will be true or false. Beneficiary validation will be performed if true; else, no beneficiary validation will be performed.
amountStringMandatoryThe amount of money to be transferred.
purposeStringMandatoryPurpose of the Payout Transactions. It should be either of these, Refund, Cashback, Comission, Incentive , Payout or Greeting
descriptionStringMandatoryDescription of the Payout transactions
referenceNoStringOptionalTransaction number for the recipient. By default, it will be NA.
activatedAtStringMandatoryThe period after which the link ia activated for the recipient.
expiredAtStringMandatoryThe period after which the payout link expires if not claimed before.
paymentModesArrayMandatoryThe list of payout modes that the recipient can use to claim the payout. It will be either of these ACCOUNT, VPA, AMAZON, CREDITCARD
sendAlertbooleanOptionalIt 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" : "[email protected]"
    },
    "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" : "[email protected]"
    },
    "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 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": "Link Created Successfully",
    "data": {
        "linkId": "657aa9841b8d3897ff0a84fb",
        "url": "https://instant.pe/LS25FH",
        "status": "ISSUED",
        "contactDetails": {
            "name" : "Instantpay India Limited",
        		"mobile"  : "7428585742",
        		"email" : "[email protected]"
        },
        "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.

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