GOgovernment-digital-service
Transactions

Get events for transaction external ID

Changed on
get/v1/transaction/{transactionExternalId}/event

Request

  • Base URL
    http://ledger_url
  • URL
    http://ledger_url/v1/transaction/{transactionExternalId}/event
  • Auth
    none declared

Path parameters

transactionExternalIdstring required

Transaction external ID

Query parameters

gateway_account_idstring required
include_all_eventsboolean

Set to 'true' to return all events. By default events that do not map to an external state are removed and duplicate events mapping to same external state are reduced to one event.

status_versioninteger

Set to '2' to return failed transaction states FAILED_REJECTED/FAILED_EXPIRED/FAILED_CANCELLED mapped to declined/timedout/cancelled status respectively.Otherwise these transaction states will all be mapped to failed status

Response

OK

transaction_idstring

Example response

{
  "events": [
    {
      "amount": 1000,
      "event_type": "CANCELLED_BY_USER",
      "resource_type": "PAYMENT",
      "state": {
        "can_retry": true,
        "code": "P0030",
        "finished": true,
        "message": "Payment was cancelled by the user",
        "status": "cancelled"
      }
    }
  ],
  "transaction_id": "9np5pocnotgkpp029d5kdfau5f"
}

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 gateway_account_id, the minLength was increased from 0 to 1