Skip to content
Last updated

This onboarding method applies to Flow services with the role_payment_service_provider role - regulated payment institutions (PI).

As a payment institution, you are responsible for verifying your submerchants, so onboarding at SimPay is simplified. Via the API you provide:

  • the submerchant's basic billing data (company or unregistered business data),
  • simplified ultimate beneficial owner (UBO) data,
  • the submerchant's Online Payments service data - provided already during registration in the service object.

Funds from submerchant transactions are not paid out directly to submerchants, but to the payment institution. Settlement with submerchants is handled by the PI.


How does it work?

  1. You register the submerchant (POST /flow/{flowServiceId}/submerchants), always providing the service object. In the response you receive onboarding.action = provide_api.
  2. You provide the submerchant's billing and UBO data via the API, and then finalize onboarding.
  3. After SimPay verification, the submerchant status changes to flow_submerchant_active - you will be notified with the flow_submerchant:status_changed webhook.
Documentation in progress

The detailed specification of the API onboarding endpoints will be available soon. If you are a payment institution and want to start the integration, contact SimPay.