Payment links enable you to accept payments from your customers through secure, shareable URLs. Whether you’re invoicing clients, collecting donations, or selling products, payment links provide a simple and professional way to get paid.

This guide outlines the available API endpoints for managing payment links and the steps to integrate them into your business operations.

Payment links are unique URLs that you can share with your customers to collect payments. Each link is tied to a specific amount and can be customized with your branding and payment details.

​
1. Connect to the payment provider

Before you can create payment links, you need to connect your Qonto account to the payment links provider. This establishes the secure connection needed to process payments.

To connect, send a POST request to /v2/payment_links/connections (see Connect to the payment links provider).

Once connected, you can check the connection status at any time by sending a GET request to /v2/payment_links/connections (see Get the connection status).

After establishing the connection, you can create payment links for your customers. Each payment link includes:

  • potential_payment_methods: The list of payment methods available to your customers. Currently supported methods include:
    • credit_card: Credit card payments
    • apple_pay: Apple Pay payments
    • paypal: PayPal payments
    • ideal: iDEAL payments

Note: The actual availability depends on which methods the customer has enabled from the provider. You can get the available payment methods with a GET request to /v2/payment_links/payment_methods (see List available payment methods).

  • reusable: A boolean value indicating whether the payment link can be used multiple times or is single-use

  • items: A breakdown of the items that make up the total payment amount

To create a payment link, send a POST request to /v2/payment_links (see Create a payment link).

​
3. Share and track payments

Once created, you can share the payment link with your customers via email, messaging apps, or embed it in your website. The link will direct customers to a secure payment page where they can complete their transaction.

You can track the status of payments by listing all payments for a specific payment link using a GET request to /v2/payment_links/{id}/payments (see List payments for a payment link).

You have full control over your payment links:

  • List all payment links: Get an overview of all your payment links with a GET request to /v2/payment_links (see List payment links)
  • View specific payment link: Retrieve details of a specific payment link with a GET request to /v2/payment_links/{id} (see Get a payment link)
  • Deactivate a payment link: Stop accepting payments on a specific link with a PATCH request to /v2/payment_links/{id}/deactivate (see Deactivate a payment link)

Payment links can have different statuses throughout their lifecycle:

  • open: The payment link is active and ready to accept payments
  • expired: The payment link has passed its expiration date
  • canceled: The payment link has been manually deactivated
  • paid: A payment has been successfully completed
  • processing: A payment is being processed

​
Payment statuses

Individual payments within a payment link can have these statuses:

  • open: The payment is ready to be completed
  • pending: The payment is being processed
  • authorized: The payment has been authorized but not yet settled
  • paid: The payment has been successfully completed
  • canceled: The payment has been canceled
  • expired: The payment has expired
  • failed: The payment failed to process

​
Summary

Here are the steps to follow when working with payment links:

  1. Connect to the payment provider: Establish the connection by sending a POST request to /v2/payment_links/connections
  2. Check connection status: Verify the connection is active with a GET request to /v2/payment_links/connections
  3. Create a payment link: Generate a new payment link with a POST request to /v2/payment_links
  4. Share the link: Send the payment link to your customers
  5. Track payments: Monitor payment status with a GET request to /v2/payment_links/{id}/payments
  6. Manage links: List, view, or deactivate payment links as needed

Payment links provide a professional, secure way to accept payments from your customers while maintaining full control over your payment collection process.