Workflows attach automated actions to payment events. They allow you to integrate external systems into the payment flow — for example, sending notifications, updating CRM records, or triggering business logic when payments are processed.

How Workflows Are Used

Workflows are configured at the legal entity route level, meaning different payment routes can have different workflow configurations. This allows you to run different automation depending on which gateway or legal entity is processing the payment.

Endpoints

This API provides read-only access to workflow configuration:

List workflows: see all workflows configured for the instance
Get workflow: retrieve details of a specific workflow
Get connection: check the connection status of a workflow
Get settings: retrieve the workflow's configuration settings