Remitter registration

Header Parameters

Name

Type

Description

Mandatory (M) , Optional (O)

Mandatory (M) , Optional (O)

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

String

Description

mobile

String

Mobile Number of the Remitter

firstName

String

First Name of the Remitter

lastName

String

Last name of the Remitter

pinCode

String

Pin 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":"74******75",
    "firstName" : "M*****a",
    "lastName" : "K*****i",
    "pinCode":"1****4"
}'
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":"74******75",
    "firstName" : "M*****a",
    "lastName" : "K*****i",
    "pinCode":"1****4"
}

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": "Success",
    "data": {
        "mobile": "74******75",
        "firstName": "M*****a",
        "lastName": "K****i",
        "address": " S********I",
        "city": "",
        "state": "D****I",
        "pincode": "1****4",
        "limitConsumed": "25000.00",
        "limitAvailable": "0.00",
        "limitIncreaseOffer": false,
        "beneficiaries": [
            {
                "id": "bb2cf*********************38b63b8",
                "name": "A**********Y       ",
                "account": "0490********001",
                "ifsc": "UT*******48",
                "bank": "A*******k"
            }
        ]
    },
    "timestamp": "2022-07-28 16:17:34",
    "ipay_uuid": "h00596e2b9e**************d29fb0228343",
    "orderid": null,
    "environment": "LIVE",
}
Language
Click Try It! to start a request and see the response here!