All pages
Powered by GitBook
1 of 1

Sending the paylink

To send the paylink via 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 intended recipient's phone number in ###-###-#### or ########## format. ℹ️ 12 Number of characters are required.

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.

The following table describes the HTTP status codes in the response body:

Code
Status
Message
Result Code

500

Success

System Error Other.

073

500

Fail

Required request body content is missing, malformed, or datatype usage (ex- Boolean, number) is invalid.

090

500

Error

The ‘To’ number +15555555 is not a valid phone number.

867