Skip to content

Retrieve Transactions

Retrieves a filtered, paginated list of transactions with all available information. If information is not available is not provided in response.

URL test:

    https://test.lightcms.io/trancore/v1/trancore/transactions?cardId=12345&transactionType=RTL&page=0&size=20&sort=CREATED_AT,desc

Method:

GET

Path items:

/trancore/transactions

Parameters:

Parameter Location Type Example Description Required
cardId query integer 12345 Exact CMS card ID. No
transactionType query string RTL,ATM Comma‑separated list of transaction types (see /v1/trancore/transactiontypes). No
merchantId query string M123456 Merchant identifier. No
terminalId query string TERM001 Terminal identifier. No
mcc query integer 5812 Merchant Category Code. No
mccGroup query string RETAIL MCC group code. No
retrievalReferenceNumber query string RRN123456789 Retrieval Reference Number. No
transactionDirection query string DEBIT,CREDIT Comma‑separated list of directions (DEBIT, CREDIT, NON_FINANCIAL). No
transactionOriginalCurrency query string USD,EUR Comma‑separated list of ISO‑4217 currency codes of the original transaction currency. No
effectiveAmountFrom query number 10.00 Minimum effective amount (issuer currency). No
effectiveAmountTo query number 1000.00 Maximum effective amount (issuer currency). Must be ≥ effectiveAmountFrom. No
effectiveAmountIssuerCurrencyFrom query number 9.00 Minimum effective amount in issuer currency. No
effectiveAmountIssuerCurrencyTo query number 950.00 Maximum effective amount in issuer currency. Must be ≥ effectiveAmountIssuerCurrencyFrom. No
oldEffectiveAmountFrom query number 5.00 Minimum previous effective amount. No
oldEffectiveAmountTo query number 500.00 Maximum previous effective amount. Must be ≥ oldEffectiveAmountFrom. No
oldEffectiveAmountIssuerCurrencyFrom query number 4.50 Minimum previous amount in issuer currency. No
oldEffectiveAmountIssuerCurrencyTo query number 450.00 Maximum previous amount in issuer currency. Must be ≥ oldEffectiveAmountIssuerCurrencyFrom. No
cardEntryMode query string CONTACTLESS,CHIP_READ Comma‑separated list of entry modes (see /v1/trancore/cardEntryMode). No
cardHolderVerifications query string PIN,BIO Comma‑separated list of verification methods (see /v1/trancore/cardHolderVerifications). No
tokenCategory query string APPLE_PAY,GOOGLE_PAY Comma‑separated list of token categories (see /v1/trancore/tokenCategories). No
holdExpiryDatetimeFrom query string 2025-07-01T00:00:00Z Lower bound for hold expiry datetime (ISO‑8601). No
holdExpiryDatetimeTo query string 2025-07-31T23:59:59Z Upper bound for hold expiry datetime (ISO‑8601). Must be ≥ holdExpiryDatetimeFrom. No
postedDateFrom query string 2025-07-01 Lower bound for posted date (YYYY‑MM‑DD). No
postedDateTo query string 2025-07-31 Upper bound for posted date (YYYY‑MM‑DD). Must be ≥ postedDateFrom. No
authRecordReferenceId query string AUTH123456 Authorization record reference ID. No
subMerchantId query string SUB123 Sub‑merchant identifier. No
cardAcceptorName query string "Best Shop" Card acceptor (merchant) name – case‑insensitive partial match. No
tokenId query string 1234 Last 4 digits of the token ID. No
dpan query string 411111**1111 Full DPAN (masked primary account number). No
status query string APPROVED,DECLINED Comma‑separated list of transaction statuses (see /v1/trancore/transactionstatus). No
page query integer 0 Page index (default 0). No
size query integer 20 Page size (default 20). No
sort query string CREATED_AT,desc Sort field and direction; default CREATED_AT,desc. See /v1/trancore/sortingFields for allowed fields. No

Example:

    curl -X GET "https://test.lightcms.io/trancore/v1/trancore/transactions?cardId=12345&transactionType=RTL&page=0&size=20&sort=CREATED_AT,desc" \
         -H 'accept: */*'

Responses:

200 - OK

Status Code: 200 OK 

[
  {
    "transactionId": 0,
    "cardId": 0,
    "effectiveAmount": 0,
    "effectiveAmountIssuerCurrency": 0,
    "transactionOriginalCurrency": "string",
    "cardAcceptorName": "string",
    "transactionStatus": "string",
    "cardEntryMode": "UNKNOWN",
    "cardHolderVerifications": "string",
    "tokenCategory": "APPLE_PAY",
    "transactionType": "ATM",
    "simpleResponseCode": "string",
    "oldEffectiveAmount": 0,
    "issuerCurrency": "string",
    "oldEffectiveAmountIssuerCurrency": 0,
    "postedDate": "2025-12-30",
    "mcc": "string",
    "mccGroup": "string",
    "tokenId": "string",
    "holdExpiryDatetime": "2025-12-30T08:47:34.874Z",
    "retrievalReferenceNumber": "string",
    "cardAcceptorCountryCode": "string",
    "cardAcceptorCity": "string",
    "merchantId": "string",
    "subMerchantId": "string",
    "terminalId": "string",
    "aggregator": "string",
    "localTransactionDateTime": "2025-12-30T08:47:34.874Z",
    "transactionDirection": "string",
    "cardAcceptorEnrichmentSource": "string",
    "paymentGatewayName": "string",
    "paymentGatewayUrl": "string",
    "paymentGatewayLogoImageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cardAcceptorLogoImageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cardAcceptorShopType": "string",
    "cardAcceptorCategory": "string",
    "cardAcceptorCategoryLogoImageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cardAcceptorPhoneNumber": "string",
    "cardAcceptorWeb": "string",
    "cardAcceptorGooglePlaceId": "string",
    "cardAcceptorStreet": "string",
    "cardAcceptorZip": "string",
    "cardAcceptorAddressAreas": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "cardAcceptorAddressUnid": "string",
    "cardAcceptorTags": ["string"],
    "cardAcceptorOtherCategories": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "cardAcceptorOtherTags": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "cardAcceptorCoordinatesType": "string",
    "cardAcceptorCoordinatesLat": 0,
    "cardAcceptorCoordinatesLon": 0,
    "cardAcceptorCoordinatesZoom": 0,
    "co2FootprintValue": 0,
    "co2FootprintUnit": "string",
    "subscriptionAutomaticCharging": true,
    "subscriptionFrequency": "string",
    "subscriptionNextAmountType": "string",
    "subscriptionNextBillingDate": "2025-12-30"
  }
]

Parameter Location Type Description
transactionId root integer Unique identifier of the transaction.
cardId root integer CMS card identifier.
effectiveAmount root number Effective amount in original currency.
effectiveAmountIssuerCurrency root number Effective amount converted to issuer currency.
transactionOriginalCurrency root string ISO‑4217 code of the original transaction currency.
cardAcceptorName root string Name of the card acceptor (merchant).
transactionStatus root string Current status of the transaction (e.g., APPROVED, DECLINED).
cardEntryMode root string Card entry mode (e.g., UNKNOWN, CONTACTLESS, CHIP_READ).
cardHolderVerifications root string Verification method used (e.g., PIN, BIO).
tokenCategory root string Token category (e.g., APPLE_PAY).
transactionType root string Type of transaction (e.g., ATM, RTL).
simpleResponseCode root string Simplified response code indicating the outcome or reason.
oldEffectiveAmount root number Previous effective amount before the current update.
issuerCurrency root string ISO‑4217 code of the issuer currency.
oldEffectiveAmountIssuerCurrency root number Previous effective amount in issuer currency.
postedDate root string Date the transaction was posted (YYYY‑MM‑DD).
mcc root string Merchant Category Code.
mccGroup root string MCC group classification.
tokenId root string Token identifier (masked or partial).
holdExpiryDatetime root string Hold expiry datetime (ISO‑8601).
retrievalReferenceNumber root string Retrieval Reference Number (RRN).
cardAcceptorCountryCode root string Country code of the card acceptor (ISO‑3166‑1 alpha‑2).
cardAcceptorCity root string City of the card acceptor.
merchantId root string Merchant identifier.
subMerchantId root string Sub‑merchant identifier.
terminalId root string Terminal identifier.
aggregator root string Aggregator name (if applicable).
localTransactionDateTime root string Local date‑time of the transaction (ISO‑8601, no offset).
transactionDirection root string Direction of the transaction (DEBIT, CREDIT, NON_FINANCIAL).
cardAcceptorEnrichmentSource root string Source of additional card‑acceptor enrichment data.
paymentGatewayName root string Name of the payment gateway used.
paymentGatewayUrl root string URL of the payment gateway.
paymentGatewayLogoImageId root string UUID of the payment‑gateway logo image.
cardAcceptorLogoImageId root string UUID of the card‑acceptor logo image.
cardAcceptorShopType root string Shop type of the card acceptor (e.g., ONLINE, PHYSICAL).
cardAcceptorCategory root string Category of the card acceptor.
cardAcceptorCategoryLogoImageId root string UUID of the category logo image.
cardAcceptorPhoneNumber root string Contact phone number of the card acceptor.
cardAcceptorWeb root string Website URL of the card acceptor.
cardAcceptorGooglePlaceId root string Google Place ID for the card acceptor location.
cardAcceptorStreet root string Street address of the card acceptor.
cardAcceptorZip root string ZIP/postal code of the card acceptor.
cardAcceptorAddressAreas root object Additional address area information (free‑form map).
cardAcceptorAddressUnid root string Unique identifier for the address record.
cardAcceptorTags root array List of tags associated with the card acceptor.
cardAcceptorOtherCategories root object Additional categories (free‑form map).
cardAcceptorOtherTags root object Additional tags (free‑form map).
cardAcceptorCoordinatesType root string Type of coordinate system used (e.g., WGS84).
cardAcceptorCoordinatesLat root number Latitude of the card acceptor location.
cardAcceptorCoordinatesLon root number Longitude of the card acceptor location.
cardAcceptorCoordinatesZoom root number Zoom level for map display.
co2FootprintValue root number Estimated CO₂ footprint value.
co2FootprintUnit root string Unit of the CO₂ footprint (e.g., kg).
subscriptionAutomaticCharging root boolean Indicates if subscription charges are automatic.
subscriptionFrequency root string Frequency of the subscription (e.g., MONTHLY).
subscriptionNextAmountType root string Type of the next amount (e.g., FIXED, VARIABLE).
subscriptionNextBillingDate root string Date of the next billing cycle (YYYY‑MM‑DD).
500 - Internal error

Status Code: 500 Internal error 

{
  "timestamp": "2025-07-22T13:09:02.348+02:00",
  "status": 500,
  "error": "Internal Server Error",
  "path": "/cms/v1/trancore/transactions"
}

Parameter Location Type Description
timestamp root string ISO‑8601 timestamp when the error occurred.
status root integer HTTP status code (500).
error root string Short description of the error.
path root string The request path that caused the error.