{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-@l10n/en/simpay-flow/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Onboarding via API","description":"Znajdziesz tutaj wszystkie niezbędne informacje dotyczące integracji i obsługi systemu płatności SimPay.pl","siteUrl":"https://docs.simpay.pl","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"onboarding-via-api","__idx":0},"children":["Onboarding via API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This onboarding method applies to Flow services with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["role_payment_service_provider"]}," role - regulated payment institutions (PI)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["As a payment institution, you are responsible for verifying your submerchants, so onboarding at SimPay is simplified. Via the API you provide:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the submerchant's basic billing data (company or unregistered business data),"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["simplified ultimate beneficial owner (UBO) data,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the submerchant's Online Payments service data - provided already during registration in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["service"]}," object."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Funds from submerchant transactions are not paid out directly to submerchants, but to the payment institution. Settlement with submerchants is handled by the PI."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-does-it-work","__idx":1},"children":["How does it work?"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You register the submerchant (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/flow/flowcreatesubmerchant"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /flow/{flowServiceId}/submerchants"]}]},"), always providing the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["service"]}," object. In the response you receive ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onboarding.action"]}," = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["provide_api"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You provide the submerchant's billing and UBO data via the API, and then finalize onboarding."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["After SimPay verification, the submerchant status changes to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow_submerchant_active"]}," - you will be notified with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow_submerchant:status_changed"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/en/simpay-flow/webhooks"},"children":["webhook"]},"."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Documentation in progress"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]}]}]},"headings":[{"value":"Onboarding via API","id":"onboarding-via-api","depth":1},{"value":"How does it work?","id":"how-does-it-work","depth":2}],"frontmatter":{"seo":{"title":"Onboarding via API"}},"lastModified":"2026-10-01T15:18:54.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/en/simpay-flow/onboarding/api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}