Onboarding and Configuration
- The platform must be enabled to operate.
- There must be sellers eligible to receive funds.
Platform Registration
The platform completes Getnet Brasil's registration and onboarding process, which includes identity verification and the compliance and risk analyses required by the Brazilian regulator. It's a process accompanied by Getnet's commercial and implementation teams: it doesn't require any development work from the platform.
At the end of this process, the platform has:
- An identifier and access credentials for the API.
- Access to the test environment to build and validate the integration.
- Access to the Portal Minha Conta as a complementary channel for day-to-day operations.
- The agreed initial configuration for split, settlement, and pricing.
Going live in production happens once the integration has been validated in the test environment.
Seller Registration and Configuration
Sellers are the parties that receive a share of the transaction amount. They can be registered in two ways, both available at the same time: via the API, recommended when registration volume is high or the platform wants to automate it; and via the Portal, when there's no interest in development or for one-off registrations.
After the request, the registration goes through automatic validations and risk and compliance analyses that may include manual review. The initial response confirms receipt of the request, not activation: the platform must check the status until the seller becomes active, and only then include it in transactions.
Information Required for Registration
| Information block | Content |
|---|---|
| Identification | Legal entity or individual, with the tax identification document and company/legal name or personal name |
| Activity | The seller's economic activity, used for risk assessment and payment processing |
| Contact and address | The seller's contact and address details |
| Bank account | The seller's bank account where funds will be settled. Must be held in the seller's own name |
| Split (optional) | Commission or split rule applicable to the seller, as described in Split Rules |
API Reference: Seller Onboarding
| Method | Endpoint | Description |
|---|---|---|
POST | /v2/mgm/pj/create-presubseller | Registers a legal-entity seller |
POST | /v2/mgm/pf/create-presubseller | Registers an individual seller |
GET | /v2/mgm/pj/callback/{merchant_id}/{cnpj} | Checks the registration status of a legal-entity seller |
GET | /v2/mgm/pf/callback/{merchant_id}/{cpf} | Checks the registration status of an individual seller |
PUT | /v2/mgm/pj/update-subseller | Updates legal-entity seller data |
PUT | /v2/mgm/pf/update-subseller | Updates individual seller data |
Split Rules
The split can be resolved in two ways, which can also be combined:
- Pre-configured rules: defined in the seller's configuration, typically at registration, and applied automatically to every transaction, with no need for the platform to specify anything when operating.
- Explicit instruction in the transaction: when the transaction arrives via the API, the platform sends the breakdown in the request itself.
Important: If a pre-configured rule exists and the transaction also carries an explicit instruction, the transaction's explicit instruction always takes precedence.
Examples of Rules That Can Be Configured
| Rule type | Example | Typical use |
|---|---|---|
| Percentage commission | The platform retains 10% of each seller sale | Standard commission model per seller or category |
| Fixed commission | The platform retains a fixed amount per transaction | Service or platform usage fees |
| Per item and per seller | Each cart item is assigned to its own seller with its own commission | Multi-seller carts in marketplaces |
When to Use Each Option
| Situation | Recommended option | Why |
|---|---|---|
| Physical channel (point of sale) | Pre-configured rule | The point-of-sale transaction doesn't travel via the API, so it can't carry the breakdown. The split is resolved by the seller's pre-configured commission rules, applied automatically to every terminal sale |
| Standard, stable commissions | Pre-configured rule | Avoids sending the breakdown on every payment and reduces integration error risk |
| Carts with multiple sellers | Explicit instruction | Allows distributing by item and assigning each amount to its own seller |
| Variable commissions (promotions, campaigns, one-off agreements) | Explicit instruction | The platform controls the exact amount in each transaction |
Status and Errors
Registration Status
| Status | Meaning | What to do |
|---|---|---|
| Requested | The request has been received and is being validated. | Check the status periodically. |
| Under review | A manual risk or compliance review is underway. | Wait. Don't include the seller in transactions. |
| Active | The seller is validated and can receive funds. | It can now be included in transactions. |
| Rejected | The seller didn't pass validation. | Review the returned reason and, if applicable, correct and resubmit. |
| Inactive | The seller exists but can't operate. | Contact Getnet or reactivate it, depending on the reason. |
Most Common Registration Errors
| Error type | Common cause | Solution |
|---|---|---|
| Invalid data | A required field is missing or the document format is invalid. | Correct and resubmit the request. |
| Duplicate seller | A seller with this document already exists on your platform. | Look up the existing one and update it instead of creating a new one. |
| Invalid account | The account doesn't exist or the holder doesn't match the seller. | Ask the seller for an account held in its own name. |
| Activity not allowed | The declared activity isn't admissible under the model. | Contact Getnet's team. |
With the platform registered, sellers active, and a split rule defined, the operation is ready to accept its first split payment.
Next Steps
- Onboarding API — PF: step-by-step guide to registering individual (PF) partners.
- Onboarding API — PJ: step-by-step guide to registering legal-entity (PJ) partners.
- Payment Acceptance: see how to process sales across physical and digital channels.
On this page