Create a payment link

Creates a new payment link that can be shared with customers

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The currency of the payment link, this currency will refer to product list prices

Allowed:
string

Currency you priced this link in (ISO 4217, case-insensitive). When set, every products[].price is read as MINOR UNITS of this currency and converted to currency at the live exchange rate; the converted amount is what we store and charge. Must differ from currency, and cannot be combined with items (catalog prices are already denominated in currency). A buyer paying in this currency sees approximately, not exactly, the figure you typed: rates move, and their payment is converted with the conversion fee applied while your price is set at the mid-market rate. Expect a small, consistently upward difference.

string
enum

The status of the link (enabled or disabled), default is enabled

Allowed:
products
array of objects

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.

products
items
array of objects

The list of catalog references to include (priceId or productId + quantity), resolved against your catalog. Provide either products or items, not both.

items
sessionCustomization
object

Customization settings for the payment session (colors, logo, merchant name)

string

Optional statement descriptor (max 11 characters) shown on the customer's bank statement as 'INFLOWPAY* '. Falls back to the account-level statement descriptor if omitted.

boolean
Defaults to false

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.

boolean
Defaults to false

Whether to enable saving the buyer's payment method for future use on checkout sessions created from this link. The buyer must still opt in at checkout for the payment method to be saved (unless consent-less save is enabled by Inflow admin).

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.

string

Optional URL the buyer is redirected to after a successful payment on a checkout session created from this link. We append sessionId and, when the flow produced one, paymentId as query parameters, preserving any query string you already set. Omit to keep the default hosted success page.

string

Optional URL the buyer is redirected to after a failed or cancelled payment on a checkout session created from this link. Same identifiers appended as on successUrl.

string
enum

Which success screen buyers see after paying on a session created from this link. DEFAULT (default) keeps the current confirmation page; APP_RETURN adds a 'Back to the app' button and an automatic redirect; APP_INSTALL shows the store badges and the email to sign in with. APP_RETURN requires a successUrl, APP_INSTALL requires appStoreUrl or playStoreUrl — a mode left without what it points at is rejected with 400. On the update endpoint the rule is applied to the merged result, so a patch that only switches the mode is fine when the stored values already satisfy it.

Allowed:
string

App Store listing shown on the APP_INSTALL success screen. Ignored on the other screens. APP_INSTALL requires this or playStoreUrl — one of the two is enough. A request that leaves APP_INSTALL without either is rejected.

string

Google Play listing shown on the APP_INSTALL success screen. Ignored on the other screens. APP_INSTALL requires this or appStoreUrl — one of the two is enough. A request that leaves APP_INSTALL without either is rejected.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json