| POST | /api/v1/transactionQuery | Gets a transaction details based on the passed in parameters | Gets a transaction details based on the passed in parameters |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApprovalNumber | body | string | No | Approval number |
| ApprovedAmount | body | decimal | No | Amount approved by the transaction. |
| ExpressTransactionDate | body | string | No | Express transaction date formatted YYYMMDD |
| ExpressTransactionTime | body | string | No | Express transaction time formatted HHMMSS |
| HostBatchId | body | string | No | Unique host batch identifier |
| HostItemId | body | string | No | Unique host batch reference number |
| ReverseOrder | body | BooleanTypeDto? | No | Flag to query records in descending order |
| TerminalId | body | string | No | Terminal identifier |
| TrackingId | body | string | No | Internal transaction tracking identifier |
| TransactionAmount | body | decimal | No | Transaction amount |
| TransactionDateTimeBegin | body | string | No | Begin date/time of transaction range. Required if TransactionID or TransactionSetupID is not included. Format "YYYY-MM-DD HH:MM:SS" |
| TransactionDateTimeEnd | body | string | No | End date/time of transaction range. Required if TransactionID or TransactionSetupID is not included. Format "YYYY-MM-DD HH:MM:SS" |
| TransactionId | body | string | No | TransactionID returned in original transaction. |
| TransactionSetupId | body | string | No | Transaction setup ID |
| TransactionStatus | body | string | No | Transaction status code |
| TransactionType | body | string | No | Transaction type |
| ReferenceNumber | body | string | No | A user defined reference number. |
| ShiftId | body | string | No | An optional shift id for reference. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReportingDataItems | form | List<ReportingDataItemDto> | No | Transaction information. A maximum of 1000 records can be returned. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Errors | form | List<ApiError> | No | A list of errors that occurred. |
| HasErrors | form | bool | No | Indicates if there are errors. |
| Links | form | IEnumerable<ApiLink> | No | A list of resource links |
| Logs | form | List<string> | No | A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose. |
| Type | form | string | No | The type of object held in the result. |
| Warnings | form | List<ApiWarning> | No | A list of warnings that occurred. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserMessage | form | string | No | An error message targeted at the end user of the integrated business application. |
| DeveloperMessage | form | string | No | An error message targeted at the developer of the integrated business application. |
| ErrorType | form | string | No | Code associated with the error if it exists. |
| ExceptionMessage | form | string | No | The body of the exception message. |
| ExceptionTypeFullName | form | string | No | The full name of the exception. |
| ExceptionTypeShortName | form | string | No | The short name of the exception. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Href | form | string | No | A target (a URI) |
| Method | form | string | No | The HTTP method to access the HREF target |
| Relation | form | string | No | The relation aka. 'rel' (the name of the link) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DeveloperMessage | form | string | No | A warning message targeted at the developer of the integrated business application. |
| UserMessage | form | string | No | A warning message targeted at the end user of the integrated business application. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AvsResponseCode | form | string | No | Address verification response code. |
| AcceptorId | form | string | No | Unique merchant account identifier. Assigned by Element Payment. |
| AccountId | form | string | No | Unique account ID. Assigned by Element Payment Services. |
| ApplicationId | form | string | No | Unique application identifier. This value is assigned by Element. |
| ApprovalNumber | form | string | No | Issuer assigned approval number. |
| ApprovedAmount | form | decimal | No | Approved dollar amount. |
| CvvResponseCode | form | string | No | Card verification value response code. |
| CardLogo | form | string | No | Brand of the card. Possible values include: Visa, Mastercard, Discover. |
| CardNumberMasked | form | string | No | Masked card account number. |
| CardType | form | string | No | Type of the card. |
| ExpirationMonth | form | string | No | Expiration month. |
| ExpirationYear | form | string | No | Expiration year. |
| ExpressResponseCode | form | string | No | The result of the transaction as determined by Express. |
| ExpressResponseMessage | form | string | No | A brief text description of the result of the transaction as determined. |
| ExpressTransactionDate | form | string | No | The date when Express processed the transaction. The format of this property is YYYYMMDD. |
| ExpressTransactionTime | form | string | No | The time when Express processed the transaction. The format of this property is HHMMSS where HH is 00-23. |
| HostBatchId | form | string | No | Host batch ID. |
| HostItemId | form | string | No | Host item ID. |
| HostResponseCode | form | string | No | Response code for the transaction returned by the host that processed. |
| HostResponseMessage | form | string | No | Response message for the transaction returned by the host that. |
| Name | form | string | No | Name. |
| ReferenceNumber | form | string | No | User assigned reference number. |
| TerminalId | form | string | No | Unique terminal identifier assigned by Element Payment Serivces. |
| TimeStamp | form | string | No | Address verification response code. |
| TrackDataPresent | form | bool | No | Indicates whether track data was present in the transaction. |
| TrackingId | form | string | No | Tracking ID. |
| TransactionAmount | form | decimal | No | Dollar amount of the transaction. |
| TransactionId | form | string | No | Unique transaction identifier. |
| TransactionStatus | form | string | No | Description of the status/state of the transaction. |
| TransactionStatusCode | form | string | No | Status/state of the transaction. |
| TransactionType | form | string | No | Type of transaction. |
| ExpressEnumIntExpressResponseCode | form | int | No | Express Enum Int Express Response Code. |
| ExpressEnumIntTransactionStatusCode | form | int | No | Express Enum Int Transaction Status Code. |
| ExpressBoolStringTrackDataPresent | form | string | No | Express Bool String Track Data Present. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/TransactionQueryRequest HTTP/1.1
Host: triposqa.vantiv.com
Content-Type: application/json
Content-Length: length
{"approvalNumber":"String","approvedAmount":0,"expressTransactionDate":"String","expressTransactionTime":"String","hostBatchId":"String","hostItemId":"String","reverseOrder":"False","terminalId":"String","trackingId":"String","transactionAmount":0,"transactionDateTimeBegin":"String","transactionDateTimeEnd":"String","transactionId":"String","transactionSetupId":"String","transactionStatusCode":"String","transactionType":"String","referenceNumber":"String","shiftId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"reportingData":[{"AvsResponseCode":"String","AcceptorId":"String","AccountId":"String","ApplicationId":"String","ApprovalNumber":"String","ApprovedAmount":0,"CvvResponseCode":"String","CardLogo":"String","CardNumberMasked":"String","CardType":"String","ExpirationMonth":"String","ExpirationYear":"String","ExpressResponseCode":"String","ExpressResponseMessage":"String","ExpressTransactionDate":"String","ExpressTransactionTime":"String","HostBatchId":"String","HostItemId":"String","HostResponseCode":"String","HostResponseMessage":"String","Name":"String","ReferenceNumber":"String","TerminalId":"String","TimeStamp":"String","TrackDataPresent":false,"TrackingId":"String","TransactionAmount":0,"TransactionId":"String","TransactionStatus":"String","TransactionStatusCode":"String","TransactionType":"String","ExpressEnumIntExpressResponseCode":0,"ExpressEnumIntTransactionStatusCode":0,"ExpressBoolStringTrackDataPresent":"String"}],"_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}