Transaction Report

Settled Transactions Report

Description

The transactionReport endpoint retrieves transactions according to the specified category.

Request¶

Endpoint¶

ui/v1/transactionReport

Method¶

POST

Headers¶

Content-Type: application/json

ELEMENT	DESCRIPTION	FORMAT
reportRequestType	*Required* Array index
• name	*Required*	• ADHOC_INVOICE • BILLING_REPORT_MODEL_2 • AGING_AUTHORIZATIONS • SETTLED_TRANSACTIONS • SUMMARY_BY_TYPE • TRANSACTION_SUMMARY
startDate	*Required*	2025-10-07
endDate	*Required*	2025-10-07
merchantId	*Required*	ID associated with the respective merchant
reportFileFormat	*Required* Array index
• name	*Required*	• HTML • PDF • CSV • XLSX • DOCX • XSLX
locale	*Required*	• en_US • fr_CA • de_DE • it_IT • pt_BR • es_MX

Body¶

{
    "reportRequestType": [
        {
            "name": "AGING_AUTHORIZATIONS"
        }
    ],
    "startDate": "2025-10-07",
    "endDate": "2025-10-07",
    "merchantId": [
        "11"
    ],
    "reportFileFormat": [
        {
            "name": "HTML"
        }
    ],
    "download": false,
    "placeholderLines": 0,
    "transactionsGroupByType": null,
    "transactionStatus": null,
    "previousProcessorName": null,
    "filterTypeMonthYear": false,
    "locale": {
        "name": "en_US"
    }
}

Updated As Of 6.7.1.0