Webhook events
Webhook events can be used to keep your system in sync with Rootline's system. For checkout related events, such as payment.succeeded we advise not to solely rely on the webhook events, but to use our GET /payments to retrieve the result of the payment.
Good to know: Rootline creates a payment object for each split payment. An event on a root payment, therefore, triggers webhook events for downstream split payments as well, unless the accounts that payments are split to are disabled from the webhook configuration.
If you wish to receive events for just your platform account, you can amend the webhook configuration in the dashboard.
Payment events
Payment events give you the information you need to be informed about the result of the checkout process, and about an update on a payment (if applicable). Update on payments are currently only sent when you updated platform fees or a reference, after the payment was created.
| event_type | Description |
|---|---|
payment.succeeded | Your payment was successfully authorized |
payment.failed | The payment failed. The authorization was declined or had an error |
payment.updated | The payment was updated, for instance after adding or updating fees |
payment.succeeded
Your payment was successfully authorized.
payment.failed
The payment failed. The authorization was declined or had an error.
payment.updated
The payment was updated, for instance after adding or updating fees. The webhook content returns the state of the payment after the update is processed.
Authorization events
Authorization events give you detailed information on authorization attempts.
| event_type | Description |
|---|---|
authorization.approved | The authorization attempt was approved |
authorization.declined | The authorization attempt was declined |
authorization.error | The authorization attempt had an error |
Authentication events
Authentication events give you detailed information about the authentication process, if applicable, such as Strong Customer Authentication for cards, also known as 3D secure.
| event_type | Description |
|---|---|
authentication.initiated | An authentication attempt is initiated |
authentication.pending | An authentication attempt is pending. There is no final result yet |
authentication.authenticated | An authentication attempt is successfully completed |
authentication.failed | An authentication attempt failed |
authentication.exempted | An authentication attempt was exempted. |
authentication.initiated
An authentication attempt is initiated.
authentication.pending
An authentication attempt is pending.
authentication.authenticated
An authentication attempt is successfully authenticated.
authentication.failed
An authentication attempt failed.
authentication.exempted
An authentication attempt was exempted.
Capture events
If automatic captures are enabled on your account, it not necessary to subscribe to the scheduled event types.
| event_type | Description |
|---|---|
capture.scheduled | A capture was successfully created and scheduled for submission to the network |
capture.schedule.failed | A capture was requested, but failed before sending the request to the schemes |
capture.failed | A capture failed when attempted to be processed by the acquirer |
capture.scheduled
A capture was successfully created and scheduled for submission to the network.
capture.schedule.failed
A capture was requested, but failed before sending the request to the schemes. This could happen for instance because the payment did not have sufficient balance to capture (any more).
capture.failed
A capture failed when attempted to be processed by the acquirer.
Refund events
Refund scheduling, authorization, and processing failures.
| event_type | Description |
|---|---|
refund.scheduled | A refund was successfully created and scheduled for submission to the network |
refund.authorized | A refund request was authorized by the issuing bank |
refund.schedule.failed | A refund was requested, but failed before sending the request to the schemes |
refund.failed | A refund was sent to the network, but in the process it failed |
refund.scheduled
A refund was successfully created and scheduled for submission to the network.
refund.schedule.failed
A refund was requested, but failed before sending the request to the schemes.
refund.failed
A refund was sent to the network, but in the process it failed.
Cancel events
Cancel scheduling, failures, and confirmed cancellation.
| event_type | Description |
|---|---|
cancel.scheduled | A cancel was successfully created and scheduled for submission to the network |
cancel.schedule.failed | A cancel request was done, but failed before sending the request to the schemes |
cancel.failed | A cancel was sent to the network, but in the process it failed |
canceled | The cancel request is confirmed with success |
cancel.scheduled
A cancel was successfully created and scheduled for submission to the network.
cancel.schedule.failed
A cancel request was done, but failed before sending the request to the schemes.
cancel.failed
A cancel was sent to the network, but in the process it failed.
canceled
The cancel request is confirmed with success.
Balance transfer events
Sent when a balance transfer reaches a terminal state, to the owner of the transfer only. Delivery is at-least-once — deduplicate on the event_type together with the id of the balance transfer in the payload.
| event_type | Description |
|---|---|
balance_transfer.succeeded | The balance transfer settled and the funds were moved |
balance_transfer.failed | The balance transfer could not be scheduled and no funds were moved |
balance_transfer.canceled | The balance transfer was canceled before settling and no funds were moved |
balance_transfer.reversed | A settled balance transfer was reversed and the funds were moved back |
balance_transfer.succeeded
The balance transfer settled and the funds were moved.
balance_transfer.failed
The balance transfer could not be scheduled — typically because the debit account's available balance did not cover the withdrawal. No funds were moved.
balance_transfer.canceled
The balance transfer was canceled before settling. No funds were moved.
balance_transfer.reversed
A settled balance transfer was reversed and the funds were moved back.
Reports
Report creation notifications.
| event_type | Description |
|---|---|
report.created | A report was successfully created and is ready to be downloaded |
report.created
A report was successfully created and is ready to be downloaded.
Company events
Company onboarding updates.
| event_type | Description |
|---|---|
company.created | A company was successfully created |
company.verification_status.updated | The verification status of a company was updated |
company.next_action.updated | The next action required for a company was updated |
company.capabilities.updated | The capabilities of a company were updated |
company.created
A company was successfully created.
company.verification_status.updated
The verification status of a company was updated.
company.next_action.updated
The next action required for a company was updated.
company.capabilities.updated
The capabilities of a company were updated. Read company.capabilities to decide whether the company's accounts may take payments or receive payouts.
Person events
Person onboarding updates.
| event_type | Description |
|---|---|
person.created | A person was successfully created |
person.created
A person object was successfully created.
Account events
Account onboarding updates.
| event_type | Description |
|---|---|
account.created | An account was successfully created and is available for payments processing |
account.created
An account was successfully created and is available for payments processing.
Tokenization events
Payment token and customer token lifecycle updates.
| event_type | Description |
|---|---|
payment_token.created | A payment token was created. |
payment_token.updated | A payment token was updated. |
payment_token.deleted | A payment token was deleted. |
customer.created | A customer token was created. |
customer.updated | A customer token was updated. |
customer.deleted | A customer token was deleted. |
payment_token.created
A payment token was created.
payment_token.updated
A payment token was updated.
payment_token.deleted
A payment token was deleted.
customer.created
A customer token was created.
customer.updated
A customer token was updated.
customer.deleted
A customer token was deleted.