Get Event

Last changes: 11-29-2021

Returns the data linked to a specific event ID provided.

The request must provide the followng header:

x-api-key: {merchantKey}

Request sample

Path:: GET {{BaseUrl}}/events/Event-cf760116-4f36-4fbe-a508-9e77d64458ae
Header:: Content-Type: application/json
Accept-Language: en-US

Response parameters

Field	Description	Type	Length	Mandatory
id	Event ID, automatically generated by the system Format: "event" + "-" + <UUID> Example: "event-f81c4016-9c74-4046-9079-c00dbe4a5ce2"	String	42	Yes
createdAt	Timestamp of when the event was created Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z (E.g: 2021-02-11T15:00:44.718Z)	String	24	Yes
origin	Origin triggering the event Possible values: "api", "widget", "automated"	String	255	Yes
eventType	Type of the logged event. Possible values: "updated", "created", "status.updated", "billing.expires", "billing.updated", "billing.scheduled"	String	255	Yes
objectId	UUID of the object to which the event is related Example: "subscription-f81c4016-9c74-4046-9079-c00dbe4a5ce2"	String	255	Yes
objectType	Type of the object linked to the event. Possible values: "subscription", "plan", "billing-cycle", "payment-series", "transactions"	String	255	Yes
context	This is the request body for "api" and "widget" events.	String	255	Yes
data	Data of the object to which the event is linked.	Object	-	Yes

Response sample

Status Code:: 200 (OK)
Header:: Content-Type: application/json
Accept-Language: en-US

{
    "id": "Event-cf760116-4f36-4fbe-a508-9e77d64458ae",
    "createdAt": "2021-06-17T17:33:53.41Z",
    "origin": "api",
    "eventType": "created",
    "objectId": "PaymentSeries-72efb867-927b-4aee-9b8d-62f49651901b",
    "objectType": "payment-series",
    "data": {
        "id": "PaymentSeries-72efb867-927b-4aee-9b8d-62f49651901b",
        "createdAt": "2021-06-17T17:33:53.41Z",
        "updatedAt": "2021-06-17T17:33:53.41Z",
        "deletedAt": null,
        "customerAccountId": "d58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3",
        "currencyIsoCode": "EUR",
        "externalMerchantId": "d58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3d58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a311111",
        "merchantMetadata": "{ \"clientId\": 453456790 }",
        "externalReference": "PaymentSerie 1 Payment 1",
        "billingAddress": {
            "addressLine1": "Leopoldstrasse",
            "addressLine2": "Leopoldstrasse",
            "addressLine3": "Leopoldstrasse",
            "number": "244",
            "city": "Munich",
            "postCode": "80807",
            "countryCode": "DE",
            "state": "MN"
        },
        "shippingAddress": {
            "addressLine1": "Leopoldstrasse",
            "addressLine2": "Leopoldstrasse",
            "addressLine3": "Leopoldstrasse",
            "number": "244",
            "city": "Munich",
            "postCode": "80807",
            "countryCode": "DE",
            "state": "MN"
        },
        "consumer": {
            "firstName": "FirstNameA",
            "lastName": "LastNameA",
            "middleName": "Middle",
            "emailAddress": "NewcustomerSerie00@mail.com",
            "title": "Mr",
            "culture": "en-en",
            "dateOfBirth": "1995-01-26",
            "gender": "M",
            "mobilePhone": "1234567890",
            "homePhone": "1234567891",
            "workPhone": "1234567892",
            "taxId": "1255211DE1252"
        },
        "billingAgreement": null
    },
    "context": "{\"customerAccountId\":\"d58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3\",\"externalMerchantId\":\"d58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3d58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a3a-bc8f-d2a55af5794ad58c3076-b496-4a311111\",\"currencyIsoCode\":\"EUR\",\"merchantMetadata\":\"{ \\\"clientId\\\": 453456790 }\",\"externalReference\":\"PaymentSerie 1 Payment 1\",\"billingAddress\":{\"addressLine1\":\"Leopoldstrasse\",\"addressLine2\":\"Leopoldstrasse\",\"addressLine3\":\"Leopoldstrasse\",\"number\":\"244\",\"city\":\"Munich\",\"postCode\":\"80807\",\"countryCode\":\"DE\",\"state\":\"MN\"},\"shippingAddress\":{\"addressLine1\":\"Leopoldstrasse\",\"addressLine2\":\"Leopoldstrasse\",\"addressLine3\":\"Leopoldstrasse\",\"number\":\"244\",\"city\":\"Munich\",\"postCode\":\"80807\",\"countryCode\":\"DE\",\"state\":\"MN\"},\"consumer\":{\"firstName\":\"FirstNameA\",\"lastName\":\"LastNameA\",\"middleName\":\"Middle\",\"emailAddress\":\"NewcustomerSerie00@mail.com\",\"title\":\"Mr\",\"culture\":\"en-en\",\"dateOfBirth\":\"1995-01-26\",\"gender\":\"M\",\"mobilePhone\":\"1234567890\",\"homePhone\":\"1234567891\",\"workPhone\":\"1234567892\",\"taxId\":\"1255211DE1252\"}}"
}

For error handling, please refer to this section.

Previous

Next