Acesse o novo portal de desenvolvedores E-commerce docs.cielo.com.br.
Atenção: O conteúdo desta página está sendo descontinuado e não receberá atualizações a partir de 14/08/2024. Visite a nova documentação em docs.cielo.br.
Essa documentação apresenta a integração com a API de Onboarding Split 2.0 para o cadastro de sellers pelo master no Split de Pagamentos.
A versão anterior da API (1.0) pode ser consultada no tópico Cadastro de Sellers 1.0, mas foi descontinuada em junho de 2024.
A API de Onboarding Split 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 2.0. Consulte as instruções para migração no artigo da nossa página de suporte.
A API de Onboarding Split 2.0 do Split de Pagamentos permite que o master gerencie seus sellers na plataforma. O master deverá coletar as informações do seller para usar no processo de onboarding.
Na API de Onboarding 2.0 o master cadastra o seller e, em seguida, o Split submete o seller à análise de Know Your Customer (KYC) de forma automática e notifica o master com o resultado desse processo, de acordo com as configurações de notificação.
O cadastro de sellers também pode ser feito pelo backoffice Split. Saiba mais neste artigo.
Assim como o master, os sellers também irão passar pelo processo de Know Your Customer (KYC) do Split de Pagamentos, com objetivo de identificar o cliente (seller). Por este motivo, alguns documentos do seller serão necessários.
O processo de KYC é uma medida obrigatória exigida pelas instituições reguladoras de pagamento.
O onboarding do seller no Split de Pagamentos ocorre da seguinte forma:
| API | URL | Descrição |
|---|---|---|
| Braspag OAUTH2 Server | https://authsandbox.braspag.com.br/ | Autenticação. |
| API de Onboarding Split 2.0 | https://splitonboardingapisandbox.braspag.com.br | Cadastro e consulta de sellers 2.0, alteração de taxas em lote e atualização de domicílio bancário. |
| API de Onboarding Split 1.0 [descontinuada] | https://splitonboardingsandbox.braspag.com.br | Consulta de sellers 1.0. |
| API | URL | Descrição |
|---|---|---|
| Braspag OAUTH2 Server | https://auth.braspag.com.br/ | Autenticação. |
| API de Onboarding Split 2.0 | https://splitonboardingapi.braspag.com.br | Cadastro e consulta de sellers 2.0, alteração de taxas em lote e atualização de domicílio bancário. |
| API de Onboarding Split 1.0 [descontinuada] | https://splitonboarding.braspag.com.br | Consulta de sellers 1.0. |
O Split de Pagamentos utiliza como segurança o protocolo OAUTH2, no qual é necessário primeiro obter um token de acesso utlizando suas credenciais, e posteriormente enviar o token de acesso à API de Onboarding Split 2.0.
Para obter um token de acesso:
MerchantId e ClientSecret: MerchantId:ClientSecret;
x-www-form-urlencoded
--header "Authorization: Basic {base64}"
--header "Content-Type: application/x-www-form-urlencoded"
grant_type=client_credentials
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbG.....WE1igNAQRuHAs",
"token_type": "bearer",
"expires_in": 1199
}
O
MerchantIdé o mesmo utilizado na integração com a API Cielo E-Commerce ou com a API do Pagador. OClientSecretdeve ser obtido junto ao Split.
Use o token retornado (access_token) em toda requisição à API de Onboarding Split 2.0 como uma chave de autorização. O token de acesso possui uma validade de 20 minutos e é necessário gerar um novo token toda vez que a validade expirar.
Siga as instruções dessa seção para novas integrações.
O master deverá solicitar o cadastro de seller enviando uma requisição com os dados do seller:
BankAccount);Address);Agreements);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.
Veja a seguir o exemplo de uma requisição completa para cadastro de um seller do tipo CNPJ:
{
"Type": "Subordinate",
"MasterMerchantId": "f88cc14d-c796-4939-957e-de4dddcb2257",
"ContactName": "Nome do Contato do Seller",
"ContactPhone": "11987654321",
"CorporateName": "Seller Corporativo Ltda",
"DocumentNumber": "96462142000140",
"DocumentType": "CNPJ",
"FancyName": "Seller Nome Fantasia",
"MailAddress": "address@email.mail.com",
"Website": "https://www.website.com.br",
"BankAccount": {
"Bank": "001",
"BankAccountType": "CheckingAccount",
"Number": "0002",
"Operation": "2",
"VerifierDigit": "2",
"AgencyNumber": "0002",
"AgencyDigit": "2",
"DocumentNumber": "96462142000140",
"DocumentType": "CNPJ"
},
"Address": {
"Street": "Rua Teste",
"Number": "50",
"Complement": "AP 255",
"Neighborhood": "Centro",
"City": "São Paulo",
"State": "SP",
"ZipCode": "12345687"
},
"Agreements": [
{
"Percent": 2.0,
"Fee": 100
}
],
"Attachments": [
{
"AttachmentType": "ProofOfBankDomicile",
"File": {
"Name": "comprovante",
"FileType": "png",
"Data": "iVBORw0KGgoAAAANSUhEUgAAAH4AAAAsCAMAAACUu/xGAAAAq1BMVEUAAABlZVJlZVKsrJthYU+zs6Grq5ylpZazs6FlZVJfX01lZVJlZVKsrJurq5urq5xlZVKtrZ1lZVJlZVKvr52zs6GysqCoqJeqqpmzs6Grq5xlZVJgYE6zs6Gnp5mrq5yiopRjY1CRkX2rq5yzs6FlZVKRkX2goJKKineRkX2Pj3yrq5yIiHWRkX2RkX2RkX1lZVKRkX2rq5yzs6GoqJdfX02goJKHh3SHh3VrpzVsAAAAMHRSTlMAQIDHx3+Ax0Ag7qBgIA9AEFCPMLOgMO7bYKBQ24+zYNuzkY9wcAXu0oiocPFBMHYlVbK0AAAD3UlEQVRYw6SW7Y6qMBCGB0IkLfKdnB9ocFmjru7HERL03P+VnXY6bdmWjcF9f2inxjydvjMDcHy99zP693oEpTpQYjBR7W4VmzA81GoZCDn/ycrValVmYOJcKBWL1/4HnUEpupLGxOI47iQmDkfc4GEBEFyNQkClzYDKQQs3VmJBufu6G7zRWNMeUzEHUnLVWs/gy9vg4NNB4wUIPOG2h7e8NcV0HRt7QPDxfzTd4ptleB5F6ro3NtsIc7UnjMKKXyuN30ZS+PuLRMW7PN+l2vlhAZ6yqCZmcrm05stfOrwVpvEBaJWStIOpVk/gC8Rb62tjRj25Fx/fEsgqE27cluKB8GR9hDFzeX44CFbmJb9/Cn8w1ldA5tO9VD/gc8FpveTbxfi1LXWOl10Z80c0Yx7/jpyyjRtd9zuxU8ZL8FEYJjZFpg6yIfOpKsf1FJ+EUkzddKkabQ+o0zCcwMN/vZm+uLh4UmW7nptTCBVq5nUF4Y0CgBaNVip18jsPn370909cfX708/gusF3fkQfrKZHXHh45Wi8meRefvfVCfwGOZ9zx8TZ9TjWY2M6vVf4jm8e3WYrDJ1Vj4N3FHwVd6vKFCxefBMFmq7ub6UI7TMZw0SEv8ryPDVaoxPiWufhL/02zY0cm3ZH1VgxIIYa1U/nIibH/EZjjp4M/9w/x9FijbyuqdzOVH+BbWQJxHMupd4pjINhDPKVH1lslBl9g6OKb73j0wmoBHrMj691nsJ0QLn4l0/09nrIm6wv7nGdQqwjGucvPJSWjN4z8aXyBlkfK+i2gmDI/HENGjXA9uPhsUJ22p2OQFg3daaFx0/9qnWBRbOl9hHlvOw3OW/xs4Hf4rcnYzj+OeFOIHj4dtG7/2y+b3IhBGAqjUiQWQ9JI/ErDpop6gcei9z9ZIXHIhLaLSGRW8zYxIuaTZccxqsGfHDXvH4cf37Z4e3ihxVOTp5bf4E8N2u+3PWB2SP7tXsfsFl80rtOeZX/gvz6//7tmnFFzD2mkxnFgL710ToHH1eCcm/LU2aA9m027v+kBH8ipyHbACxAMWaV5I4v2ZgAzIxkUGXIqkn3xrhw4wVe8hoMmOwBmYJMiJy+lHPriNcSyrvgEgUS2h/vl1BcvSqgcZsPbbABrhgdgvhgvS6hIYsPP8MwTVR5SLZA4573xHMpCV7xGZBFmxyProfR64yNCgKh4hygjXIuvpdcbPyEayA2vsEpRHcgl6gtzr8A9ho0RlgQnBPoK4tV45gBfGQZ6KQBDqzRcjdeAqQwHUfYp+SohcQdc1/Ukm4Gw4dV6vqTkM+uQpRv8E2VPF/sPp9xSb2qlGH4AAAAASUVORK5CYII="
}
}
]
}
| PROPRIEDADE | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO |
|---|---|---|---|---|
Type |
Texto | 15 | Sim | Tipo de merchant a ser criado (Subordinate). |
MasterMerchantId |
GUID | 36 | Sim | Identificação do master. |
ContactName |
Texto | 100 | Sim | Nome do contato responsável. |
ContactPhone |
Texto | 11 | Sim | Número do telefone do contato responsável (apenas números). |
CorporateName |
Texto | 100 | Sim | Razão social. |
DocumentNumber |
Texto | 14 | Sim | Número do documento (apenas números). |
DocumentType |
Texto | - | Sim | Tipo do documento. Os tipos válidos são “CPF” ou “CNPJ”. |
FancyName |
Texto | 50 | Sim | Nome fantasia. |
MailAddress |
Texto | 50 | Sim | Endereço de e-mail. |
Website |
Texto | 200 | Não | Endereço do website . |
BirthdayDate* |
Data | 10 | Sim*, quando DocumentType for “CPF”. |
Data de nascimento (apenas para cadastro de pessoa física - CPF). Formato: yyyy-MM-dd |
BusinessActivityId* |
Número | - | Sim*, quando DocumentType for “CPF”. |
Ramo de atividade que o seller atua. (apenas para cadastro de pessoa física - CPF). Veja a Lista de Ramos de Atividades. |
*Não é obrigatório quando DocumentType for “CNPJ”.
| PROPRIEDADE | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO |
|---|---|---|---|---|
BankAccount.Bank |
Texto | 3 | Sim | Código de compensação do banco. Lista de Códigos de compensação |
BankAccount.BankAccountType |
Texto | - | Sim | Tipo de conta bancária. Os tipos válidos são “CheckingAccount” (conta corrente) e “SavingsAccount” (conta poupança). |
BankAccount.Number |
Texto | 10 | Sim | Número da conta do seller. |
BankAccount.Operation |
Texto | 10 | Não | Operação da conta do seller. |
BankAccount.VerifierDigit |
Texto | 1 | Sim | Dígito verificador da conta do seller. |
BankAccount.AgencyNumber |
Texto | 4 | Sim | Número da agência do seller. Atenção: Valores zerados como “0”, “00”, “000” são inválidos. |
BankAccount.AgencyDigit |
Texto | 1 | Sim | Dígito da agência do seller. Caso a agência não tenha dígito, informar o valor “x”. |
BankAccount.DocumentNumber |
Texto | 14 | Não | Número do documento da conta (apenas números) do seller. |
BankAccount.DocumentType |
Texto | - | Não | Tipo do documento. Os tipos válidos são “CPF” ou “CNPJ”. |
| PROPRIEDADE | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO |
|---|---|---|---|---|
Address.Street |
Texto | 100 | Sim | Logradouro do endereço do seller. |
Address.Number |
Texto | 15 | Sim | Número do endereço do seller. |
Address.Complement |
Texto | 80 | Não | Complemento do endereço do seller. |
Address.Neighborhood |
Texto | 50 | Sim | Bairro do seller. |
Address.City |
Texto | 50 | Sim | Cidade do seller. |
Address.State |
Texto | 2 | Sim | Sigla do estado (UF) do seller. |
Address.ZipCode |
Texto | 9 | Sim | CEP (apenas números) do seller. |
No Split de Pagamentos há possibilidades de acordos de taxas entre o master e seus sellers:
Na seção Exemplos dos Acordos de Taxas, você pode visualizar os exemplos de requisições para os três cenários: Não cadastrar taxa, Taxa global e Taxa por meio de pagamento.
ATENÇÃO: Se 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.
| PROPRIEDADE | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO |
|---|---|---|---|---|
Agreements[].Percent |
Decimal | - | Sim, para requisições cujo acordo é com Taxa global. | Porcentagem da taxa de desconto única (MDR único) que será aplicada para todos os acordos entre master e seller. Valor com até duas casas decimais. |
Agreements[].Fee |
Número | - | Sim | Taxa fixa por transação. Valor em centavos. Ex: R$ 1,00 = Fee : 100 |
Agreements[].MerchantDiscountRates[].PaymentArrangement.Product |
Texto | - | Não* | Produto do arranjo de pagamento da taxa de desconto do seller. Os produtos válidos são “CreditCard” e “DebitCard”. |
Agreements[].MerchantDiscountRates[].PaymentArrangement.Brand |
Texto | - | Não* | Bandeira do arranjo de pagamento da taxa de desconto do seller. As bandeiras válidas são Visa, Master, Amex, Elo, Diners e Hipercard. |
Agreements[].MerchantDiscountRates[].InitialInstallmentNumber |
Número | - | Não* | Número inicial do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12. |
Agreements[].MerchantDiscountRates[].FinalInstallmentNumber |
Número | - | Não* | Número final do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12. |
Agreements[].MerchantDiscountRates[].Percent |
Decimal | - | Não* | Porcentagem da taxa de desconto do seller. Valor com até duas casas decimais. |
{
"Id": "5dcee8e4-f432-42e4-a2a6-5a30c8ce2ca5",
"Type": "Subordinate",
"MasterMerchantId": "2b8e9c38-0d9e-4f30-adac-fef3601632e4",
"CorporateName": "Corporate Name Seller",
"FancyName": "Fancy Name Seller",
"DocumentType": 1,
"DocumentNumber": "64829167000142",
"BirthdayDate": "2019-04-25",
"WebSite": "https://www.website.com.br",
"ContactName": "Joao Costa",
"MailAddress": "address@email.mail.com",
"ContactPhone": "2133333334",
"Blocked": true,
"Analysis": {
"Status": 5
},
"Address": {
"ZipCode": "20020081",
"Street": "My street updated",
"Number": "20",
"Complement": "My Complement Seller",
"City": "My City Master",
"Neighborhood": "My Neighborhood Seller",
"State": "RJ"
},
"BankAccount": {
"BankId": 1,
"Bank": "001",
"BankAccountType": "CheckingAccount",
"Number": "0002",
"AgencyNumber": "0002",
"AgencyDigit": "2",
"VerifierDigit": "2",
"Operation": "2"
},
"Agreements": [
{
"Fee": 100,
"AntiFraudFee": 0,
"AntiFraudFeeWithReview": 0,
"MerchantDiscountRates": [
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Elo"
},
"InitialInstallmentNumber": 1,
"FinalInstallmentNumber": 1,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "BankSlip",
"Brand": "BancoDoBrasil"
},
"InitialInstallmentNumber": 1,
"FinalInstallmentNumber": 1,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "DebitCard",
"Brand": "Elo"
},
"InitialInstallmentNumber": 1,
"FinalInstallmentNumber": 1,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber": 1,
"FinalInstallmentNumber": 1,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Visa"
},
"InitialInstallmentNumber": 1,
"FinalInstallmentNumber": 1,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Amex"
},
"InitialInstallmentNumber": 1,
"FinalInstallmentNumber": 12,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "DebitCard",
"Brand": "Visa"
},
"InitialInstallmentNumber": 1,
"FinalInstallmentNumber": 1,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Elo"
},
"InitialInstallmentNumber": 2,
"FinalInstallmentNumber": 6,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber": 2,
"FinalInstallmentNumber": 6,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Visa"
},
"InitialInstallmentNumber": 2,
"FinalInstallmentNumber": 6,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Elo"
},
"InitialInstallmentNumber": 7,
"FinalInstallmentNumber": 12,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Visa"
},
"InitialInstallmentNumber": 7,
"FinalInstallmentNumber": 8,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber": 7,
"FinalInstallmentNumber": 8,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Visa"
},
"InitialInstallmentNumber": 9,
"FinalInstallmentNumber": 12,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber": 9,
"FinalInstallmentNumber": 12,
"Percent": 2.0
}
]
}
],
"Links": [
{
"Href": "http://splitonboardingapisandbox.braspag.com.br/api/merchants/5dcee8e4-f432-42e4-a2a6-5a30c8ce2ca5",
"Rel": "self",
"Method": "GET"
}
]
}
| PROPRIEDADE | TIPO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|
Id |
GUID | 36 | Identificação do merchant (Subordinate) |
Type |
Texto | 15 | Tipo de merchant criado (Subordinate) |
MasterMerchantId |
GUID | 36 | Identificação do Master |
CorporateName |
Texto | 100 | Razão social |
FancyName |
Texto | 50 | Nome fantasia |
DocumentType |
Texto | - | Tipo do documento. Os tipos válidos são Cpf, Cnpj |
DocumentNumber |
Texto | 14 | Número do documento |
BirthdayDate |
Data | 10 | Data de nascimento (apenas para cadastro de pessoa física - CPF) |
Website |
Texto | 200 | Endereço do website |
ContactName |
Texto | 100 | Nome do contato responsável |
MailAddress |
Texto | 50 | Endereço de e-mail |
ContactPhone |
Texto | 11 | Número do telefone do contato responsável |
Blocked |
Booleano | - | Flag para indicar se o seller está bloqueado para participar da transação |
Analysis.Status |
Texto | - | Status da análise do processo de KYC. Os Status válidos são UnderAnalysis, Approved, ApprovedWithRestriction e Rejected |
| PROPRIEDADE | TIPO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|
Address.ZipCode |
Texto | 9 | CEP |
Address.Street |
Texto | 100 | Rua do endereço |
Address.Number |
Texto | 15 | Número do endereço |
Address.Complement |
Texto | 80 | Complemento do endereço |
Address.Neighborhood |
Texto | 50 | Bairro |
Address.City |
Texto | 50 | Cidade |
Address.State |
Texto | 2 | Sigla do estado |
| PROPRIEDADE | TIPO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|
BankAccount.BankId |
Número | - | Identificação do banco. |
BankAccount.Bank |
Texto | 3 | Código de compensação do banco. Lista de Códigos de compensação |
BankAccount.BankAccountType |
Texto | - | Tipo de conta bancária. Os tipos válidos são CheckingAccount (Conta corrente) e SavingsAccount (Conta poupança) |
BankAccount.Number |
Texto | 10 | Número da conta |
BankAccount.AgencyNumber |
Texto | 4 | Número da agência do seller. Atenção: Valores zerados como “0”, “00”, “000” são inválidos. |
BankAccount.AgencyDigit |
Texto | 1 | Dígito da agência |
BankAccount.DocumentNumber |
Texto | 14 | Número do documento da conta |
BankAccount.DocumentType |
Texto | - | Tipo do documento. Os tipos válidos são Cpf, Cnpj |
BankAccount.VerifierDigit |
Texto | 1 | Dígito verificador da conta |
BankAccount.Operation |
Texto | 10 | Operação da conta |
| PROPRIEDADE | TIPO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|
Agreements[].Fee |
Número | - | Taxa fixa por transação |
Agreements[].AntiFraudFee |
Número | - | Taxa do anti-fraude |
Agreements[].AntiFraudFeeWithReview |
Número | - | Taxa do anti-fraude taxa com revisão manual |
Agreements[].MerchantDiscountRates[].PaymentArrangement.Product |
Texto | - | Produto do arranjo de pagamento da taxa de desconto do seller |
Agreements[].MerchantDiscountRates[].PaymentArrangement.Brand |
Texto | - | Bandeira do arranjo de pagamento da taxa de desconto do seller |
Agreements[].MerchantDiscountRates[].InitialInstallmentNumber |
Número | - | Número inicial do intervalo de parcelas da taxa de desconto do seller |
Agreements[].MerchantDiscountRates[].FinalInstallmentNumber |
Número | - | Número final do intervalo de parcelas da taxa de desconto do seller |
Agreements[].MerchantDiscountRates[].Percent |
Decimal | - | Porcentagem da taxa de desconto do seller |
Links |
- | - | Links para navegação |
Quando não haverá cobrança de MDR, siga a requisição padrão excluindo o nó Agreements.
Veja a seguir o exemplo de uma requisição completa para cadastro de um seller do tipo CNPJ e ausência de cobrança de MDR:
Requisição
{
"Type": "Subordinate",
"MasterMerchantId": "f88cc14d-c796-4939-957e-de4dddcb2257",
"ContactName": "Nome do Contato do Seller",
"ContactPhone": "11987654321",
"CorporateName": "Seller Corporativo Ltda",
"DocumentNumber": "96462142000140",
"DocumentType": "CNPJ",
"FancyName": "Seller Nome Fantasia",
"MailAddress": "address@email.mail.com",
"Website": "https://www.website.com.br",
"BankAccount": {
"Bank": "001",
"BankAccountType": "CheckingAccount",
"Number": "0002",
"Operation": "2",
"VerifierDigit": "2",
"AgencyNumber": "0002",
"AgencyDigit": "2",
"DocumentNumber": "96462142000140",
"DocumentType": "CNPJ"
},
"Address": {
"Street": "Rua Teste",
"Number": "50",
"Complement": "AP 255",
"Neighborhood": "Centro",
"City": "São Paulo",
"State": "SP",
"ZipCode": "12345687"
},
"Attachments": [
{
"AttachmentType": "ProofOfBankDomicile",
"File": {
"Name": "comprovante",
"FileType": "png",
"Data": "iVBORw0KGgoAAAANSUhEUgAAAH4AAAAsCAMAAACUu/xGAAAAq1BMVEUAAABlZVJlZVKsrJthYU+zs6Grq5ylpZazs6FlZVJfX01lZVJlZVKsrJurq5urq5xlZVKtrZ1lZVJlZVKvr52zs6GysqCoqJeqqpmzs6Grq5xlZVJgYE6zs6Gnp5mrq5yiopRjY1CRkX2rq5yzs6FlZVKRkX2goJKKineRkX2Pj3yrq5yIiHWRkX2RkX2RkX1lZVKRkX2rq5yzs6GoqJdfX02goJKHh3SHh3VrpzVsAAAAMHRSTlMAQIDHx3+Ax0Ag7qBgIA9AEFCPMLOgMO7bYKBQ24+zYNuzkY9wcAXu0oiocPFBMHYlVbK0AAAD3UlEQVRYw6SW7Y6qMBCGB0IkLfKdnB9ocFmjru7HERL03P+VnXY6bdmWjcF9f2inxjydvjMDcHy99zP693oEpTpQYjBR7W4VmzA81GoZCDn/ycrValVmYOJcKBWL1/4HnUEpupLGxOI47iQmDkfc4GEBEFyNQkClzYDKQQs3VmJBufu6G7zRWNMeUzEHUnLVWs/gy9vg4NNB4wUIPOG2h7e8NcV0HRt7QPDxfzTd4ptleB5F6ro3NtsIc7UnjMKKXyuN30ZS+PuLRMW7PN+l2vlhAZ6yqCZmcrm05stfOrwVpvEBaJWStIOpVk/gC8Rb62tjRj25Fx/fEsgqE27cluKB8GR9hDFzeX44CFbmJb9/Cn8w1ldA5tO9VD/gc8FpveTbxfi1LXWOl10Z80c0Yx7/jpyyjRtd9zuxU8ZL8FEYJjZFpg6yIfOpKsf1FJ+EUkzddKkabQ+o0zCcwMN/vZm+uLh4UmW7nptTCBVq5nUF4Y0CgBaNVip18jsPn370909cfX708/gusF3fkQfrKZHXHh45Wi8meRefvfVCfwGOZ9zx8TZ9TjWY2M6vVf4jm8e3WYrDJ1Vj4N3FHwVd6vKFCxefBMFmq7ub6UI7TMZw0SEv8ryPDVaoxPiWufhL/02zY0cm3ZH1VgxIIYa1U/nIibH/EZjjp4M/9w/x9FijbyuqdzOVH+BbWQJxHMupd4pjINhDPKVH1lslBl9g6OKb73j0wmoBHrMj691nsJ0QLn4l0/09nrIm6wv7nGdQqwjGucvPJSWjN4z8aXyBlkfK+i2gmDI/HENGjXA9uPhsUJ22p2OQFg3daaFx0/9qnWBRbOl9hHlvOw3OW/xs4Hf4rcnYzj+OeFOIHj4dtG7/2y+b3IhBGAqjUiQWQ9JI/ErDpop6gcei9z9ZIXHIhLaLSGRW8zYxIuaTZccxqsGfHDXvH4cf37Z4e3ihxVOTp5bf4E8N2u+3PWB2SP7tXsfsFl80rtOeZX/gvz6//7tmnFFzD2mkxnFgL710ToHH1eCcm/LU2aA9m027v+kBH8ipyHbACxAMWaV5I4v2ZgAzIxkUGXIqkn3xrhw4wVe8hoMmOwBmYJMiJy+lHPriNcSyrvgEgUS2h/vl1BcvSqgcZsPbbABrhgdgvhgvS6hIYsPP8MwTVR5SLZA4573xHMpCV7xGZBFmxyProfR64yNCgKh4hygjXIuvpdcbPyEayA2vsEpRHcgl6gtzr8A9ho0RlgQnBPoK4tV45gBfGQZ6KQBDqzRcjdeAqQwHUfYp+SohcQdc1/Ukm4Gw4dV6vqTkM+uQpRv8E2VPF/sPp9xSb2qlGH4AAAAASUVORK5CYII="
}
}
]
}
Veja as propriedades na requisição padrão.
Quando o MDR é único para todos os acordos, envie apenas os campos Agreements[].Percent (porcentagem do MDR) e Agreements[].Fee (taxa fixa) no nó Agreements.
Requisição
{
"Type": "Subordinate",
"MasterMerchantId": "f88cc14d-c796-4939-957e-de4dddcb2257",
"ContactName": "Nome do Contato do Seller",
"ContactPhone": "11987654321",
"CorporateName": "Seller Corporativo Ltda",
"DocumentNumber": "96462142000140",
"DocumentType": "CNPJ",
"FancyName": "Seller Nome Fantasia",
"MailAddress": "addres@email.mail.com",
"Website": "https://www.website.com.br",
"BankAccount": {
"Bank": "001",
"BankAccountType": "CheckingAccount",
"Number": "0002",
"Operation": "2",
"VerifierDigit": "2",
"AgencyNumber": "0002",
"AgencyDigit": "2",
"DocumentNumber": "96462142000140",
"DocumentType": "CNPJ"
},
"Address": {
"Street": "Rua Teste",
"Number": "50",
"Complement": "AP 255",
"Neighborhood": "Centro",
"City": "São Paulo",
"State": "SP",
"ZipCode": "12345687"
},
"Agreements": [
{
"Percent": 2.0,
"Fee": 100
}
],
"Attachments": [
{
"AttachmentType": "ProofOfBankDomicile",
"File": {
"Name": "comprovante",
"FileType": "png",
"Data": "iVBORw0KGgoAAAANSUhEUgAAAH4AAAAsCAMAAACUu/xGAAAAq1BMVEUAAABlZVJlZVKsrJthYU+zs6Grq5ylpZazs6FlZVJfX01lZVJlZVKsrJurq5urq5xlZVKtrZ1lZVJlZVKvr52zs6GysqCoqJeqqpmzs6Grq5xlZVJgYE6zs6Gnp5mrq5yiopRjY1CRkX2rq5yzs6FlZVKRkX2goJKKineRkX2Pj3yrq5yIiHWRkX2RkX2RkX1lZVKRkX2rq5yzs6GoqJdfX02goJKHh3SHh3VrpzVsAAAAMHRSTlMAQIDHx3+Ax0Ag7qBgIA9AEFCPMLOgMO7bYKBQ24+zYNuzkY9wcAXu0oiocPFBMHYlVbK0AAAD3UlEQVRYw6SW7Y6qMBCGB0IkLfKdnB9ocFmjru7HERL03P+VnXY6bdmWjcF9f2inxjydvjMDcHy99zP693oEpTpQYjBR7W4VmzA81GoZCDn/ycrValVmYOJcKBWL1/4HnUEpupLGxOI47iQmDkfc4GEBEFyNQkClzYDKQQs3VmJBufu6G7zRWNMeUzEHUnLVWs/gy9vg4NNB4wUIPOG2h7e8NcV0HRt7QPDxfzTd4ptleB5F6ro3NtsIc7UnjMKKXyuN30ZS+PuLRMW7PN+l2vlhAZ6yqCZmcrm05stfOrwVpvEBaJWStIOpVk/gC8Rb62tjRj25Fx/fEsgqE27cluKB8GR9hDFzeX44CFbmJb9/Cn8w1ldA5tO9VD/gc8FpveTbxfi1LXWOl10Z80c0Yx7/jpyyjRtd9zuxU8ZL8FEYJjZFpg6yIfOpKsf1FJ+EUkzddKkabQ+o0zCcwMN/vZm+uLh4UmW7nptTCBVq5nUF4Y0CgBaNVip18jsPn370909cfX708/gusF3fkQfrKZHXHh45Wi8meRefvfVCfwGOZ9zx8TZ9TjWY2M6vVf4jm8e3WYrDJ1Vj4N3FHwVd6vKFCxefBMFmq7ub6UI7TMZw0SEv8ryPDVaoxPiWufhL/02zY0cm3ZH1VgxIIYa1U/nIibH/EZjjp4M/9w/x9FijbyuqdzOVH+BbWQJxHMupd4pjINhDPKVH1lslBl9g6OKb73j0wmoBHrMj691nsJ0QLn4l0/09nrIm6wv7nGdQqwjGucvPJSWjN4z8aXyBlkfK+i2gmDI/HENGjXA9uPhsUJ22p2OQFg3daaFx0/9qnWBRbOl9hHlvOw3OW/xs4Hf4rcnYzj+OeFOIHj4dtG7/2y+b3IhBGAqjUiQWQ9JI/ErDpop6gcei9z9ZIXHIhLaLSGRW8zYxIuaTZccxqsGfHDXvH4cf37Z4e3ihxVOTp5bf4E8N2u+3PWB2SP7tXsfsFl80rtOeZX/gvz6//7tmnFFzD2mkxnFgL710ToHH1eCcm/LU2aA9m027v+kBH8ipyHbACxAMWaV5I4v2ZgAzIxkUGXIqkn3xrhw4wVe8hoMmOwBmYJMiJy+lHPriNcSyrvgEgUS2h/vl1BcvSqgcZsPbbABrhgdgvhgvS6hIYsPP8MwTVR5SLZA4573xHMpCV7xGZBFmxyProfR64yNCgKh4hygjXIuvpdcbPyEayA2vsEpRHcgl6gtzr8A9ho0RlgQnBPoK4tV45gBfGQZ6KQBDqzRcjdeAqQwHUfYp+SohcQdc1/Ukm4Gw4dV6vqTkM+uQpRv8E2VPF/sPp9xSb2qlGH4AAAAASUVORK5CYII="
}
}
]
}
Veja as propriedades na requisição padrão.
Nesse caso, você deverá informar os campos referentes à taxa fixa, produto, bandeira, intervalo de parcelas e porcentagem do MDR.
Os arranjos informados no cadastro do seller precisam ser iguais aos acordos entre master e Split.
Exemplo
MDR do master com seller igual a 4%.
| ACORDO SUBADQUIRENTE (SPLIT) E MASTER | VISA | MASTERCARD | ELO |
|---|---|---|---|
| Débito | 2.00% | 2.00% | 2.00% |
| Crédito à vista | 2.50% | 2.50% | 2.50% |
| Crédito 2x a 6x | 3.00% | 3.00% | 3.00% |
| Crédito 7x a 12x | 3.50% | 3.50% | 3.50% |
| ACORDO MASTER E SELLER | VISA | MASTERCARD | ELO |
|---|---|---|---|
| Débito | 4.00% | 4.00% | 4.00% |
| Crédito à vista | 4.00% | 4.00% | 4.00% |
| Crédito 2x a 6x | 4.00% | 4.00% | 4.00% |
| Crédito 7x a 12x | 4.00% | 4.00% | 4.00% |
Requisição
Veja a seguir o exemplo de requisição de cadastro de seller com CPF com acordo de taxas por arranjo de pagamento e intervalo de parcelas.
{
"Type": "Subordinate",
"MasterMerchantId": "f88cc14d-c796-4939-957e-de4dddcb2257",
"BusinessActivityId" : 10,
"ContactName": "Nome do Contato do Seller",
"ContactPhone": "11987654321",
"CorporateName": "Nome do Seller",
"DocumentNumber": "91205046089",
"DocumentType": "CPF",
"FancyName": "Nome do Seller",
"BirthdayDate": "1984-04-25",
"MailAddress": "address@email.mail.com",
"Website": "https://www.website.com.br",
"BankAccount": {
"Bank": "001",
"BankAccountType": "CheckingAccount",
"Number": "0002",
"Operation": "2",
"VerifierDigit": "2",
"AgencyNumber": "0002",
"AgencyDigit": "2",
"DocumentNumber": "91205046089",
"DocumentType": "CPF"
},
"Address": {
"Street": "Rua Teste",
"Number": "50",
"Complement": "AP 255",
"Neighborhood": "Centro",
"City": "São Paulo",
"State": "SP",
"ZipCode": "12345687"
},
"Agreements": [
{
"Fee": 10,
"MerchantDiscountRates": [
{
"PaymentArrangement": {
"Product": "DebitCard",
"Brand": "Master"
},
"InitialInstallmentNumber": 1,
"FinalInstallmentNumber": 1,
"Percent": 1.5
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber": 1,
"FinalInstallmentNumber": 1,
"Percent": 2.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber": 2,
"FinalInstallmentNumber": 6,
"Percent": 3.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber": 7,
"FinalInstallmentNumber": 12,
"Percent": 4.0
}
]
}
],
"Attachments": [
{
"AttachmentType": "ProofBusinessActivity",
"File": {
"Name": "comprovante",
"FileType": "png",
"Data": "iVBORw0KGgoAAAANSUhEUgAAAH4AAAAsCAMAAACUu/xGAAAAq1BMVEUAAABlZVJlZVKsrJthYU+zs6Grq5ylpZazs6FlZVJfX01lZVJlZVKsrJurq5urq5xlZVKtrZ1lZVJlZVKvr52zs6GysqCoqJeqqpmzs6Grq5xlZVJgYE6zs6Gnp5mrq5yiopRjY1CRkX2rq5yzs6FlZVKRkX2goJKKineRkX2Pj3yrq5yIiHWRkX2RkX2RkX1lZVKRkX2rq5yzs6GoqJdfX02goJKHh3SHh3VrpzVsAAAAMHRSTlMAQIDHx3+Ax0Ag7qBgIA9AEFCPMLOgMO7bYKBQ24+zYNuzkY9wcAXu0oiocPFBMHYlVbK0AAAD3UlEQVRYw6SW7Y6qMBCGB0IkLfKdnB9ocFmjru7HERL03P+VnXY6bdmWjcF9f2inxjydvjMDcHy99zP693oEpTpQYjBR7W4VmzA81GoZCDn/ycrValVmYOJcKBWL1/4HnUEpupLGxOI47iQmDkfc4GEBEFyNQkClzYDKQQs3VmJBufu6G7zRWNMeUzEHUnLVWs/gy9vg4NNB4wUIPOG2h7e8NcV0HRt7QPDxfzTd4ptleB5F6ro3NtsIc7UnjMKKXyuN30ZS+PuLRMW7PN+l2vlhAZ6yqCZmcrm05stfOrwVpvEBaJWStIOpVk/gC8Rb62tjRj25Fx/fEsgqE27cluKB8GR9hDFzeX44CFbmJb9/Cn8w1ldA5tO9VD/gc8FpveTbxfi1LXWOl10Z80c0Yx7/jpyyjRtd9zuxU8ZL8FEYJjZFpg6yIfOpKsf1FJ+EUkzddKkabQ+o0zCcwMN/vZm+uLh4UmW7nptTCBVq5nUF4Y0CgBaNVip18jsPn370909cfX708/gusF3fkQfrKZHXHh45Wi8meRefvfVCfwGOZ9zx8TZ9TjWY2M6vVf4jm8e3WYrDJ1Vj4N3FHwVd6vKFCxefBMFmq7ub6UI7TMZw0SEv8ryPDVaoxPiWufhL/02zY0cm3ZH1VgxIIYa1U/nIibH/EZjjp4M/9w/x9FijbyuqdzOVH+BbWQJxHMupd4pjINhDPKVH1lslBl9g6OKb73j0wmoBHrMj691nsJ0QLn4l0/09nrIm6wv7nGdQqwjGucvPJSWjN4z8aXyBlkfK+i2gmDI/HENGjXA9uPhsUJ22p2OQFg3daaFx0/9qnWBRbOl9hHlvOw3OW/xs4Hf4rcnYzj+OeFOIHj4dtG7/2y+b3IhBGAqjUiQWQ9JI/ErDpop6gcei9z9ZIXHIhLaLSGRW8zYxIuaTZccxqsGfHDXvH4cf37Z4e3ihxVOTp5bf4E8N2u+3PWB2SP7tXsfsFl80rtOeZX/gvz6//7tmnFFzD2mkxnFgL710ToHH1eCcm/LU2aA9m027v+kBH8ipyHbACxAMWaV5I4v2ZgAzIxkUGXIqkn3xrhw4wVe8hoMmOwBmYJMiJy+lHPriNcSyrvgEgUS2h/vl1BcvSqgcZsPbbABrhgdgvhgvS6hIYsPP8MwTVR5SLZA4573xHMpCV7xGZBFmxyProfR64yNCgKh4hygjXIuvpdcbPyEayA2vsEpRHcgl6gtzr8A9ho0RlgQnBPoK4tV45gBfGQZ6KQBDqzRcjdeAqQwHUfYp+SohcQdc1/Ukm4Gw4dV6vqTkM+uQpRv8E2VPF/sPp9xSb2qlGH4AAAAASUVORK5CYII="
}
}
]
}
Veja as propriedades na requisição padrão.
Esta seção detalha a integração da API de Onboarding Split 1.0, que será descontinuada em breve.
Para novas integrações, veja a seção Cadastro de Sellers 2.0.
Para migração da versão 1.0 para a API de Onboarding Split 2.0, veja as instruções neste artigo.
A solicitação de cadastro deve ser realizada através de uma requisição pelo master informando os dados do seller.
Para a definição de acordos entre o master e seus sellers, o Split de Pagamentos dispõe de duas possibilidades:
Exemplo:
MDR do master com seller igual a 4%
| ACORDO SUBADQUIRENTE e MASTER | Visa | Master | Elo | Diners | Amex | Hipercard |
|---|---|---|---|---|---|---|
| Débito | 2.00% | 2.00% | 2.00% | - | - | - |
| Crédito a Vista | 2.50% | 2.50% | 2.50% | 2.50% | 2.50% | 2.50% |
| Crédito 2x a 6x | 3.00% | 3.00% | 3.00% | 3.00% | 3.00% | 3.00% |
| Crédito 7x a 12x | 3.50% | 3.50% | 3.50% | 3.50% | 3.50% | 3.50% |
| ACORDO MASTER e SELLER | Visa | Master | Elo | Diners | Amex | Hipercard |
|---|---|---|---|---|---|---|
| Débito | 4.00% | 4.00% | 4.00% | - | - | - |
| Crédito a Vista | 4.00% | 4.00% | 4.00% | 4.00% | 4.00% | 4.00% |
| Crédito 2x a 6x | 4.00% | 4.00% | 4.00% | 4.00% | 4.00% | 4.00% |
| Crédito 7x a 12x | 4.00% | 4.00% | 4.00% | 4.00% | 4.00% | 4.00% |
--header "Authorization: Bearer {access_token}"
{
"CorporateName":"Seller Corporativo Ltda",
"FancyName":"Seller Nome Fantasia",
"DocumentNumber":"96462142000140",
"DocumentType":"CNPJ",
"MerchantCategoryCode":"5719",
"ContactName":"Nome do Contato do Seller",
"ContactPhone":"11987654321",
"MailAddress":"addres@email.mail.com",
"Website":"https://www.website.com.br",
"BankAccount": {
"Bank":"001",
"BankAccountType":"CheckingAccount",
"Number":"0002",
"Operation":"2",
"VerifierDigit":"2",
"AgencyNumber":"0002",
"AgencyDigit":"2",
"DocumentNumber":"96462142000140",
"DocumentType":"CNPJ"
},
"Address":{
"Street":"Rua Teste",
"Number":"50",
"Complement":"AP 255",
"Neighborhood":"Centro",
"City":"São Paulo",
"State" : "SP",
"ZipCode": "12345687"
},
"Agreement":{
"Fee" : 10,
"MerchantDiscountRates": [{
"PaymentArrangement": {
"Product": "DebitCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 1,
"FinalInstallmentNumber" : 1,
"Percent" : 1.5
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 1,
"FinalInstallmentNumber" : 1,
"Percent" : 2.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 2,
"FinalInstallmentNumber" : 6,
"Percent" : 3.0
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 7,
"FinalInstallmentNumber" : 12,
"Percent" : 4.0
}]
},
"Notification": {
"Url": "https://site.com.br/api/subordinados",
"Headers": [{
"Key": "key1",
"Value": "value1"
},
{
"Key": "key2",
"Value": "value2"
}]
},
"Attachments": [{
"AttachmentType": "ProofOfBankDomicile",
"File": {
"Name": "comprovante",
"FileType": "png",
"Data": "iVBORw0KGgoAAAANSUhEUgAAAH4AAAAsCAMAAACUu/xGAAAAq1BMVEUAAABlZVJlZVKsrJthYU+zs6Grq5ylpZazs6FlZVJfX01lZVJlZVKsrJurq5urq5xlZVKtrZ1lZVJlZVKvr52zs6GysqCoqJeqqpmzs6Grq5xlZVJgYE6zs6Gnp5mrq5yiopRjY1CRkX2rq5yzs6FlZVKRkX2goJKKineRkX2Pj3yrq5yIiHWRkX2RkX2RkX1lZVKRkX2rq5yzs6GoqJdfX02goJKHh3SHh3VrpzVsAAAAMHRSTlMAQIDHx3+Ax0Ag7qBgIA9AEFCPMLOgMO7bYKBQ24+zYNuzkY9wcAXu0oiocPFBMHYlVbK0AAAD3UlEQVRYw6SW7Y6qMBCGB0IkLfKdnB9ocFmjru7HERL03P+VnXY6bdmWjcF9f2inxjydvjMDcHy99zP693oEpTpQYjBR7W4VmzA81GoZCDn/ycrValVmYOJcKBWL1/4HnUEpupLGxOI47iQmDkfc4GEBEFyNQkClzYDKQQs3VmJBufu6G7zRWNMeUzEHUnLVWs/gy9vg4NNB4wUIPOG2h7e8NcV0HRt7QPDxfzTd4ptleB5F6ro3NtsIc7UnjMKKXyuN30ZS+PuLRMW7PN+l2vlhAZ6yqCZmcrm05stfOrwVpvEBaJWStIOpVk/gC8Rb62tjRj25Fx/fEsgqE27cluKB8GR9hDFzeX44CFbmJb9/Cn8w1ldA5tO9VD/gc8FpveTbxfi1LXWOl10Z80c0Yx7/jpyyjRtd9zuxU8ZL8FEYJjZFpg6yIfOpKsf1FJ+EUkzddKkabQ+o0zCcwMN/vZm+uLh4UmW7nptTCBVq5nUF4Y0CgBaNVip18jsPn370909cfX708/gusF3fkQfrKZHXHh45Wi8meRefvfVCfwGOZ9zx8TZ9TjWY2M6vVf4jm8e3WYrDJ1Vj4N3FHwVd6vKFCxefBMFmq7ub6UI7TMZw0SEv8ryPDVaoxPiWufhL/02zY0cm3ZH1VgxIIYa1U/nIibH/EZjjp4M/9w/x9FijbyuqdzOVH+BbWQJxHMupd4pjINhDPKVH1lslBl9g6OKb73j0wmoBHrMj691nsJ0QLn4l0/09nrIm6wv7nGdQqwjGucvPJSWjN4z8aXyBlkfK+i2gmDI/HENGjXA9uPhsUJ22p2OQFg3daaFx0/9qnWBRbOl9hHlvOw3OW/xs4Hf4rcnYzj+OeFOIHj4dtG7/2y+b3IhBGAqjUiQWQ9JI/ErDpop6gcei9z9ZIXHIhLaLSGRW8zYxIuaTZccxqsGfHDXvH4cf37Z4e3ihxVOTp5bf4E8N2u+3PWB2SP7tXsfsFl80rtOeZX/gvz6//7tmnFFzD2mkxnFgL710ToHH1eCcm/LU2aA9m027v+kBH8ipyHbACxAMWaV5I4v2ZgAzIxkUGXIqkn3xrhw4wVe8hoMmOwBmYJMiJy+lHPriNcSyrvgEgUS2h/vl1BcvSqgcZsPbbABrhgdgvhgvS6hIYsPP8MwTVR5SLZA4573xHMpCV7xGZBFmxyProfR64yNCgKh4hygjXIuvpdcbPyEayA2vsEpRHcgl6gtzr8A9ho0RlgQnBPoK4tV45gBfGQZ6KQBDqzRcjdeAqQwHUfYp+SohcQdc1/Ukm4Gw4dV6vqTkM+uQpRv8E2VPF/sPp9xSb2qlGH4AAAAASUVORK5CYII="
}
}]
}
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
CorporateName |
Texto | 100 | Sim | Razão social |
FancyName |
Texto | 50 | Sim | Nome fantasia |
DocumentNumber |
Texto | 14 | Sim | Número do documento (Apenas números) |
DocumentType |
Texto | - | Sim | Tipo do documento. Os tipos válidos são Cpf, Cnpj |
BirthdayDate |
Data | 10 | Sim Obrigatório apenas caso DocumentType seja Cpf |
Data de nascimento (apenas para cadastro de pessoa física - CPF). Formato: yyyy-MM-dd |
MerchantCategoryCode |
Texto | 4 | Sim | (MCC) número registrado na ISO 18245 para serviços financeiros de varejo, utilizado para classificar o negócio pelo tipo fornecido de bens ou serviços. |
ContactName |
Texto | 100 | Sim | Nome do contato responsável |
ContactPhone |
Texto | 11 | Sim | Número do telefone do contato responsável (Apenas números) |
MailAddress |
Texto | 50 | Sim | Endereço de e-mail |
Website |
Texto | 200 | Não | Endereço do website |
BankAccount.Bank |
Texto | 3 | Sim | Código de compensação do banco. Lista de Códigos de compensação |
BankAccount.BankAccountType |
Texto | - | Sim | Tipo de conta bancária. Os tipos válidos são CheckingAccount (Conta corrente) e SavingsAccount (Conta poupança) |
BankAccount.Number |
Texto | 10 | Sim | Número da conta |
BankAccount.Operation |
Texto | 10 | Não | Operação da conta |
BankAccount.VerifierDigit |
Texto | 1 | Sim | Dígito verificador da conta |
BankAccount.AgencyNumber |
Texto | 15 | Sim | Número da agência |
BankAccount.AgencyDigit |
Texto | 1 | Sim | Dígito da agência. Caso a agência não tenha dígito, informar o valor x |
BankAccount.DocumentNumber |
Texto | 14 | Sim | Número do documento da conta (Apenas números) |
BankAccount.DocumentType |
Texto | - | Sim | Tipo do documento. Os tipos válidos são Cpf, Cnpj |
Address.Street |
Texto | 100 | Sim | Rua do endereço |
Address.Number |
Texto | 15 | Sim | Número do endereço |
Address.Complement |
Texto | 80 | Não | Complemento do endereço |
Address.Neighborhood |
Texto | 50 | Sim | Bairro |
Address.City |
Texto | 50 | Sim | Cidade |
Address.State |
Texto | 2 | Sim | Sigla do estado |
Address.ZipCode |
Texto | 9 | Sim | CEP (Apenas números) |
Agreement.Fee |
Número | - | Sim | Taxa fixa por transação. Valor em centavos. Ex: R$ 1,00 = "Fee" : 100 |
Agreement.MerchantDiscountRates[].PaymentArrangement.Product |
Texto | - | Sim | Produto do arranjo de pagamento da taxa de desconto do seller. Os produtos válidos são CreditCard e DebitCard |
Agreement.MerchantDiscountRates[].PaymentArrangement.Brand |
Texto | - | Sim | Bandeira do arranjo de pagamento da taxa de desconto do seller. As bandeiras válidas são Visa, Master, Amex, Elo, Diners e Hipercard |
Agreement.MerchantDiscountRates[].InitialInstallmentNumber |
Número | - | Sim | Número inicial do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12 |
Agreement.MerchantDiscountRates[].FinalInstallmentNumber |
Número | - | Sim | Número final do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12 |
Agreement.MerchantDiscountRates[].Percent |
Decimal | - | Sim | Porcentagem da taxa de desconto do seller. Valor com até duas casas decimais |
Notification.Url |
Texto | 200 | Sim | Url de notificação de mudança de status da análise do processo de KYC |
Notification.Headers[].Key |
Texto | 100 | Sim | Chave do header da requisição para a notificação de mudança de status da análise do processo de KYC |
Notification.Headers[].Value |
Texto | 100 | Sim | Valor do header da requisição para a notificação de mudança de status da análise do processo de KYC |
Attachments[].AttachmentType |
Texto | - | Não | Tipo do documento em anexo do seller. Os tipos válidos são ProofOfBankDomicile (Comprovante de domicílio bancário) e ModelOfAdhesionTerm (Modelo de termo de adesão) |
Attachments[].File.Name |
Texto | 50 | Não | Nome do arquivo do documento em anexo do seller |
Attachments[].File.FileType |
Texto | - | Não | Tipo do arquivo do documento em anexo do seller. Os tipos de arquivos válidos são pdf, png, jpg e jpeg |
Attachments[].File.Data |
Texto | - | Não | Documento convertido para Base64 |
--header "Authorization: Bearer {access_token}"
{
"MasterMerchantId": "665a33c5-0022-4a40-a0bd-daad04eb3236",
"MerchantId": "b8ccc729-a874-4b51-a5a9-ffeb5bd98878",
"CorporateName":"Seller Corporativo Ltda",
"FancyName":"Seller Nome Fantasia",
"DocumentNumber":"96462142000140",
"DocumentType":"CNPJ",
"MerchantCategoryCode":"5719",
"ContactName":"Nome do Contato do Seller",
"ContactPhone":"11987654321",
"MailAddress":"addres@email.mail.com",
"Website":"https://www.website.com.br",
"Blocked": true,
"Analysis": {
"Status": "UnderAnalysis"
},
"BankAccount": {
"Bank":"001",
"BankAccountType":"CheckingAccount",
"Number":"0002",
"Operation":"2",
"VerifierDigit":"2",
"AgencyNumber":"0002",
"AgencyDigit":"2",
"DocumentNumber":"96462142000140",
"DocumentType":"CNPJ"
},
"Address":{
"Street":"Rua Teste",
"Number":"50",
"Complement":"AP 255",
"Neighborhood":"Centro",
"City":"São Paulo",
"State" : "SP",
"ZipCode": "12345687"
},
"Agreement":{
"Fee" : 10,
"MerchantDiscountRates": [{
"MerchantDiscountRateId": "662e340f-07f2-4827-816d-b1878eb03eae",
"PaymentArrangement": {
"Product": "DebitCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 1,
"FinalInstallmentNumber" : 1,
"Percent" : 1.5
},
{
"MerchantDiscountRateId": "eb9d6357-7ad1-4fe0-90fe-364cff7ff0fd",
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 1,
"FinalInstallmentNumber" : 1,
"Percent" : 2.0
},
{
"MerchantDiscountRateId": "d09fe9d3-98c7-4c37-9bd3-7c1c91ee15de",
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 2,
"FinalInstallmentNumber" : 6,
"Percent" : 3.0
},
{
"MerchantDiscountRateId": "e2515c24-fd73-4b8e-92ad-cfe2b95239de",
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 7,
"FinalInstallmentNumber" : 12,
"Percent" : 4.0
}]
},
"Notification": {
"Url": "https://site.com.br/api/subordinados",
"Headers": [{
"Key": "key1",
"Value": "value1"
},
{
"Key": "key2",
"Value": "value2"
}]
},
"Attachments": [{
"AttachmentType": "ProofOfBankDomicile",
"File": {
"Name": "comprovante",
"FileType": "png"
}
}]
}
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
MasterMerchantId |
GUID | 36 | Sim | Identificação do master do seller |
MerchantId |
GUID | 36 | Sim | Identificação do seller |
CorporateName |
Texto | 100 | Sim | Razão social |
FancyName |
Texto | 50 | Sim | Nome fantasia |
DocumentNumber |
Texto | 14 | Sim | Número do documento |
DocumentType |
Texto | - | Sim | Tipo do documento. Os tipos válidos são Cpf, Cnpj |
BirthdayDate |
Data | 10 | Sim Obrigatório apenas caso DocumentType seja Cpf |
Data de nascimento (apenas para cadastro de pessoa física - CPF). Formato: yyyy-MM-dd |
MerchantCategoryCode |
Texto | 4 | Sim | (MCC) número registrado na ISO 18245 para serviços financeiros de varejo, utilizado para classificar o negócio pelo tipo fornecido de bens ou serviços. |
ContactName |
Texto | 100 | Sim | Nome do contato responsável |
ContactPhone |
Texto | 11 | Sim | Número do telefone do contato responsável (Apenas números) |
MailAddress |
String | 50 | Sim | Endereço de e-mail |
Website |
Texto | 200 | Não | Endereço do website |
Blocked |
Booleano | - | Sim | Flag para indicar se o seller está bloqueado para participar da transação |
Analysis.Status |
Texto | - | Sim | Status da análise do processo de KYC. Os Status válidos são Approved, ApprovedWithRestriction e Rejected |
BankAccount.Bank |
Texto | 3 | Sim | Código de compensação do banco. Lista de Códigos de compensação |
BankAccount.BankAccountType |
Texto | - | Sim | Tipo de conta bancária. Os tipos válidos são CheckingAccount (Conta corrente) e SavingsAccount (Conta poupança) |
BankAccount.Number |
Texto | 10 | Sim | Número da conta |
BankAccount.Operation |
Texto | 10 | Não | Operação da conta |
BankAccount.VerifierDigit |
Texto | 1 | Sim | Dígito verificador da conta |
BankAccount.AgencyNumber |
Texto | 15 | Sim | Número da agência |
BankAccount.AgencyDigit |
Texto | 1 | Sim | Dígito da agência. Caso a agência não tenha dígito, informar o valor x |
BankAccount.DocumentNumber |
Texto | 14 | Sim | Número do documento da conta |
BankAccount.DocumentType |
Texto | - | Sim | Tipo do documento. Os tipos válidos são Cpf, Cnpj |
Address.Street |
Texto | 100 | Sim | Rua do endereço |
Address.Number |
Texto | 15 | Sim | Número do endereço |
Address.Complement |
Texto | 80 | Não | Complemento do endereço |
Address.Neighborhood |
Texto | 50 | Sim | Bairro |
Address.City |
Texto | 50 | Sim | Cidade |
Address.State |
Texto | 2 | Sim | Sigla do estado |
Address.ZipCode |
Texto | 9 | Sim | CEP |
Agreement.Fee |
Número | - | Sim | Taxa fixa por transação. Valor em centavos. Ex: R$ 1,00 = "Fee" : 100 |
Agreement.MerchantDiscountRates[].MerchantDiscountRateId |
GUID | 36 | Sim | Identificação da taxa de desconto do seller |
Agreement.MerchantDiscountRates[].PaymentArrangement.Product |
Texto | - | Sim | Produto do arranjo de pagamento da taxa de desconto do seller. Os produtos válidos são CreditCard e DebitCard |
Agreement.MerchantDiscountRates[].PaymentArrangement.Brand |
Texto | - | Sim | Bandeira do arranjo de pagamento da taxa de desconto do seller. As bandeiras válidas são Visa, Master, Amex, Elo, Diners e Hipercard |
Agreement.MerchantDiscountRates[].InitialInstallmentNumber |
Número | - | Sim | Número inicial do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12 |
Agreement.MerchantDiscountRates[].FinalInstallmentNumber |
Número | - | Sim | Número final do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12 |
Agreement.MerchantDiscountRates[].Percent |
Decimal | - | Sim | Porcentagem da taxa de desconto do seller. Valor com até duas casas decimais |
Notification.Url |
Texto | 200 | Sim | Url de notificação de mudança de status da análise do processo de KYC |
Notification.Headers[].Key |
Texto | 100 | Sim | Chave do header da requisição para a notificação de mudança de status da análise do processo de KYC |
Notification.Headers[].Value |
Texto | 100 | Sim | Valor do header da requisição para a notificação de mudança de status da análise do processo de KYC |
Attachments[].AttachmentType |
Texto | - | Não | Tipo do documento em anexo do seller. Os tipos válidos são ProofOfBankDomicile (Comprovante de domicílio bancário) e ModelOfAdhesionTerm (Modelo de termo de adesão) |
Attachments[].File.Name |
Texto | 50 | Não | Nome do arquivo do documento em anexo do seller |
Attachments[].File.FileType |
Texto | - | Não | Tipo do arquivo do documento em anexo do seller. Os tipos de arquivos válidos são pdf, png, jpg e jpeg |
--header "Authorization: Bearer {access_token}"
{
"CorporateName":"Seller Corporativo Ltda",
"FancyName":"Seller Nome Fantasia",
"DocumentNumber":"96462142000140",
"DocumentType":"CNPJ",
"MerchantCategoryCode":"5719",
"ContactName":"Nome do Contato do Seller",
"ContactPhone":"11987654321",
"MailAddress":"addres@email.mail.com",
"Website":"https://www.website.com.br",
"BankAccount": {
"Bank":"001",
"BankAccountType":"CheckingAccount",
"Number":"0002",
"Operation":"2",
"VerifierDigit":"2",
"AgencyNumber":"0002",
"AgencyDigit":"2",
"DocumentNumber":"96462142000140",
"DocumentType":"CNPJ"
},
"Address":{
"Street":"Rua Teste",
"Number":"50",
"Complement":"AP 255",
"Neighborhood":"Centro",
"City":"São Paulo",
"State" : "SP",
"ZipCode": "12345687"
},
"Agreement":{
"Fee" : 10,
"MdrPercentage": 4.00
},
"Notification": {
"Url": "https://site.com.br/api/subordinados",
"Headers": [{
"Key": "key1",
"Value": "value1"
},
{
"Key": "key2",
"Value": "value2"
}]
},
"Attachments": [{
"AttachmentType": "ProofOfBankDomicile",
"File": {
"Name": "comprovante",
"FileType": "png",
"Data": "iVBORw0KGgoAAAANSUhEUgAAAH4AAAAsCAMAAACUu/xGAAAAq1BMVEUAAABlZVJlZVKsrJthYU+zs6Grq5ylpZazs6FlZVJfX01lZVJlZVKsrJurq5urq5xlZVKtrZ1lZVJlZVKvr52zs6GysqCoqJeqqpmzs6Grq5xlZVJgYE6zs6Gnp5mrq5yiopRjY1CRkX2rq5yzs6FlZVKRkX2goJKKineRkX2Pj3yrq5yIiHWRkX2RkX2RkX1lZVKRkX2rq5yzs6GoqJdfX02goJKHh3SHh3VrpzVsAAAAMHRSTlMAQIDHx3+Ax0Ag7qBgIA9AEFCPMLOgMO7bYKBQ24+zYNuzkY9wcAXu0oiocPFBMHYlVbK0AAAD3UlEQVRYw6SW7Y6qMBCGB0IkLfKdnB9ocFmjru7HERL03P+VnXY6bdmWjcF9f2inxjydvjMDcHy99zP693oEpTpQYjBR7W4VmzA81GoZCDn/ycrValVmYOJcKBWL1/4HnUEpupLGxOI47iQmDkfc4GEBEFyNQkClzYDKQQs3VmJBufu6G7zRWNMeUzEHUnLVWs/gy9vg4NNB4wUIPOG2h7e8NcV0HRt7QPDxfzTd4ptleB5F6ro3NtsIc7UnjMKKXyuN30ZS+PuLRMW7PN+l2vlhAZ6yqCZmcrm05stfOrwVpvEBaJWStIOpVk/gC8Rb62tjRj25Fx/fEsgqE27cluKB8GR9hDFzeX44CFbmJb9/Cn8w1ldA5tO9VD/gc8FpveTbxfi1LXWOl10Z80c0Yx7/jpyyjRtd9zuxU8ZL8FEYJjZFpg6yIfOpKsf1FJ+EUkzddKkabQ+o0zCcwMN/vZm+uLh4UmW7nptTCBVq5nUF4Y0CgBaNVip18jsPn370909cfX708/gusF3fkQfrKZHXHh45Wi8meRefvfVCfwGOZ9zx8TZ9TjWY2M6vVf4jm8e3WYrDJ1Vj4N3FHwVd6vKFCxefBMFmq7ub6UI7TMZw0SEv8ryPDVaoxPiWufhL/02zY0cm3ZH1VgxIIYa1U/nIibH/EZjjp4M/9w/x9FijbyuqdzOVH+BbWQJxHMupd4pjINhDPKVH1lslBl9g6OKb73j0wmoBHrMj691nsJ0QLn4l0/09nrIm6wv7nGdQqwjGucvPJSWjN4z8aXyBlkfK+i2gmDI/HENGjXA9uPhsUJ22p2OQFg3daaFx0/9qnWBRbOl9hHlvOw3OW/xs4Hf4rcnYzj+OeFOIHj4dtG7/2y+b3IhBGAqjUiQWQ9JI/ErDpop6gcei9z9ZIXHIhLaLSGRW8zYxIuaTZccxqsGfHDXvH4cf37Z4e3ihxVOTp5bf4E8N2u+3PWB2SP7tXsfsFl80rtOeZX/gvz6//7tmnFFzD2mkxnFgL710ToHH1eCcm/LU2aA9m027v+kBH8ipyHbACxAMWaV5I4v2ZgAzIxkUGXIqkn3xrhw4wVe8hoMmOwBmYJMiJy+lHPriNcSyrvgEgUS2h/vl1BcvSqgcZsPbbABrhgdgvhgvS6hIYsPP8MwTVR5SLZA4573xHMpCV7xGZBFmxyProfR64yNCgKh4hygjXIuvpdcbPyEayA2vsEpRHcgl6gtzr8A9ho0RlgQnBPoK4tV45gBfGQZ6KQBDqzRcjdeAqQwHUfYp+SohcQdc1/Ukm4Gw4dV6vqTkM+uQpRv8E2VPF/sPp9xSb2qlGH4AAAAASUVORK5CYII="
}
}]
}
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
CorporateName |
Texto | 100 | Sim | Razão social |
FancyName |
Texto | 50 | Sim | Nome fantasia |
DocumentNumber |
Texto | 14 | Sim | Número do documento (Apenas números) |
DocumentType |
Texto | - | Sim | Tipo do documento. Os tipos válidos são Cpf, Cnpj |
BirthdayDate |
Data | 10 | Sim Obrigatório apenas caso DocumentType seja Cpf |
Data de nascimento (apenas para cadastro de pessoa física - CPF). Formato: yyyy-MM-dd |
MerchantCategoryCode |
Texto | 4 | Sim | (MCC) número registrado na ISO 18245 para serviços financeiros de varejo, utilizado para classificar o negócio pelo tipo fornecido de bens ou serviços. |
ContactName |
Texto | 100 | Sim | Nome do contato responsável |
ContactPhone |
Texto | 11 | Sim | Número do telefone do contato responsável (Apenas números) |
MailAddress |
Texto | 50 | Sim | Endereço de e-mail |
Website |
Texto | 200 | Não | Endereço do website |
BankAccount.Bank |
Texto | 3 | Sim | Código de compensação do banco. Lista de Códigos de compensação |
BankAccount.BankAccountType |
Texto | - | Sim | Tipo de conta bancária. Os tipos válidos são CheckingAccount (Conta corrente) e SavingsAccount (Conta poupança) |
BankAccount.Number |
Texto | 10 | Sim | Número da conta |
BankAccount.Operation |
Texto | 10 | Não | Operação da conta |
BankAccount.VerifierDigit |
Texto | 1 | Sim | Dígito verificador da conta |
BankAccount.AgencyNumber |
Texto | 15 | Sim | Número da agência |
BankAccount.AgencyDigit |
Texto | 1 | Sim | Dígito da agência. Caso a agência não tenha dígito, informar o valor x |
BankAccount.DocumentNumber |
Texto | 14 | Sim | Número do documento da conta (Apenas números) |
BankAccount.DocumentType |
Texto | - | Sim | Tipo do documento. Os tipos válidos são Cpf, Cnpj |
Address.Street |
Texto | 100 | Sim | Rua do endereço |
Address.Number |
Texto | 15 | Sim | Número do endereço |
Address.Complement |
Texto | 80 | Não | Complemento do endereço |
Address.Neighborhood |
Texto | 50 | Sim | Bairro |
Address.City |
Texto | 50 | Sim | Cidade |
Address.State |
Texto | 2 | Sim | Sigla do estado |
Address.ZipCode |
Texto | 9 | Sim | CEP (Apenas números) |
Agreement.Fee |
Número | - | Sim | Taxa fixa por transação. Valor em centavos. Ex: R$ 1,00 = "Fee" : 100 |
Agreement.MdrPercentage |
Decimal | - | Sim | Porcentagem da taxa de desconto única que será aplicada para todos os acordos entre Master e Seller. Valor com até duas casas decimais |
Notification.Url |
Texto | 200 | Sim | Url de notificação de mudança de status da análise do processo de KYC |
Notification.Headers[].Key |
Texto | 100 | Sim | Chave do header da requisição para a notificação de mudança de status da análise do processo de KYC |
Notification.Headers[].Value |
Texto | 100 | Sim | Valor do header da requisição para a notificação de mudança de status da análise do processo de KYC |
Attachments[].AttachmentType |
Texto | - | Não | Tipo do documento em anexo do seller. Os tipos válidos são ProofOfBankDomicile (Comprovante de domicílio bancário) e ModelOfAdhesionTerm (Modelo de termo de adesão) |
Attachments[].File.Name |
Texto | 50 | Não | Nome do arquivo do documento em anexo do seller |
Attachments[].File.FileType |
Texto | - | Não | Tipo do arquivo do documento em anexo do seller. Os tipos de arquivos válidos são pdf, png, jpg e jpeg |
Attachments[].File.Data |
Texto | - | Não | Documento convertido para Base64 |
--header "Authorization: Bearer {access_token}"
{
"MasterMerchantId": "665a33c5-0022-4a40-a0bd-daad04eb3236",
"MerchantId": "b8ccc729-a874-4b51-a5a9-ffeb5bd98878",
"CorporateName":"Seller Corporativo Ltda",
"FancyName":"Seller Nome Fantasia",
"DocumentNumber":"96462142000140",
"DocumentType":"CNPJ",
"MerchantCategoryCode":"5719",
"ContactName":"Nome do Contato do Seller",
"ContactPhone":"11987654321",
"MailAddress":"addres@email.mail.com",
"Website":"https://www.website.com.br",
"Blocked": true,
"Analysis": {
"Status": "UnderAnalysis"
},
"BankAccount": {
"Bank":"001",
"BankAccountType":"CheckingAccount",
"Number":"0002",
"Operation":"2",
"VerifierDigit":"2",
"AgencyNumber":"0002",
"AgencyDigit":"2",
"DocumentNumber":"96462142000140",
"DocumentType":"CNPJ"
},
"Address":{
"Street":"Rua Teste",
"Number":"50",
"Complement":"AP 255",
"Neighborhood":"Centro",
"City":"São Paulo",
"State" : "SP",
"ZipCode": "12345687"
},
"Agreement":{
"Fee" : 10,
"MerchantDiscountRates": [{
"MerchantDiscountRateId": "662e340f-07f2-4827-816d-b1878eb03eae",
"PaymentArrangement": {
"Product": "DebitCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 1,
"FinalInstallmentNumber" : 1,
"Percent" : 4
},
{
"MerchantDiscountRateId": "eb9d6357-7ad1-4fe0-90fe-364cff7ff0fd",
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 1,
"FinalInstallmentNumber" : 1,
"Percent" : 4
},
{
"MerchantDiscountRateId": "d09fe9d3-98c7-4c37-9bd3-7c1c91ee15de",
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 2,
"FinalInstallmentNumber" : 6,
"Percent" : 4
},
{
"MerchantDiscountRateId": "e2515c24-fd73-4b8e-92ad-cfe2b95239de",
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 7,
"FinalInstallmentNumber" : 12,
"Percent" : 4
}]
},
"Notification": {
"Url": "https://site.com.br/api/subordinados",
"Headers": [{
"Key": "key1",
"Value": "value1"
},
{
"Key": "key2",
"Value": "value2"
}]
},
"Attachments": [{
"AttachmentType": "ProofOfBankDomicile",
"File": {
"Name": "comprovante",
"FileType": "png"
}
}]
}
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
MasterMerchantId |
GUID | 36 | Sim | Identificação do master do seller |
MerchantId |
GUID | 36 | Sim | Identificação do seller |
CorporateName |
Texto | 100 | Sim | Razão social |
FancyName |
Texto | 50 | Sim | Nome fantasia |
DocumentNumber |
Texto | 14 | Sim | Número do documento |
DocumentType |
Texto | - | Sim | Tipo do documento. Os tipos válidos são Cpf, Cnpj |
BirthdayDate |
Data | 10 | Sim Obrigatório apenas caso DocumentType seja Cpf |
Data de nascimento (apenas para cadastro de pessoa física - CPF). Formato: yyyy-MM-dd |
MerchantCategoryCode |
Texto | 4 | Sim | (MCC) número registrado na ISO 18245 para serviços financeiros de varejo, utilizado para classificar o negócio pelo tipo fornecido de bens ou serviços. |
ContactName |
String | 100 | Sim | Nome do contato responsável |
ContactPhone |
Texto | 11 | Sim | Número do telefone do contato responsável (Apenas números) |
MailAddress |
Texto | 50 | Sim | Endereço de e-mail |
Website |
Texto | 200 | Não | Endereço do website |
Blocked |
Booleano | - | Sim | Flag para indicar se o seller está bloqueado para participar da transação |
Analysis.Status |
Texto | - | Sim | Status da análise do processo de KYC. Os Status válidos são Approved, ApprovedWithRestriction e Rejected |
BankAccount.Bank |
Texto | 3 | Sim | Código de compensação do banco. Lista de Códigos de compensação |
BankAccount.BankAccountType |
Texto | - | Sim | Tipo de conta bancária. Os tipos válidos são CheckingAccount (Conta corrente) e SavingsAccount (Conta poupança) |
BankAccount.Number |
Texto | 10 | Sim | Número da conta |
BankAccount.Operation |
Texto | 10 | Não | Operação da conta |
BankAccount.VerifierDigit |
Texto | 1 | Sim | Dígito verificador da conta |
BankAccount.AgencyNumber |
Texto | 15 | Sim | Número da agência |
BankAccount.AgencyDigit |
Texto | 1 | Sim | Dígito da agência. Caso a agência não tenha dígito, informar o valor x |
BankAccount.DocumentNumber |
Texto | 14 | Sim | Número do documento da conta |
BankAccount.DocumentType |
Texto | - | Sim | Tipo do documento. Os tipos válidos são Cpf, Cnpj |
Address.Street |
Texto | 100 | Sim | Rua do endereço |
Address.Number |
Texto | 15 | Sim | Número do endereço |
Address.Complement |
Texto | 80 | Não | Complemento do endereço |
Address.Neighborhood |
Texto | 50 | Sim | Bairro |
Address.City |
Texto | 50 | Sim | Cidade |
Address.State |
Texto | 2 | Sim | Sigla do estado |
Address.ZipCode |
Texto | 9 | Sim | CEP |
Agreement.Fee |
Número | - | Sim | Taxa fixa por transação. Valor em centavos. Ex: R$ 1,00 = "Fee" : 100 |
Agreement.MerchantDiscountRates[].MerchantDiscountRateId |
GUID | 36 | Sim | Identificação da taxa de desconto do seller |
Agreement.MerchantDiscountRates[].PaymentArrangement.Product |
Texto | - | Sim | Produto do arranjo de pagamento da taxa de desconto do seller. Os produtos válidos são CreditCard e DebitCard |
Agreement.MerchantDiscountRates[].PaymentArrangement.Brand |
Texto | - | Sim | Bandeira do arranjo de pagamento da taxa de desconto do seller. As bandeiras válidas são Visa, Master, Amex, Elo, Diners e Hipercard |
Agreement.MerchantDiscountRates[].InitialInstallmentNumber |
Número | - | Sim | Número inicial do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12 |
Agreement.MerchantDiscountRates[].FinalInstallmentNumber |
Número | - | Sim | Número final do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12 |
Agreement.MerchantDiscountRates[].Percent |
Decimal | - | Sim | Porcentagem da taxa de desconto do seller. Valor com até duas casas decimais |
Notification.Url |
Texto | 200 | Sim | Url de notificação de mudança de status da análise do processo de KYC |
Notification.Headers[].Key |
Texto | 100 | Sim | Chave do header da requisição para a notificação de mudança de status da análise do processo de KYC |
Notification.Headers[].Value |
Texto | 100 | Sim | Valor do header da requisição para a notificação de mudança de status da análise do processo de KYC |
Attachments[].AttachmentType |
Texto | - | Não | Tipo do documento em anexo do seller. Os tipos válidos são ProofOfBankDomicile (Comprovante de domicílio bancário) e ModelOfAdhesionTerm (Modelo de termo de adesão) |
Attachments[].File.Name |
Texto | 50 | Não | Nome do arquivo do documento em anexo do seller |
Attachments[].File.FileType |
Texto | - | Não | Tipo do arquivo do documento em anexo do seller. Os tipos de arquivos válidos são pdf, png, jpg e jpeg |
Você pode consultar um seller específico através do MerchantId do seller. Essa consulta é feita pela API de Onboarding Split 2.0.
Path
| PROPRIEDADE | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO |
|---|---|---|---|---|
MerchantId |
GUID | 36 | sim | Identificação do seller |
{
"id": "4d60b133-478e-4ff2-beee-f19bcf618cee",
"type": "Subordinate",
"masterMerchantId": "71db272b-526f-4adf-b655-3c74670cbf0d",
"corporateName": "RAZAO SOCIAL LTDA",
"fancyName": "NOME FANTASIA LTDA",
"mcc": 8999,
"mccDescription": "Serviços Profissionais (não especificadas)",
"documentType": 1,
"documentNumber": "14625224000101",
"webSite": "https://www.website.com.br",
"contactName": "Nome do contato",
"mailAddress": "contato@minhaempresa.com.br",
"contactPhone": "999999999",
"blocked": false,
"notification": {
"url": "https://website.com/webhooks/braspag"
},
"analysis": {
"status": 4
},
"address": {
"zipCode": "06455030",
"street": "Alameda Xingu",
"number": "01",
"complement": "",
"city": "Barueri",
"neighborhood": "Alphaville Industrial",
"state": "SP"
},
"bankAccount": {
"bankId": 10,
"bank": "341",
"bankAccountType": "CheckingAccount",
"number": "0001",
"agencyNumber": "0001",
"agencyDigit": "1",
"verifierDigit": "1",
"operation": "1",
"documentNumber": "14625224000101",
"documentType": 1
},
"bankAccountValidationInfo": {
"id": "bb53d96e-c655-454b-9f82-41f893725ac0",
"status": "Created",
"bankId": 10,
"bank": "323",
"bankAccountType": "CheckingAccount",
"accountNumber": "9836457708",
"accountDigit": "4",
"agencyNumber": "0001",
"agencyDigit": "X",
"createdAt": "2024-03-08T12:07:07.0833333"
},
"onboardingValidationStatus": "UnderAnalysis",
"agreements": [
{
"fee": 20,
"bankSlipFee": 0,
"antiFraudFee": 50,
"antiFraudFeeWithReview": 0,
"merchantDiscountRates": [
{
"paymentArrangement": {
"product": "CreditCard",
"brand": "Visa"
},
"initialInstallmentNumber": 1,
"finalInstallmentNumber": 1,
"percent": 1.81
},
{
"paymentArrangement": {
"product": "CreditCard",
"brand": "Visa"
},
"initialInstallmentNumber": 2,
"finalInstallmentNumber": 6,
"percent": 1.92
},
{
"paymentArrangement": {
"product": "CreditCard",
"brand": "Visa"
},
"initialInstallmentNumber": 7,
"finalInstallmentNumber": 12,
"percent": 2.24
}
]
},
{
"fee": 0,
"bankSlipFee": 200,
"bankSlipChargeType": 1,
"antiFraudFee": 0,
"antiFraudFeeWithReview": 0,
"merchantDiscountRates": [
{
"paymentArrangement": {
"product": "BankSlip",
"brand": "BancoDoBrasil"
},
"initialInstallmentNumber": 1,
"finalInstallmentNumber": 1,
"percent": 0.00
}
]
}
],
"links": [
{
"href": "http://splitonboardingapisandbox.braspag.com.br/api/merchants/4d60b133-478e-4ff2-beee-f19bcf618cee",
"rel": "self",
"method": "GET"
}
]
}
| PROPRIEDADE | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO |
|---|---|---|---|---|
Id |
GUID | 36 | sim | Identificação do seller |
Type |
string | - | sim | Tipo do merchant |
MasterMerchantId |
GUID | 36 | sim | Identificação do Master |
CorporateName |
string | 100 | sim | Razão social |
Mcc |
int | 4 | sim | (MCC) número registrado na ISO 18245 para serviços financeiros de varejo, utilizado para classificar o negócio pelo tipo fornecido de bens ou serviços. |
MccDescription |
string | 4 | sim | Descrição do MCC. |
BusinessActivityId |
int | - | não - Disponível apenas para pessoa física | Id do ramo de atividade da empresa |
BusinessActivityDescription |
string | 200 | não - Disponível apenas para pessoa física | Descrição do ramo de atividade |
BusinessActivityCode |
string | 10 | não - Disponível apenas para pessoa física | Código do ramo de atividade |
FancyName |
string | 50 | sim | Nome fantasia |
DocumentType |
int | - | sim | Tipo do documento. Os tipos válidos são: CNPJ = 1 CPF = 2 |
DocumentNumber |
string | 14 | sim | Número do documento |
Website |
string | 200 | não | Endereço do website |
BirthdayDate |
Date | - | não - Disponível apenas para pessoa física | Data de nascimento |
ContactName |
string | 100 | sim | Nome do contato responsável |
MailAddress |
string | 50 | sim | Endereço de e-mail |
ContactPhone |
string | 11 | sim | Número do telefone do contato responsável |
Blocked |
booleano | - | - | Indica se o seller está bloqueado |
Notification.Url |
string | - | - | URL de notificação. |
Analysis.Status |
int | - | - | Status da análise do processo de KYC. Os Status válidos são: UnderAnalysis = 1; Approved = 2; ApprovedWithRestriction = 3; Rejected = 4; Pending = 5 |
Address.ZipCode |
string | 9 | sim | CEP |
Address.Street |
string | 100 | sim | Logradouro |
Address.Number |
string | 15 | sim | Número do endereço |
Address.Complement |
string | 80 | não | Complemento do endereço |
Address.City |
string | 50 | sim | Cidade |
Address.Neighborhood |
string | 50 | sim | Bairro |
Address.State |
string | 2 | sim | Sigla do estado |
BankAccount.Bank |
string | 3 | sim | Código do banco |
BankAccount.BankAccountType |
string | - | sim | Tipo de conta bancária. Os tipos válidos são CheckingAccount (Conta corrente) e SavingsAccount (Conta poupança). |
BankAccount.Number |
string | 10 | sim | Número da conta |
BankAccount.AgencyNumber |
string | 4 | sim | Número da agência |
BankAccount.AgencyDigit |
Char | 1 | sim | Dígito da agência |
BankAccount.VerifierDigit |
Char | 1 | sim | Dígito verificador da conta |
BankAccount.Operation |
string | 10 | não | Operação da conta |
BankAccount.DocumentNumber |
string | - | - | Número do documento da conta |
BankAccount.DocumentType |
string | - | - | Tipo do documento da conta. Os tipos válidos são: CNPJ = 1 CPF = 2 |
BankAccountValidationInfo.Id |
GUID | 36 | sim | Identificador da validação de domicílio. |
BankAccountValidationInfo.Status |
string | - | sim | Status da análise do processo de domicílio bancário. Os status válidos são: internalError = 0; Created = 1; Processing = 2; Success = 3; Error = 4; |
BankAccountValidationInfo.BankId |
string | - | sim | Identificador do Banco. |
BankAccountValidationInfo.Bank |
string | 3 | sim | Código de compensação do banco. |
BankAccountValidationInfo.BankAccountType |
string | - | sim | Tipo de conta bancária. Os tipos válidos são CheckingAccount (Conta corrente) e SavingsAccount (Conta poupança). |
BankAccountValidationInfo.AccountNumber |
string | 10 | sim | Número da conta |
BankAccountValidationInfo.AccountDigit |
char | 1 | sim | Dígito verificador da conta |
BankAccountValidationInfo.AgencyNumber |
string | 10 | sim | Número da agência |
BankAccountValidationInfo.AgencyDigit |
char | 1 | sim | Dígito da agência |
OnboardingValidationStatus |
string | - | sim | Status do processo de Onboarding. Os status válidos são: UnderAnalysis = 1; Approved = 2; AwaitingMerchantAction = 3; Unknown = 4; |
Agreements[].Fee |
int | - | sim | Taxa fixa por transação. Valor em centavos. Ex: R$ 1,00 = “Fee” : 100 |
Agreements[].AntiFraudFee |
int | - | - | Taxa do anti-fraude |
Agreements[].AntiFraudFeeWithReview |
int | - | - | Taxa do anti-fraude com revisão manual |
Agreements[].MerchantDiscountRates[].PaymentArrangement.Product |
string | - | sim | Produto do arranjo de pagamento da taxa de desconto do seller. Os produtos válidos são CreditCard e DebitCard |
Agreements[].MerchantDiscountRates[].PaymentArrangement.Brand |
string | - | sim | Bandeira do arranjo de pagamento da taxa de desconto do seller. As bandeiras válidas são Visa, Master, Amex, Elo, Diners e Hipercard |
Agreements[].MerchantDiscountRates[].InitialInstallmentNumber |
int | - | sim | Número inicial do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12. |
Agreements[].MerchantDiscountRates[].FinalInstallmentNumber |
int | - | sim | Número final do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12. |
Agreements[].MerchantDiscountRates[].Percent |
Decimal | - | sim | Porcentagem da taxa de desconto do seller. Valor com até duas casas decimais. |
Links |
- | - | não | Links para navegação |
* O objeto BankAccountValidationInfo guarda as informações referentes À validação do domicílio bancário.
Para novas integrações, veja a seção Consulta de Sellers 2.0.
Para migração da versão 1.0 para a API de Onboarding Split 2.0, siga as instruções deste artigo.
--header "Authorization: Bearer {access_token}"
{
"MasterMerchantId": "665a33c5-0022-4a40-a0bd-daad04eb3236",
"MerchantId": "b8ccc729-a874-4b51-a5a9-ffeb5bd98878",
"CorporateName":"Seller Corporativo Ltda",
"FancyName":"Seller Nome Fantasia",
"DocumentNumber":"96462142000140",
"DocumentType":"CNPJ",
"MerchantCategoryCode":"5719",
"ContactName":"Nome do Contato do Seller",
"ContactPhone":"11987654321",
"MailAddress":"addres@email.mail.com",
"Website":"https://www.website.com.br",
"Blocked": false,
"Analysis": {
"Status": "Approved",
"Score": 89,
"DenialReason": null
},
"BankAccount": {
"Bank":"001",
"BankAccountType":"CheckingAccount",
"Number":"0002",
"Operation":"2",
"VerifierDigit":"2",
"AgencyNumber":"0002",
"AgencyDigit":"2",
"DocumentNumber":"96462142000140",
"DocumentType":"CNPJ"
},
"Address":{
"Street":"Rua Teste",
"Number":"50",
"Complement":"AP 255",
"Neighborhood":"Centro",
"City":"São Paulo",
"State" : "SP",
"ZipCode": "12345687"
},
"Agreement":{
"Fee" : 10,
"MerchantDiscountRates": [{
"MerchantDiscountRateId": "662e340f-07f2-4827-816d-b1878eb03eae",
"PaymentArrangement": {
"Product": "DebitCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 1,
"FinalInstallmentNumber" : 1,
"Percent" : 1.5
},
{
"MerchantDiscountRateId": "eb9d6357-7ad1-4fe0-90fe-364cff7ff0fd",
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 1,
"FinalInstallmentNumber" : 1,
"Percent" : 2.0
},
{
"MerchantDiscountRateId": "d09fe9d3-98c7-4c37-9bd3-7c1c91ee15de",
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 2,
"FinalInstallmentNumber" : 6,
"Percent" : 3.0
},
{
"MerchantDiscountRateId": "e2515c24-fd73-4b8e-92ad-cfe2b95239de",
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber" : 7,
"FinalInstallmentNumber" : 12,
"Percent" : 4.0
}]
},
"Notification": {
"Url": "https://site.com.br/api/subordinados",
"Headers": [{
"Key": "key1",
"Value": "value1"
},
{
"Key": "key2",
"Value": "value2"
}]
},
"Attachments": [{
"AttachmentType": "ProofOfBankDomicile",
"File": {
"Name": "comprovante",
"FileType": "png"
}
}]
}
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
MasterMerchantId |
GUID | 36 | sim | Identificação do master do seller |
MerchantId |
GUID | 36 | sim | Identificação do seller |
CorporateName |
texto | 100 | sim | Razão social |
FancyName |
texto | 50 | sim | Nome fantasia |
DocumentNumber |
texto | 14 | sim | Número do documento |
DocumentType |
texto | - | sim | Tipo do documento. Os tipos válidos são Cpf, Cnpj |
MerchantCategoryCode |
texto | 4 | sim | (MCC) número registrado na ISO 18245 para serviços financeiros de varejo, utilizado para classificar o negócio pelo tipo fornecido de bens ou serviços. |
ContactName |
texto | 100 | sim | Nome do contato responsável |
ContactPhone |
texto | 11 | sim | Número do telefone do contato responsável (Apenas números) |
MailAddress |
texto | 50 | sim | Endereço de e-mail |
Website |
texto | 200 | não | Endereço do website |
Blocked |
booleanooo | - | sim | Flag para indicar se o seller está bloqueado para participar da transação |
Analysis.Status |
texto | - | sim | Status da análise do processo de KYC. Os Status válidos são Approved, ApprovedWithRestriction e Rejected |
Analysis.Score |
Número | - | não | Score da análise do processo de KYC. Range de 1 a 100 |
Analysis.DenialReason |
texto | - | não | Motivo de reprovação do seller |
BankAccount.Bank |
texto | 3 | sim | Código de compensação do banco. Lista de Códigos de compensação |
BankAccount.BankAccountType |
texto | - | sim | Tipo de conta bancária. Os tipos válidos são CheckingAccount (Conta corrente) e SavingsAccount (Conta poupança) |
BankAccount.Number |
texto | 10 | sim | Número da conta |
BankAccount.Operation |
texto | 10 | não | Operação da conta |
BankAccount.VerifierDigit |
texto | 1 | sim | Dígito verificador da conta |
BankAccount.AgencyNumber |
texto | 15 | sim | Número da agência |
BankAccount.AgencyDigit |
texto | 1 | sim | Dígito da agência. Caso a agência não tenha dígito, informar o valor x |
BankAccount.DocumentNumber |
texto | 14 | sim | Número do documento da conta |
BankAccount.DocumentType |
texto | - | sim | Tipo do documento. Os tipos válidos são Cpf, Cnpj |
Address.Street |
texto | 100 | sim | Rua do endereço |
Address.Number |
texto | 15 | sim | Número do endereço |
Address.Complement |
texto | 80 | não | Complemento do endereço |
Address.Neighborhood |
texto | 50 | sim | Bairro |
Address.City |
texto | 50 | sim | Cidade |
Address.State |
texto | 2 | sim | Sigla do estado |
Address.ZipCode |
texto | 9 | sim | CEP |
Agreement.Fee |
Número | - | sim | Taxa fixa por transação. Valor em centavos. Ex: R$ 1,00 = "Fee" : 100 |
Agreement.MerchantDiscountRates[].MerchantDiscountRateId |
GUID | 36 | sim | Identificação da taxa de desconto do seller |
Agreement.MerchantDiscountRates[].PaymentArrangement.Product |
texto | - | sim | Produto do arranjo de pagamento da taxa de desconto do seller. Os produtos válidos são CreditCard e DebitCard |
Agreement.MerchantDiscountRates[].PaymentArrangement.Brand |
texto | - | sim | Bandeira do arranjo de pagamento da taxa de desconto do seller. As bandeiras válidas são Visa, Master, Amex, Elo, Diners e Hipercard |
Agreement.MerchantDiscountRates[].InitialInstallmentNumber |
Número | - | sim | Número inicial do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12 |
Agreement.MerchantDiscountRates[].FinalInstallmentNumber |
Número | - | sim | Número final do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12 |
Agreement.MerchantDiscountRates[].Percent |
Decimal | - | sim | Porcentagem da taxa de desconto do seller. Valor com até duas casas decimais |
Notification.Url |
texto | 200 | sim | Url de notificação de mudança de status da análise do processo de KYC |
Notification.Headers[].Key |
texto | 100 | sim | Chave do header da requisição para a notificação de mudança de status da análise do processo de KYC |
Notification.Headers[].Value |
texto | 100 | sim | Valor do header da requisição para a notificação de mudança de status da análise do processo de KYC |
Attachments[].AttachmentType |
texto | - | não | Tipo do documento em anexo do seller. Os tipos válidos são ProofOfBankDomicile (Comprovante de domicílio bancário) e ModelOfAdhesionTerm (Modelo de termo de adesão) |
Attachments[].File.Name |
texto | 50 | não | Nome do arquivo do documento em anexo do seller |
Attachments[].File.FileType |
texto | - | não | Tipo do arquivo do documento em anexo do seller. Os tipos de arquivos válidos são PDF, PNG, JPG e JPEG . |
A API de Alteração de Taxas em Lote permite que o master realize a alteração das taxas entre ele e os seus sellers através de uma requisição. Atualmente, somente será possível informar o mesmo conjunto de taxas para todos os sellers.
A alteração de taxas é feita pela API de Onboarding Split 2.0.
--header "Authorization: Bearer {access_token}"
{
"MasterMerchantId": "2161acd0-3767-48d5-85c2-84d6dd412254",
"SubordinateIds": [
"aab81d0c-88a8-43df-b15d-eee58d98a54e",
"770d5796-25cf-4277-9a29-0b41cafd6d71",
"4152723e-a693-458f-be78-6eacbaeb3966",
"24654353-2035-4412-ae8f-4b7f31c65efb"
],
"Aggrement": {
"InitialValidityDate": "2023-12-30",
"Fees": {
"Fee": 150
},
"MerchantDiscountRates": [
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Visa"
},
"InitialInstallmentNumber": 9,
"FinalInstallmentNumber": 12,
"Percent": 1
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Visa"
},
"InitialInstallmentNumber": 1,
"FinalInstallmentNumber": 1,
"Percent": 2
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Visa"
},
"InitialInstallmentNumber": 7,
"FinalInstallmentNumber": 8,
"Percent": 3
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber": 2,
"FinalInstallmentNumber": 6,
"Percent": 6.00
},
{
"PaymentArrangement": {
"Product": "CreditCard",
"Brand": "Master"
},
"InitialInstallmentNumber": 9,
"FinalInstallmentNumber": 12,
"Percent": 7.00
}
]
}
}
| PROPRIEDADE | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO |
|---|---|---|---|---|
MasterMerchantId |
Guid | 36 | Sim | Identificação do master. |
SubordinateIds |
Guid[] | - | Sim | Identificação dos sellers que terão o acordo alterado. |
Aggrement.InitialValidityDate |
Data | 10 | Sim | Data de início da validade do acordo. Formato: yyyy-MM-dd |
Aggrement.Fees.Fee |
Int | - | Sim | Taxa fixa por transação. Valor em centavos. Ex: R$ 1,00 = “Fee” : 100 |
Aggrement.MerchantDiscountRates[].PaymentArrangement.Product |
String | - | Sim | Produto do arranjo de pagamento da taxa de desconto do seller. Os produtos válidos são “CreditCard” e “DebitCard” |
Aggrement.MerchantDiscountRates[].PaymentArrangement.Brand |
String | - | Sim | Bandeira do arranjo de pagamento da taxa de desconto do seller. As bandeiras válidas são Visa, Master, Amex, Elo, Diners e Hipercard |
Aggrement.MerchantDiscountRates[].InitialInstallmentNumber |
Int | - | Sim | Número inicial do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12 |
Aggrement.MerchantDiscountRates[].FinalInstallmentNumber |
Int | - | Sim | Número final do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12 |
Aggrement.MerchantDiscountRates[].Percent |
Decimal | - | Sim | Porcentagem da taxa de desconto do seller. Valor com até duas casas decimais |
{
"initialValidityDate": "2024-06-02T00:00:00",
"fees": {
"fee": 150,
},
"merchantDiscountRates": [
{
"paymentArrangement": {
"product": "CreditCard",
"brand": "Visa"
},
"initialInstallmentNumber": 9,
"finalInstallmentNumber": 12,
"percent": 1
},
{
"paymentArrangement": {
"product": "CreditCard",
"brand": "Visa"
},
"initialInstallmentNumber": 1,
"finalInstallmentNumber": 1,
"percent": 2
},
{
"paymentArrangement": {
"product": "CreditCard",
"brand": "Visa"
},
"initialInstallmentNumber": 7,
"finalInstallmentNumber": 8,
"percent": 3
},
{
"paymentArrangement": {
"product": "CreditCard",
"brand": "Master"
},
"initialInstallmentNumber": 2,
"finalInstallmentNumber": 6,
"percent": 6.00
},
{
"paymentArrangement": {
"product": "CreditCard",
"brand": "Master"
},
"initialInstallmentNumber": 9,
"finalInstallmentNumber": 12,
"percent": 7.00
}
]
}
A API de Onboarding Split 2.0 disponibiliza um endpoint para solicitar a atualização dos dados bancários de um seller específico, através do MerchantId do seller. Após a solicitação de atualização, os dados serão submetidos ao processo de validação do domicílio bancário.
Importante:
- Os novos dados bancários serão atualizados de fato na plataforma após a validação de domicílio bancário com sucesso;
- A validação pode demorar até dois dias úteis para ser concluída, e todos os passos podem ser acompanhados via webhook. Saiba mais em Notificação de validação de domicílio bancário.
Parâmetros no cabeçalho (header)
| KEY | VALUE |
|---|---|
Content-Type |
application/json |
Authorization |
Bearer {access_token} |
Parâmetros na rota (path)
| PROPRIEDADE | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO |
|---|---|---|---|---|
MerchantId |
GUID | - | Sim | Identificador do seller. |
Parâmetros no corpo (body)
{
"Number": "111110",
"VerifierDigit": "X",
"AgencyNumber": "444",
"AgencyDigit": "X",
"Bank": "341",
"BankAccountType": "CheckingAccount",
"DocumentNumber": "81777265000100",
"DocumentType": "CNPJ",
"Operation":"123"
}
| PROPRIEDADE | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO |
|---|---|---|---|---|
Number |
string | 12 | Sim | Número da conta do seller. |
VerifierDigit |
string | 1 | Sim | Dígito verificador da conta do seller. |
AgencyNumber |
string | 4 | Sim | Número da agência do seller. |
AgencyDigit |
string | 1 | Sim | Dígito da agência do seller. |
Bank |
string | 3 | Sim | Código de compensação do banco. |
BankAccountType |
string | - | Sim | Tipo de conta bancária. Os tipos válidos são “CheckingAccount” (conta corrente) e “SavingsAccount” (conta poupança). |
DocumentNumber |
string | 14 | Sim | Número do documento da conta |
DocumentType |
string | - | Sim | Tipo do documento. Os tipos válidos são “CPF” ou “CNPJ”. |
Operation |
string | 10 | Não | Operação da conta do seller. |
A resposta irá retornar o Status HTTP para a solicitação.
| Status Code | Cenário |
|---|---|
| 204 | A solicitação foi enviada com sucesso. |
| 442 | Já existe uma solicitação de atualização para o MerchantId informado. Mensagem: The bank account validation is in progress. Please wait. |
Após o envio da requisição de cadastro de seller, a Braspag irá conduzir a análise de KYC e validação de domicílio bancário do seller. Ao final de cada análise, a Braspag enviará as seguintes notificações com o status de cada processo:
IMPORTANTE: O seller estará apto a transacionar somente quando a notificação de onboarding retornar o status Aprovado.
Para receber as notificações de alteração de status, é necessário configurar o campo “URL de Notificação” durante o cadastro do master na Braspag para receber uma requisição do tipo “POST”. O endereço deve ser HTTPS e não se deve utilizar uma porta fora do padrão HTTPS (443).
É esperado que a loja retorne a seguinte resposta:
HTTP Status Code 200 OK. Caso essa resposta não seja retornada, haverá mais duas tentativas de envio da notificação.
Os prazos estimados para cada notificação são:
Quando houver alteração no status da análise de KYC, a Braspag enviará uma notificação com os parâmetros do tipo de notificação, identificação do master e do seller e status da análise de KYC.
Exemplo de notificação enviada pela Braspag:
{
"ChangeType": 20,
"MasterMerchantId": "96ffb8be-6693-4f9b-bf8e-925b555b3207",
"Data": {
"SubordinateMerchantId": "4d76b525-e66d-402e-a318-5fd3ce1af7aa",
"Status": 2
}
}
| PROPRIEDADE | TIPO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|
ChangeType |
Número | - | Identificador do tipo de notificação. Para a notificação de KYC, o ChangeType é igual a “20”. |
MasterMerchantId |
GUID | 36 | Identificação do master. |
Data.SubordinateMerchantId |
GUID | 36 | Identificação do seller. |
Data.Status |
Número | - | Status da análise do processo de KYC. Os status válidos são: UnderAnalysis = 1; Approved = 2; ApprovedWithRestriction = 3 e Rejected = 4 |
Quando houver alteração no status da validação de domicílio bancário, a Braspag enviará uma notificação com os parâmetros do tipo de notificação, identificação do seller (MerchantId) e os dados do domicílio bancário.
Exemplo de notificação de domicílio bancário enviada pela Braspag:
{
"ChangeType": 21,
"MasterMerchantId": "96ffb8be-6693-4f9b-bf8e-925b555b3207",
"Data": {
"MerchantId": "4d76b525-e66d-402e-a318-5fd3ce1af7aa",
"MerchantType": "Subordinate",
"Status": 3,
"AccountNumber": "123",
"AccountDigit": "1",
"AgencyNumber": "3581",
"AgencyDigit": "x",
"CompeCode": "260",
"BankAccountType": 1,
"DocumentNumber": "45224563215",
"DocumentType": 2
}
}
| PROPRIEDADE | TIPO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|
ChangeType |
Número | - | Número identificador do tipo de notificação. Para a notificação de validação de domicílio bancário, o ChangeType é igual a “21”. |
MasterMerchantId |
GUID | 36 | Identificação do master. |
Data.MerchantId |
GUID | 36 | Identificação do seller. |
Data.MerchantType |
Texto | 14 | Tipo do Merchant. Os tipos válidos são “Subordinate” ou “Master”. |
Data.BankAccountValidationStatus |
Número | 1 | Status da análise do processo de domicílio bancário. Os status válidos são: InternalError = 0; Created = 1; Processing =2; Success= 3; Error= 4; |
Data.CompeCode |
Texto | 3 | Código de compensação do banco. Ver Lista de Códigos de compensação. |
Data.BankAccountType |
Texto | 1 | Tipo de conta bancária. Os tipos válidos são: 1 - “CheckingAccount” (conta corrente); 2 - “SavingsAccount” (conta poupança). |
Data.AccountNumber |
Texto | 10 | Número da conta do seller. |
Data.AccountDigit |
Texto | 1 | Dígito verificador da conta do seller. |
Data.AgencyNumber |
Texto | 15 | Número da agência do seller. Atenção: Valores zerados como “0”, “00”, “000” são inválidos. |
Data.AgencyDigit |
Texto | 1 | Dígito da agência do seller. Caso a agência não tenha dígito, informar o valor “x”. |
Data.DocumentNumber |
Texto | 14 | Número do documento da conta (apenas números) do seller. |
Data.DocumentType |
Texto | - | Tipo do documento. Os tipos válidos são “CPF” ou “CNPJ”. |
A notificação do status do onboarding sinaliza o status global do cadastro do seller e é enviada após cada uma das notificações anteriores. Atualmente, esse status é composto pela junção de duas validações (KYC e domicílio bancário). Assim, após a primeira notificação, o status de onboarding irá informar que o processo ainda está em análise; após a segunda notificação é que irá retornar o status “2” (considerando o cenário de aprovação em todas as análises).
A Braspag enviará uma notificação com os parâmetros do tipo de notificação, identificação do seller (SubordinateMerchantId) e as informações de todos os status.
- Quando o status de onboarding (
Data.OnboardingStatus) apresentar o valor “2” significa que o seller já passou em todas as validações e está apto a transacionar;- Quando o status de onboarding apresentar o valor “3”, significa que o cadastro não foi bem sucedido em pelo menos uma validação e que o master precisa tomar alguma ação em relação a esse cadastro.
Confira todos os valores possíveis para o status de onboarding na tabela abaixo.
Exemplo de notificação de onboarding enviada pela Braspag:
{
"ChangeType": 23,
"MasterMerchantId": "96ffb8be-6693-4f9b-bf8e-925b555b3207",
"Data": {
"SubordinateMerchantId":"4d76b525-e66d-402e-a318-5fd3ce1af7aa",
"OnboardingStatus": 2,
"KycAnalysisInfo": {
"Status": 2
},
"BankAccountValidation": {
"Status": 3
}
}
}
| PROPRIEDADE | TIPO | TAMANHO | DESCRIÇÃO |
|---|---|---|---|
ChangeType |
Número | - | Identificador do tipo de notificação. Para a notificação do status do Onboarding, o ChangeType é igual a “23”. |
MasterMerchantId |
GUID | 36 | Identificação do master. |
Data.SubordinateMerchantId |
GUID | 36 | Identificação do seller. |
Data.OnboardingStatus |
Número | 1 | Status do processo de Onboarding. Os status válidos são: UnderAnalysis = 1; Approved = 2; AwaitingMerchantAction = 3; Unknown = 4; Banned = 5 |
Data.KycAnalysisInfo.Status |
Número | 1 | Status da análise de KYC. Os status válidos são: UnderAnalysis = 1; Approved = 2; ApprovedWithRestriction = 3; Rejected = 4 |
Data.BankAccountValidation.Status |
Número | 1 | Status da análise do domicílio bancário. Os status válidos são: InternalError = 0; Created = 1; Processing = 2; Success = 3; Error = 4 |
Caso ache necessário, o master pode permitir o acesso do seller ao backoffice do Split. Para isso, o master precisa enviar para o suporte:
MerchantId do seller;| Status | Nome do Status | Descrição |
|---|---|---|
| 1 | UnderAnalysis | Análise de KYC em andamento. |
| 2 | Approved | Seller aprovado na análise de KYC. |
| 3 | ApprovedWithRestriction | Seller aprovado com restrições na análise de KYC. |
| 4 | Rejected | Seller não aprovado na análise de KYC. |
| Código | Descrição |
|---|---|
| 1 | NÃO ENCONTRADO |
| 2 | SALÃO DE BELEZA BARBEARIA |
| 3 | DENTISTAS E ORTODONDISTAS |
| 4 | LANCHONETE |
| 5 | VENDAS DE ROUPAS |
| 6 | TAXI E LIMUSINE |
| 7 | MERCEARIAS E SUPERMERCADOS |
| 8 | LOJAS DE VARIEDADES |
| 9 | BARES DISCOTECAS CASAS NOTURNAS |
| 10 | EMPREITEIROS EM GERAL |
| 11 | COSMÉTICOS |
| 12 | CONVENIÊNCIA DELICATESSE |
| 13 | MEDICOS E CLINICAS |
| 14 | SERVIÇOS VETERINÁRIOS |
| 15 | LOJAS DE REPAROS E SERVIÇOS |
| 16 | COMIDA RÁPIDA (DOCES E SALGADOS) |
| 17 | DIVERSÃO E RECREAÇÃO |
| 18 | CRECHES |
| 19 | ALFAIATES / COSTUREIRAS (OS) |
| 20 | CLÍNICAS DE BELEZA - SPA |
| 21 | SERVIÇOS LEGAIS |
| 22 | FABRICAÇÃO DE MÁQUINAS, FERRAMENTAS, PEÇAS E ACESSÓRIOS |
| 23 | LOJAS DE UTENSILIOS |
| 24 | RESTAURANTES |
| 25 | PEÇAS E SERVIÇOS PARA VEICULOS |
| 26 | CORRETOR IMOBILIÁRIO |
| 27 | FORNECEDORES DE ALIMENTOS OU MANTIMENTOS |
| 28 | CONSERTO - RÁDIO,TV,APARELHO DE SOM |
| 29 | PRESENTES,CARTÕES,SOUVENIRS |
| 30 | LOJAS DE ACESSÓRIOS PARA VEICULOS |
| 31 | SERVIÇOS DE HORTICULTURA E JARDINAGEM |
| 32 | LOJAS DE MATERIAL DE CONSTRUÇÃO |
| 33 | LOJAS DE SAPATOS |
| 34 | JOALHERIAS E RELOJOARIAS |
| 35 | ATACADISTA |
| 36 | SERVIÇOS EDUCACIONAIS |
| 37 | PADARIAS |
| 38 | LOJAS DE BEBIDAS |
| 39 | EQUIPAMENTOS E PECAS ELETRÔNICAS |
| 40 | CONSERTOS ELÉTRICOS |
| 41 | BORRACHEIRO |
| 42 | DROGARIAS FARMÁCIAS |
| 43 | SERVIÇOS DE CARPINTARIA |
| 44 | LOJA DE ANIMAIS |
| 45 | CAMPO DE ESPORTES CLUBES |
| 46 | ESTUDIO FOTOGRÁFICO |
| 47 | ELETRICISTA |
| 48 | TRANSPORTES URBANOS |
| 49 | LABORATORIOS MEDICOS DENTARIOS |
| 50 | DOCERIAS E CONFEITARIAS |
| 51 | LAVA RAPIDO |
| 52 | MOBILIA E UTILIDADES PARA O LAR |
| 53 | LATICÍNIOS |
| 54 | DANÇA ACADEMIAS |
| 55 | SERVIÇOS DE MANUTENÇÃO E CONSERVAÇÃO |
| 56 | BRINQUEDOS E JOGOS |
| 57 | HOTEIS MOTEIS |
| 58 | SERVIÇOS DE ADMINISTRAÇÃO E CONSULTORIA |
| 59 | SERVIÇOS DE PESQUISA PARA ARQUITETURA E ENGENHARIA |
| 60 | BANCA DE JORNAIS |
| 61 | PEDICURE |
| 62 | LOJAS DE DEPARTAMENTO |
| 63 | FLORICULTURA |
| 64 | CONSERTO E MANUTENÇÃO DE COMPUTADORES |
| 65 | MATERIAIS DE CONSTRUÇÃO |
| 66 | OTICAS |
| 67 | SERVIÇOS ESCOLARES |
| 68 | CASAS DE MASSAGEM |
| 69 | FUNILARIA LANTERNAGEM |
| 70 | ARMARINHOS TECIDOS |
| 71 | REPARO E RESTAURAÇÃO DE MOVEIS |
| 72 | CENTROS DE SERVIÇOS E OFICINAS DE METAL |
| 73 | CONSERTO - JOIAS E RELÓGIOS |
| 74 | ARTIGOS DE SEGUNDA MÃO |
| 75 | SERVIÇOS DE PROCESSAMENTOS DE DADOS |
| 76 | CONSERTO DE CHAPEUS SAPATOS |
| 77 | LIVROS,PERIÓDICOS E JORNAIS |
| 78 | COPIAS FOTOCÓPIAS |
| 79 | ALUGUEL DE ROUPAS |
| 80 | LOJAS DE FERRAGENS |
| 81 | MATERIAIS DE ESCRITÓRIO |
| 82 | CASAS DE REPOUSO SERVIÇOS DE ENFERMAGEM |
| 83 | MATERIAL ESPORTIVOS |
| 84 | CLUBES ATLETISMO - SÓCIOS |
| 85 | BICICLETAS - VENDAS E SERVIÇOS |
| 86 | ESTACIONAMENTO DE AUTOMOVEIS |
| 87 | ESCOLA VOCAÇÃO E OCUPAÇÃO |
| 88 | LOJAS DE INFORMÁTICA - SOFTWARE |
| 89 | PAPELARIAS |
| 90 | ANUNCIOS CLASSIFICADOS PROPAGANDA |
| 91 | TAPECARIA CORTINAS |
| 92 | REDE DE COMPUTADORES PROVEDORES |
| 93 | ALUGUEL DE EQUIPAMENTOS E MOBILIAS |
| 94 | ORGANIZAÇÃO RELIGIOSA |
| 95 | CORRETOR DE SEGUROS |
| 96 | SERVIÇOS DE AUDITORIA E CONTABILIDADE |
| 97 | GALERIAS DE ARTE LEILÃO DE ARTE |
| 98 | SAPATARIA |
| 99 | TV A CABO,SATELITE,E OUTROS TIPOS DE TV |
| 100 | SERVIÇO DE FRETE |
| CÓDIGO DE COMPENSAÇÃO | BANCO |
|---|---|
| 001 | Banco do Brasil |
| 003 | Amazônia - BASA |
| 004 | BNB |
| 012 | BANCO INBURSA |
| 021 | Est. ES - Banestes |
| 025 | Alfa |
| 033 | Santander |
| 037 | Est. PA - Banpará |
| 041 | Est. RS - Banrisul |
| 047 | Est. SE - Banese |
| 063 | BANCO BRADESCARD |
| 069 | Banco Crefisa |
| 070 | BRB - Banco de Brasília |
| 077 | Banco Inter |
| 081 | BANCOSEGURO S.A. |
| 082 | Banco Topázio |
| 083 | BCO DA CHINA BRASIL S.A. |
| 084 | CC Uniprime Norte do Paraná |
| 085 | CC Cecred |
| 089 | CC Região da Mogiana |
| 093 | POLOCRED SCMEPP LTDA. |
| 094 | Banco Finaxis |
| 097 | CC Centralcredi |
| 099 | CC Uniprime Central |
| 102 | XP INVESTIMENTOS CCTVM S/A |
| 104 | Caixa Econômica Federal |
| 107 | BBM |
| 120 | Rodobens |
| 121 | BCO AGIBANK S.A. |
| 125 | BANCO GENIAL |
| 130 | Scfi Caruana |
| 133 | CRESOL CONFEDERAÇÃO |
| 136 | CC Unicred do Brasil |
| 149 | FACTA S.A. CFI |
| 174 | PEFISA S.A. - C.F.I. |
| 195 | VALOR SCD S.A. |
| 197 | STONE PAGAMENTOS S.A |
| 208 | BANCO BTG PACTUAL S.A |
| 212 | Banco Original |
| 213 | Arbi |
| 218 | Banco BS2 |
| 224 | Fibra |
| 237 | Bradesco |
| 243 | Banco Master |
| 246 | ABC - Brasil |
| 260 | NU PAGAMENTOS S.A (NUBANK) |
| 274 | Money Plus SCMEPP LTDA |
| 299 | BCO SOROCRED S.A. - BM |
| 301 | Bpp Instituição De Pagamentos S.A |
| 318 | BCO BMG S.A. |
| 320 | BCO CCB BRASIL S.A. |
| 323 | Mercado Pago |
| 329 | QI SCD S.A. |
| 330 | BANCO BARI S.A. |
| 335 | Banco Digio S.A. |
| 336 | Banco C6 S.A |
| 341 | Itaú Unibanco |
| 348 | BCO XP S.A. |
| 359 | ZEMA CFI S/A |
| 364 | GERENCIANET |
| 368 | BCO CSF S.A. |
| 376 | J. P. Morgan |
| 380 | PICPAY |
| 382 | FIDUCIA SCMEPP LTDA |
| 383 | JUNO |
| 389 | Mercantil do Brasil |
| 394 | BCO BRADESCO FINANC. S.A. |
| 396 | HUB PAGAMENTOS |
| 403 | CORA SCD S.A. |
| 404 | SUMUP SCD S.A. |
| 406 | ACCREDITO SCD S.A. |
| 413 | BCO BV S.A. |
| 414 | WORK SCD S.A. |
| 422 | Safra |
| 435 | DELCRED SCD S.A. |
| 450 | FITBANK PAGAMENTOS ELETRONICOS S.A. |
| 477 | CITIBANK N.A. |
| 487 | DEUTSCHE BANK S.A.BCO ALEMAO |
| 542 | Cloud Walk Meios de Pagamentos |
| 595 | Zoop Instituição de Pagamentos |
| 600 | Luso Brasileiro |
| 604 | Indl. do Brasil |
| 611 | Paulista |
| 612 | Guanabara |
| 613 | OMNI BANCO S.A. |
| 623 | BANCO PAN |
| 630 | Banco Smartbank |
| 633 | Rendimento |
| 634 | Triângulo |
| 637 | Sofisa |
| 643 | Pine |
| 653 | BANCO VOITER |
| 654 | Banco Digimais |
| 655 | Votorantim |
| 707 | Daycoval |
| 735 | Banco Neon |
| 741 | Ribeirão Preto |
| 743 | Semear |
| 745 | Citibank S. A. |
| 748 | Sicredi |
| 752 | BCO BNP PARIBAS BRASIL S A |
| 753 | NOVO BCO CONTINENTAL S.A. - BM |
| 755 | Bank of America Merrill Lynch |
| 756 | Bancoob - Banco Cooperativo do Brasil (Sicoob) |
| 757 | BCO KEB HANA DO BRASIL S.A. |