PaymentSessionInitializationResponse

qrCodestring

Nullable

QR code version of the paymentWindowUrl in base64, 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. Is only present if generateQrCode is set to true.

QR code version of the `paymentWindowUrl` in base64, 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. Is only present if `generateQrCode` is set to `true`.

paymentWindowUrlstring

URL for ePay Checkout. If you are using Checkout and not Blocks, then you must redirect the customer to this URL.

Format:

uri

javascriptstring

For merchants implementing Blocks, load this script to use the ePay.js client

Format:

uri

keystring

For merchants implementing Blocks, this is the client secret used to allow the ePay.js client to interact with the payment session

idstring

The ID of the payment session

Format:

uuid

subscriptionIdstring

Nullable

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.

Format:

uuid

amountinteger

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.

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.

Example:

[
  "CARD",
  "VIPPS_MOBILEPAY"
]

currencystring

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

Match:

^[A-Z]{3}$

expiresAtstring

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

Format:

date-time

instantCapturestring

The instant capture mode.

Possible values:

"OFF""VOID""NO_VOID"

maxAttemptsinteger

The maximum number of transaction attempts allowed for the session

attemptsinteger

The current number of transaction attempts so far.

minimumAgeinteger

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.

ageVerifiedboolean

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

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

reportFailureboolean

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

reportExpiredboolean

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

dynamicAmountboolean

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

notificationUrlstring

The URL to receive webhooks related to transaction attempts

Format:

uri

preAuthUrlstring

Nullable

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.

Format:

uri

successUrlstring

The URL to redirect the client on successful payment attempts

Format:

uri

returnUrlstring

Nullable

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 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>

Format:

uri

Length:

1 <= length <= 1024

failureUrlstring

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

Format:

uri

retryUrlstring

Nullable

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

Format:

uri

customerIdstring

Nullable

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.

pointOfSaleIdstring

The ID of the associated point of sale

Format:

uuid

referencestring

Nullable

The transaction reference - Typically the order id.

statestring

The state of the transaction

Possible values:

"PENDING""PROCESSING""COMPLETED""EXPIRED"

textOnStatementstring

The text to display on the cardholders bank statement

Length:

1 <= length <= 39

scaModestring

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

Possible values:

"SKIP""NORMAL""FORCE"

timeoutinteger

The number of minutes the session is available.

createdAtstring

The time of creation

Format:

date-time

PaymentSessionInitializationResponse

{  "qrCode": "string",  "paymentWindowUrl": "http://example.com",  "javascript": "http://example.com",  "key": "string",  "session": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",    "amount": 0,    "attributes": {      "property1": null,      "property2": null    },    "exemptions": [      "string"    ],    "allowedPaymentMethods": [      "CARD",      "VIPPS_MOBILEPAY"    ],    "currency": "string",    "expiresAt": "2019-08-24T14:15:22Z",    "instantCapture": "OFF",    "maxAttempts": 0,    "attempts": 0,    "minimumAge": 0,    "ageVerified": true,    "reportFailure": true,    "reportExpired": true,    "dynamicAmount": true,    "notificationUrl": "http://example.com",    "preAuthUrl": "http://example.com",    "successUrl": "http://example.com",    "returnUrl": "http://example.com",    "failureUrl": "http://example.com",    "retryUrl": "http://example.com",    "customerId": "string",    "pointOfSaleId": "be6bff4f-7fac-43c0-9f6b-cf2cd45ed7d1",    "reference": "string",    "state": "PENDING",    "textOnStatement": "string",    "scaMode": "SKIP",    "timeout": 0,    "createdAt": "2019-08-24T14:15:22Z"  }}