GOgovernment-digital-service
Events

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

Changed on
get/v1/event/ticker

Request

  • Base URL
    http://ledger_url
  • URL
    http://ledger_url/v1/event/ticker
  • Auth
    none declared

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

  • 450e568b5b08Revision changes
    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_ADYEN enum value to the response property for the response status

    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_STRIPE enum value to the response property for the response status

    • info

      removed the AMOUNT_BELOW_MINIMUM enum value from the response property for the response status

  • 10ffeffca918Revision changes
    • breaking

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

    • breaking

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