Beneficiary Registration

Headers 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


ParametersTypeDescription
beneficiaryMobileNumberStringBeneficiary Mobile Number
remitterMobileNumberStringRemitter Mobile Number
accountNumberStringBank Account Number
ifscStringIfsc Code
bankIdStringBank Id. You will get from Bank List API
nameStringBeneficary Name

Sample Request

curl --location 'https://api.instantpay.in/fi/remit/out/domestic/v2/beneficiaryRegistration' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'User-Agent: {{userAgent}}' \
--header 'Content-Type: application/json' \
--data '{
    "beneficiaryMobileNumber" : "9876543210",
    "remitterMobileNumber":"9876543210",
    "accountNumber":"{{accountNumber}}",
    "ifsc":"{{ifsc}}",
    "bankId": "{{bankId}}",
    "name": "ABC"
}'
POST /fi/remit/out/domestic/v2/beneficiaryRegistration HTTP/1.1
Host: api.instantpay.in
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Auth-Code: 1
User-Agent: {{userAgent}}
Content-Type: application/json
Content-Length: 200

{
    "beneficiaryMobileNumber" : "9876543210",
    "remitterMobileNumber":"9876543210",
    "accountNumber":"{{accountNumber}}",
    "ifsc":"{{ifsc}}",
    "bankId": "{{bankId}}",
    "name": "ABC"
}

Response Parameters

NameTypeDescription
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 )
environmentStringLive

Sample Response

{
    "statuscode": "OTP",
    "actcode": null,
    "status": "OTP Successfully sent",
    "data": {
        "beneficiaryId": "80bdd0f178f21016e4711765770dc91c",
        "validity": "2025-12-16 17:49:19",
        "referenceKey": "TcTkLK9J+Oyz1rpbTDbDrHGZ7rFtOOpQY4lYINGnPlpUGn2u6WludIqrhCzb7O8G"
    },
    "timestamp": "2025-12-16 17:34:19",
    "ipay_uuid": "h000a09b40b3-a510-4feb-ae21-86c5f2c83779-4DbyTgDsBBL0",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}
Language
Click Try It! to start a request and see the response here!