A partir de 01/06/2024, a API de Onboarding Split 1.0 será desativada, e todas as suas funcionalidades serão transferidas exclusivamente para a API de Onboarding Split 2.0. É crucial que todos os usuários realizem a migração para a nova versão a fim de garantir a continuidade das operações sem interrupções. Caso necessite de auxílio durante esse processo, entre em contato com o nosso Suporte.

Confira as principais alterações para que você possa fazer a migração da API de Onboarding 1.0 para a API de Onboarding 2.0: 

Autenticação

A autenticação continua sendo feita pelo endpoint da Braspag OAUTH2 https://authsandbox.braspag.com.br/ (para sandbox) e https://auth.braspag.com.br/ (para produção).

Ambientes

Para migração para a API de Onboarding 2.0, você vai precisar alterar as URLs e contratos de Sandbox e Produção.

Sandbox

Como era na API de Onboarding 1.0 (antiga): https://splitonboardingsandbox.braspag.com.br 
Na API de Onboarding 2.0 (nova) atualize para: https://splitonboardingapisandbox.braspag.com.br 

Produção

Como era na API de Onboarding 1.0 (antiga): https://splitonboarding.braspag.com.br 
Na API de Onboarding 2.0 (nova) atualize para: https://splitonboardingapi.braspag.com.br 

Requisição de Cadastro de Sellers

Endpoint

Como era na API de Onboarding 1.0 (antiga): [POST] {baseURL}/api/subordinates
Na API de Onboarding 2.0 (nova) atualize para: [POST] {baseURL}/api/merchants

Propriedades da requisição

Na API de Onboarding 2.0 (nova) adicionamos algumas novas propriedades e também excluímos propriedades que existiam na 1.0 (antiga).

Propriedades novas para seller tipo CPF

Propriedades ADICIONADAS para o sellers do tipo CPF na API de Onboarding 2.0 (nova):

*Propriedades exclusivas para CPF.

Propriedades novas para seller tipo CNPJ

Propriedades ADICIONADAS para sellers do tipo CNPJ na API de Onboarding 2.0 (nova):

Nenhuma das propriedades adicionadas existiam na API de Onboarding 1.0.

Propriedade removida

Propriedade REMOVIDA na API de Onboarding 2.0 (nova) e que deve ser excluída da sua integração:

MerchantCategoryCode

Propriedades com alterações

Algumas mudanças foram realizadas nas propriedades do nó Agreements e do nó Attachments.

Alterações no nó Agreements

• Na API de Onboarding 2.0 (nova), é possível cadastrar o seller sem informar as taxas, enviando o nó Agreements como nulo;
• O nó Agreement agora se chama Agreements e passa a ser um array (antes era um objeto).

Quando utilizar a possibilidade  Informando a porcentagem do MDR único aplicado para todos os acordos, houve uma alteração na propriedade Agreement.MdrPercentageda API de Onboarding 1.0 (antiga) para Agreements[].Percentna API de Onboarding 2.0 (nova).

*Quando as taxas não são definidas no cadastro do seller, será necessário informar as taxas de divisão de pagamento no momento da captura da transação ou da emissão do boleto

Alterações no nó Attachments

Na API de Onboarding 2.0 (nova) é obrigatório enviar o Attachments[].AttachmentTypedo tipo ProofBusinessActivity quando o seller é do tipo CPF.

Alterações na resposta

A resposta do cadastro de sellers também passou por algumas alterações. Veja mais na documentação da API de Onboarding Split 2.0.

O endpoint de consulta de Seller também será descontinuado, para conferir o que mudou acesse a nossa documentação da API de cadastro de seller 2.0.