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

Transaction

idstring

The ID of the transaction

Example:
"LDG7M4WW44G"
subscriptionIdstring
Nullable

The ID of the associated subscription

Format:
uuid
Example:
"0197c07b-3f6d-7be2-b848-702b08958128"
billingAgreementChargeIdstring
Nullable

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

Format:
uuid
Example:
"019a727b-987f-7768-a59e-71af920ef81f"
statestring

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

Possible values:
"PENDING""PROCESSING""SUCCESS""FAILED"
errorCodestring
Nullable

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.

createdAtstring

The time of creation

Format:
date-time
sessionIdstring
Nullable

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

paymentMethodIdstring

The ID of the associated payment method

Format:
uuid
paymentMethodTypePaymentMethodType

The type of the payment method.

Possible values:
"CARD""VIPPS_MOBILEPAY""MOBILEPAY_ONLINE""APPLE_PAY""GOOGLE_PAY""SWISH""VIABILL""ANYDAY""KLARNA"
Example:
"CARD"
paymentMethodSubTypestring
Nullable

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.

Possible values:
"Visa""Mastercard""Maestro""Dankort""VisaDankort""Discover""UnionPay""Electron""Amex""JCB"
Example:
"Visa"
paymentMethodExpirystring
Nullable

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.

Format:
date
paymentMethodDisplayTextstring

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

paymentMethodHolderNamestring
Nullable

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.

Possible values:
"SKIP""NORMAL""FORCE"
customerIdstring
Nullable

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 (e.g., 1095 = 10.95 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.

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

currencystring

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

instantCapturestring

The instant capture mode.

Possible values:
"OFF""VOID""NO_VOID"
notificationUrlstring

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

Format:
uri
Length:
length <= 1024
pointOfSaleIdstring

The ID of the associated point of sale

Format:
uuid
referencestring
Nullable

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

textOnStatementstring
Nullable

The text to show on the cardholder bank statement

Length:
1 <= length <= 39

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

clientIpstring

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.

Example:
"52.212.176.122"
clientCountrystring

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

  • Data derived from GeoLite2 by MaxMind.
Example:
"DK"
typestring

The type of transaction.

Possible values:
"PAYMENT""PAYOUT""MOTO"
Transaction
{  "id": "LDG7M4WW44G",  "subscriptionId": "0197c07b-3f6d-7be2-b848-702b08958128",  "billingAgreementChargeId": "019a727b-987f-7768-a59e-71af920ef81f",  "state": "PENDING",  "errorCode": "string",  "externalStatusCodes": {    "terminal": "string",    "acquirer": "string",    "network": "string",    "sca": "string"  },  "createdAt": "2019-08-24T14:15:22Z",  "sessionId": "string",  "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",  "paymentMethodType": "CARD",  "paymentMethodSubType": "Visa",  "paymentMethodExpiry": "2019-08-24",  "paymentMethodDisplayText": "string",  "paymentMethodHolderName": "string",  "scaMode": "SKIP",  "customerId": "string",  "amount": 0,  "fee": 0,  "currency": "string",  "instantCapture": "OFF",  "notificationUrl": "http://example.com",  "pointOfSaleId": "be6bff4f-7fac-43c0-9f6b-cf2cd45ed7d1",  "reference": "string",  "textOnStatement": "string",  "exemptions": [    "LVT",    "TRA"  ],  "attributes": {    "property1": null,    "property2": null  },  "clientIp": "52.212.176.122",  "clientCountry": "DK",  "type": "PAYMENT"}