Payment Reminders

Send payment reminders to clients through text or e-mail

As an integrator, you may wish to send a payment reminder to a client through a text or e-mail which will allow them to pay the amount due. Here's an example reminder:

You have a payment due to Merchant XYZ of $125.00 due on 10/4/2016. Please follow the link below to make the payment. https://easypay5.com/stdwidget/?SP=E8E5EC

Once they receive the reminder, they can click the link that is sent along with the message to open a payment page. This will allow them to enter their card details and make a payment.

After the payment is submitted, a transaction receipt would be sent to the e-mail address on file.

Implementation

To send a payment reminder using the REST API, use the Text to Payendpoint.

Request

Both implementations use a similar body structure, and the fields are described below.

Field name	Description
Person	The name, address, email, and phone number for the payee.
MessageType	The type of message for the payee. EMAIL: Send an email with a link to the payment form URLONLY: Only return a URL to the payment form in the response TEXT: Send a text message with a link to the payment form
RefID	A custom user-defined field to save with the transaction.
RPGUID	Another custom user-defined field to save with the transaction.
MessageBody	The message to send. Use **Merch1** to insert merchant's name into your message template. If the body is left empty, a default generic message will be used: You have a Payment Due to [Merchant Name] of [Amount] due on [DueOn]. Please follow the link below to make the Payment. [Link Here]
AcctHolderID	Not used, please fill with 0.
Amount	The $ amount to collect.
ConsentID	Not used, please fill with 0.
DueOn	The payment due date in mm/dd/yyyy or yyyy/mm/dd format to display to the customer.
EINDEX	This is your unique Integrator Key Index for encryption. It should be provided by Number when you make an account with us, otherwise contact Number customer support.
MerchID	The unique identifier for the Merchant record.
TXID	Not used, please fill with 0.
WType	This specifies which payment widget to display, including custom widgets built for your company. Contact Number for more information.
RedirectURL	This specifies where to redirect the user and post the results of the transaction.
WidgetURL	The endpoint for the widget payment form, including custom forms. Contact Number and we will provide you with a value. You can start with https://easypay5.com/stdwidget/
ExpiresOn	A date in yyyy-mm-dd format for when the payment link should no longer be available.
SingleUse	Indicates whether the payment link should only accept a single payment.
OptParams	Parameters which control the design and behavior of the payment form including the visible fields, read-only fields, color and styling, and submission options. See the PayForm builder section in the PayForm guide to learn how you can generate those parameters.

Response

If you didn't catch any exceptions and your response is not null, check the value of FunctionOK. If FunctionOk is false, it indicates an error that was handled on the Number servers. You can find more details by looking at ErrMsg and ErrCode included in the response.

You don't have to do anything else, the reminder was sent successfully. A friendly response message is included in RespMsg field, and the PaymentURL is also returned if you wish to store it.