v1

latestOpenAPI 3.1.02026-07-2414704.6 MB

Transaction Status

Check the status of any transaction initiated on InstantPay platform. Call this API after 15 minutes of transaction completion and if transaction is in PENDING (TUP) or TIMEOUT (no response) status. Maintain a time difference of at least 4 hours between status query attempts for the same transaction.

post/txnStatus

Headers

X-Ipay-Auth-Codestring

Auth Code - 1 (Fixed)

X-Ipay-Client-Idstring

Unique Client ID

X-Ipay-Client-Secretstring

Unique secret key

X-Ipay-Endpoint-Ipstring

End Customer IP Address

Request body

transactionDatestring date

externalRefstring

sourcestring

Response

200

statuscodestring

{"stackTrail":"paths:/txnStatus:post:responses:200:content:application/json:schema:properties:actcode","oasType":"schema","type":"unknown"}

statusstring

timestampstring

ipay_uuidstring

Example response

{
  "statuscode": "TXN",
  "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",
      "account": "841XXXX786",
      "optional1Label": "IIN",
      "optional1": "XXXXXX",
      "optional2Label": "Aadhaar",
      "optional2": "xxxxxxxx0110",
      "optional3Label": "Bank",
      "optional3": "STATE XXXXX INDIA",
      "optional4Label": "Balance"
    },
    "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"
      }
    }
  },
  "timestamp": "2022-06-29 17:42:13",
  "ipay_uuid": "h00596a8819e-XXXX-XXXX-XXXX-e50540126dc3"
}