Send Payment Reminders using the API:
An API method allows users to accomplish three typical tasks:
- Send a SMS text with a message and Payment Link
- Send an email with message and Payment Link
- Acquire the Payment Link and use it internally or externally
The method name is SMSPayment:
api_SMSPaymentResponse SMSPayment(string SessKey, api_SMSPayment PaymentObject);
In order to use this method you will need to populate the following object:
public class api_SMSPayment
{
public api_Person Person { get; set; }
public string MessageType { get; set; }
public string RefID { get; set; }
public string RPGUID { get; set; }
public string MessageBody { get; set; }
public int AcctHolderID { get; set; }
public decimal Amount { get; set; }
public int ConsentID { get; set; }
public DateTime DueOn { get; set; }
public string EINDEX { get; set; }
public int MerchID { get; set; }
public int TXID { get; set; }
public string WType { get; set; }
public string RedirectURL { get; set; }
public string WidgetURL { get; set; }
public string ExpiresOn { get; set; }
public bool SingleUse { get; set; }
public string OptParam { get; set; }
public List <api_Question> Questions { get; set; }
public api_SMSPayment()
{
Person = new api_Person();
Questions = new List <api_Question>();
}
}
Below is a list of the members and a brief explanation:
- Person
Use this object to populate the name, address, email and phone number for the Payee.
- MessageType
This will be EMAIL or URLONLY or TEXT.
- RefID
Your user defined field.
- RPGUID
Another User Defined Field
- MessageBody
If you send an empty string then a generic message will be sent as follows:
- You have a Payment Due to [Merchant Name] of [Amount] due on [DueOn]. Please follow the link below to make the Payment. [Link Here]
- If you send your own message the payment link will appear just below your message.
- If you want the proper Merchant name to show up in your custom message then place the following in your message: **Merch1**
- We will replace that text with the proper merchant's name.
- AcctHolderID
(not used please fill with Zero)
- Amount
This is the payment amount you need to collect
- ConsentID
(not used please fill with Zero)
- DueOn
Payment due date
- EINDEX
This is your Integrator Key Index for encryption (example 100 or 200 or 302)
- MerchID
Your integer index for the merchant record for the account
- TXID
(not used please fill with Zero)
- WType
This specifies which payment widget to display (example SMSPN);
- RedirectURL
This specifies where we will post the results of the transaction
- WidgetURL
Here is the endpoint for the widget transaction. EasyPay will guide you here but you can start with this: https://easypay5.com/stdwidget/
- ExpiresOn
This will allow you to provide a date for when the payment link should no longer be available
- SingleUse
Provide a true or false indicating whether the payment link should only accept a single payment
- OptParams
Here we can supply parameters which control the design and behavior of the payment form