Description

The sendInvoicePaymentLink endpoint allows the admin users to send a secure payment link to the customer to make the payment.

Request

Endpoint

    ui/v1/sendInvoicePaymentLink

Method

    POST

Header

Content-Type: application/json

Request Body

[
  {
    "itemType": {
      "name": "INVOICE_PAYMENT"
    },
    "itemId": "233358",
    "secondaryItemId": "53345",
    "merchantId": 42,
    "userId": "2193",
    "deliveryMethod": {
      "name": "EMAIL"
    },
    "locale": {
      "name": "en_US"
    },
    "contactInfo": "user@email.com",
    "emailSubject": "Pay Your ABCcomp Invoice Now!",
    "customerName": "Ivy Rehan"
  }
]

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 7.0.1