Sign in

v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB
Links

Create a payment link

Creates a new payment link that can be shared with customers

post/api/link

Request body

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

statementDescriptorstring

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.

isVatIncludedboolean

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.

defaultBillingCountrystring

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.

Example request

{
  "currency": "EUR",
  "status": "enabled",
  "items": [
    {
      "priceId": "price_1234567890abcdef",
      "productId": "pro_1234567890abcdef",
      "quantity": 1
    }
  ],
  "sessionCustomization": {
    "bgColor": "#ffffff",
    "fontColor": "#000000"
  },
  "statementDescriptor": "MY BRAND",
  "defaultBillingCountry": "FR"
}

Response

Create a payment link successful

idstring required

The unique identifier of the link

namestring required

The name of the link

amountnumber 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

isArchivedboolean required

Whether the payment link is archived

paymentIdsstring[] required

The list of payment IDs associated with this link

paymentLinkUrlstring required

The URL to access the payment link

statementDescriptorstring nullable

Optional statement descriptor (max 11 characters) shown on the customer's bank statement

createdAtstring date-time required

The creation date of the link

updatedAtstring date-time required

The last update date of the link

Example response

{
  "id": "link_1234567890abcdef",
  "name": "Product A and 2 more",
  "amount": 5000,
  "currency": "EUR",
  "status": "enabled",
  "products": [
    {
      "name": "Product A",
      "price": 1000,
      "quantity": 2
    }
  ],
  "paymentIds": [
    "payment_abc123",
    "payment_def456"
  ],
  "sessionCustomization": {
    "bgColor": "#FF5733",
    "fontColor": "#FFFFFF",
    "logoUrl": "https://example.com/logo.png",
    "merchantName": "My Store"
  },
  "paymentLinkUrl": "https://checkout.inflowpay.com/l/link_1234567890abcdef",
  "statementDescriptor": "MY BRAND",
  "createdAt": "2025-10-09T10:00:00.000Z",
  "updatedAt": "2025-10-09T12:00:00.000Z"
}