Remitter Limit

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

mobile

String

Mobile Number of remitter

Sample Request

curl --location --request GET 'https://api.instantpay.in/fi/remit/out/domestic/remitterTransferLimit' \
--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": "9971462546"
}'
GET /fi/remit/out/domestic/remitterTransferLimit 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": "9971462546"
}

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": "Successfully fetched remitter limit",
    "data": {
        "limitConsumed": "25000.00",
        "limitAvailable": "0.00"
    },
    "timestamp": "2022-07-28 12:36:20",
    "ipay_uuid": "h00596e26ac3-*************-4493f7bb5b6a",
    "orderid": null,
    "environment": "LIVE",
}
Language
Click Try It! to start a request and see the response here!