paymentLink

Generate payment link from Invoice

Generates a payment link for an invoice from the invoice ID.

The payment page configuration blocks (logo, page, paymentMethods, review, messageBeforePaying, paymentButton, notes, contactUs, and settings) are optional. When you omit a block, Payabli applies a default rather than hiding it. The block is enabled at a fixed display order, so the generated page stays complete and branded. To hide a section, send the block explicitly with enabled set to false. An explicit value is always honored and is never replaced by a default. For each block's default, see its description in the request body.

post/PaymentLink/{idInvoice}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/PaymentLink/{idInvoice}
  • Auth: HTTP bearer

Path parameters

idInvoiceinteger required

Invoice ID

Query parameters

amountFixedboolean

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.

mail2string

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

Headers

idempotencyKeystring

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. The key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

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.

Request body

Response

Success

isSuccessboolean required

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

responseDatastring

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

responseTextstring required

Response text for operation: 'Success' or 'Declined'.

Changes

No recorded changes to this operation across all 1 revision of this API.