Cadastrar seller

Cadastra um seller vinculado a um master no Split de Pagamento.

AmbienteMétodoEndpoint
Sandboxhttps://splitonboardingapisandbox.braspag.com.br/api/merchants
Produçãohttps://splitonboardingapi.braspag.com.br/api/merchants

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 SellerParâmetros (Nó)
Dados de identificação e contatoBody
Dados bancáriosBankAccount
EndereçoAddress
Acordos de taxasAgreements
Documentos anexosAttachments

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.

Propriedades do acordo de taxas

No Split de Pagamento há possibilidades de acordos de taxas entre o master e seus sellers:

  1. 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;
  2. Taxa global: configure uma única taxa para todos os acordos (MDR único);
  3. Taxa por meio de pagamento: você deverá definir as taxas cobradas por transação por arranjos de pagamento e intervalo de parcelas.

⚠️

Atenção

Se não houver cobrança de MDR, basta não enviar o nó Agreements.
O campo Agreements[].Percent só 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.Product incluir o valor "Pix";
  • Em Agreements.MerchantDiscountRates.PaymentArrangement.Brand envie o valor "PixCielo".

⚠️

O meio de pagamento Pix estará disponível em breve.

Language
Click Try It! to start a request and see the response here!