Remitter Profile

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 secret keyMY
X-Ipay-Outlet-IdStringMerchant unique IDMY
X-Ipay-Endpoint-IpStringEnd Customer IP AddressMN

Request Parameters

mobileNumberMobile number of the Remitter

Sample Request

curl --location --request GET '' \
--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 '' \
--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}}

Response Parameters

statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus Message
dataArrayResponse Data (If Present)
timestampStringCurrent time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )

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.

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