Generate vendor link for lot number
BetaGenerates a vendor payment link for a specific bill lot number. This allows you to pay all bills with the same lot number for a vendor with a single payment link.
Path parameters
lotNumber
Lot number of the bills to pay. All bills with this lot number will be included.
Headers
requestToken
Query parameters
entryPoint
The entity’s entrypoint identifier. Learn more
vendorNumber
The vendor number for the vendor being paid with this payment link.
mail2
List of recipient email addresses. When there is more than one, separate them by a semicolon (;).
amountFixed
Indicates whether customer can modify the payment amount. A value of true means the amount isn’t modifiable, a value false means the payor can modify the amount to pay.
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’.