Skip to main content

PointOfSaleListResponse

pageinteger

The current pagination page

per_pageinteger

The requested number of entries per page

last_pageinteger

The last page with entries

totalinteger

The total number of entries

first_page_urlstring

URL for the first page

last_page_urlstring

URL for the last page

next_page_urlstring

URL for the next page

previous_page_urlstring

URL for the 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 [
  • pointOfSale object
    iduuidrequired

    The ID of the point of sale. This is used when creating new payment session.

    namestringrequired

    A visual name displayed in the ePay backoffice to help the merchant and ePay staff identify the point of sale

    descriptorstringrequired

    The merchant name displayed to the cardholder in both their bank statement and any 3DS challenge such as MitId.

    created_atdate-timerequired

    The time of creation in UTC.

    updated_atdate-timerequired

    The last time the point of sale was modified in UTC

    hostedConfiguration object
    instantCapturestringrequired

    If the payment should be captured instantly or not.

    • OFF indicates that the payment should not be captured instantly.
    • VOID indicates that the payment should be captured instantly and if somehow the instant capture fails the payment is voided.
    • NO_VOID indicates that the payment should be captured instantly and if the capture fails the authorization is kept (no void is made)

    scaModestringrequired

    How 3D secure is handled:

    • SKIP 3DS is not tried and full liability is put at merchant.
    • NORMAL 3DS flow is attempted as normal guidelines suggests - Both challenge and frictionless can occur.
    • FORCE A challenge flow is forced. Note: Third parties in the 3DS flow might ignore this instruction.

    timeoutintegerrequired

    How many minutes sessions stays active.

    notificationUrlurirequired

    The URL to receive webhook notifications for any attempted transactions

    successUrlurirequired

    The URL the client is redirected to on successful payments

    failureUrlurirequired

    The URL the client is redirected to when no more payment attempts is possible for the current session.

    retryUrlurinullable

    The URL the client is redirected to on failed payments while there is still more attempts available. If null, then failureUrl is used as a fallback.

    maxAttemptsintegerrequired

    The maximum number of transaction attempts allowed for the payment session

    processorstring[]required

    A priority list of processors to attempt when processing card transactions

    exemptionsstring[]required

    List of exemptions to apply when possible. Note exemptions shifts liability from the issuer to the merchant.

    reportFailurebooleanrequired

    If true, the notificationUrl will also receive webhooks for failed transactions. Otherwise, only successful transactions is notified.

  • ]
  • PointOfSaleListResponse
    {
    "page": 0,
    "per_page": 0,
    "last_page": 0,
    "total": 0,
    "first_page_url": "string",
    "last_page_url": "string",
    "next_page_url": "string",
    "previous_page_url": "string",
    "from": 0,
    "to": 0,
    "path": "string",
    "items": [
    {
    "pointOfSale": {
    "id": "0192473a-e381-705c-b61c-fc2ac9624afc",
    "name": "Store #42",
    "descriptor": "POS Copenhagen",
    "created_at": "2024-10-01T10:38:14.658688472+02:00",
    "updated_at": "2024-10-01T12:38:14.658688472+02:00"
    },
    "hostedConfiguration": {
    "instantCapture": "OFF",
    "scaMode": "SKIP",
    "timeout": 60,
    "notificationUrl": "https://example.com/notification",
    "successUrl": "https://example.com/success",
    "failureUrl": "https://example.com/failure",
    "retryUrl": null,
    "maxAttempts": 10,
    "processor": [
    "shift4",
    "nets"
    ],
    "exemptions": [
    "TRA",
    "LVT"
    ],
    "reportFailure": false
    }
    }
    ]
    }