v1

latestOpenAPI 3.0.02026-07-2671142187.3 KB

Card Transaction

Collects up to 1000 Card Transactions

get/card-transactions

Query parameters

dateFromstring

Filters transactions created from 2020-01-01 (Mountain Time)

dateTostring

Filters transactions created until 2021-01-01 (Mountain Time)

searchstring

Searches amount, card number(F6L4 only), cardholder name, & approval codes

customerCodestring

The code of the customer associated with the transaction

invoiceNumberstring

The number of the invoice associated with the transaction

cardTokenstring

The token of the card associated with the transaction

cardBatchIdinteger

The id of the batch associated with the transaction

limitinteger

The limit number of transactions will be returned in one request. We only allow maximum 1000 objects per request. If no limit specified, the default limit will be 1000 objects.

pageinteger

Specifies the page number of the results you want to retrieve.

Response

Successful

transactionIdnumber

The transaction id

cardBatchIdnumber

The id of associated card batch

dateCreatedstring

The date(Mountain Time) when the transaction is created.

statusstring

The status of the transaction. possible values are APPROVED | DECLINED

userstring

Full name of the user who processed the transaction. Default value is Helcim System

typestring

The type of the transaction. possible values are purchase | preauth | verify

amountnumber

The amount of processed transaction

currencystring

The abbreviation of the transaction's currency

avsResponsestring

AVS Response

cvvResponsestring

CVV Response

cardTypestring

Abbreviated card issuer name

VI - Visa
MC - MasterCard
AX - American Express
DI - Discover
DCI - Diners Club
JCB - JCB
UP - China Union Pay
MR - Maestro
AF - AFFN
AO - Alaska Option
CU - Credit Union 24
EB - EBT Network
EX - Accel
IL - Interlink
NT - Nets
NY - NYCE
PS - Pulse
ST - Star
SZ - Shazam
AT - ATH
IN - Interac
DB - Debit

approvalCodestring

Approval Code

cardTokenstring

Card token associated to the transaction

cardNumberstring

First-6 Last-4 numbers of the card number associated to the transaction

cardHolderNamestring

Cardholdername associated to the transaction

customerCodestring

Customer code associated to the transaction

invoiceNumberstring

Invoice number associated to the transaction

warningstring

Warnings

Example response

[
  {
    "transactionId": 10,
    "cardBatchId": 11,
    "dateCreated": "2020-01-01 00:00:00",
    "status": "APPROVED",
    "user": "Helcim System",
    "type": "purchase",
    "amount": 11.99,
    "currency": "CAD",
    "avsResponse": "M",
    "cvvResponse": "Y",
    "cardType": "Visa",
    "approvalCode": "HCMAPPRV",
    "cardToken": "5454HCMXTEST5454",
    "cardHolderName": "John Smith",
    "customerCode": "CST1010",
    "invoiceNumber": "INV2022",
    "warning": "Failed to link customer to invoice"
  }
]