Headers Parameter

Name	Type	Description	Mandatory (M) , Optional (O)	Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-Code	String	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-Endpoint-Ip	String	End Customer IP Address	M	N

📘
Info :
Click Here to know how to get the Credentials.

Request Parameter

Parameter Name	Requirement	Description
transactionDate	Mandatory	Date of the Transaction (YYYY-MM-DD)
externalRef	Mandatory	Your Transaction Id
source	Optional	It will be ORDER (For AePS Transactions only)

📘
Note :
If checking the Transaction status other than AePS API then you don't need to pass the source parameter in the request.

Sample Request

curl --location --request POST 'https://api.instantpay.in/reports/txnStatus' \
--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 'Content-Type: application/json' \
--data-raw '{
                "transactionDate" : "2021-11-29",
                "externalRef"     : "IMPS1",
                "source"          : "ORDER"
      			}

POST /reports/txnStatus 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}}
Content-Type: application/json

{
			"transactionDate" : "2021-11-29",
   		"externalRef"     : "IMPS1",
			"source"          : "ORDER"
}

Response Parameter

Parameter Name	Type	Description
statuscode	String	InstantPay Status Code
actcode	String	Action Code
status	String	Status message
data	Array	Response Data (If Present)
pool	Array	Pool Account Details after the Transaction amount debited
reversal	Array	Reversal Details
timestamp	String	Response time (YYYY-MM-DD HH:MM:SS)
ipay_uuid	String	Request reference number
environment	String	Live/Sandbox

Sample Response

{
  "statuscode": "TXN",
  "actcode": null,
  "status": "-",
  "data": {
    "transactionDateTime": "2022-05-01 00:52:54",
    "transactionStatusCode": "TXN",
    "transactionStatus": "Transaction Successful",
    "transactionAmount": "10000.00",
    "transactionReferenceId": "212100597800",
    "order": {
      "referenceId": "CPJ012212100524740",
      "externalRef": "1651346567",
      "spKey": "WAP",
      "spName": "Cash Withdrawal via AePS",
      "sspKey": "ALL",
      "sspName": null,
      "account": "841XXXX786",
      "optional1Label": "IIN",
      "optional1": "XXXXXX",
      "optional2Label": "Aadhaar",
      "optional2": "xxxxxxxx0110",
      "optional3Label": "Bank",
      "optional3": "STATE XXXXX INDIA",
      "optional4Label": "Balance",
      "optional4": "",
      "optional5Label": "",
      "optional5": "",
      "optional6Label": "",
      "optional6": "",
      "optional7Label": "",
      "optional7": "",
      "optional8Label": "",
      "optional8": "",
      "optional9Label": "",
      "optional9": ""
    },
    "pool": {
      "transaction": {
        "referenceId": "122050100XXXXYHVCA",
        "openingBalance": "7514.29",
        "paymentAmount": "10009.50",
        "mode": "CR",
        "closingBalance": "17523.79",
        "convenienceFee": "0.00",
        "surcharge": "0.0000",
        "cashback": "10.0000",
        "tds": "0.5000"
      },
      "reversal": {
        "referenceId": null,
        "openingBalance": null,
        "paymentAmount": null,
        "mode": null,
        "closingBalance": null
      }
    },
    "tag": {
      "1": {
        "desc": null,
        "value": null
      },
      "2": {
        "desc": null,
        "value": null
      },
      "3": {
        "desc": null,
        "value": null
      },
      "4": {
        "desc": null,
        "value": null
      },
      "5": {
        "desc": null,
        "value": null
      }
    }
  },
  "timestamp": "2022-06-29 17:42:13",
  "ipay_uuid": "h00596a8819e-XXXX-XXXX-XXXX-e50540126dc3"
}

Status Code Information

statuscode	transactionStatusCode	Action
TXN	TXN	Transaction is Successful
TXN	TUP	Still Transaction is under process. No Action Required.
TXN	Other than TXN and TUP	Transaction is Failed
Other than TXN		No Action Required.

📘
Note

Call this API at least after 30 minutes of transaction and only when the Transaction is Under Process (TUP) or Timeout(No Response).

If transactionStatusCode is TUP then hit the API again but maintain a time difference of at least 4 hours between status query attempts for the same transaction.

You will get the Reversal details if the Transaction is failed and the amount is refunded.

The Status of the Transactions can be checked for the last 30 days only.

If Transaction initiated between 11:55 PM to 12:00 AM then check the status on T and T+1 Days.

Every day from 11:30 PM to 00:30 AM, the Transaction Status API will be down for maintenance.