Skip to content

Split payout

The Split Payout functionality allows SIBS Gateway to divide a single transaction amount between a maximum of four different settlement accounts.

This functionality is particularly useful for business models involving multiple beneficiaries, where part of the transaction amount must be allocated to different parties.

During transaction processing, merchants must include the Settlement Point information in the API requests to ensure the transaction amount is correctly distributed between the configured settlement accounts.

Benefits

This functionality brings different benefits for merchants such as:

Notice

Improved Flexibility. Ability to setup how the funds are distributed within multiple accounts, allowing merchants to adapt their payouts structures to fit their specific business models.

 

Simplified Operations. Split payout automates the process of dividing funds across multiple accounts, reducing manual and administrative work. This allows improving operational efficiency and optimizing the available resources.

 

Transparent Operations. With detailed reporting and transaction tracking, merchants will gain great visibility into the payout transactions.

 

Secure Operations. Split payout reduces the risk of errors or delays in payment distribution, as funds are automatically allocated according to predefined rules.

Overall, the SIBS Gateway Split Payout functionality allows merchants to manage financial relationships more effectively, improve operational efficiency, and provide a seamless payment experience to all stakeholders involved in the transaction flow.

Before you start

To use Split Payout, the functionality must be activated during onboarding.

Settlement Point identifiers are generated and configured during the Split Payout activation process.

Once configured, the corresponding Settlement Point IDs become available in the SIBS Backoffice, where merchants can consult them and use them during transaction processing.

Info

To activate Split Payout functionality, contact your Account Manager.

How it works

Step 1: Define Settlement Points
Step 2: Get the Response
Step 3: Make a payment
Step 1: Define Settlement Points

Once Split Payout is activated, Settlement Point IDs become available in the SIBS Backoffice.

The merchant backend system should retrieve and store the corresponding Settlement Point identifiers to be used during transaction processing.

When creating a checkout transaction using Split Payout, the settlementPoint object must be included inside the transaction object of the checkout request.

Each Settlement Point defines:

  • the destination settlement account;
  • the amount allocated to that settlement account.
SettlementPoint (array) – Mandatory for Split Payout transactions

Settlement Point information defines how the transaction amount is distributed between settlement accounts.

The settlementPoint object must be included inside the transaction object of the checkout request.

FieldTypeConditionDescriptionExample
requestBody.transaction.settlementPointArrayMandatorySettlement Point object list used to distribute transaction funds across multiple settlement accounts.
requestBody.transaction.settlementPoint.idStringMandatoryUnique Settlement Point identifier configured during onboarding and available in the SIBS Backoffice.T13d4f9fb115f54b6cbe6f20a6ae68dbd6
requestBody.transaction.settlementPoint.amountObjectMandatorySettlement Point amount information.
requestBody.transaction.settlementPoint.amount.valuenumber: DoubleMandatoryAmount allocated to the Settlement Point.2
requestBody.transaction.settlementPoint.amount.currencycurrency code: ISO 4217 Alpha-3 CodeMandatoryCurrency used in the transaction.PLN
Request Body
{
  "transaction": {
    "settlementPoint": [
      {
        "id": "T13d4f9fb115f54b6cbe6f20a6ae68dbd6",
        "amount": {
          "value": 2,
          "currency": "PLN"
        }
      },
      {
        "id": "T23d4f9fb115f54b6cbe6f20a6ae68dbd6",
        "amount": {
          "value": 2,
          "currency": "PLN"
        }
      }
    ]
  }
}
Step 2: Get the Response

The response includes a statusMsg, a transactionID, a transactionSignature and the list of available paymentMethodList that can be displayed to the shopper.

Ensure the order has been successfully created and submitted before proceeding with the payment flow.

Step 3: Make a payment

After the checkout order containing Settlement Points is created and submitted, the shopper can proceed with the selected payment method.

For payment methods requiring redirection, the merchant must continue the payment flow using the corresponding payment request APIs.

For more details, please check Payment Methods.

Follow-up Operations

For transactions processed using Split Payout, the same settlementPoint information provided during the initial transaction must also be included in the request body of follow-up operations related to Authorization, Capture, and Purchase transactions.

This applies to:

  • Capture operations created from an Authorization;
  • Cancel operations created from an Authorization;
  • Refund operations created from a Purchase transaction;
  • Refund operations created from a Capture transaction.

The settlementPoint structure must follow the same format used during the initial checkout transaction.

Authorization, Capture, Cancel, and Refund requests related to Split Payout transactions require the settlementPoint object to ensure correct settlement allocation processing.

This ensures the transaction settlement allocation remains consistent across the entire transaction lifecycle.

Warning

If the settlementPoint information is not included in Capture or Refund requests related to Split Payout transactions, the operation may fail due to missing settlement allocation information.

Monitoring and Reporting

Settlement Points configured for each store can be consulted through the SIBS Backoffice in Configuration > Split Payouts.

Transaction details and allocated amounts per Settlement Point are available in Business > Transactions.

For more details, see our Transactions page.

Supported payment methods

Split Payout is compatible with all payment methods supported by SIBS Gateway.

Privacy Overview
blank

This website uses cookies so that we can provide you with the best user experience possible. Cookie information is stored in your browser and performs functions such as recognising you when you return to our website and helping our team to understand which sections of the website you find most interesting and useful.

Strictly Necessary Cookies

Strictly Necessary Cookie should be enabled at all times so that we can save your preferences for cookie settings.