---
title: "Create a payment link"
method: POST
path: "/api/link"
tags: ["Links"]
---

# Create a payment link

`POST /api/link`

Creates a new payment link that can be shared with customers

## Request body

- CreateLinkDto
  - `currency` 'EUR' | 'USD', required — The currency of the payment link, this currency will refer to product list prices
  - `status` 'enabled' | 'disabled' — The status of the link (enabled or disabled), default is enabled
  - `products` CreateProductDto[] — The list of inline products to include in the payment link, the total amount will be calculated based on the sum of the product prices times the quantity. Provide either products or items, not both.
    - `name` string, required — The name of the product to purchase
    - `price` number, required — The price of the product to purchase in cents (1000 = 10.00)
    - `quantity` number, required — The quantity of the product to purchase
  - `items` CatalogItemRefDto[] — The list of catalog references to include (priceId or productId + quantity), resolved against your catalog. Provide either products or items, not both.
    - `priceId` string — The immutable price to charge. Provide either priceId or productId.
    - `productId` string — The product to charge; its active price in the payment currency is used. Provide either priceId or productId.
    - `quantity` number, required — The quantity to purchase
  - `sessionCustomization` CreateSessionCustomizationDto
    - `bgColor` string — The background color of the checkout session
    - `fontColor` string — The font color of the checkout session
    - `logoUrl` string — The logo url of the checkout session
    - `merchantName` string — The merchant name of the checkout session, the default merchant name will be used if not provided
  - `statementDescriptor` string — Optional statement descriptor (max 11 characters) shown on the customer's bank statement as 'INFLOWPAY* <descriptor>'. Falls back to the account-level statement descriptor if omitted.
  - `isVatIncluded` boolean — Whether product prices include VAT (TTC). false (default): Product prices are excluding tax (HT), tax is added on top. true: Product prices include tax (TTC), tax is extracted from the total.
  - `defaultBillingCountry` string — Optional default billing country (ISO 3166-1 alpha-2). When set, the checkout session created from this link is pre-filled with this country and VAT is recomputed accordingly. Ignored silently if the country is not supported for tax.

## Response `201`

Create a payment link successful

- ApiLinkDto
  - `id` string, required — The unique identifier of the link
  - `name` string, required — The name of the link
  - `amount` number, required — The total amount of the link in cents
  - `currency` 'EUR' | 'GBP' | 'USD', required — The currency of the link
  - `status` 'enabled' | 'disabled', required — The status of the link
  - `isArchived` boolean, required — Whether the payment link is archived
  - `products` object[], required — The list of products included in this link
    - `name` string
    - `price` number
    - `quantity` number
  - `paymentIds` string[], required — The list of payment IDs associated with this link
  - `sessionCustomization` SessionCustomizationDto, required
    - `bgColor` string, nullable — Background color for the payment session
    - `fontColor` string, nullable — Font color for the payment session
    - `logoUrl` string, nullable — Logo URL for the payment session
    - `merchantName` string, nullable — Merchant name for the payment session
  - `paymentLinkUrl` string, required — The URL to access the payment link
  - `statementDescriptor` string, nullable — Optional statement descriptor (max 11 characters) shown on the customer's bank statement
  - `createdAt` string, date-time, required — The creation date of the link
  - `updatedAt` string, date-time, required — The last update date of the link

## Other responses

- `400` — Invalid input data
- `401` — Unauthorized - Invalid API key

---

[API](https://skmtc.dev/inflowpay/apis/inflow-api.md) · [All operations](https://skmtc.dev/inflowpay/apis/inflow-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/inflowpay/inflow-api/revisions/3012dd3dd14a/schema)