Remitter Registration

Header Parameters

NameTypeDescriptionMandatory (M) , Optional (O)Mandatory (M) , Optional (O)
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

NameStringDescription
mobileStringMobile Number of the Remitter
firstNameStringFirst Name of the Remitter
lastNameStringLast name of the Remitter
pinCodeStringPin Code of the Remitter

Sample Request

curl --location --request POST 'https://api.instantpay.in/fi/remit/out/domestic/remitterRegistration' \
--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 '{
    "mobile":"7428585742",
    "firstName" : "Sample First Name",
    "lastName" : "Sample Last Name",
    "pinCode":"110044"
}'
POST /fi/remit/out/domestic/remitterRegistration HTTP/1.1
Host: api.instantpay.in
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

{
    "mobile":"7428585742",
    "firstName" : "Sample First Name",
    "lastName" : "Sample Last Name",
    "pinCode":"110044"
}'

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": "7866374c59486f50316a595269696a51734b54566371674764676f69367768346e6650574d7459357663544e744c5230737332506d3233615135665a6e6d4653567a4c49736e4450674e566d336e3674534e57694d336c667a3566734a3166616e665862324f4b7443524246727639485a654a504e63666a756632486b5346584e704a4a3364633837786b666a306a526d42755138707a3376794b32446f31792b4c5944416a4d7334724432524731584372564f344e78496e7665543942474733613979436753564573614c7a3664774f684c2f345a637a38794377414d6f6e6e6c6c51464a76645731593d"
    },
    "timestamp": "2022-11-17 16:07:53",
    "ipay_uuid": "h06897c404a5-60f0-47bc-a76d-488563d9cff8",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}
Language
Click Try It! to start a request and see the response here!