A Braspag está disponibilizando uma nova versão da API de Onboarding do Split de Pagamentos, a API de Onboarding 2.0, para que o master cadastre seus subordinados.
Na API de Onboarding 2.0, após o cadastro, a Braspag irá submeter os subordinados à análise de Know Your Customer (KYC) de forma automática e irá notificar o master com o resultado desse processo, de acordo com as configurações de notificação.
A migração para a API de Onboarding 2.0 será obrigatória para novos cadastros de subordinados a partir de agosto de 2022.
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 Subordinados
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 subordinado tipo CPF
Propriedades ADICIONADAS para o subordinados do tipo CPF na API de Onboarding 2.0 (nova):
Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
Type |
Tipo de merchant a ser criado (Subordinate). | String | 15 | Sim |
MasterMerchantId |
Identificação do master. | Guid | 36 | Sim |
BusinessActivityId * |
Ramo de atividade que o subordinado atua. (apenas para cadastro de pessoa física - CPF). | Int | - | Sim |
BirthdayDate * |
Data de nascimento (apenas para cadastro de pessoa física - CPF). Formato: yyyy-MM-dd | Date | 10 | Sim |
*Propriedades exclusivas para CPF.
Propriedades novas para subordinado tipo CNPJ
Propriedades ADICIONADAS para subordinados do tipo CNPJ na API de Onboarding 2.0 (nova):
Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
Type |
Tipo de merchant a ser criado (Subordinate). | String | 15 | Sim |
MasterMerchantId |
Identificação do master. | Guid | 36 | Sim |
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 subordinado sem informar as taxas, enviando o nó
Agreements
como nulo; - O nó
Agreement
agora se chamaAgreements
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.MdrPercentage
da API de Onboarding 1.0 (antiga) para Agreements[].Percent
na API de Onboarding 2.0 (nova).
*Quando as taxas não são definidas no cadastro do subordinado, 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[].AttachmentType
do tipo ProofBusinessActivity
quando o subordinado é do tipo CPF.
Alterações na resposta
A resposta do cadastro de subordinados também passou por algumas alterações. Veja mais na documentação da API de Onboarding Split 2.0.
Comentários
0 comentário
Por favor, entre para comentar.