STATUS

STATUS provides a method to query a single transaction. The transaction is specified by placing the transaction ID in the query status 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.

Only one transaction is returned since this query is by transaction ID.

Successful requests will be indicated with a 2xx HTTP response code and the Approved attribute set to 'true'. NOTE: It is possible to receive a 2xx HTTP response code and have the Approved attribute set to 'false'.

Available Functions

Perform transaction status query

GET, /v0/query/transaction/status

REQUEST Object Attributes

Status Request Table

Attribute	Data Type	Description
TransactionID	ksuid	TransactionID from original transaction response

REQUEST Example

Code For Request Example

URL=https://api.qa.paynetworx.net/v0/query/transaction/status
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "TransactionId": "24TYPcWqX7F4DboNPcmsSIodhCe"
}'

RESPONSE Object Attributes

Status Response Table

Attribute	Data Type	Description
TransactionID	ksuid	Unique query 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	Latest transaction status for a single transaction
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 or false) Approved is aKey/Value of the "Transactions" Object.

RESPONSE Example

Code for Response Example

{
  "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
  "EventID": "1XSnvq7J5ggxZg70sWuRg4kEBcu",
  "RequestID": "1XSnzEjZ4IBh5Nj0OEVPTWpwYo8",
  "Approved": true,
  "Transactions": [
    {
      "TransactionID": "24TYPcWqX7F4DboNPcmsSIodhCe",
      "EventID": "24TYPT7R25a3wXUx3lrj0kXbE3i",
      "RequestID": "24TYPUXaNrGz0TCwBdCRahEI1eF",
      "EventDate": "2022-01-31T19:07:00Z",
      "Status": "Authorization Capture",
      "ResponseCode": "00",
      "Approved": true
    }
  ]
}