get https://api.instantpay.in/fi/remit/out/domestic/remitterProfile
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 secret key | M | Y |
| X-Ipay-Outlet-Id | String | Merchant unique ID | M | Y |
| X-Ipay-Endpoint-Ip | String | End Customer IP Address | M | N |
Request Parameters
| Name | Type | Description |
|---|---|---|
| mobile | Number | Mobile number of the Remitter |
Sample Request
curl --location --request GET 'https://api.instantpay.in/fi/remit/out/domestic/remitterProfile?mobile=7428585742' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--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 'X-Ipay-Outlet-Id: {{outletId}}'
curl --location --request GET 'https://api.instantpay.in/fi/remit/out/domestic/remitterProfile?mobile=7428585742' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
X-Ipay-Outlet-Id:{{outletId}}
Response Parameters
| Name | Type | Description |
|---|---|---|
| statuscode | String | InstantPay Status Code |
| actcode | String | Action Code |
| status | String | Status Message |
| data | Array | Response Data (If Present) |
| timestamp | String | Current 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 |
Sample Response
{
"statuscode": "TXN",
"actcode": null,
"status": "Success",
"data": {
"mobile": "7428585742",
"firstName": "Sample First Name",
"lastName": "Sample Last Name",
"address": " Sample Full Address",
"city": "City Name",
"state": "State Name",
"pincode": "Pin Code",
"limitPerTransaction": "5000.00",
"limitTotal": "25000.00",
"limitConsumed": "0.00",
"limitAvailable": "25000.00",
"limitIncreaseOffer": false,
"allowProfileUpdate": true,
"limitDetails": {
"maximumDailyLimit": "25000.00",
"consumedDailyLimit": "0.00",
"availableDailyLimit": "25000.00",
"maximumMonthlyLimit": "25000.00",
"consumedMonthlyLimit": "0.00",
"availableMonthlyLimit": "25000.00"
},
"beneficiaries": [
{
"id": "d580b9d86ec9f86cb26ce0cc4ed80726",
"name": "Beneficiary Name",
"account": "7770007428585742",
"ifsc": "YESB0CMSNOC",
"bank": "YES BANK",
"branch": "New Delhi",
"verificationDt": null
},
{
"id": "db997c6e1a6f3228c2ede1722a52073c",
"name": "Beneficiary Name",
"account": "33339835799007",
"ifsc": "IDFB0020101",
"bank": "IDFC BANK",
"branch": "New Delhi",
"verificationDt": "2021-04-12 12:06:34"
}
]
},
"timestamp": "2023-01-02 12:21:27",
"ipay_uuid": "h00698203cef-695f-434c-b6d9-a65a98de8d89",
"orderid": null,
"environment": "LIVE",
"internalCode": null
}
Note :
If you get actcode IRN in Remitter Profile API then you need to update the Remitter Name through Remitter Update API.