Get All Events

Returns a list of all events linked to a specific object (e.g subscription) with pagination.

info

The request must provide the following header:

x-api-key: {merchantKey}

Request sample

Path:

GET {baseURL}/events?origin=api&page=7&objectType=transaction&pageSize=1

Header:

Content-Type: application/json
Accept-Language: en-US

Response parameters

Field	Description	Type
page	Number of the page for which the data is to be returned.	Int
pageSize	Number of the records to display per page.	Int
count	Number of total records(events) returned for the made search/request.	Int
totalPages	Number of pages returned for the made search/request.	Int
data	Data of the object linked to the events	Object

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
    "page": 7,
    "pageSize": 1,
    "count": 8,
    "totalPages": 8,
    "data": [
        {
            "id": "Event-0d51a439-7e17-4dc8-9060-5c2ec9ac9ce7",
            "createdAt": "2021-06-08T08:37:03.14Z",
            "origin": "api",
            "eventType": "created",
            "objectId": "Transaction-cc9b3585-c7bf-4ae0-9be7-545778593299",
            "objectType": "transaction",
            "data": {
                "id": "Transaction-cc9b3585-c7bf-4ae0-9be7-545778593299",
                "customerAccountId": "NewcustomerTestPSerie00",
                "storedPaymentOptionReference": "8ac7a49f79ea7b760179eaae946a4ff7",
                "modificationId": "783ad3b1-69a6-4fe1-9c3e-1742dd81e4a6",
                "paymentStatus": null,
                "payment": {
                    "description": "MerchantExternalIDPSerie01",
                    "amount": 6.0,
                    "currencyIsoCode": "EUR"
                },
                "billingAddress": {
                    "addressLine1": "Leopoldstrasse",
                    "addressLine2": null,
                    "addressLine3": null,
                    "number": "244",
                    "city": "Munich",
                    "postCode": "80807",
                    "countryCode": "DE",
                    "state": null
                },
                "shippingAddress": {
                    "addressLine1": "Leopoldstrasse",
                    "addressLine2": null,
                    "addressLine3": null,
                    "number": "244",
                    "city": "Munich",
                    "postCode": "80807",
                    "countryCode": "DE",
                    "state": null
                },
                "consumer": {
                    "firstName": "FirstNameA",
                    "lastName": "LastNameA",
                    "middleName": null,
                    "emailAddress": "NewcustomerTestPSerie00@mail.com",
                    "title": "Mr",
                    "culture": "en-en",
                    "dateOfBirth": "1995-01-26",
                    "gender": "M",
                    "mobilePhone": "1234567890",
                    "homePhone": "1234567891",
                    "workPhone": "1234567892",
                    "taxId": null
                },
                "transactionLogs": null
            },
            "context": "{\"description\":\"first TRX PS!\",\"amount\":6.00}"
        }
    ]
}

info

For error handling, please refer to this section.