Cancel Link

Instantly cancel any unprocessed payout links to avoid unnecessary payments.

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 Client SecretMY
X-Ipay-Endpoint-IpStringEnd Customer IP AddressMY

Request Parameters

NameTypeRequirementDescription
linkIdStringMandatoryGenerated link id of the payment transactions.

Sample Request

curl --location 'https://api.instantpay.in/payments/payout/link/cancel' \
--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 '{
    "linkId" : "657a99b961f05879ae06cb56"
}'
POST /payments/payout/link/cancel 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: 45

{
    "linkId" : "657a99b961f05879ae06cb56"
}

Response Parameters

Parameter NameTypeDescription
statuscodeStringInstantPay StatusCode
actcodeStringAction Code
statusStringStatus message
dataStringResponse Data(if Present)
timestampStringResponse time(YYYY-MM-DD HH:||: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 Cancelled Successfully",
    "data": null,
    "timestamp": "2023-12-14 11:29:45",
    "ipay_uuid": "h0009ad832f4-f43d-40c0-81d3-c04979ab81df-e51WjQG73oSk",
    "orderid": null,
    "environment": "PRODUCTION",
    "internalCode": null
}
Language
Click Try It! to start a request and see the response here!