Cadastra um seller vinculado a um master no Split de Pagamento.
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | post | https://splitonboardingapisandbox.braspag.com.br/api/merchants |
| Produção | post | https://splitonboardingapi.braspag.com.br/api/merchants |
Para gerar o
access_token, consulte a documentação: Obter token de acesso.
A API de Onboarding Split de Pagamento 1.0 foi descontinuada em 03/06/2024.Caso o seu estabelecimento ainda use a versão 1.0, deverá obrigatoriamente migrar para a API de onboarding Split de Pagamento 2.0, disponível nesse manual. Consulte as instruções para migração no artigo da nossa página de suporte.
O master deverá solicitar o cadastro de seller enviando uma requisição com os dados do seller:
| Dados do Seller | Parâmetros (Nó) |
|---|---|
| Dados de identificação e contato | Body |
| Dados bancários | BankAccount |
| Endereço | Address |
| Acordos de taxas | Agreements |
| Documentos anexos | Attachments |
O seller pode ser cadastrado com um CPF ou CNPJ. Caso o documento seja um CPF, envie também os campos BirthdayDate e BusinessActivity, conforme descrito na tabela de propriedades da requisição.
CNPJs alfanuméricos serão implementados pela Receita Federal em julho de 2026Essa mudança afeta apenas novas inscrições, não havendo mudanças em CNPJs existentes.
O CNPJ alfanumérico já está sendo suportado pela Cielo, sem mudanças na sua integração.
Recomendamos verificar a necessidade de possíveis ajustes nos sistemas próprios de checkout de sua loja.
Propriedades do acordo de taxas
No Split de Pagamento há possibilidades de acordos de taxas entre o master e seus sellers:
- Não cadastrar taxa: quando as taxas não são definidas no momento do cadastro do seller, você deverá informá‑las a cada transação, no momento da captura da transação ou da emissão do boleto. Se não cadastrar taxas e não informar a taxa na transação, o Split de Pagamento vai replicar os mesmos acordos do master com o Split de Pagamento para o master com o seller;
- Taxa global: configure uma única taxa para todos os acordos (MDR único);
- Taxa por meio de pagamento: você deverá definir as taxas cobradas por transação por arranjos de pagamento e intervalo de parcelas.
AtençãoSe não houver cobrança de MDR, basta não enviar o nó
Agreements.
O campoAgreements[].Percentsó deve ser enviado em caso de cadastro de seller com Taxa global.
Cadastrar novo seller habilitando o Pix via API
Para cadastrar um novo seller habilitando o meio de pagamento Pix será necessário enviar valores específicos nos parâmetros a seguir:
- Em
Agreements.MerchantDiscountRates.PaymentArrangement.Productincluir o valor "Pix"; - Em
Agreements.MerchantDiscountRates.PaymentArrangement.Brandenvie o valor "PixCielo".
O meio de pagamento Pix estará disponível em breve.