Sign in

v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

GET Transaction List

The GET Transaction List API allows the API user to retrieve all transactions or transaction filtered by transaction ID

get/v1/client/transaction/get-transaction-list

Query parameters

transactionIdstring required

The Transaction ID from the Quote Generation API

pageSizeinteger

Count of transactions per page

pageNumberinteger

Number of the active page

statusstring

Status of the transaction to filter transactions, it may be one of the following statuses ["INITIATED","HOLD","FUND_RECEIVED"]

fromstring

From date for the list of transactions in the format YYYY-MM-DD

tostring

To date for the list of transactions in the format YYYY-MM-DD

Headers

api-keystring required

API Key

auth-keystring required

The Auth key as received from Generate Auth Key API

userIdstring required

User Id as generated via the "Create Account (sign-Up) API". Identifier of an individual user, you can map this to the User identification at your end.

Response

200

statusinteger
messagestring

Example response

{
  "status": 200,
  "message": "Success",
  "data": {
    "transactionData": [
      {
        "status": "EXPIRED",
        "amount": 83448.57,
        "createdAt": "2024-03-17T05:51:50.452Z",
        "expiry": "2024-03-17T06:21:17.325Z",
        "transactionId": "ER397446",
        "userAccountId": "oa3a472e-5692-4cff-b94e-3a40e9c10o7f",
        "beneName": "Harvard University"
      }
    ],
    "length": 28
  }
}