Beneficiary Registration

This API is used to create the beneficiary.

Request Parameters

remitterMobileMandatoryMobile Number of the Remitter
nameMandatoryBeneficiary Name
genderMandatoryGender of the Beneficiary
(You will get this from Static Data API)
mobileMandatoryMobile Number of the beneficiary
(It must be of Nepal)
relationshipMandatoryRelationship of the Beneficiary
((You will get this from Static Data API)
addressMandatoryAddress Of the Beneficiary
paymentModeMandatoryIt will be Cash Payment or Account Deposit
(Mandatory when paymentMode is Account Deposit)
Bank Branch Id
(Mandatory when paymentMode is Account Deposit)
Bank Account Number

Sample Request

POST /fi/remit/out/nepal/beneficiaryRegistration HTTP/1.1
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825
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",
    "paymentMode":"Cash Payment",
curl --location --request POST '' \
--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:' \
--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",
    "paymentMode":"Cash Payment",

Response Parameters

Parameter NameTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus message
dataArrayResponse Data (If Present)
timestampStringResponse time (YYYY-MM-DD HH:II:SS
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
    "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

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