Create a payment link

OAuth scope: payment_link.write

Create a payment link for collecting payments from your customers.

This endpoint supports two types of payment links:

Basket payment links (CreateBasketPaymentLink):

• Include an items array with detailed item information, unit prices, and VAT rates
• Use the reusable field to control whether the link can be used multiple times
• Required fields: items, reusable, potential_payment_methods

Invoice payment links (CreateInvoicePaymentLink):

• Include invoice_id, invoice_number, debitor_name, and amount fields
• Specifically designed for invoice payments
• Required fields: invoice_id, invoice_number, debitor_name, amount, potential_payment_methods

POST /v2/payment_links

Create a payment link

cURL

curl --request POST \
  --url https://thirdparty.qonto.com/v2/payment_links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_link": {
    "potential_payment_methods": [
      "credit_card"
    ],
    "reusable": true,
    "items": [
      {
        "title": "Item 1",
        "quantity": 1,
        "unit_price": {
          "value": "10.99",
          "currency": "EUR"
        },
        "vat_rate": "21.0",
        "type": "good",
        "description": "Item 1 description",
        "measure_unit": "unit"
      }
    ]
  }
}
'

201

Example

{
  "payment_link": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "open",
    "expiration_date": "2021-01-01T00:00:00Z",
    "potential_payment_methods": [
      "credit_card"
    ],
    "amount": {
      "value": "13.30",
      "currency": "EUR"
    },
    "resource_type": "Basket",
    "reusable": true,
    "created_at": "2021-01-01T00:00:00Z",
    "url": "https://pay.qonto.com/019788b3-57ab-727c-b26e-86b95c16e93f?resource_id=4c56f862-6117-4b20-a3e3-7fa6fccea029",
    "items": [
      {
        "title": "Item 1",
        "quantity": 1,
        "unit_price": {
          "value": "10.99",
          "currency": "EUR"
        },
        "vat_rate": "21.0",
        "type": "good",
        "description": "Item 1 description",
        "measure_unit": "unit"
      }
    ],
    "invoice_id": "550e8400-e29b-41d4-a716-446655440001",
    "invoice_number": "INV-12345",
    "debitor_name": "John Doe"
  }
}

Authorizations

Authorization · string · header · required

Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.

Headers

X-Qonto-Staging-Token · string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Body

application/json

CreateBasketPaymentLink

CreateInvoicePaymentLink

payment_link · object · required

Show child attributes

Response

201

application/json

The payment link has been created successfully.

payment_link · object · required

Show child attributes