Create a payment link

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"
      }
    ]
  }
}
'

{
  "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"
  }
}

Payment Links

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

Both types support an optional redirect_url field.

POST

payment_links

Create a payment link

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"
      }
    ]
  }
}
'

{
  "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

payment_link.potential_payment_methods

enum<string>[]

required

The payment methods that can be used to pay the payment link.

Available options:

credit_card,

apple_pay,

paypal,

ideal

payment_link.reusable

boolean

default:false

required

Whether the payment link can be reused.

Example:

true

payment_link.items

object[]

required

Items that make up the payment link.

Minimum array length: 1

Show child attributes

payment_link.items.title

string

required

The title of the item.

Example:

"Item 1"

payment_link.items.quantity

number<double>

required

The quantity of the item.

Example:

1

payment_link.items.unit_price

object

required

Show child attributes

payment_link.items.unit_price.value

string

required

The amount of the item.

Example:

"10.99"

payment_link.items.unit_price.currency

string

required

The currency of the item, formatted as an ISO 4217 currency code.

Example:

"EUR"

payment_link.items.vat_rate

string

required

The VAT rate of the item, formatted as a decimal string.

Example:

"21.0"

payment_link.items.type

enum<string>

The type of the item.

Available options:

good,

service

Example:

"good"

payment_link.items.description

string

The description of the item.

Example:

"Item 1 description"

payment_link.items.measure_unit

string

The unit of measure of the item.

Example:

"unit"

Response

The payment link has been created successfully.

payment_link

object

required

Show child attributes

payment_link.id

string<uuid>

required

The ID of the payment link.

payment_link.status

enum<string>

required

The status of the payment link.

Available options:

open,

expired,

canceled,

paid,

processing

Example:

"open"

payment_link.expiration_date

string<date-time>

required

The date and time when the payment link will expire, formatted as an ISO 8601 date-time string.

Example:

"2021-01-01T00:00:00Z"

payment_link.potential_payment_methods

enum<string>[]

required

Available options:

credit_card,

apple_pay,

paypal,

ideal

payment_link.amount

object

required

The gross amount of the payment link, including VAT.

Show child attributes

payment_link.amount.value

string

required

The amount of the payment link, formatted as a decimal string.

Example:

"13.30"

payment_link.amount.currency

string

required

The currency of the payment link, formatted as an ISO 4217 currency code.

Example:

"EUR"

payment_link.resource_type

enum<string>

required

Type of payment link resource.

Available options:

Invoice,

Basket

Example:

"Basket"

payment_link.reusable

boolean

required

Whether the payment link can be reused. Defaults to false for invoice payment links.

Example:

true

payment_link.created_at

string<date-time>

required

The date and time when the payment link was created, formatted as an ISO 8601 date-time string.

Example:

"2021-01-01T00:00:00Z"

payment_link.url

string

required

The URL of the payment link.

Example:

"https://pay.qonto.com/019788b3-57ab-727c-b26e-86b95c16e93f?resource_id=4c56f862-6117-4b20-a3e3-7fa6fccea029"

payment_link.items

object[] | null

Items for basket payment links. Null for invoice payment links.

Show child attributes

payment_link.items.title

string

required

The title of the item.

Example:

"Item 1"

payment_link.items.quantity

number<double>

required

The quantity of the item.

Example:

1

payment_link.items.unit_price

object

required

Show child attributes

payment_link.items.unit_price.value

string

required

The amount of the item.

Example:

"10.99"

payment_link.items.unit_price.currency

string

required

The currency of the item, formatted as an ISO 4217 currency code.

Example:

"EUR"

payment_link.items.vat_rate

string

required

The VAT rate of the item, formatted as a decimal string.

Example:

"21.0"

payment_link.items.type

enum<string>

The type of the item.

Available options:

good,

service

Example:

"good"

payment_link.items.description

string

The description of the item.

Example:

"Item 1 description"

payment_link.items.measure_unit

string

The unit of measure of the item.

Example:

"unit"

payment_link.invoice_id

string<uuid> | null

The ID of the invoice. Present for invoice payment links, null for basket payment links.

Example:

"550e8400-e29b-41d4-a716-446655440001"

payment_link.invoice_number

string | null

The invoice number. Present for invoice payment links, null for basket payment links.

Example:

"INV-12345"

payment_link.debitor_name

string | null

Name of the customer/debitor. Present for invoice payment links, null for basket payment links.

Example:

"John Doe"

Get the connection status List payment links

⌘I

Business API

Onboarding API

Create a payment link

Authorizations

Headers

Body

Response