{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-@l10n/en/simpay-flow/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"What is SimPay Flow?","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":"what-is-simpay-flow","__idx":0},"children":["What is SimPay Flow?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["SimPay Flow lets you accept payments ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["on behalf of your Customers"]}," (submerchants) within a single SimPay account and a single API integration."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["SimPay Flow is designed for:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["marketplace platforms"]},","]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["products in which your Customers accept payments"]}," - fundraising systems, invoicing systems, ERP applications, booking systems, etc.,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["regulated payment institutions"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-concepts","__idx":1},"children":["Key concepts"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Concept"},"children":["Concept"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Flow service"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your service in SimPay Flow (ID in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow_xxxxxxxx"]}," format). You create it in the SimPay Partner Panel, and it must be approved by SimPay before use."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parent service"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Online Payments service linked to the Flow service. You pass its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serviceId"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/payment/{serviceId}/..."]}," requests when creating transactions for submerchants."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Submerchant"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your Customer, registered by you in the Flow service. It has its own ID (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flsm_xxxxxxxx"]},") and a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customId"]}," assigned by you."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Submerchant service"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The submerchant's Online Payments service, created automatically during registration. You never use it directly - you always create transactions through the parent service."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Submerchant wallet"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The submerchant's balance, which receives funds from its transactions and from which withdrawals are made."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"flow-service-roles","__idx":2},"children":["Flow service roles"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every Flow service has one of two roles. The role determines how submerchant onboarding and settlement work."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"platforms--role_non_financial_provider-","__idx":3},"children":["Platforms (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["role_non_financial_provider"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For marketplaces and products that ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["do not intermediate in the transfer of funds"]},"."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The submerchant goes through full onboarding at SimPay - verification of billing data, UBO data, identity document (or mObywatel) and a verification transfer. Details: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/en/simpay-flow/onboarding/redirect"},"children":["Onboarding via SimPay Panel"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["SimPay settles with the submerchant - funds go to the submerchant's wallet and are paid out to its bank account."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You receive a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/en/simpay-flow/commissions"},"children":["commission"]}," on submerchant transactions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Apart from onboarding, you handle everything for the submerchant - payment channels, withdrawals, reports - through the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/flow"},"children":["SimPay Flow API"]}," in your application."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"payment-institutions--role_payment_service_provider-","__idx":4},"children":["Payment institutions (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["role_payment_service_provider"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["regulated payment institutions (PI)"]}," that are responsible for their own submerchants."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Onboarding is simplified - via the API you provide basic company data (or unregistered business data), simplified UBO data and the submerchant's Online Payments service data. Details: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/en/simpay-flow/onboarding/api"},"children":["Onboarding via API"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All funds are transferred to the PI, and settlement with submerchants is handled by the PI."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["PIs mainly use SimPay Flow to register submerchants for additional payment methods, e.g.:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["PayPo,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Twisto,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["PaysafeCard,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["BLIK Level 0 + OneClick,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["BLIK Recurring Payments,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["LATAM."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The PI requests the registration of a payment channel for a submerchant via the API, and SimPay registers it with the payment method operator on behalf of the PI."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-does-the-integration-look-like","__idx":5},"children":["What does the integration look like?"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create a Flow service"]}," in the SimPay Partner Panel and wait for its approval (status ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow_service_active"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Generate an API key"]}," with SimPay Flow permissions (see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#api-key-permissions"},"children":["API key permissions"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Register a submerchant"]}," via the API - ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/en/simpay-flow/onboarding"},"children":["Submerchant registration"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Complete the submerchant onboarding"]}," and wait until its status changes to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow_submerchant_active"]}," - you will be notified by a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/en/simpay-flow/webhooks"},"children":["webhook"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Configure the submerchant's payment channels"]}," - ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/en/simpay-flow/channels"},"children":["Payment channels"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Accept payments"]}," on behalf of the submerchant - ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/en/simpay-flow/payments"},"children":["Payments"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Handle finances"]}," - balance, withdrawals, reports and invoices - ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/en/simpay-flow/finances"},"children":["Finances and withdrawals"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-key-permissions","__idx":6},"children":["API key permissions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["SimPay Flow endpoints require an API key with the appropriate permissions. Grant the key only the permissions you actually need."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Permission"},"children":["Permission"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scope"},"children":["Scope"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.services"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View Flow services"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.submerchants"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View submerchants"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.submerchants.create"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Register submerchants"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.submerchants.onboardings"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submerchant onboarding"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.submerchants.widget"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generate submerchant widget links"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.payment_methods"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View and enable/disable payment channels"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.payment_methods.register"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Register new payment channels"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.submerchants.webhooks"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View submerchant webhook settings"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.submerchants.webhooks.update"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Change submerchant webhook settings and keys"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.submerchants.finances"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View wallets and operations"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.submerchants.finances.reports"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generate CSV reports"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.submerchants.finances.invoices"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View commission invoices"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.submerchants.withdraws"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View withdrawals"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.submerchants.withdraws.create"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request withdrawals"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flow.submerchants.withdraws.settings"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Change wallet withdrawal settings"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To create transactions on behalf of submerchants, you also need the standard Online Payments permissions (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment.*"]},")."]}]},"headings":[{"value":"What is SimPay Flow?","id":"what-is-simpay-flow","depth":1},{"value":"Key concepts","id":"key-concepts","depth":2},{"value":"Flow service roles","id":"flow-service-roles","depth":2},{"value":"Platforms ( role_non_financial_provider )","id":"platforms--role_non_financial_provider-","depth":3},{"value":"Payment institutions ( role_payment_service_provider )","id":"payment-institutions--role_payment_service_provider-","depth":3},{"value":"What does the integration look like?","id":"what-does-the-integration-look-like","depth":2},{"value":"API key permissions","id":"api-key-permissions","depth":2}],"frontmatter":{"seo":{"title":"What is SimPay Flow?"}},"lastModified":"2026-10-01T15:18:54.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/en/simpay-flow","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}