LIST

LIST provides a method to query into previous transactions by timeframe. The group of transactions is specified by the date fields in the query list request object. The merchant data required for this transaction is linked through the access token data.

Responses contain the status as the most recent transaction event recorded. The returned value for status changes as the transaction completes each event.

Successful requests will be indicated with a 2xx HTTP response code and the Approved attribute set to 'true'.

NOTE

The maximum return is twenty (20) transactions.

It is possible to receive an HTTP 2xx response code indicating that the request was successfully received, understood, and processed at the HTTP protocol level, but still have the Approved attribute set to false. (A 2xx response code with an Approved attribute set to false means the server successfully handled the request itself; however the actual business or application logic determined that the request was not approved).

Available Functions

Perform transaction list query

GET, /v0/query/transaction/list

REQUEST Object Attributes

View REQUEST Object Attributes

Transaction List Request Table
Attribute	Data Type	Description	Required
Query	object	Query request options
StartTime	date	ISO 8601-formatted date, default UTC (e.g. 2021-12-13T20:57:38Z) StartTime is aKey/Value of the "Query" Object	False
EndTime	date	ISO 8601-formatted date, default UTC (e.g. 2021-12-13T20:57:38Z) EndTime is aKey/Value of the "Query" Object	False
Approved	Boolean	When true, only approved transactions are returned. When false, only denied transactions are returned. When absent, both approved and denied transactions are returned. Approved is aKey/Value of the "Query" Object	False

REQUEST Example

Code for Request Example

URL=https://api.qa.paynetworx.net/v0/query/transaction/list
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
  "Query": {
    "StartTime": "2022-01-25T00:00:00Z",
    "EndTime": "2022-01-31T00:00:00Z"
  }
}'

RESPONSE Object Attributes

View RESPONSE Object Attributes

Transaction List Request Table
Attribute	Data Type	Description
TransactionID	ksuid	Unique transaction lifetime system ID
EventID	ksuid	Unique transaction event system ID
RequestID	ksuid	Unique transaction request system ID
Approved	string	Query request approval indicator (e.g. "true", "false")
Transactions	array	List of transaction status objects
TransactionID	ksuid	Transaction List unique transaction lifetime system ID TransactionID is aKey/Value of the "Transactions" Object
EventID	ksuid	Transaction List unique transaction event system ID EventID is aKey/Value of the "Transactions" Object
RequestID	ksuid	Transaction List unique request ID from merchant obtained from request header RequestID is aKey/Value of the "Transactions" Object
EventDate	date	Transaction List event date ISO 8601-formatted date, default UTC (e.g. 2021-12-13T20:57:38Z) EventDate is aKey/Value of the "Transactions" Object
Status	string	Transaction List latest transaction status (e.g. "Authorization", "Clearing") Status is aKey/Value of the "Transactions" Object
ResponseCode	string	Transaction List Response Code ResponseCode is aKey/Value of the "Transactions" Object
ResponseText	string	Transaction List Response Text for transaction further explaining transaction result ResponseText is aKey/Value of the "Transactions" Object
Error	string	Transaction List description of the error if present Error is aKey/Value of the "Transactions" Object
Approved	boolean	Transaction List approval indicator (true, false) Approved is aKey/Value of the "Transactions" Object

RESPONSE Example

Code for Response Example

json

{
  "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
  "EventID": "1XSnvq7J5ggxZg70sWuRg4kEBcu",
  "RequestID": "1XSnzEjZ4IBh5Nj0OEVPTWpwYo8",
  "Approved": true,
  "Transactions": [
    {
      "TransactionID": "24Cix6u5CxeMsuwcRIb7U2SCW1J",
      "EventID": "24Cix4ZaZnx2AH0VHR2hj8JMZ5I",
      "RequestID": "24Cix747TeXve4dZT8fNel7Zb3i",
      "EventDate": "22-01-25T20:06:52Z",
      "Status": "Authorization Capture",
      "ResponseCode": "00",
      "Approved": true
    },
    {
      "TransactionID": "24IPTHTHL3GazpCbnULvZJaXFQj",
      "EventID": "24IPTLA4CM5SKNvPuJXqBOsugFW",
      "RequestID": "24IPTADSZ6oZgLfqQ22pdy84K8i",
      "EventDate": "2022-01-27T20:25:33Z",
      "Status": "Authorization Capture",
      "ResponseCode": "91",
      "Approved": false
    },
    {
      "TransactionID": "24IPUcKsKZeAspdmo7ZJ7PnWITn",
      "EventID": "24IPUggjy5VFV1epY8PKgsvDGiY",
      "RequestID": "24IPUfNj02iwRQX6QlkmskmBa9X",
      "EventDate": "2022-01-27T20:25:45Z",
      "Status": "Authorization Capture",
      "ResponseCode": "05",
      "Approved": false,
      "AddressLine1Check": "unchecked",
      "AddressZipCheck": "unchecked",
      "CVCCheck": "pass"
    },
    {
      "TransactionID": "24TYPcWqX7F4DboNPcmsSIodhCe",
      "EventID": "24TYPT7R25a3wXUx3lrj0kXbE3i",
      "RequestID": "24TYPUXaNrGz0TCwBdCRahEI1eF",
      "EventDate": "2022-01-31T19:07:00Z",
      "Status": "Authorization Capture",
      "ResponseCode": "00",
      "Approved": true
    },
    {
      "TransactionID": "24Tw1wmSpO2dDnzM6zcxFyLyK1T",
      "EventID": "24Tw1ndacxgEKHemOQi7ezKXVK2",
      "RequestID": "24Tw1kWa2HMktcG5mwpXqwZVAHd",
      "EventDate": "2022-01-31T21:30:50Z",
      "Status": "Authorization Capture",
      "Error": "Terminal timeout detected",
      "Approved": false
    }
  ]
}

LIST ​

Available Functions ​

Perform transaction list query ​

REQUEST Object Attributes ​

REQUEST Example ​

RESPONSE Object Attributes ​