Skip to navigation

Payment Link request for an existing invoice ID

View as Markdown

The Get Payment Link endpoint allows clients to generate or retrieve a secure payment URL associated with a specific invoice. By providing a valid invoiceId, the API returns a unique payment link that can be shared with the customer for completing the transaction.

This link ensures a safe and traceable payment process, tied directly to the requested invoice, and helps streamline billing workflows without exposing sensitive financial details in the request.

Typical Use Cases:

  • Sending payment links to customers for outstanding invoices.

  • Embedding secure payment URLs in email, SMS, or portal notifications.

  • Automating invoice-to-payment workflows within billing or ERP systems.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

invoiceIDstringRequired

Response

OK
codeinteger
dataobject
messagestring