| 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 |
| Name | Type | Requirement | Description |
|---|
| filters | Array | Optional | Filters to retrieve all the Links |
| filters.status | String | Optional | Retrieve all the Payout Links created through status. Status can be ISSUED, CLAIMED, CANCELLED, PROCESSING or EXPIRED |
| filters.contact | String | Optional | Retrieve all the Payout Links created through contact. Contact can be Name, Mobile Number or Email |
| filters.linkId | String | Optional | Retrieve all the Payout Links created through the link id. |
| pagination | Array | Optional | Number of Payout link requested to retrieve |
| pagination.pageNumber | String | Optional | Page number of the payout links |
| pagination.recordsPerPage | String | Optional | Records available in the page. |
curl --location --request GET 'https://api.instantpay.in/payments/payout/link/list' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'Content-Type: application/json' \
--data '{
"filters" : {
"status" : ["ISSUED"],
"contact" : "Contact Name /Contact Mobile / Contact Email",
"linkId" : "657aa9841b8d3897ff0a84fb"
},
"pagination" : {
"pageNumber" : "1",
"recordsPerPage" : "10"
}
}'
GET /payments/payout/link/list 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: 262
{
"filters" : {
"status" : ["ISSUED"],
"contact" : "Contact Name /Contact Mobile / Contact Email",
"linkId" : "657aa9841b8d3897ff0a84fb"
},
"pagination" : {
"pageNumber" : "1",
"recordsPerPage" : "10"
}
}
| 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 |
{
"statuscode": "TXN",
"actcode": null,
"status": "Transaction Successful",
"data": {
"meta": {
"totalPages": 6,
"currentPage": 1,
"totalRecords": 12,
"recordsOnCurrentPage": 2,
"recordFrom": 1,
"recordTo": 2
},
"records": [
{
"amount": 120.11,
"purpose": "refund",
"description": "Giving captch payment",
"status": "ISSUED",
"linkId": "657aa9841b8d3897ff0a84fb",
"contactDetails": {
"name": "Sample Name",
"email": "[email protected]",
"mobile": "7428585742"
},
"referenceNo": "NA",
"orderId": "1231214070644TLWAP",
"url": "https://instant.pe/LS25FH",
"qrUrl": "https://api.instantpay.in/payment/payout/link/qr/LS25FH",
"paymentModes": [
"ACCOUNT"
],
"verifyBene": true,
"activatedAt": "2023-11-20 14:02:00",
"expiredAt": "2024-03-13 12:36:44"
},
{
"amount": 120.11,
"purpose": "refund",
"description": "Giving captch payment",
"status": "PROCESSING",
"linkId": "657a9ac51b8d3897ff0a84f9",
"contactDetails": {
"name": "Sample Name",
"email": "[email protected]",
"mobile": "7428585742"
},
"referenceNo": "NA",
"orderId": "1231214060349YVGXT",
"url": "https://instant.pe/CH24wF",
"qrUrl": "https://api.instantpay.in/payment/payout/link/qr/CH24wF",
"paymentModes": [
"ACCOUNT"
],
"verifyBene": true,
"activatedAt": "2023-11-20 14:02:00",
"expiredAt": "2024-03-13 11:33:49"
}
]
},
"timestamp": "2023-12-14 16:43:59",
"ipay_uuid": "h0009ad8a356-b745-4ee2-88bb-0c4abb750ed7-bQQqUjuG4ASN",
"orderid": null,
"environment": "PRODUCTION",
"internalCode": null
}
