Sellers & distribution

Split API

Internal centre to organise the integration of distribution among participants, from the seller register to the result reconciliation.

Pre-requisiteSellers identified
UseMulti-participant distribution
State of the UnionMigration of documentation

Overview

Use Split when an operation needs to target values to multiple participants within the same payment context. The implementation shall be based on previously identified sellers and distribution rules compatible with the contract of the operation.

Participants

Sellers identified.

Each destination must be properly represented on the platform.

Rule of thumb

The distribution is explicit.

Set the split composition according to the business model and the current contract.

Reconciliation

The reference is preserved.

Keep internal IDs to reconcile request, transaction and participants.

Flow

01 · RegisterIdentify the sellers.

Make sure every participant is fit for the operation.

02 · RuleSet up the distribution.

Define participants and values/percentages according to the contract.

03 · PaymentCreate the transaction.

Take the split rule to the API compatible flow.

04 · FinancialReconcilie.

Use references and events to track the outcome of the operation.

Modelling

Logical fieldWhat's the point?Good practice
reference_idCorrelation of payment to your request/operation.Use a stable and unique value.
seller_idIdentify the participant who will receive part of the operation.Validate seller before you install the split.
amount / percentageTo represent the distribution rule when supported by the contract.Avoid ambiguous roundings.
metadataAdditional internal context where available.Do not store unnecessary secrets or sensitive data.
It's a road contract. The exact names of fields and endpoints must be migrated from the official collection to this page before the external reference is permanently removed.

Checklist of the

  • Sellers registered and eligible for the operation.
  • Distribution rule validated with financial/commercial.
  • Validation of value/percentage sum.
  • Internal reference for preserved application.
  • Webhooks connected to the transaction cycle.
  • Conciliation and treatment of defined cancellations/withdrawals.

Temporary external reference

Until the endpoint migration is completed, use the Postman collection to check the technical contract.

Open the technical collection —