This API call lets you retrieve the details of a specific transaction. The response is an XML of the available transaction information.
Request Fields
Field Name |
Type |
Required |
Description |
action |
String |
Yes |
transactionView |
accountId |
Integer |
Yes |
The Helcim Commerce account ID. |
apiToken |
String |
Yes |
API token used for authentication and access control. |
transactionId |
String |
Yes |
The transaction ID. |
Response Fields
Field Name |
Type |
Description |
transactions |
- |
XML structure |
transaction |
- |
XML structure |
id |
Integer |
The transaction ID. |
dateCreated |
String |
The date the transaction was created. |
status |
String |
Approved/Denied. |
user |
String |
The customer's name. |
type |
String |
The transaction type (Purchase, Pre-auth, Capture, Refund). |
amount |
Decimal |
The transaction amount. |
approvalCode |
String |
The approval code. |
avsResponse |
String |
Address verification response. |
cvvResponse |
String |
Card verification value response. |
test |
Integer |
1 or 0. Whether or not the transaction is processed as test. |
acquirerTransactionId |
Integer |
Transaction Id assigned by the acquirer to the transaction. |
responseMessage |
String |
Approved/Denied. |
ipAddress |
String |
The IP address. |
orderNumber |
String |
The order number. |
card |
- |
XML structure |
cardType |
String |
The credit card brand. |
cardNumber |
String |
The credit card number (first 4 and last 4 digits only). |
cardExpiry |
Integer |
The credit card expiry date. |
cardHolderName |
String |
The credit card holder's name. |
cardToken |
String |
The credit card token. |
card |
- |
XML structure |
batch |
- |
XML structure |
batchNumber |
Integer |
The batch number. |
terminal |
String |
The terminal the transaction was processed through. |
settled |
Integer |
1 or 0. Whether the transaction was settled or not. |
dateOpened |
String |
The date the batch was open. |
dateClosed |
String |
The date the batch was closed. |
Errors
For all API requests, there are also generic API authentication and user access restriction errors.
Response Code |
Error Code |
Message |
Description |
0 |
- |
Invalid Transaction ID |
The transaction ID is invalid, or not entered. |
0 |
- |
User Access Error - Transaction cannot be viewed by this user. |
The user does not have permission to view this transaction. |
0 |
- |
Invalid API Token1 |
The API Token is invalid, or not entered. |
0 |
- |
Missing or Invalid Fields - Account ID |
The Account ID is invalid, or not entered. |