Sending the Paylink by SMS

To send the paylink by SMS:

1

Use the POST method with the /rest/v2/sms-reg/send-sms endpoint.

2

Add the parameters as shown in the following sample request body.

{
    "phone": "678-999-8212",
    "link": "https://gateway-sb.clearent.net/paylink/919922950769/10011120?amount=41.33",
    "merchantName": "Los Pollos Hermanos"
}

The following table describes the request body parameters:

Name	Data type	Required?	Description
phone	Numeric	Required	The recipient’s phone number in either ###-###-#### or ########## format. The field requires exactly 12 characters.
link	String	Required	The paylink URL.
merchantName	String	Required	The merchant’s “doing business as” (DBA) name.

The following response code appears when the paylink is sent successfully:

{
    "code": "201",
    "status": "SUCCESS",
    "exchange-id": "ID-clearent-sms-registration-1-123456789-1011-1213-1415-e4f438233dd5"
}

The following table describes the fields in the response body for the sent paylink:

Name	Data type	Description
code	Numeric	The HTTP status code returned in the response.
status	Text	A text in response to your API authentication request, such as: Success: The API request was authenticated successfully. Fail: The API request failed authentication.
exchange-id	String	The GUID (Global Unique Identifier) associated with the paylink sent to the intended recipient.