Create payment link from bill

View as MarkdownOpen in Claude

Generates a payment link for a bill from the bill ID. The vendor receives a secure page where they can select their preferred payment method (ACH, virtual card, or check) and complete the payment.

Authentication

AuthorizationBearer
OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
OR
requestTokenstring

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

Path parameters

billIdintegerRequired
The Payabli ID for the bill.

Headers

idempotencyKeystringOptional

Optional but recommended A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn’t generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

Query parameters

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

mail2stringOptional

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

Request

This endpoint expects an object.
contactUsobjectOptional
ContactUs 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’.

responseDatastring

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

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error