Header Parameters

Name	Type	Description	Mandatory(M),Optional(O)	Provided by INSTANTPAY(Y/N)
X-Ipay-Auth-Code	String	Auth Code -1 (Fixed)	M	Y
X-Ipay-Client-Id	String	Unique Client Id	M	Y
X-Ipay-Client-Secret	String	Unique Client Secret	M	Y
X-Ipay-Endpoint-Ip	String	End Customer IP Address	M	Y

Request Parameters

Name	Requirement	Description
linkId	Mandatory	Generated link id of the payment transactions.

Sample Request

curl --location --request GET 'http://127.0.0.1:8000/payments/payout/link/track/65704add83911e52b70ebcbc' \
--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 '
'

GET /payments/payout/link/track/65704add83911e52b70ebcbc HTTP/1.1
Host: 127.0.0.1:8000
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: 1

Response Parameters

Parameter Name	Type	Description
statuscode	String	InstantPay StatusCode
actcode	String	Action Code
status	String	Status message
data	String	Response Data(if Present)
timestamp	String	Response time(YYYY-MM-DD HH:\|\|: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": "Transaction Successful",
    "data": {
        "status": "CLAIMED",
        "amount": 120.11,
        "linkActivity": [
            {
                "status": "Payout link created",
                "activityAt": "2023-12-12 14:51:25"
            },
            {
                "status": "Payout link notification sent to 8430454547 and [email protected]",
                "activityAt": "2023-12-12 14:51:26"
            },
            {
                "status": "Beneficiary verification successful",
                "activityAt": "2023-12-12 14:51:31",
                "orderId": "1231212092131KTMDF",
                "accountType": "ACCOUNT",
                "accountNumber": "7770007428585742",
                "accountIfsc": "YESB0CMSNOC"
            },
            {
                "status": "Link Claimed successfully",
                "activityAt": "2023-12-12 14:51:31",
                "orderId": "1231212092131FDBUT",
                "accountType": "ACCOUNT",
                "accountNumber": "7770007428585742",
                "accountIfsc": "YESB0CMSNOC"
            }
        ]
    },
    "timestamp": "2023-12-14 16:42:49",
    "ipay_uuid": "h0009ad8a2eb-7790-4fe2-a9af-8cdb732d668c-WbrjDVgsp8oy",
    "orderid": null,
    "environment": "PRODUCTION",
    "internalCode": null
}

📘
Status of the Link will be :
ISSUED - > Link has been Issue Successfully
CANCELLED - > Link has been cancelled.
EXPIRED - > Link has been expired.
PROCESSING - > Payout is under process.
CLAIMED - > Link has been claimed successfully