Update a payment link

patch

https://api.inflowpay.com/api/link/{id}

Updates the details of an existing payment link

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Unique identifier of the link

Body Params

name

string

The name of the payment link

status

string

enum

The status of the link (enabled or disabled)

Allowed:

sessionCustomization

object

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

statementDescriptor

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.

isVatIncluded

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.

savePaymentMethod

boolean

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).

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.

metadatas

object

Arbitrary key-value metadata attached to this payment link

successUrl

object | null

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. Send null to clear it and fall back to the default hosted success page.

cancelUrl

object | null

URL the buyer is redirected to after a failed or cancelled payment on a checkout session created from this link. Send null to clear it.

returnMode

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:

appStoreUrl

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.

playStoreUrl

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Update a payment link successful

400Invalid input data

401Unauthorized - Invalid API key

404Resource not found