*Send Email With Report

Description

The sendEmailWithReport endpoint is used to send an email that includes the generated report as an attachment.

Request¶

Endpoint¶

ui/v1/sendEmailWithReport

Method¶

POST

Headers¶

Content-Type: application/json

ELEMENT	DESCRIPTION	FORMAT
reportRequestType	Required Array index
• name	Required	SETTLED_TRANSACTIONS
startDate	Required	2025-10-07
endDate	Required	2025-10-07
merchantId	Required	ID associated with the respective merchant
reportFileFormat	Required Array index
• name	Required	PDF
locale	Required	• en_US • fr_CA • de_DE • it_IT • pt_BR • es_MX

Body¶

{{
    "reportRequestType": [
        {
            "name": "SETTLED_TRANSACTIONS"
        }
    ],
    "startDate": "2025-10-06",
    "endDate": "2025-10-06",
    "merchantId": [
        "42"
    ],
    "reportFileFormat": [
        {
            "name": "PDF"
        }
    ],
    "download": false,
    "placeholderLines": 0,
    "transactionsGroupByType": null,
    "transactionStatus": null,
    "previousProcessorName": null,
    "filterTypeMonthYear": false,
    "locale": {
        "name": "en_US"
    }
}

Response¶

{
    "records": null,
    "recordCount": null,
    "message": {
        "code": "250",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "SETTLED_TRANSACTIONS_REPORT_EMAIL_NOTIFICATION_SENT",
        "parameters": null
    }
}

---

Updated As Of 6.7.1.0