Remitter Update

Header Parameters

NameTypeDescrip[tionMandatory (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

mobileStringMobile Number of Remitter
firstNameStringFirst Name of the Remitter
lastNameStringlast name of the Remitter
pinCodeStringPin code of the Remitter

Sample Request

curl --location --request PUT '' \
--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 '{
    "firstName" : "Sample First Name",
    "lastName" : "Sample Last Name"
PUT /fi/remit/out/domestic/remitterUpdate HTTP/1.1
Accept: application/json
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Type: application/json

    "firstName" : "Sample First Name",
    "lastName" : "Sample Last Name"

Response Parameters

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 )

Sample Response

    "statuscode": "OTP",
    "actcode": null,
    "status": "OTP sent to remitter mobile number XXXXXXX742",
    "data": {
        "otpReference": "76474543436a43344397432634744e6d7a3874462b536a78453d"
    "timestamp": "2022-07-28 10:55:00",
    "ipay_uuid": "h00696e24687-a8bd-7e08dfddb672-03908e9bfede",
    "orderid": null,
    "environment": "LIVE",
Click Try It! to start a request and see the response here!