Transaction History

Description

The transactionHistory endpoint is used to retrieve a list of payments for an authorized user over a given time period.

Request

Endpoint

/ui/v1/transactionHistory

Method

POST
Content-Type: application/json
Authorization: Digest nonce="0cada2c21ae94896", nl="16", token="480771ff499c028178f560e395bb0d21"  

Header Attributes

ELEMENT DESCRIPTION FORMAT
Content-Type **Required****

Specifies the media type of the request body.
application/json
Authorization **Required****

Authentication information used to authorize the request.

The Digest authorization header contains the nonce, nonce length (nl), and token.
Digest nonce="{nonce}", nl="{nonceLength}", token="{token}"
• nonce **Required****

Unique value used as part of the request authentication.
e.g., 0bafa2c21ae94792
• nl **Required****

Nonce Length. Specifies the length of the nonce value.
e.g., 19
• token **Required****

token is the MD5 of (Merchant Code : Secret : DATE in UTC : Nonce : Nonce Length).
MD5 hash

Attributes

ELEMENT DESCRIPTION FIELD CONSTRAINTS
startDate Required

Specifies the start date for the transaction search.
Date format is defined at the merchant level based on merchant-specific requirements.

e.g., YYYY-MM-DD
endDate Required

Specifies the end date for the transaction search.
Date format is defined at the merchant level based on merchant-specific requirements.

e.g., YYYY-MM-DD
dateType Required

Specifies the type of date used for the transaction search.
Must contain a valid name value, such as TRANSACTION.
userId Required

Unique identifier of the user performing the search.
Must be a valid numeric user ID.
transactionType Optional

Specifies the transaction type(s) to include in the search.

Transaction Types
Array of transaction type IDs or values. Can be empty.
paymentGateway Optional

Specifies the payment gateway(s) to include in the search.

Payment Gateways
Array of payment gateway IDs or values. Can be empty.
transactionCategory Optional

Specifies the transaction category/categories to include in the search.

Transaction Categories
Array of transaction category IDs or values. Can be empty.
transactionStatus Optional

Specifies the transaction status(es) to include in the search.

Transaction Statuses
Array of transaction status IDs or values. Can be empty.
paymentMethodType Optional

Specifies the payment method type(s) to include in the search.

Payment Method Types
Array of payment method types. Can be empty.
currencyId Optional

Specifies the currency/currencies used for the transaction search.
Array of currency IDs. Can be empty.
channelId Optional

Specifies the transaction channel(s) to include in the search.
Array of channel IDs. Can be empty.
posTerminalId Optional

Specifies the POS terminal(s) to include in the search.
Array of POS terminal IDs. Can be empty.
createdUserId Optional

Filters transactions based on the user who created them.
Array of user IDs. Can be empty.
transactionOwnerId Optional

Filters transactions based on the transaction owner.
Array of user IDs. Can be empty.
posEntryMode Optional

Specifies the POS entry mode(s) used for the transaction.

POS Entry Modes
Array of POS entry modes. Can be empty.
merchantId Optional

Specifies the merchant(s) to include in the search.
Array of merchant IDs. Can contain one or more numeric merchant IDs.
customerId Optional

Specifies the customer(s) to include in the search.
Array of customer IDs. Can be empty.
productId Optional

Specifies the product to include in the search.
Array of product IDs. Can be empty.
productIds Optional

Specifies multiple products to include in the search.
Array of product IDs. Can be empty.
batchStatuses Optional

Specifies the batch status(es) to include in the search.

Batch Statuses
Array of batch statuses. Can be empty.
fromAmount Optional

Specifies the minimum transaction amount for the search.
Numeric value. Can be an empty string when no minimum amount is specified.
toAmount Optional

Specifies the maximum transaction amount for the search.
Numeric value. Can be an empty string when no maximum amount is specified.
memo Optional

Filters transactions based on memo information.
String value or null.
orderId Optional

Filters transactions using the order ID.
String or numeric value, or null.
cardNetworkTransctionId Optional

Filters transactions using the card network transaction ID.
String value, or null.
eightDigitBIN Optional

Filters transactions using the first eight digits of the card BIN.
Must contain an eight-digit BIN when provided; otherwise null.
lastFourDigitsOfAcctNum Optional

Filters transactions using the last four digits of the account number.
Must contain the last four digits when provided; otherwise null.
pymtGtwyRefNumber Optional

Filters transactions using the payment gateway reference number.
String value, or null.
postPreAuthorizationStatus Optional

Specifies the post-pre-authorization status used for the transaction search.
Array List. Can be empty.
binIssuingCountryCode Optional

Specifies the issuing country code(s) associated with the card BIN used for the transaction search.
Array List. Can be Empty.
paymentType Optional

Specifies the payment type(s) used for the transaction search.

Payment Types
Array list of valid payment types. Can be empty.
invoiceNumber Optional

Filters transactions using the invoice number.String value or null.
salesOrderNumber Optional

Filters transactions using the Sales Order number.
String value or null.
customerNumber Optional

Filters transactions using the Customer number.
String value or null.
bookingNumber Optional

Filters transactions using the booking number.
String value or null.
membershipNumber Optional

Filters transactions using the membership number.
String value or null.
billingEmail Optional

Filters transactions using the billing email address.
Must be a valid email address when provided; otherwise null..
authCode Optional

Filters transactions using the authorization code.
String value or null.
addTokenAsPartOfPaymentSubmission Optional

Specifies whether the token should be added as part of the payment submission.
Single Select Enumeration

Request Body

{
    "startDate": "2026-10-01",
    "endDate": "2026-10-06",
    "dateType": {
        "name": "TRANSACTION"
    },
    "userId": 752,
    "transactionType": [],
    "paymentGateway": [],
    "transactionCategory": [],
    "transactionStatus": [],
    "paymentMethodType": [],
    "currencyId": [],
    "channelId": [],
    "posTerminalId": [],
    "createdUserId": [],
    "transactionOwnerId": [],
    "posEntryMode": [],
    "merchantId": [
        42
    ],
    "customerId": [],
    "productId": [],
    "productIds": [],
    "batchStatuses": [],
    "fromAmount": "",
    "toAmount": "",
    "memo": null,
    "orderId": null,
    "cardNetworkTransactionId": null,
    "eightDigitBIN": null,
    "lastFourDigitsOfAcctNum": null,
    "pymtGtwyRefNumber": null,
    "invoiceNumber": null,
    "salesOrderNumber": null,
    "bookingNumber": null,
    "membershipNumber": null,
    "billingEmail": null,
    "authCode": null
}

Response

{
    "records": [
        {
            "id": 9666,
            "amount": 10.00,
            "amountValue": null,
            "paymentMethod": "MASTERCARD",
            "refundMethod": {
                "name": "ORIGINAL_PAYMENT_METHOD"
            },
            "transactionDate": "2026-10-05 11:23 AM -05:00",
            "postingDate": "2026-10-05",
            "paymentStatus": {
                "name": "PROCESSED"
            },
            "accountHolderName": "",
            "accountNumber": "XXXXXXXXXXXX0078",
            "currencyCode": "USD",
            "pymtGtwyRefNumber": "051026C87-29293A1E-4C1E-4F13-AF83-33D7E855B7FD",
            "orderId": "f7e2d8ba-3a67-4d95-a3c2-b7e172520dce",
            "invoiceNumber": null,
            "salesOrderNumber": "",
            "customerNumber": "",
            "transactionCategory": {
                "name": "CARD_PRESENT"
            },
            "transactionStatus": {
                "name": "SUCCESS"
            },
            "batchStatus": {
                "name": "PROCESSED"
            },
            "paymentGatewayName": "Elavon (Commerce SDK)",
            "transactionType": {
                "name": "SALE"
            },
            "transactionTypeText": "Sale",
            "channelName": "elavon-commerce SDK",
            "createdUserName": "ElavonCPadmin",
            "transactionOwnerUserName": "ElavonCPadmin",
            "terminalName": "3091200936127307",
            "terminalEntryMode": {
                "name": "EMV_CONTACT_WIRED"
            },
            "merchantName": "Vela-Atlanta",
            "bookingNumber": "",
            "groupName": "",
            "routingLevel": {
                "name": "PRIMARY"
            },
            "productName": "",
            "checkInDate": "",
            "checkOutDate": "",
            "customerName": "John Smith",
            "convenienceFees": 0.00,
            "billingEmail": "john.smith@gmail.com",
            "billingMobileNumber": "",
            "authCode": "181907",
            "responseCode": "00",
            "responseMsg": "",
            "subscriptionId": null,
            "expirationMonthYear": "12/2049",
            "voidActionInd": false,
            "refundActionInd": false,
            "captureActionInd": false,
            "incrementalAuthActionInd": false,
            "reAuthActionInd": false,
            "totalRefundedAmount": null,
            "paymentType": {
                "name": "SINGLE_PAYMENT"
            },
            "hasTransactionDocuments": false,
            "roomNumber": "",
            "addTokenAsPartOfPaymentSubmission": false,
            "qrcodeBase64Image": null,
            "qrcodeCopyURL": null,
            "qrcodePayment": false
        },
        {
            "id": 9665,
            "amount": 10.00,
            "amountValue": null,
            "paymentMethod": "MASTERCARD",
            "refundMethod": {
                "name": "ORIGINAL_PAYMENT_METHOD"
            },
            "transactionDate": "2026-10-05 11:22 AM -05:00",
            "postingDate": "2026-10-05",
            "paymentStatus": {
                "name": "PROCESSED"
            },
            "accountHolderName": "",
            "accountNumber": "XXXXXXXXXXXX0078",
            "currencyCode": "USD",
            "pymtGtwyRefNumber": "051026C87-9DECBFE9-0332-4BEF-9E83-23BFB4A5A498",
            "orderId": "ae3f0f4a-5a70-407a-b106-58500835a8fb",
            "invoiceNumber": null,
            "salesOrderNumber": "",
            "customerNumber": "",
            "transactionCategory": {
                "name": "CARD_PRESENT"
            },
            "transactionStatus": {
                "name": "SUCCESS"
            },
            "batchStatus": {
                "name": "PROCESSED"
            },
            "paymentGatewayName": "Elavon (Commerce SDK)",
            "transactionType": {
                "name": "SALE"
            },
            "transactionTypeText": "Sale",
            "channelName": "elavon-commerce SDK",
            "createdUserName": "ElavonCPadmin",
            "transactionOwnerUserName": "ElavonCPadmin",
            "terminalName": "3091200936127307",
            "terminalEntryMode": {
                "name": "EMV_CONTACTLESS_WIRED"
            },
            "merchantName": "Vela-Atlanta",
            "bookingNumber": "",
            "groupName": "",
            "routingLevel": {
                "name": "PRIMARY"
            },
            "productName": "",
            "checkInDate": "",
            "checkOutDate": "",
            "customerName": "Lee Jones",
            "convenienceFees": 0.00,
            "billingEmail": "lee.jones@gmail.com",
            "billingMobileNumber": "",
            "authCode": "181879",
            "responseCode": "00",
            "responseMsg": "",
            "subscriptionId": null,
            "expirationMonthYear": "12/2049",
            "voidActionInd": false,
            "refundActionInd": false,
            "captureActionInd": false,
            "incrementalAuthActionInd": false,
            "reAuthActionInd": false,
            "totalRefundedAmount": null,
            "paymentType": {
                "name": "SINGLE_PAYMENT"
            },
            "hasTransactionDocuments": false,
            "roomNumber": "",
            "addTokenAsPartOfPaymentSubmission": false,
            "qrcodeBase64Image": null,
            "qrcodeCopyURL": null,
            "qrcodePayment": false
        }
    ],
    "recordCount": null,
    "message": null
}

Updated as of Version 7.2.x