Beneficiary Deletion

Header 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

NameTypeDescription
remitterMobileString
beneficiaryIdString

Sample Request

curl --location --request DELETE 'https://api.instantpay.in/fi/remit/out/domestic/beneficiaryDelete' \
--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": "7428585742",
    "beneficiaryId": "d580b9d86ec9f86cb26ce0cc4ed80726"
}'
DELETE /fi/remit/out/domestic/beneficiaryDelete 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": "7428585742",
    "beneficiaryId": "d580b9d86ec9f86cb26ce0cc4ed80726"
}'

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 sent to remitter mobile number XXXXXXX742",
    "data": {
        "otpReference": "2f786e79695a75657a5157322f5947746271673d3d"
    },
    "timestamp": "2022-07-28 10:52:26",
    "ipay_uuid": "h00696e24-a8bd-7e08dfddb672-a9fdddd2bfd9",
    "orderid": null,
    "environment": "LIVE",
}
Language
Click Try It! to start a request and see the response here!