Fund Transfer

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

remitterMobile

String

Mobile Number of Remitter

beneficiaryId

String

transferMode

String

Modes can be IMPS,NEFT or RTGS

transferAmount

String

Amount to be transferred

latitude

String

Current location latitude

longitude

String

Current location longitude

externalRef

String

Unique Reference number

Sample Request

curl --location --request POST 'https://api.instantpay.in/fi/remit/out/domestic/fundTransfer' \
--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":"99******46",
    "beneficiaryId":"9a1a15fd62***************05e1a85",
    "transferMode":"IMPS",
    "transferAmount":2,
    "latitude":"8*******6",
    "longitude":"1*******7",
    "externalRef":"abc1256"
}'
POST /fi/remit/out/domestic/fundTransfer 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":"99******46",
    "beneficiaryId":"9a1a15fd62***************05e1a85",
    "transferMode":"IMPS",
    "transferAmount":2,
    "latitude":"8*******6",
    "longitude":"1*******7",
    "externalRef":"abc1256"
}

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

Response 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/Sandbox

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "externalRef": "abc1256",
        "poolReferenceId": "12207**********CZQ",
        "txnValue": "2.00",
        "txnReferenceId": "22********52",
        "pool": {
            "account": "99******46",
            "openingBal": "22.72",
            "mode": "DR",
            "amount": "8.70",
            "closingBal": "14.02"
        },
        "remitterMobile": "99******46",
        "beneficiaryAccount": "07********16",
        "beneficiaryIfsc": "IC*******16"
    },
    "timestamp": "2022-07-25 16:38:56",
    "ipay_uuid": "h00696dcb88***************2bace8782a54",
    "orderid": "122072*********CZQ",
    "environment": "LIVE",
}

❗️

Important Information

Consider the Transaction as Pending when you get No Response or Timeout Response and then check the status of the transactions through Transaction Status API.

Language
Click Try It! to start a request and see the response here!