This endpoint allows you to add events to subscriptions and to define which company id(s) or bank account(s) you would like to receive notifications for.
Learn More
Supported events
Here is a list of the events that you can subscribe to:
| Event | Description | Enum |
|---|---|---|
| IncomingPaymentProcessed | One of your accounts is successfully funded (this also includes internal credit transfers) | 1 |
| OutgoingPaymentRejected | One of your outgoing payments is rejected. The status of the payment is now Rejected | 2 |
| OutgoingPaymentProcessed | One of your outgoing payments is successfully processed (this also includes internal debit transfers). The status of the payment is now Processed | 3 |
| MissingFunding | One of your outgoing payments cannot be executed due to insufficient balance. The payment will be automatically executed when there are sufficient funds, or rejected after 2 days. The status of the payment is now MissingFunding | 4 |
| Reversed | One of your outgoing payments is reversed. The status of the payment is now Reversed | 5 |
| OutgoingPaymentBooked | One of your outgoing payments is successfully booked on your account. | 6 |
| PaymentRouting | One of your outgoing payment is routed via other payment scheme. More details will be available in 'routingStatus' field. | 7 |
| IncomingPaymentBooked | One of your incoming payments is successfully booked on your account | 8 |
| OutgoingDirectDebitPendingProcessing | One of your accounts has an outgoing payment initiated by a third party (e.g. through Bacs or SEPA Direct Debit) that is pending processing. | 10 |
You need to create a new subscription before you can add any events
You can set up several events for each subscription. If you want to receive a notification for all five events, you must add each event separately to the subscription.
You can set up subscription events on company id(s) level (thereby receiving notifications for all bank accounts belonging to such company id(s)), or on bank account level (thereby only receiving notifications for the specified bank accounts).
Use GET/api/v1/accounts to obtain the Company id guid(s) that maps to the ownedByCompanyId field and the bank account guid(s) that maps to the accountId field. These guid(s) needs to be populated to the targetId parameter in this endpoint.
A subscription cannot be set up with a combination of companies and bank accounts
You cannot subscribe to the same event under the same subscription. You also can’t edit the subscribed event or targetIds of an existing subscription event. If you wish to change the events and/or targetIds, you must delete the event and add a new event to the subscription with the desired parameters.
Note, your endpoint should return a 2xx HTTP status code to acknowledge the receipt of a webhook. If we don’t receive a 2xx from you, we’ll consider it as a failed delivery, and we will retry sending the notification. After the tenth unsuccessful retry, we will stop sending notifications and deactivate the subscription.