Remitter Details

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

String

Mobile number of the Remitter

Sample Request

curl --location --request GET 'https://api.instantpay.in/fi/remit/out/domestic/remitterProfile' \
--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}}' \
--data-raw '{
    "mobile": "9********6"
}'
GET /fi/remit/out/domestic/remitterProfile HTTP/1.1
Host: api.instantpay.in
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}}
Content-Type: application/json

{
    "mobile": "9********6"
}

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": "983******7",
        "firstName": "Shahbaz",
        "lastName": "Ali",
        "address": " WEST DELHI DELHI",
        "city": "",
        "state": "DELHI",
        "pincode": "110059",
        "limitConsumed": "0.00",
        "limitAvailable": "25000.00",
        "limitIncreaseOffer": false,
        "beneficiaries": [
            {
                "id": "8129ffb2ccbe8a6b4464ba69029aa50d",
                "name": "BILAL A",
                "account": "33391****6427",
                "ifsc": "CNRB0RTGS01",
                "bank": "CANARA BANK",
                "verificationDt": "2021-12-23 19:03:06"
            },
            {
                "id": "d56c6f9909438aebb602fef4be0360f6",
                "name": "Shahbaz Ali",
                "account": "0490101160001",
                "ifsc": "UTIB0000248",
                "bank": "Axis Bank",
                "verificationDt": null
            },
            {
                "id": "db997c6e1a6f3228c2ede1722a52073c",
                "name": "MANTAJ",
                "account": "62700*******780",
                "ifsc": "PUNB0RRBBGB",
                "bank": "BANGIYA GRAMIN VIKASH BANK",
                "verificationDt": "2021-04-12 12:06:34"
            },
            {
                "id": "df7182f2531859d2f34b6e82aef1d528",
                "name": "MVBBNK",
                "account": "987654****66",
                "ifsc": "SBIN0000002",
                "bank": "STATE BANK OF INDIA",
                "verificationDt": null
            },
            {
                "id": "ef0de1201d5f3c54a00e699b777cb9a1",
                "name": "raju",
                "account": "192*******10000058",
                "ifsc": "BKID0ARYAGB",
                "bank": "ARYAVART BANK",
                "verificationDt": "2022-01-21 12:31:08"
            }
        ]
    },
    "timestamp": "2022-09-07 12:40:50",
    "ipay_uuid": "h0689734e6b8-f99f-460f-b0ea-4adf6530fa8f",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}
Language
Click Try It! to start a request and see the response here!