Sending the Paylink SMS

To send the paylink SMS to the intended recipient:

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

Request Parameters

Field Name	Description	Field Type
phone	This field has phone number in ###-###-#### or ########## format.	String
link	This field has the paylink URL.	String
merchantName	This field has the Merchant DBA.	String
message	This field has the message text to send to the recipient.	String

Request Sample Code

{ 
    "phone": "678-999-8212", 
    "link": "https://gateway.clearent.net/paylink/Q6mEwmXKzG7", 
    "merchantName": "Los Pollos Hermanos"      
} 

Response

• code (numeric) - This parameter includes the following HTTP Status response codes.

Code	Status
201	Success
400	Fail
500	Error

Error Response

• code (numeric) - This parameter includes the following HTTP Status response codes.

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 [phone] is not a valid phone number	867

Response Sample Code

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