MultiLink | ePay documentation

A reusable payment-link configuration owned by a merchant.

idstring

Required

The unique ID of the multi-link.

Example:

"KSNMWEWZPPA"

pointOfSaleIdstring

Required

The ID of the point of sale associated with the multi-link.

Format:

uuid

Example:

"0192473a-e381-705c-b61c-fc2ac9624afc"

statestring

Required

Whether the multi-link can start new payment sessions.

Possible values:

"ACTIVE""DEACTIVATED"

Example:

"ACTIVE"

amountinteger

Required

The default payment amount in minor units.

Example:

1095

currencystring

Required

The ISO 4217 alpha-3 currency code.

Example:

"DKK"

The subscription configuration, when the multi-link creates subscriptions.

amountinteger

Nullable

The configured recurring amount in minor units.

Example:

1095

typestring

Nullable

The configured subscription type.

Possible values:

"SCHEDULED""UNSCHEDULED"

Example:

"SCHEDULED"

expiryDatestring

Nullable

The configured subscription expiry date.

Format:

date

Example:

"2027-12-31"

The configured scheduled-subscription interval.

The configured automatic billing agreement.

scaModestring

Nullable

The configured 3-D Secure mode.

Example:

"NORMAL"

timeoutinteger

Nullable

The configured payment-session timeout in minutes.

Example:

30

instantCapturestring

Nullable

The configured instant-capture behavior.

Example:

"OFF"

textOnStatementstring

Nullable

The configured cardholder statement text.

Example:

"Store purchase"

The configured merchant pass-through attributes.

reportFailureboolean

Nullable

Whether failed-payment notifications are configured.

Example:

false

reportExpiredboolean

Nullable

Whether expired-session notifications are configured.

Example:

false

dynamicAmountboolean

Nullable

Whether cardholders can enter their own payment amount.

Example:

true

notificationUrlstring

Nullable

The configured payment-status notification URL.

Format:

uri

Example:

"https://example.com/payment-notifications"

preAuthUrlstring

Nullable

The configured pre-authorization callback URL.

Format:

uri

Example:

"https://example.com/pre-authorizations"

successUrlstring

Nullable

The configured successful-payment redirect URL.

Format:

uri

Example:

"https://example.com/payment-success"

returnUrlstring

Nullable

The configured payment-window return URL.

Format:

uri

Example:

"https://example.com/payment-return"

failureUrlstring

Nullable

The configured final-failure redirect URL.

Format:

uri

Example:

"https://example.com/payment-failure"

retryUrlstring

Nullable

The configured retry redirect URL.

Format:

uri

Example:

"https://example.com/payment-retry"

maxAttemptsinteger

Nullable

The configured maximum payment attempts for a session.

Example:

3

The configured SCA exemptions.

The configured age-verification requirements.

The configured line items.

Array [

A line item copied to every payment session created from the multi-link.

descriptionstring

Required

The descriptive name of the line item.

Length:

1 <= length <= 255

Example:

"Reusable coffee cup"

imageUrlstring

Nullable

A registered point-of-sale URL for an image of the line item.

Format:

uri

Length:

1 <= length <= 1024

Example:

"https://example.com/images/reusable-cup.png"

quantityinteger

Required

The quantity of the line item.

Range:

0 <= value

Example:

1

totalAmountinteger

Required

The line total in minor units, including tax and discounts.

Range:

0 <= value <= 200000000

Example:

1095

unitPriceinteger

Required

The price of one item in minor units, before discounts.

Range:

value <= 200000000

Example:

1095

typestring

Required

The category of the line item.

Possible values:

"PHYSICAL""DISCOUNT""SHIPPING_FEE""SALES_TAX""DIGITAL""GIFT_CARD""STORE_CREDIT""SURCHARGE""OTHER"

Example:

"PHYSICAL"

]

The configured allowed payment methods.

createdAtstring

Required

The UTC time at which the multi-link was created.

Format:

date-time

Example:

"2026-04-01T15:04:05Z"

MultiLink

{  "id": "KSNMWEWZPPA",  "pointOfSaleId": "0192473a-e381-705c-b61c-fc2ac9624afc",  "state": "ACTIVE",  "amount": 1095,  "currency": "DKK",  "subscription": {    "amount": 1095,    "type": "SCHEDULED",    "expiryDate": "2027-12-31",    "interval": {      "period": "MONTH",      "frequency": 1    },    "billingAgreement": {      "billingPlanId": "019a7266-2f3a-7b26-9c93-b950aea9e13c",      "nextChargeAt": "2027-01-01"    }  },  "scaMode": "NORMAL",  "timeout": 30,  "instantCapture": "OFF",  "textOnStatement": "Store purchase",  "attributes": {    "property1": null,    "property2": null  },  "reportFailure": false,  "reportExpired": false,  "dynamicAmount": true,  "notificationUrl": "https://example.com/payment-notifications",  "preAuthUrl": "https://example.com/pre-authorizations",  "successUrl": "https://example.com/payment-success",  "returnUrl": "https://example.com/payment-return",  "failureUrl": "https://example.com/payment-failure",  "retryUrl": "https://example.com/payment-retry",  "maxAttempts": 3,  "exemptions": [    "TRA"  ],  "ageVerification": {    "minimumAge": 18,    "country": "DK"  },  "orderLines": [    {      "description": "Reusable coffee cup",      "imageUrl": "https://example.com/images/reusable-cup.png",      "quantity": 1,      "totalAmount": 1095,      "unitPrice": 1095,      "type": "PHYSICAL"    }  ],  "allowedPaymentMethods": [    "CARD",    "VIPPS_MOBILEPAY"  ],  "createdAt": "2026-04-01T15:04:05Z"}