Looking for ePay classic docs? Go to docs.epay.dk
ePay documentationDocsePay documentation
Payment Links

Get Multi-Link

OpenAPI Spec

Test this endpoint live

Open the same request directly in API Explorer.

Open in API Explorer

Server URL

GET
/public/api/v1/multi-links/{multiLinkId}

Retrieves one multi-link belonging to the authenticated merchant, including its reusable checkout URL and QR-code URL.

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

multiLinkIdstring
Required

The ID of the multi-link.

Header Parameters

Idempotency-Keystring

Ensures that a request can be safely retried without causing duplicate operations. Typically used for actions like payment creation and operations such as refund and void to prevent accidental double processing.

  • If a response is replayed due to using the same key, the response will include the header Idempotent-Replayed: true.
  • Idempotency keys are scoped by [Key, Endpoint, HTTP Verb]; the same key on a different endpoint or method will not replay the original response.
  • Responses are cached for 24 hours. After that, the cache is cleared, so idempotency is only guaranteed within 24 hours of the initial request.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/public/api/v1/multi-links/KSNMWEWZPPA" \  -H "Idempotency-Key: c4f5e8d2-1234-5678-90ab-cdef12345678"
{  "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"  },  "url": "https://payments.epay.eu/ml/KSNMWEWZPPA",  "qrUrl": "https://payments.epay.eu/multi-links/KSNMWEWZPPA/qr.png"}
{  "errorCode": "SERVER_ERROR",  "message": "An unexpected system error"}
{  "errorCode": "SERVER_ERROR",  "message": "An unexpected system error"}
{  "errorCode": "VALIDATION_ERROR",  "message": "Input validation errors",  "errors": {    "amount": [      "[required]: Is a required non-nullable field",      "[int]: Must be an integer",      "[min:0]: Must be greater than 0",      "[max:999999999]: Must be less than 999999999"    ]  }}
{  "errorCode": "SERVER_ERROR",  "message": "An unexpected system error"}

Create Multi-Link

Creates a reusable payment link and returns its URL and QR-code URL. Unlike a regular payment link, this endpoint does not create a single payment. Each time a cardholder opens the returned url or scans the QR code, ePay starts a new, independent payment session from the multi-link configuration. This is useful for a reusable checkout QR code - for example, a QR code where the cardholder enters the amount and completes payment with Vipps MobilePay. Configuration omitted from the request is resolved from the point of sale's current configuration when the multi-link is used. Redirect and notification URLs are not inherited; provide them explicitly when they are needed. URL values, including order-line image URLs, must use a domain registered for the selected point of sale.

Deactivate Multi-Link

Deactivates a multi-link so that its public URL and QR code can no longer start new payment sessions. This operation is idempotent: deactivating an already deactivated multi-link succeeds. Existing payment sessions created from the multi-link are not affected.