HomeGuidesAPI ReferenceChangelog
Log InChangelog
Guides
Changelog

WSP Events

Tis page describe some tecnical aspects of how events are structured and sent to a Wallet Service Provider.


📘

Before you begin, read the "Getting started" page.

For information about how you should integrate events into your API, please look into the Process WLW events API reference

How does it work?

The wallet infrastructure provides a set of Events, which a WSP can subscribe to. These events are sent in batches, in fixed intervals.

They all contains a set of fixed fields (see API Reference), but the "data" field can vary, depending on what type of event it is (e.g. WALLET_CREATED, ONBOARDING, etc).

Available events

Below is all the currently available events, that a WSP can subscribe to, including an example with all the fields you can expect for that specific event.

📘

For the most up to date information, always look at the definitions under API Reference.

🚧

More content may be added to each event in the future.

🚧

More events will be available at a later point in time. The events below are the once currently available.

Events

JSON structure with example data

Wallet created

{
  "sub":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type":"WALLET_CREATED",
  "initiator":"CONSUMER",
  "startTime":"2025-08-06T15:57:22.004Z",
  "completionTime":"2025-08-06T15:57:22.004Z",
  "statusCode":"0",
  "statusReason":"Wallet created.",
  "idempotencyKey":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Onboarding complete

{
  "sub":"5a493208-a67a-465b-9bc9-42f63d7718e9",
  "type":"ONBOARDING",
  "initiator":"CONSUMER",
  "startTime":"2025-08-06T11:16:30.642Z",
  "completionTime":"2025-08-06T11:16:35.642Z",
  "statusCode":"0",
  "statusReason":"Wallets SDK onboarding successful.",
  "data":{
    "sessionId":[
      "da9a9661-a4d5-4db8-8525-cda6a2a15f26"
    ],
    "sdkId":[
      "73809a15-fd56-4ced-aca7-83497a5f1135"
    ]
  },
  "idempotencyKey":"148b34d9-7985-46ae-a9d4-97dc767fb341"
}

Wallet deleted

{
  "sub":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type":"WALLET_DELETED",
  "initiator":"CONSUMER",
  "startTime":"2025-08-06T15:57:22.004Z",
  "completionTime":"2025-08-06T15:57:22.004Z",
  "statusCode":"0",
  "statusReason":"Consumer deleted wallet.",
  "data":{
    "paymentInstrumentsDeleted":[4]
  },
  "idempotencyKey":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Payment method added

{
  "sub":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type":"PAYMENT_METHOD_ADDED",
  "initiator":"CONSUMER",
  "startTime":"2025-08-06T15:57:22.004Z",
  "completionTime":"2025-08-06T15:57:22.004Z",
  "statusCode":"0",
  "statusReason":"Payment instrument added to wallet.",
  "data":{
    "participatingPaymentSystem":["MONIZZE"]
  },
  "idempotencyKey":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Payment method deleted

{
  "sub":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type":"PAYMENT_METHOD_DELETED",
  "initiator":"CONSUMER",
  "startTime":"2025-08-06T15:57:22.004Z",
  "completionTime":"2025-08-06T15:57:22.004Z",
  "statusCode":"0",
  "statusReason":"Payment instrument deleted.",
  "data":{
    "participatingPaymentSystem":["MONIZZE"]
  },
  "idempotencyKey":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

What’s Next

Look at the API Reference for details about how to integrate these events