--- title: "Update payment" method: PATCH path: "/v2/payments/{paymentId}" tags: ["Payments API"] --- # Update payment `PATCH /v2/payments/{paymentId}` Certain details of an existing payment can be updated. Updating the payment details will not result in a webhook call. ## Headers - `idempotency-key` string ## Request body - object - `description` string — The description of the payment will be shown to your customer on their card or bank statement when possible. We truncate the description automatically according to the limits of the used payment method. The description is also visible in any exports you generate. We recommend you use a unique identifier so that you can always link the payment to the order in your back office. This is particularly useful for bookkeeping. The maximum length of the description field differs per payment method, with the absolute maximum being 255 characters. The API will not reject strings longer than the maximum length but it will truncate them to fit. - `redirectUrl` string, nullable — The URL your customer will be redirected to after the payment process. It could make sense for the redirectUrl to contain a unique identifier – like your order ID – so you can show the right page referencing the order when your customer returns. The parameter is normally required, but can be omitted for recurring payments (`sequenceType: recurring`) and for Apple Pay payments with an `applePayPaymentToken`. - `cancelUrl` string, nullable — The URL your customer will be redirected to when the customer explicitly cancels the payment. If this URL is not provided, the customer will be redirected to the `redirectUrl` instead — see above. Mollie will always give you status updates via webhooks, including for the canceled status. This parameter is therefore entirely optional, but can be useful when implementing a dedicated customer-facing flow to handle payment cancellations. - `webhookUrl` string, nullable — The webhook URL where we will send payment status updates to. The webhookUrl is optional, but without a webhook you will miss out on important status changes to your payment. The webhookUrl must be reachable from Mollie's point of view, so you cannot use `localhost`. If you want to use webhook during development on `localhost`, you must use a tool like ngrok to have the webhooks delivered to your local machine. - `metadata` union — Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB. - string - number - object - string[] - `method` union — Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment method and your customer will skip the selection screen and is sent directly to the chosen payment method. The parameter enables you to fully integrate the payment method selection into your website. You can also specify the methods in an array. By doing so we will still show the payment method selection screen but will only show the methods specified in the array. For example, you can use this functionality to only show payment methods from a specific country to your customer `['bancontact', 'belfius']`. - 'alma' | 'applepay' | 'bacs' | 'bancomatpay' | 'bancontact' | 'banktransfer' | 'belfius' | 'billie' | 'billink' | 'bizum' | 'blik' | 'creditcard' | 'directdebit' | 'eps' | 'giftcard' | 'ideal' | 'in3' | 'kbc' | 'klarna' | 'mbway' | 'mobilepay' | 'multibanco' | 'mybank' | 'paybybank' | 'paypal' | 'paysafecard' | 'pointofsale' | 'przelewy24' | 'riverty' | 'satispay' | 'swish' | 'trustly' | 'twint' | 'vipps' | 'voucher', nullable - Method[] - `locale` 'ca_ES' | 'cs_CZ' | 'da_DK' | 'de_AT' | 'de_CH' | 'de_DE' | 'de_LU' | 'en_BE' | 'en_GB' | 'en_NL' | 'en_US' | 'es_ES' | 'fi_FI' | 'fr_BE' | 'fr_FR' | 'fr_LU' | 'hu_HU' | 'is_IS' | 'it_IT' | 'lt_LT' | 'lv_LV' | 'nb_NO' | 'nl_BE' | 'nl_NL' | 'pl_PL' | 'pt_PT' | 'sk_SK' | 'sv_SE' | 'null', nullable — Sets the language for customer-facing content and communications. - `dueDate` string, nullable — The date by which the payment should be completed in `YYYY-MM-DD` format. Sending `null` has the same effect as omitting the field. - `restrictPaymentMethodsToCountry` string, nullable — For digital goods in most jurisdictions, you must apply the VAT rate from your customer's country. Choose the VAT rates you have used for the order to ensure your customer's country matches the VAT country. Use this parameter to restrict the payment methods available to your customer to those from a single country. If available, the credit card method will still be offered, but only cards from the allowed country are accepted. The field expects a country code in ISO 3166-1 alpha-2 format, for example `NL`. - `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`. - `issuer` string, nullable — **Only relevant for iDEAL, KBC/CBC, gift card, and voucher payments.** **⚠️ With the introduction of iDEAL 2 in 2025, this field will be ignored for iDEAL payments. For more information on the migration, refer to our [help center](https://help.mollie.com/hc/articles/19100313768338-iDEAL-2-0).** Some payment methods are a network of connected banks or card issuers. In these cases, after selecting the payment method, the customer may still need to select the appropriate issuer before the payment can proceed. We provide hosted issuer selection screens, but these screens can be skipped by providing the `issuer` via the API up front. The full list of issuers for a specific method can be retrieved via the Methods API by using the optional `issuers` include. A valid issuer for iDEAL is for example `ideal_INGBNL2A` (for ING Bank). - `billingAddress` BillingAddress — The customer's billing address details. We advise to provide these details to improve fraud protection and conversion. Should include `email` or a valid postal address consisting of `streetAndNumber`, `postalCode`, `city` and `country`. Required for payment method `alma`, `in3`, `klarna`, `billie`, `billink` and `riverty`. - `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. Required for payment method `billie`. - `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` ShippingAddress - `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`. - `billingEmail` string ## Response `200` The updated payment object. ## Other responses - `404` — No entity with this ID exists. - `422` — The request contains issues. For example, if you are trying to update a property that can no longer be updated. - `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/versions/8b6839e22c14/schema)