Participants of the platform

Sellers API

Internal reference for modelling, registering and monitoring participants used in platform, marketplace and Split operations.

The objectSeller
UseMarketplace · Split
State of the UnionMigration of documentation

Overview

Use the Sellers layer to give operational identity to participants on a platform or marketplace. This context is used for times when receipt, split, trade rules or settlement depend on who is involved in the transaction.

Identity

One ID for each participant.

Preserve the link between your internal register and the identifier returned by IOPAY.

Register

Consistent data.

Submit complete register information according to the seller type and operation.

Operations

Context for Split.

seller shall include multi-participant rounds and conciliation processes.

The seller's flow

01 · OriginHis record.

The participant is born in their system with a self-identifier.

02 · IOPAYCreate the seller.

Send the necessary data and save the returned ID.

03 · StateAcompanhe.

Valid status and pending before using seller operationally.

04 · PaymentsUse the context.

Associate seller with compatible marketplace and Split streams.

Modelling

ReferenceUseRecommendation for the Council
seller_internal_idParticipant identifier in your domain.Never rely solely on outside ID.
iopay_seller_idIdentifier returned by IOPAY.Continue immediately after creation/consultation.
statusKnown operating status.Update as you return and review.
documentRegistered document applicable to the participant.Protect in accordance with the LGPD and internal policy.

Operating rules

  • Valid seller before you build a Split rule.
  • Do not reuse IDs between different participants.
  • Record any relevant changes in the register.
  • Deals with non-eligible status before creating a financial transaction.
  • Use rows and reprocessing for integrations that rely on asynchronous revision.

Temporary external reference

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

Open the technical collection —