Generate vendor link for lot number

Beta

POST

/PaymentLink/bill/lotNumber/:lotNumber

POST

/api/PaymentLink/bill/lotNumber/:lotNumber

curl -X POST "https://api-sandbox.payabli.com/api/PaymentLink/bill/lotNumber/LOT-2024-001?amountFixed=true&entryPoint=8cfec329267&mail2=customer%40example.com%3B%20billing%40example.com&vendorNumber=VEN-123" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "contactUs": {
    "emailLabel": "Email",
    "enabled": true,
    "header": "Contact Us",
    "order": 0,
    "paymentIcons": true,
    "phoneLabel": "Phone"
  },
  "logo": {
    "enabled": true,
    "order": 0
  },
  "messageBeforePaying": {
    "enabled": true,
    "label": "Please review your payment details",
    "order": 0
  },
  "notes": {
    "enabled": true,
    "header": "Additional Notes",
    "order": 0,
    "placeholder": "Enter any additional notes here",
    "value": ""
  },
  "page": {
    "description": "Get paid securely",
    "enabled": true,
    "header": "Payment Page",
    "order": 0
  },
  "paymentButton": {
    "enabled": true,
    "label": "Pay Now",
    "order": 0
  },
  "paymentMethods": {
    "allMethodsChecked": true,
    "allowMultipleMethods": true,
    "defaultMethod": "vcard",
    "enabled": true,
    "header": "Payment Methods",
    "methods": {
      "ach": true,
      "check": true,
      "vcard": true
    },
    "order": 0,
    "showPreviewVirtualCard": true
  },
  "review": {
    "enabled": true,
    "header": "Review Payment",
    "order": 0
  },
  "settings": {
    "color": "#000000",
    "language": "en"
  }
}'

200Successful

{
  "isSuccess": true,
  "responseText": "Success",
  "responseData": "2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234"
}

Generates 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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

Path parameters

lotNumberstringRequired

Lot number of the bills to pay. All bills with this lot number will be included.

Query parameters

entryPointstringRequired

The entity’s entrypoint identifier. Learn more

vendorNumberstringRequired

The vendor number for the vendor being paid with this payment link.

mail2stringOptional

List of recipient email addresses. When there is more than one, separate them by a semicolon (;).

amountFixedstringOptionalDefaults to true

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.

contactUsobjectOptional

ContactUs section of payment link page.

logoobjectOptional

Logo section of payment link page.

messageBeforePayingobjectOptional

Message section of payment link page.

notesobjectOptional

Notes section of payment link page.

pageobjectOptional

Page header section of payment link page.

paymentButtonobjectOptional

Payment button section of payment link page.

paymentMethodsobjectOptional

Payment methods section of payment link page. Use this to configure which payout methods (ACH, vCard, check) are offered to the vendor.

reviewobjectOptional

Review section of payment link page.

billsobjectOptional

Bills section of payment link page.

settingsobjectOptional

Settings section of payment link page.

Response

Success

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

responseDatastringOptional

If isSuccess = true, this contains the payment link identifier. If isSuccess = false, this contains the reason of the error.