--- title: "Update payment link" method: PATCH path: "/v2/payment-links/{paymentLinkId}" tags: ["Payment Links API"] --- # Update payment link `PATCH /v2/payment-links/{paymentLinkId}` Certain details of an existing payment link can be updated. ## Headers - `idempotency-key` string ## Request body - object - `description` string — A short description of the payment link. The description is visible in the Dashboard and will be shown on the customer's bank or card statement when possible. Updating the description does not affect any previously existing payments created for this payment link. - `minimumAmount` Amount — In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field. - `currency` string, required — A three-character ISO 4217 currency code. - `value` string, required — A string containing an exact monetary amount in the given currency. - `archived` boolean — Whether the payment link is archived. Customers will not be able to complete payments on archived payment links. - `allowedMethods` PaymentLinkMethod[], nullable — An array of payment methods that are allowed to be used for this payment link. When this parameter is not provided or is an empty array, all enabled payment methods will be available. - `lines` PaymentLineItem[], nullable — Optionally provide the order lines for the payment. Each line contains details such as a description of the item ordered and its price. All lines must have the same currency as the payment. Required for payment methods `billie`, `in3`, `klarna`, `riverty` and `voucher`. - `type` 'physical' | 'digital' | 'shipping_fee' | 'discount' | 'store_credit' | 'gift_card' | 'surcharge' | 'tip' — The type of product purchased. For example, a physical or a digital product. The `tip` payment line type is not available when creating a payment. - `description` string, required — A description of the line item. For example *LEGO 4440 Forest Police Station*. - `quantity` integer, required — The number of items. - `quantityUnit` string — The unit for the quantity. For example *pcs*, *kg*, or *cm*. - `unitPrice` Amount, required — In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field. - `currency` string, required — A three-character ISO 4217 currency code. - `value` string, required — A string containing an exact monetary amount in the given currency. - `discountAmount` Amount — In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field. - `currency` string, required — A three-character ISO 4217 currency code. - `value` string, required — A string containing an exact monetary amount in the given currency. - `totalAmount` Amount, required — In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field. - `currency` string, required — A three-character ISO 4217 currency code. - `value` string, required — A string containing an exact monetary amount in the given currency. - `vatRate` string — The VAT rate applied to the line, for example `21.00` for 21%. The vatRate should be passed as a string and not as a float, to ensure the correct number of decimals are passed. - `vatAmount` Amount — In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field. - `currency` string, required — A three-character ISO 4217 currency code. - `value` string, required — A string containing an exact monetary amount in the given currency. - `sku` string — The SKU, EAN, ISBN or UPC of the product sold. - `categories` LineCategories[] — An array with the voucher categories, in case of a line eligible for a voucher. See the [Integrating Vouchers](https://docs.mollie.com/docs/integrating-vouchers/) guide for more information. - `imageUrl` string — A link pointing to an image of the product sold. - `productUrl` string — A link pointing to the product page in your web shop of the product sold. - `billingAddress` PaymentAddress - `title` string — The title of the person, for example *Mr.* or *Mrs.*. - `givenName` string — The given name (first name) of the person should be at least two characters and cannot contain only numbers. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. - `familyName` string — The given family name (surname) of the person should be at least two characters and cannot contain only numbers. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. - `organizationName` string — The name of the organization, in case the addressee is an organization. - `streetAndNumber` string — A street and street number. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. - `streetAdditional` string — Any additional addressing details, for example an apartment number. - `postalCode` string — A postal code. This field may be required if the provided country has a postal code system. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. - `email` string — A valid e-mail address. If you provide the email address for a `banktransfer` payment, we will automatically send the instructions email upon payment creation. The language of the email will follow the locale parameter of the payment. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. If the domain contains non-ASCII characters, encode it as Punycode per [RFC 3492](https://www.rfc-editor.org/rfc/rfc3492). - `phone` string — If provided, it must be in the [E.164](https://en.wikipedia.org/wiki/E.164) format. For example: +31208202070. - `city` string — A city name. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. - `region` string — The top-level administrative subdivision of the country. For example: Noord-Holland. - `country` string — A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. - `shippingAddress` PaymentAddress - `title` string — The title of the person, for example *Mr.* or *Mrs.*. - `givenName` string — The given name (first name) of the person should be at least two characters and cannot contain only numbers. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. - `familyName` string — The given family name (surname) of the person should be at least two characters and cannot contain only numbers. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. - `organizationName` string — The name of the organization, in case the addressee is an organization. - `streetAndNumber` string — A street and street number. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. - `streetAdditional` string — Any additional addressing details, for example an apartment number. - `postalCode` string — A postal code. This field may be required if the provided country has a postal code system. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. - `email` string — A valid e-mail address. If you provide the email address for a `banktransfer` payment, we will automatically send the instructions email upon payment creation. The language of the email will follow the locale parameter of the payment. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. If the domain contains non-ASCII characters, encode it as Punycode per [RFC 3492](https://www.rfc-editor.org/rfc/rfc3492). - `phone` string — If provided, it must be in the [E.164](https://en.wikipedia.org/wiki/E.164) format. For example: +31208202070. - `city` string — A city name. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. - `region` string — The top-level administrative subdivision of the country. For example: Noord-Holland. - `country` string — A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. Required for payment methods `billie`, `in3`, `klarna` and `riverty`. - `testmode` boolean — Whether the entity was created in test mode or live mode. This field does not update the mode of the entity. Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`. ## Response `200` The payment link object. ## Other responses - `404` — No entity with this ID exists. - `422` — The request contains issues. For example, if no parameters are provided. - `429` — Rate Limit has been reached. --- [API](https://skmtc.net/mollie/apis/mollie-api.md) · [All operations](https://skmtc.net/mollie/apis/mollie-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mollie/mollie-api/revisions/8b6839e22c14/schema)