| Field | Type | Required | Description | Example |
|---|---|---|---|---|
description |
Optional<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. |
Chess Board |
minimumAmount |
Optional<Amount> | ➖ | In v2 endpoints, monetary amounts are represented as objects with a currency and value field. |
|
archived |
Optional<Boolean> | ➖ | Whether the payment link is archived. Customers will not be able to complete payments on archived payment links. |
false |
allowedMethods |
List<PaymentLinkMethod> | ➖ | 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 |
List<PaymentLineItem> | ➖ | 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. |
|
billingAddress |
Optional<PaymentAddress> | ➖ | N/A | |
shippingAddress |
Optional<PaymentAddress> | ➖ | N/A | |
testmode |
Optional<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. |
false |