Send Paylink via Email or SMS
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
ID for the payment link.
Body
Request body for the push paylink operation.
Use email to send the paylink. This is the standard method for sending paylinks.
email
When true
, attaches a PDF version of the invoice to the email.
false
List of additional email addresses you want to send the paylink to, formatted as an array. Paylinks and opt-in requests are sent to the customer email address on file, and additional recipients can be specified here.
Request body for the push paylink operation.
Use email to send the paylink. This is the standard method for sending paylinks.
email
When true
, attaches a PDF version of the invoice to the email.
false
List of additional email addresses you want to send the paylink to, formatted as an array. Paylinks and opt-in requests are sent to the customer email address on file, and additional recipients can be specified here.
Request body for the push paylink operation.
Use SMS to send the paylink. Pay by SMS is an add-on feature that must be configured by the Payabli team. If this feature isn't enabled on your account, you will get an error when using this option.
sms
Response
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
true
Response text for operation: 'Success' or 'Declined'.
"Success"
Code for the response. Learn more in API Response Codes.
1
The paylink ID or error details.
Auxiliary validation used internally by payment pages and components.
null
Was this page helpful?