Skip to main content

TransactionsListResponse

pageinteger

The current pagination page

perPageinteger

The requested number of entries per page

lastPageinteger

The last page with entries

totalinteger

The total number of entries

firstPageUrlstring

URL for the first page

lastPageUrlstring

URL for the last page

nextPageUrlstringnullable

URL for the next page

previousPageUrlstringnullable

URL for the previous page

nextPageintegernullable

The page number for the next page. Null if no next page.

previousPageintegernullable

The page number for the previous page. Null if no previous page.

frominteger

The entry offset for the first entry in the page

tointeger

The entry offset for the last entry in the page

pathstring

The path for the pagination endpoint

items object[]

The page contents

  • Array [
  • 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. See our Core Concepts page.

    Possible values: [PENDING, PROCESSING, SUCCESS, FAILED]

    errorCodestringnullable

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

    externalStatusCodes objectnullable

    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.

    acquirerstring

    The status code from the acquirer. The possible values depend on processing acquirer. The key is only present if the value is known to ePay.

    networkstring

    The status code from the scheme network. The field is only used for card based payments but stays consistent between acquirers. The key is only present if the value is known to ePay.

    scastring

    A unified status code representing the result of the Strong Customer Authentication (SCA) flow, such as 3DS. The code is built by concatenating the challenge status (transStatus) and reason code (transStatusReason) from the two steps of the 3DS protocol.

    CodeMeaning
    CTransaction was challenged
    NTransaction was rejected
    YTransaction was approved
    UTechnical issues
    IInformational Only (No authentication performed)

    The reason code (transStatusReason) is appended if present, e.g., 07.

    Examples:

    • Y - Frictionless approval
    • CY - Challenged then approved
    • CN07 - Challenged then rejected due to reason 07
    • N07 - Rejected without a challenge due to reason 07
    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

    paymentMethodTypePaymentMethodType (string)

    The type of the payment method.

    Possible values: [CARD, VIPPS_MOBILEPAY, MOBILEPAY_ONLINE, APPLE_PAY, GOOGLE_PAY, SWISH, VIABILL, ANYDAY]

    Example: CARD
    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. 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.

    paymentMethodExpirydate

    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.

    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.

    Possible values: [SKIP, NORMAL, FORCE]

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

    notificationUrluri

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

    Possible values: <= 1024 characters

    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

    Possible values: non-empty and <= 39 characters

    exemptionsstring[]

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

    Example: ["LVT","TRA"]
    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 (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]

  • ]
  • TransactionsListResponse
    {
    "page": 0,
    "perPage": 0,
    "lastPage": 0,
    "total": 0,
    "firstPageUrl": "string",
    "lastPageUrl": "string",
    "nextPageUrl": "string",
    "previousPageUrl": "string",
    "nextPage": 0,
    "previousPage": 0,
    "from": 0,
    "to": 0,
    "path": "string",
    "items": [
    {
    "id": "LDG7M4WW44G",
    "subscriptionId": "0197c07b-3f6d-7be2-b848-702b08958128",
    "state": "PENDING",
    "errorCode": "string",
    "externalStatusCodes": {
    "acquirer": "string",
    "network": "string",
    "sca": "string"
    },
    "createdAt": "2024-07-29T15:51:28.071Z",
    "sessionId": "string",
    "paymentMethodId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "paymentMethodType": "CARD",
    "paymentMethodSubType": "string",
    "paymentMethodExpiry": "2024-07-29",
    "paymentMethodDisplayText": "string",
    "paymentMethodHolderName": "string",
    "scaMode": "SKIP",
    "customerId": "string",
    "amount": 0,
    "fee": 0,
    "currency": "string",
    "instantCapture": "OFF",
    "notificationUrl": "string",
    "pointOfSaleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "reference": "string",
    "textOnStatement": "string",
    "exemptions": [
    "LVT",
    "TRA"
    ],
    "attributes": {},
    "clientIp": "52.212.176.122",
    "clientCountry": "DK",
    "type": "PAYMENT"
    }
    ]
    }