paymentLink

Generate payment link from lot number

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.

post/PaymentLink/bill/lotNumber/{lotNumber}

Request

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

Path parameters

lotNumberstring required

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

Query parameters

entryPointstring required

The entity's entrypoint identifier. Learn more.

The entity's entrypoint identifier. Learn more

vendorNumberstring required

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

mail2string

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

amountFixedstring

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