Paylinks is a way for merchants to create a link that can be used to make a payment. The link can optionally be sent out via email/sms to a customer. Paylinks is similar to Quick Invoices but much simpler.
The detail listed below in this document explains how to use the API to create and update paylinks. When a paylink is created, the system will optionally send an email and/or SMS with the details of the paylink and a link on how to make a payment towards the invoice. The paylink will only be sent via email or SMS if either of those fields contain valid recipient data.
If an email/SMS is generated by the system during creation time, it will look something like the following:
If neither the email or SMS fields are populated at creation time, then it is the ISV/Merchants responsibilty to send the paylink to the customer. If the ISV/Merchant chooses to construct and send pylinks on their own, they will need to be constructed like the one listed above. When the user receives this paylink, they will be able to click the link and it will take them to that page that looks like the image below:
Once a payment is made on the paylink, the transaction will show up in the transaction listing with a reference to the paylink.
NOTE: a Paylink cannot be updated if it's already closed,
View Single Record
View Record List
Note: Filters can be used to search for Paylinks by including the columns you want to filter on as URL parameters. i.e.
Resend Notification Email / SMS Notification
There may be times when it is necessary to Resend the Notification Email and/or SMS Notification to the recipient. You can use the following request to make that happen.
|Name||Min||Max||Format||POST Required||POST Allowed||PUT Allowed||Comments|
|ach_product_transaction_id||24||36||string||✔||✔||✔||ACH product transaction on which Paylink is created. This field is optional and will default to default_ach product if not supplied at all. Either this or cc_product_transaction_id must be supplied. Changes are allowed on PUT if payments have not been made against Paylink.|
|active||1||1||boolean||Determines whether the invoice is currently active or not|
|amount_due||0||12||decimal(10,2)||✔||✔||This is the amount that need to be paid (automatically calculated by system). amount_due= sum of items in item_list|
|cc_product_transaction_id||24||36||string||✔||✔||✔||CC product transaction on which Paylink is created. This field is optional and will default to default_cc product if not supplied at all. Either this or ach_product_transaction_id must be supplied. Changes are allowed on PUT if payments have not been made against Paylink.|
|contact_id||24||36||string||✔||✔||Optional, the contact of the paylink|
|contact_api_id||1||64||string||✔||✔||Optional. If there is a matching contact in the system, the API will translate this to a
|created_ts||10||10||timestamp||System created timestamp|
|created_user_id||24||36||string||User id who created the Paylink|
the method of notifying the recipient
|1||1||boolean||show the receipt details after the successful payment|
|1||1||boolean||show the billing field inputs in the paylink form|
|5||128||string||✔||✔||Optional. An email address that should be used as the "To" address when sending a Paylink Notification email.|
|expire_date||10||10||date||✔||✔||Expire date of paylink|
|id||24||36||string||System generated id|
|location_id||24||36||string||✔||✔||Location id to which Paylink belongs to|
|modified_ts||10||10||timestamp||System created timestamp|
|modified_user_id||24||36||integer||User id who modified the paylink|
|paylink_api_id||0||64||string||✔||✔||An alterate id that can be used to access the record. API id's are unique per location.|
The various statuses of the paylink:
0 - Unpaid
Expands (Related Records)
For detail on how to use Expands on an Endpoint, please visit the Expands (Related Records) page.
|Related Record||Filter Name|
|The url of the actual payment form||payment_url|
An example of “expanding” this endpoint to one of the above related records would look like this:
To use multiple expands on this endpoint, simply include them both separated by a comma like so: