Beneficiary Registration

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

remitterMobile

String

Remitter Mobile Number

firstName

String

Full Name of Beneficiary

ifsc

String

Bank IFSC code of Beneficiary

accountNumber

String

Bank Account Number of Beneficiary

bankId

String

Bank Id of Beneficiary

Sample Request

curl --location --request POST 'https://api.instantpay.in/fi/remit/out/domestic/beneficiaryRegistration' \
--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}}' \
--data-raw '{
    " "remitterMobile":"74******75",
    "firstName":"S*****z",
    "ifsc":"UT*******48",
    "accountNumber":"04**********01",
    "bankId": 1****8
}'
POST /fi/remit/out/domestic/beneficiaryRegistration HTTP/1.1
Host: api.instantpay.in
Accept: application/json
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

{
    "remitterMobile":"74******75",
    "firstName":"S*****z",
    "ifsc":"UT*******48",
    "accountNumber":"04**********01",
    "bankId": 1****8
}

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": "Beneficiary details",
    "data": {
        "id": "d56c*********************be0360f6",
        "name": "S*********i",
        "account": "04*********01",
        "ifsc": "UT*******48",
        "bank": "A*******k"
    },
    "timestamp": "2022-07-28 16:27:33",
    "ipay_uuid": "h00596e2bd75*****************fbfe2da7ac32",
    "orderid": null,
    "environment": "LIVE",
}
Language
Click Try It! to start a request and see the response here!