GetPaymentSessionResponse

The ID of the payment session

The subscription id related to the session, this can either be a new ID for new subscriptions or the given ID of a previous subscription which needs to be updated.

The transaction amount in minor units (e.g., 1095 = 10.95 DKK)

Pass-through data which will be returned back to the merchant in any webhook.

List of exemptions to apply when available. Note exemptions may cause liability shift from the issuer to the merchant.

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.

The currency of the payment. For Danish Kroner defined as DKK.

The expiration time of the payment session. After this time the session can no longer be used and a new session must be created.

The instant capture mode.

The maximum number of transaction attempts allowed for the session

The current number of transaction attempts so far.

The minimum age required. If not null and ePay Verify is enabled on your account, the cardholder will be prompted to verify their age using local online IDs such as MitID in Denmark.

Is true once the customers age has been verified to be at least equal to minimumAge parameter.

Boolean flag to enable / disable receiving webhook notifications for failed transactions.

Boolean flag to enable / disable receiving webhook notifications for sessions that reach the expired state.

Boolean flag to enable / disable dynamic amounts, allowing the client to determine the transaction amount. This is generally not recommended for most merchants.

The URL to receive notifications for successful transaction attempts. Failed transaction attempts are sent only when reportFailure is true, and expired sessions are sent only when reportExpired is true.

Optional URL to receive a webhook just before authorization is attempted. Can be used to update or reject the transaction. This is often used by merchants integrating external risk tooling to trigger 3DS challenges depending on the payment.

The URL to redirect the client on successful payment attempts

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.

Only used in Payment Window integrations.

The URL to redirect the client on failed payment attempts when no more attempts are possible.

The URL to redirect the client on failed payment attempts when more attempts are possible. If null, then failureUrl is used instead.

The ID of the cardholder. This field is required to enable stored cards. Do not use any "guest" customer ids. Customer ids must be unique for each customer and secured behind authentication.

The ID of the associated point of sale

The transaction reference - Typically the order id.

The state of the transaction

The text to display on the cardholders bank statement

The chosen SCA mode. This can be used to control the level of cardholder authentication performed before the transaction is authorized.

The number of minutes the session is available.

The time of creation

The ID of the transaction

The ID of the associated subscription

The ID of any associated subscription billing charge. Will be null if the transaction was not an automatic charge made on a billing agreement.

The current state of the transaction. See our Core Concepts page.

If the transaction has failed, this contains the associated error code explaining what went wrong.

A nullable object containing any known external status codes, such as the status code from the acquirer or the network. This can be useful for merchants who want to be able to react to very specific rejection reasons.

The time of creation

The ID of the associated session. This will be null for any MIT transactions.

The ID of the associated payment method

The type of the payment method.

The sub type of the associated payment method. For card based payments, this will contain the name of the scheme, such as Visa or Mastercard. The card scheme name formatted with a uppercase starting character. For non-card based payments the field vary depending on the requirements of the payment method.

The expiration date of the associated payment method.
Although payment cards are specified by a month and year (MM/YY), this value is returned as a full date (YYYY-MM-DD) representing the last day of the expiration month. Example: "2030-05-31" for a card expiring in May 2030.

A cardholder friendly text to help them identify the payment method. For cards this will be a masked version of the card number.

Contains the entered cardholder name of the optional "name" field. Will be null if the field is not rendered.

The SCA mode of the transaction.

The merchant customer id of the transaction. This field is required to enable advanced features such as storing a card for later reuse. Do not use any "guest" customer ids. Customer ids must be unique for each customer and must be protected by authentication.

The transaction amount in minor units (e.g., 1095 = 10.95 DKK)

The applied transaction fee in minor units. The fee is included in the amount field. To get the original amount you must subtract fee from amount. Fees are only applied if surcharge is configured in the ePay backoffice.

Fees are calculated during transaction processing and as such is always 0 when initially created during MIT transactions.

The currency of the transaction in ISO 4217 alpha-3. DKK for danish kroner.

The instant capture mode.

The URL to receive webhook notifications of any transaction attempts. May contain templating variables.

The ID of the associated point of sale

The merchant reference of the transaction, this is often used for the order id.

The text to show on the cardholder bank statement

The list of exemptions to apply when possible. Note that exemptions may shift liability from the issuer to the merchant.

A list of pass-through parameters that will be sent back to the merchant for following any webhooks

The ip (ipv4/ipv6) of the cardholder making the transaction. The IP is captured by ePay at the initialization of the transaction client-side. Can be empty.

The detected origin country (Alpha-2) based on the clientIp property. Can be empty.

• Data derived from GeoLite2 by MaxMind.

The type of transaction.