Create payment link
Generates a payment link for an invoice from the invoice ID.
Path parameters
idInvoice
Invoice ID
Headers
requestToken
idempotencyKey
A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.
Query parameters
amountFixed
Indicates whether customer can modify the payment amount. A value of true
means the amount is not modifiable, a value false
means the payor can modify the amount to pay.
Allowed values:
mail2
List of recipient email addresses. When there is more than one, separate them by a semicolon (;).
Request
This endpoint expects an object.
contactUs
ContactUs section of payment link page
invoices
Invoices section of payment link page
logo
Logo section of payment link page
messageBeforePaying
Message section of payment link page
notes
Notes section of payment link page
page
Page header section of payment link page
paymentButton
Payment button section of payment link page
paymentMethods
Payment methods section of payment link page
payor
Customer/Payor section of payment link page
review
Review section of payment link page
settings
Settings section of payment link page
Response
Success
isSuccess
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
responseData
If isSuccess
= true, this contains the payment link identifier. If isSuccess
= false, this contains the reason of the error.
responseText
Response text for operation: ‘Success’ or ‘Declined’.