/send_sms

post

https://api.paynearme-sandbox.com/json-api/send_sms

Create and send an SMS message to the consumer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Creates and sends a new SMS message

Creates and sends an SMS message

site_identifier

string

required

Defaults to S2411573363

Identifies your client site.

timestamp

string

required

The Unix Epoch time of the call

version

string

required

Defaults to 3.0

The version of the API. This version must match the version associated with your API key pair.

signature

string

The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm.

NOTE: This field is required when authenticating with the HMAC signature method; it is not required when authenticating with OAuth 2.0.

recipients

string

required

Defaults to 2145589687

The mobile phone number where you are sending the text. Use commas to separate numbers when sending the message to multiple recipients. NOTE: Upon request, PayNearMe can configure the /send_sms endpoint to return an error response for numbers blocked due to STOP opt-outs. Contact your Technical Account Manager for configuration details.

body_text

string

required

Defaults to Your bill was due yesterday. Please remit payment as soon as possible.

The text of the SMS message. This parameter does not support HTML or special characters like emojis.

body_spanish

string

Defaults to Tu factura vencía ayer. Por favor envíe el pago lo antes posible.

The text of the SMS message in Spanish. This parameter does not support HTML

language

string

enum

Indicates which version of the SMS message should be sent to the specified recipient. Options include

en - English
sp- Spanish

If sending the message in Spanish, the body_spanish parameter must be included.

Allowed:

Responses

200SMS Sent