Ctrlk
HomeStatus
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Supported Events

Below are the support events available for subscription. Contact your account manager for information on accessing custom events.

Examples shared below for each event type will be sent to your URL handler within the payloadfield of the HTTP request. You can check the full HTTP request structure below:

{
	"event": "<event-name>",
	"eventId": "<unique event id>",
	"version": "<version-of-the-event-payload>",
	"payload": {
		// detailed payload fields vary per event type
	}
}

Webhook Test Event

This event only sent when the webhook test API is triggered. Should only be used for connectivity testing purposes.

Event Name: webhook.test

Event Version: 1

Example Payload Field

{
    "response": "<data added to your test request>"
}

Transaction State Events

Transactions having a complicated flow of execution. Especially, when you initiate payments using API platform. State change events are only triggered when a transaction state is changed to COMPLETED CANCELLED and FAILED states. You won't get webhooks for interim state changes.

Event Name: transaction.state-changed

Event Version: 1

Example payload for Outbound Transfers

Example payloads for Account Funding with PISP

Successful Funding

Failed Funding

Account Lifecycle Events

Webhooks have the following account lifecycle events.

  1. READY: This is the phase where the account is fully set up and operational for funding operations.

  2. CLOSED: This marks the final phase in the lifecycle of an account. Reaching the terminated state implies that the account is no longer active and accessible. The transition to this state may result from various triggers, such as policy enforcement.

Event Name: account.state-changed

Event Version: 1

Example payload for the Account State Change

Prospect Onboarding Events

The onboarding journey varies between personal users and business clients. Personal users typically require a straightforward journey, focusing on individual information about the prospect. In contrast, business prospects need a more complex onboarding process that requires additional information about the business structure. Therefore, the supporting events are different.

Personal prospect onboarding journey

Event Name: onboarding.personal.state-changed

Event Version: 1

Example payload for the Personal Onboarding State Changes

Investment Settled Event

This event is triggered when an investment placement has been fully settled and becomes active on the platform. The webhook provides the finalised investment details including the invested amount, associated account references, settlement and maturity dates, and projected returns.

Event Name: investment.settled

Event Version: 1

Automated Payment State Changed Events

This event is sent when an automated payment changes state.

Event Name: automated-payment.state-changed

Event Version: 1

Automated Payment Upcoming Transaction Events

This event is sent when an upcoming automated payment transaction is created. For direct debit payments, this notifies you that a collection has been received and matched to an automated payment before the payment is processed.

Event Name: automated-payment.upcoming-transaction

Event Version: 1

PreviousWebhook GuidelinesNextTesting Webhooks

Last updated

Was this helpful?