Beneficiary Registration

Request Parameters

Parameters		Description
remitterMobile	Mandatory	Mobile Number of the Remitter
name	Mandatory	Beneficiary Name
gender	Mandatory	Gender of the Beneficiary (You will get this from Static Data API)
mobile	Mandatory	Mobile Number of the beneficiary (It must be of Nepal)
relationship	Mandatory	Relationship of the Beneficiary ((You will get this from Static Data API)
address	Mandatory	Address Of the Beneficiary
paymentMode	Mandatory	It will be Cash Payment or Account Deposit
bankBranchId	Optional (Mandatory when paymentMode is Account Deposit)	Bank Branch Id
accountNumber	Optional (Mandatory when paymentMode is Account Deposit)	Bank Account Number

Sample Request

POST /fi/remit/out/nepal/beneficiaryRegistration 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: 14.142.186.14
X-Ipay-Request-Hash: 123456789|123456789|123456789|123456789|123456789|123456789|1234
X-Ipay-Request-Timestamp: 1665723055000
X-Ipay-Hash-Check: OFF
User-Agent: InstantPayAPITest/1.0.0
X-Ipay-Outlet-Id: 72762
Content-Type: application/json
Content-Length: 316

{
    "remitterMobile": "7428585742",
    "name":"Sample Name",
    "gender":"Male",
    "mobile":"9876543210",
    "relationship":"Brother",
    "address":"DELHI",
    "paymentMode":"Cash Payment",
    "bankBranchId":"",
    "accountNumber":""
}

curl --location --request POST 'https://api.instantpay.in/fi/remit/out/nepal/beneficiaryRegistration' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825' \
--header 'X-Ipay-Endpoint-Ip: 14.142.186.14' \
--header 'X-Ipay-Request-Hash: 123456789|123456789|123456789|123456789|123456789|123456789|1234' \
--header 'X-Ipay-Request-Timestamp: 1665723039000' \
--header 'X-Ipay-Hash-Check: OFF' \
--header 'User-Agent: InstantPayAPITest/1.0.0' \
--header 'X-Ipay-Outlet-Id: 72762' \
--header 'Content-Type: application/json' \
--data-raw '{
    "remitterMobile": "7428585742",
    "name":"Sample Name",
    "gender":"Male",
    "mobile":"9876543210",
    "relationship":"Brother",
    "address":"DELHI",
    "paymentMode":"Cash Payment",
    "bankBranchId":"",
    "accountNumber":""
}'

Response Parameters

Parameter Name	Type	Description
statuscode	String	InstantPay Status Code
actcode	String	Action Code
status	String	Status message
data	Array	Response Data (If Present)
timestamp	String	Response time (YYYY-MM-DD HH:II:SS
ipay_uuid	String	Request reference number
orderid	String	Transaction Id ( If transaction otherwise it is null )
enviroment	String	Live/Sandbox

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "id": "649717",
        "mobile": "7428585742",
        "firstName": "Sample Name",
        "gender": "Male",
        "dob": "1995-01-01",
        "address": "Sample Address",
        "city": "City Name",
        "state": "State Name",
        "district": "District Name",
        "nationality": "Nationality",
        "employer": "Business Name",
        "incomeSource": "Business",
        "status": "Unverified",
        "approveStatus": "Commented",
        "approveComment": "PHOTO IS NOT CLEAR",
        "ids": [
            {
                "idType": "Aadhaar Card",
                "idNumber": "XXXXXXXX6077"
            }
        ],
        "transactionCount": {
            "day": "0",
            "month": "0",
            "year": "0"
        },
        "beneficiaries": [
            {
                "id": "1036010",
                "name": "Sample Name",
                "gender": "Male",
                "relationship": "Brother",
                "address": "DELHI",
                "mobile": "9876543210",
                "paymentMode": "Cash Payment",
                "bankBranchId": "",
                "bankName": "",
                "bankBranchName": "",
                "acNumber": ""
            }
        ]
    },
    "timestamp": "2022-10-17 10:24:56",
    "ipay_uuid": "h00597852d7b-e20d-4d5b-9686-50e394d0b64f",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}

📘
Info :
For API Headers Click Here