Events

Get list of events between a date/time range and event type

get/v1/event/ticker

Query parameters

from_datestring required

from date of events to be searched (this date is inclusive).

to_datestring required

to date of events to be searched (this date is exclusive)

event_typesstring[]

event types to find

Response

OK

amountinteger
card_brandstring
event_datestring date-time
event_typestring
gateway_account_idstring
is_motoboolean
is_recurringboolean
payment_providerstring
resource_external_idstring
resource_type'agreement' | 'payment' | 'refund' | 'service' | 'card_payment' | 'payout' | 'dispute' | 'payment_instrument'
service_external_idstring
sourcestring
transaction_typestring
wallet_typestring

Example response

[
  {
    "amount": 100,
    "card_brand": "visa",
    "event_type": "PAYMENT_CREATED",
    "gateway_account_id": "1",
    "is_moto": true,
    "is_recurring": true,
    "payment_provider": "sandbox",
    "resource_external_id": "9np5pocnotgkpp029d5kdfau5f",
    "resource_type": "payment",
    "service_external_id": "HrMU7UgY7OUM8fgT2bZCTKzvKu",
    "source": "CARD_API",
    "transaction_type": "PAYMENT",
    "wallet_type": "APPLE_PAY"
  }
]

Changes

Changed in 12 of the 34 revisions of this API.4208

    • for the query request parameter from_date, the minLength was increased from 0 to 1

      request-parameter-min-length-increased

    • for the query request parameter to_date, the minLength was increased from 0 to 1

      request-parameter-min-length-increased

    • for the query request parameter from_date, the minLength was decreased from 1 to 0

      request-parameter-min-length-decreased

    • for the query request parameter to_date, the minLength was decreased from 1 to 0

      request-parameter-min-length-decreased

    • for the query request parameter from_date, the minLength was increased from 0 to 1

      request-parameter-min-length-increased

    • for the query request parameter to_date, the minLength was increased from 0 to 1

      request-parameter-min-length-increased

    • added the new AMOUNT_BELOW_MINIMUM enum value to the response property for the response status

      response-property-enum-value-added

    • added the new NON_HTTPS_RETURN_URL_NOT_ALLOWED_FOR_A_LIVE_ACCOUNT enum value to the response property for the response status

      response-property-enum-value-added

    • added the new optional query request parameter event_types

      new-optional-request-parameter

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the new CARD_NUMBER_IN_PAYMENT_LINK_REFERENCE_REJECTED enum value to the response property for the response status

      response-property-enum-value-added

    • added the new IDEMPOTENCY_KEY_USED enum value to the response property for the response status

      response-property-enum-value-added

    • added the new RECURRING_CARD_PAYMENTS_NOT_ALLOWED enum value to the response property for the response status

      response-property-enum-value-added

    • added the new INCORRECT_AUTHORISATION_MODE_FOR_SAVE_PAYMENT_INSTRUMENT_TO_AGREEMENT enum value to the response property for the response status

      response-property-enum-value-added

    • added the new REFUND_NOT_AVAILABLE_DUE_TO_DISPUTE enum value to the response property for the response status

      response-property-enum-value-added