Email Transaction Details

Description

The emailTransactionDetailsToRecipients endpoint facilitates the delivery of transaction details to designated recipients through email.

Request

Endpoint

/ui/v1/emailTransactionDetailsToRecipients

Method

POST

Content-Type: application/json
Authorization: Basic $TOKEN

Note

Replace $TOKEN in the request with the base64-encoded username/password combination in the format username:password.

Given a username of username and a password of password, the request header would appear as follows:

Content-Type: application/json
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Request Body

{
    "orderId": [
        "100000001234"
    ],
    "emailSubject": "ABC Co® Transaction Receipt",
    "emailAddress": [
        "testuser@email.com",
        "",
        "",
        "",
        ""
    ],
    "merchantId": 11,
    "transactionInfoId": 12345,
    "locale": {
        "name": "en_US"
    }
}

Response

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

Updated As Of Version 6.7.0