Skip to main content

NotificationWebhook

The notification webhook received on completed transaction attempts. The transaction can be either successful or failed.

acquirerAgreement object
acquirerstring

The name of the used acquirer / processor of the transaction

Example: shift4
mccstring

The merchant category code registered on the agreement. Note 4514 is the default code when none is registered or when not relevant.

Example: 4514
transaction object
idstring

The ID of the transaction

Example: LDG7M4WW44G
subscriptionIduuidnullable

The ID of the associated subscription

Example: 0197c07b-3f6d-7be2-b848-702b08958128
statestring

The current state of the transaction

errorCodestringnullable

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

createdAtdate-time

The time of creation

sessionIdstringnullable

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

paymentMethodIduuid

The ID of the associated payment method

paymentMethodTypestring

The method type of the associated payment method.

paymentMethodSubTypestring

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

paymentMethodExpirydate

The expiration date of the associated payment method.

paymentMethodDisplayTextstring

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

paymentMethodHolderNamestringnullable

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

scaModestring

The SCA mode of the transaction.

customerIdstring

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.

amountinteger

The transaction amount in minor units. 10000 would be 100 DKK

feeinteger

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.

currencystring

The currency of the transaction in alpha-3. DDK for danish kroner.

instantCapturestring

The instant capture mode.

Possible values: [OFF, VOID, NO_VOID]

notificationUrluri

The URL to receive webhook notifications of any transaction attempts

pointOfSaleIduuid

The ID of the associated point of sale

referencestring

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

textOnStatementstring

The text to show on the cardholder bank statement

exemptionsstring[]

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

attributes object

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

property name*string
clientIpstring

The ip of the cardholder making the transaction

typestring

The type of transaction.

Possible values: [PAYMENT, PAYOUT]

session objectnullable
iduuid

The ID of the payment session

subscriptionIduuidnullable

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.

amountinteger

The transaction amount in minor units. 10000 equal 100 DKK

attributes objectnullable

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

property name*string
exemptionsstring[]

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

currencystring

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

expiresAtdate-time

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

instantCapturestring

The instant capture mode.

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 Age Verification 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.

reportFailureboolean

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

dynamicAmountboolean

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

notificationUrluri

The URL to receive webhooks related to transaction attempts

preAuthUrlurinullable

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.

successUrluri

The URL to redirect the client on successful payment attempts

failureUrluri

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

retryUrlurinullable

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

customerIdstringnullable

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.

pointOfSaleIduuid

The ID of the associated point of sale

referencestringnullable

The transaction reference - Typically the order id.

statestring

The state of the transaction

textOnStatementstring

The text to display on the cardholders bank statement

scaModestring

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

timeoutinteger

The number of minutes the session is available.

createdAtdate-time

The time of creation

subscription objectnullable
iduuid

The ID of the subscription

Example: 01929a94-5fce-7ccc-a7e4-7e9249133b39
paymentMethodIduuid

The ID of the associated payment method

Example: 01924756-d1f6-738d-8040-90d76cedf01f
currencystring

The currency of the original transaction which created the subscription. This is used as the default currency for new MIT transactions, if no currency is given.

Example: DKK
customerIdstring

The id of the merchant customer

Example: User159
pointOfSaleIduuid

The ID of the associated point of sale used during the creation of the subscription

Example: 0192473a-e381-705c-b61c-fc2ac9624afc
referencestring

The merchant reference for the subscription.

Example: reference-1
statestring

The current state of the subscription.

Possible values: [PENDING, ACTIVE, INVALID, DISABLED]

Example: ACTIVE
typestring

The type of subscription. SCHEDULED is used for fixed interval charges such as a monthly subscription fee. UNSCHEDULED is used for varying transaction intervals such as pay-as-you-go solutions such as parking or bike renting.

Possible values: [SCHEDULED, UNSCHEDULED]

Example: SCHEDULED
expiryDatedate-timenullable

The expiration date of the subscription. ePay does not enforce this expiration, but uses it in the processing of transactions which may improve approval rates.

Example: 2050-01-01
interval object

Interval configuration. Is can only be present when type equal SCHEDULED. A frequency=2 and period=WEEK means one charge for every two weeks.

periodstring

The time unit of the frequency field

Example: MONTH
frequencyinteger

The number of period's between each charge.

Example: 1
createdAtdate-time

The time of creation

sca objectnullable
rejectedboolean

Boolean indicator which is true when the transaction is rejected due to failing SCA such as a 3DS challenge with MitId.

Example: false
typestring

The type of SCA performed during the transaction.

Possible values: [3DS, DELEGATED, UNKNOWN]

Example: 3DS
verificationstring

The level of verification performed during the transaction. The value will be CHALLENGED if the customer was prompted with challenges such as MitID login.

Possible values: [NONE, FRICTIONLESS, CHALLENGED, UNKNOWN]

Example: FRICTIONLESS
NotificationWebhook
{
"acquirerAgreement": {
"acquirer": "shift4",
"mcc": "4514"
},
"transaction": {
"id": "LDG7M4WW44G",
"subscriptionId": "0197c07b-3f6d-7be2-b848-702b08958128",
"state": "string",
"errorCode": "string",
"createdAt": "2024-07-29T15:51:28.071Z",
"sessionId": "string",
"paymentMethodId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentMethodType": "string",
"paymentMethodSubType": "string",
"paymentMethodExpiry": "2024-07-29",
"paymentMethodDisplayText": "string",
"paymentMethodHolderName": "string",
"scaMode": "string",
"customerId": "string",
"amount": 0,
"fee": 0,
"currency": "string",
"instantCapture": "OFF",
"notificationUrl": "string",
"pointOfSaleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"textOnStatement": "string",
"exemptions": [
"string"
],
"attributes": {},
"clientIp": "string",
"type": "PAYMENT"
},
"session": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"amount": 0,
"attributes": {},
"exemptions": [
"string"
],
"currency": "string",
"expiresAt": "2024-07-29T15:51:28.071Z",
"instantCapture": "string",
"maxAttempts": 0,
"attempts": 0,
"minimumAge": 0,
"ageVerified": true,
"reportFailure": true,
"dynamicAmount": true,
"notificationUrl": "string",
"preAuthUrl": "string",
"successUrl": "string",
"failureUrl": "string",
"retryUrl": "string",
"customerId": "string",
"pointOfSaleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"state": "string",
"textOnStatement": "string",
"scaMode": "string",
"timeout": 0,
"createdAt": "2024-07-29T15:51:28.071Z"
},
"subscription": {
"id": "01929a94-5fce-7ccc-a7e4-7e9249133b39",
"paymentMethodId": "01924756-d1f6-738d-8040-90d76cedf01f",
"currency": "DKK",
"customerId": "User159",
"pointOfSaleId": "0192473a-e381-705c-b61c-fc2ac9624afc",
"reference": "reference-1",
"state": "ACTIVE",
"type": "SCHEDULED",
"expiryDate": "2050-01-01",
"interval": {
"period": "MONTH",
"frequency": 1
},
"createdAt": "2024-07-29T15:51:28.071Z"
},
"sca": {
"rejected": false,
"type": "3DS",
"verification": "FRICTIONLESS"
}
}