v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB

Payment Links API

Update payment link

Certain details of an existing payment link can be updated.

🔑 Access with

API key

Advanced access token with payment-links.write

OAuth access with payment-links.write

patch/payment-links/{paymentLinkId}

Request body

descriptionstring

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.

archivedboolean

Whether the payment link is archived. Customers will not be able to complete payments on archived payment links.

allowedMethodsstring[] 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.

Possible values: applepay bacs bancomatpay bancontact banktransfer belfius billie blik creditcard eps giftcard ideal in3 kbc klarna mbway multibanco mybank paybybank paypal paysafecard pointofsale przelewy24 riverty satispay swish trustly twint voucher

testmodeboolean

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.

Example request

{
  "description": "Chess Board",
  "minimumAmount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "allowedMethods": [
    "ideal"
  ],
  "lines": [
    {
      "type": "physical",
      "description": "LEGO 4440 Forest Police Station",
      "quantity": 1,
      "quantityUnit": "pcs",
      "unitPrice": {
        "currency": "EUR",
        "value": "10.00"
      },
      "discountAmount": {
        "currency": "EUR",
        "value": "10.00"
      },
      "totalAmount": {
        "currency": "EUR",
        "value": "10.00"
      },
      "vatRate": "21.00",
      "vatAmount": {
        "currency": "EUR",
        "value": "10.00"
      },
      "sku": "9780241661628",
      "categories": [
        "meal",
        "eco"
      ],
      "imageUrl": "https://...",
      "productUrl": "https://..."
    }
  ],
  "billingAddress": {
    "title": "Mr.",
    "givenName": "Piet",
    "familyName": "Mondriaan",
    "organizationName": "Mollie B.V.",
    "streetAndNumber": "Keizersgracht 126",
    "streetAdditional": "Apt. 1",
    "postalCode": "1234AB",
    "email": "piet@example.org",
    "city": "Amsterdam",
    "region": "Noord-Holland",
    "country": "NL"
  },
  "shippingAddress": {
    "title": "Mr.",
    "givenName": "Piet",
    "familyName": "Mondriaan",
    "organizationName": "Mollie B.V.",
    "streetAndNumber": "Keizersgracht 126",
    "streetAdditional": "Apt. 1",
    "postalCode": "1234AB",
    "email": "piet@example.org",
    "city": "Amsterdam",
    "region": "Noord-Holland",
    "country": "NL"
  }
}

Response

The payment link object.