CreatePaymentLinkRequest
Id of the point of sale to associate the payment with.
uuid"01924737-9c18-71c0-ab1a-88698eaceabf"This is the transaction reference, similar to an order ID. The reference **SHOULD** be unique for each payment, as some acquirers enforce per-payment uniqueness. Using a duplicate reference may result in failed payments or make reconciliation difficult. Only ASCII alphanumeric characters and dashes are allowed. **Worldline specific**: `-` is removed if present and if the value is longer than 12 position, the left most part is used.
^[A-Za-z0-9-]{1,36}$1 <= length <= 36"reference-1"The amount must be defined in minor units. E.g. 2,50 DKK must be set as 250. If amount is set to 0 a token will be created only and returned to the integrator.
100The currency code of the payment. For Danish Kroner defined as DKK. ISO 4217 alpha-3 (e.g., DKK)
^[A-Z]{3}$"DKK"If the payment should be captured instantly or not.<ul><li> `OFF` indicates that the payment should not be captured instantly.</li><li> `VOID` indicates that the payment should be captured instantly and if somehow the instant capture fails the payment is voided.</li><li> `NO_VOID` indicates that the payment should be captured instantly and if the capture fails the authorization is kept (no void is made)</li></ul>
"OFF""VOID""NO_VOID""OFF"**DEPRECATED:** *This parameter will soon be removed and will no longer have any effect. The functionality has been replaced by routing rules in the ePay back office.* List of processors to use. This is the routing of the payment. The value can be `shift4`, `clearhaus` and `nets`.<br/><br/>Processor priority follows the order in the list. If the first processor fails or declines, the next processor in the list will be attempted, and so on until all processors have been tried. Note that the actual processing order is not guaranteed and may depend on external factors, such as the specific payment card used by the cardholder.
[
"shift4"
]Identifier of a payment processor. This value determines which payment gateway(s) are used to process a payment.
"shift4""clearhaus""nets""worldline"This is the text set on the transaction in the bank viewed by the card holder. That can be e.g. "order 123". Defaults to the ePay transaction id. Some providers does not support long texts, ePay will automatically cut the text to fit the providers requirements.
1 <= length <= 39"order 123"A list of pass through attributes that is sent back to the merchant on webhooks. Max size is 1kb.
An optional merchant defined customer id used to uniquely identify a user in the merchant system. This field is required to enable stored payment methods and enhanced age verification.
"User159"Customer info. These data points are used during SCA/3DS and is required for some schemes. These data may also be sent to the specific payment provider, if required to complete the payment such as Klarna. It is recommended to send all the info that is available to improve the approval rate.
{
"firstName": "Peter",
"lastName": "Nielsen",
"email": "email@example.com"
}Customer info. These data points are used during SCA/3DS and is required for some schemes. These data may also be sent to the specific payment provider, if required to complete the payment such as Klarna. It is recommended to send all the info that is available to improve the approval rate.
{
"firstName": "Peter",
"lastName": "Nielsen",
"email": "email@example.com"
}If not null then pre-authorization webhook are enabled for all transaction attempts for the session. Max length is `1024`.
uri1 <= length <= 1024"https://example.com/preAuth"The array containing list of line items that are part of this order. Maximum of 1000 line items could be processed in a single order. This is used by some payment methods, such as Klarna.
items <= 1000**Note `scaMode` is always set to `FORCE` when initializing a subscription due to EU PSD2 regulations.** <br><br> To create a subscription, allowing you to process MIT transactions in the future, you must send the subscription object. To process MIT transactions you must ensure your acquirer agreement has recurring payments enabled.
An optional subscription ID can be used to update an existing active subscription with new payment details, such as a new card or a completely different payment method.
uuidAn optional amount in minor units (e.g., 1095 = 10.95 DKK) that can be used to differentiate the recurring subscription amount from the current transaction amount. This is useful if customers are not expected to pay today, but must pay a monthly fee going forward - In this case set amount=0 and subscription.amount=XXX. Defaults to the transaction amount if not given.
The type of subscription. <br/><br/><ul><li>`UNSCHEDULED` Pay-as-you-go type subscriptions with no fixed interval for charges.</li><li>`SCHEDULED` Fixed interval charges like a subscription paid monthly.</li></ul>
"UNSCHEDULED""SCHEDULED""SCHEDULED"An optional merchant defined reference for the subscription. If none is given, then the session reference will be used as a fallback.
"subscription-1"An optional field indicating the expiry of the subscription. This date is used during 3DS, and may improve conversion rates. ePay does not reject payments after this date.
dateAn optional subscription schedule for `SCHEDULED` type subscriptions. Must be omitted for `UNSCHEDULED` type subscriptions. Is required by some payment methods such as Vipps Mobilepay. Is used during 3DS - May improve conversion rates.
The period unit between charges
"DAY""WEEK""MONTH""YEAR"The number of period units between each charge. `1-31`. Example: `Frequency: 3, Period: DAY` One charge every 3 days.
An optional property. When given a automatic scheduled billing agreement will be created. This can be used to sign up customers to automatic subscription billing, such as monthly payments. This field is mutually exclusive with subscription.id and subscription.interval
The type of transaction to process. Most merchants should use `PAYMENT` unless they have specific use cases. - `PAYMENT` is for ordinary purchases and the standard type to use for most merchants. - `MOTO` is short for Mail Order & Telephone Order and is typically used by travel agencies who receive payment info over the phone or email. MOTO is exempt from SCA but requires a special acquirer agreement to use.
"PAYMENT""PAYMENT""MOTO"How 3D secure is handled:<br/><ul><li>`SKIP` 3DS is not tried and full liability is put at merchant.</li><li>`NORMAL` 3DS flow is attempted as normal guidelines suggests - Both challenge and frictionless can occur.</li><li>`FORCE` A challenge flow is forced. Note: Third parties in the 3DS flow might ignore this instruction.</li></ul>
"SKIP""NORMAL""FORCE""NORMAL"The session is valid for the specified number of minutes. If a timeout occurs, the session expires and no more payment attempts are possible.
1 <= value <= 120120List of exemptions to apply when applicable. Supports [`TRA`, `LVT`]. Note: Using exemptions may shift liability for fraud from the issuer to the merchant.
[]"TRA""LVT"List of allowed payment methods to use for this session. If left empty, all payment methods will be allowed. This is useful for controlling which payment methods are visible in the payment window. If only 1 payment method is allowed and it is redirect-based, such as `VIPPS_MOBILEPAY`, the user will be automatically redirected from the payment window to the MobilePay payment page, without the user having to click anything. If the user then cancels the MobilePay payment, they will be redirected back to the `returnUrl` (Or the `failureUrl` if the `returnUrl` is not specified) instead of going back to the payment window.
[
"CARD",
"VIPPS_MOBILEPAY"
]The type of the payment method.
"CARD""VIPPS_MOBILEPAY""MOBILEPAY_ONLINE""APPLE_PAY""GOOGLE_PAY""SWISH""VIABILL""ANYDAY""KLARNA""CARD"The maximum allowed number of payment attempts for the session.
1 <= value <= 2525If set to `true` the response property `qrCode` will be filled with a Base64 encoded QR code, which can be displayed for quick device-to-device link sharing such as from a POS device where the customer can scan the code and complete the payment on their own phone
falsefalseIf true: Enables webhooks to the `notificationUrl` for failed transactions. Otherwise only successful transactions are reported.
falseIf true: Enables webhooks to the `notificationUrl` for sessions that reach the expired state.
falseIf true: Enables the cardholder to define the transaction amount. Otherwise, the amount from the session is used for transactions. Can be used in conjunction with pre-auth webhooks to reject transactions with unacceptable amounts. **NOTE: This gives client side control over the payment amount. Only use if necessary.**. Must be enabled by ePay support.
falseThe URL to where ePay notifies about payment statuses. Max length is `1024`. <div class="theme-admonition theme-admonition-info alert alert--info"> <p style="margin-bottom:8px;">All URL properties support dynamic templating with session and transaction data, allowing merchants to define URLs that include ePay-generated resource ID's.</p> <p style="margin-bottom:8px;">This feature can be particularly helpful for some merchants, especially with success and failure URLs, as it simplifies fetching order information upon transaction completion.</p> <p style="margin-bottom:8px;">Unknown template keys will be rejected during request validation.</p> - `${transaction.id}`: The primary id of the associated transaction. - `${transaction.reference}`: The merchant supplied reference from session init. - `${session.id}`: The primary id of the associated session. - `${subscription.id}`: The primary id of the associated subscription. </div>
uri1 <= length <= 1024"https://example.com/notification"The URL to where the browser is returned, when clicking the `back` button in the Payment Window. This overrides the default defined in the payment window configuration and supports url templating. Max length is `1024`. <div class="theme-admonition theme-admonition-info alert alert--info"> Only used in Payment Window integrations. </div>
uri1 <= length <= 1024"https://example.com/success"The URL the client is redirected to on a successful payment. Max length is `1024`.
uri1 <= length <= 1024"https://example.com/success"The URL the client is redirected to when no more payment attempts are allowed. Max length is `1024`.
uri1 <= length <= 1024"https://example.com/failure"An optional URL the client is redirected to when a payment attempt fails but more attempts are still allowed. If the retryUrl is not provided then the client will be redirected to the failureUrl. Max length is `1024`.
uri1 <= length <= 1024"https://example.com/retry"Specifies age verification requirements for the purchase. - If not provided or set to null, no age verification will be performed. - If provided, the customer must verify their age to be at least the value specified in the `minimumAge` property. For danish customers this id verified using MitID. Session.minimumAge will be set; transactions may be rejected if age not verified.
0 <= value <= 99Country code for the delivery country (ISO 3166 alpha-2 country codes). This code determines which electronic ID (eID) is presented to the user (e.g., MitID in Denmark).
"DK"