Sobre essa documentação

Essa documentação apresenta a integração com a API de Onboarding Split 2.0 para o cadastro de subordinados pelo master no Split de Pagamentos. A versão anterior da API (1.0) pode ser consultada no tópico Cadastro de Subordinados 1.0.

Na API de Onboarding 2.0, depois que o master cadastrar o subordinado, a Braspag irá submeter o subordinado à 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.

Se você já possui integração com a API de Onboarding Split 1.0, a migração para a API de Onboarding Split 2.0 será obrigatória para novos cadastros de subordinados a partir de agosto de 2022. Consulte as instruções para migração no artigo da nossa página de suporte.

Visão geral

A API de Onboarding Split 2.0 do Split de Pagamentos permite que o master gerencie seus subordinados na plataforma. O master deverá coletar as informações do subordinado para usar no processo de onboarding.

O cadastro de subordinados também pode ser feito pelo backoffice Split. Saiba mais neste artigo.

Assim como o master, os subordinados também irão passar pelo processo de Know Your Customer (KYC) do Split de Pagamentos, com objetivo de identificar o cliente (subordinado). Por este motivo, alguns documentos do subordinado serão necessários.

O processo de KYC é uma medida obrigatória exigida pelas instituições reguladoras de pagamento.

O onboarding do subordinado no Split de Pagamentos ocorre da seguinte forma:

  1. O master solicita o cadastro do subordinado;
  2. O subordinado será criado com status “Em análise” e estará bloqueado para participar da transação até que o processo de KYC seja finalizado;
  3. Ao final da análise, o master será notificado com o resultado do processo de KYC, juntamente com a identificação do subordinado.

Ambientes

Sandbox

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 de subordinados.
API de Onboarding Split 1.0 https://splitonboardingsandbox.braspag.com.br Consulta de subordinados.

Produção

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 de subordinados.
API de Onboarding Split 1.0 https://splitonboarding.braspag.com.br Consulta de subordinados.

Autenticação

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:

  1. Concatene o MerchantId e ClientSecret: MerchantId:ClientSecret;
  2. Codifique o resultado da concatenação em Base64;
  3. Realize uma requisição ao servidor de autorização.

SplitAuth

Requisição

x-www-form-urlencoded
--header "Authorization: Basic {base64}"  
--header "Content-Type: application/x-www-form-urlencoded"  
grant_type=client_credentials

Resposta

{
    "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. O ClientSecret deve ser obtido junto à Braspag.

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.

Cadastro de Subordinados

Cadastro de Subordinados 2.0

Siga as instruções dessa seção para novas integrações.

O master deverá solicitar o cadastro de subordinado enviando uma requisição com os dados do subordinado:

O subordinado 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 subordinado do tipo CNPJ:

Requisição

{
    "Type": "Subordinate",
    "MasterMerchantId": "f88cc14d-c796-4939-957e-de4dddcb2257",
    "ContactName": "Nome do Contato do Subordinado",
    "ContactPhone": "11987654321",
    "CorporateName": "Subordinado Corporativo Ltda",
    "DocumentNumber": "96462142000140",
    "DocumentType": "CNPJ",
    "FancyName": "Subordinado 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="
            }
        }
    ]
}

Propriedades do Subordinado

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 subordinado atua. (apenas para cadastro de pessoa física - CPF). Veja a Lista de Ramos de Atividades.

*Não é obrigatório quando DocumentType for “CNPJ”.

Propriedades da Conta Bancária

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 subordinado.
BankAccount.Operation Texto 10 Não Operação da conta do subordinado.
BankAccount.VerifierDigit Texto 1 Sim Dígito verificador da conta do subordinado.
BankAccount.AgencyNumber Texto 15 Sim Número da agência do subordinado.
BankAccount.AgencyDigit Texto 1 Sim Dígito da agência do subordinado. 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) do subordinado.
BankAccount.DocumentType Texto - Sim Tipo do documento. Os tipos válidos são “CPF” ou “CNPJ”.

Propriedades do Endereço

PROPRIEDADE TIPO TAMANHO OBRIGATÓRIO DESCRIÇÃO
Address.Street Texto 100 Sim Logradouro do endereço do subordinado.
Address.Number Texto 15 Sim Número do endereço do subordinado.
Address.Complement Texto 80 Não Complemento do endereço do subordinado.
Address.Neighborhood Texto 50 Sim Bairro do subordinado.
Address.City Texto 50 Sim Cidade do subordinado
Address.State Texto 2 Sim Sigla do estado (UF) do subordinado.
Address.ZipCode Texto 9 Sim CEP (apenas números) do subordinado.

Propriedades do Acordo de Taxas

Para a definição de acordos de taxas entre o master e seus subordinados, o Split de Pagamentos dispõe de três possibilidades:

  1. Cadastro do subordinado sem informar o acordo de taxas (taxas zeradas). 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;
  2. Definição de porcentagem do MDR cobrado por transação por Arranjos de Pagamento e intervalo de parcelas;
  3. Aplicação de MDR único, aplicado para todos os acordos. Caso o master não queira definir a porcentagem do MDR para cada Arranjo de Pagamento e intervalo de parcelas, o Split de Pagamentos irá replicar os mesmos acordos do master com a Subadquirente (Braspag), para o master com o subordinado.

Na seção Exemplos dos Acordos de Taxas, você pode visualizar os exemplos de requisições para os três cenários: Acordo de Taxas não informado no cadastro, MDR por arranjo de pagamento e intervalo de parcelas e MDR único para todos os acordos.

ATENÇÃO: Se não houver cobrança de MDR, basta não enviar o nó Agreements.
O campo Agreements[].Percent só deve ser enviado em caso de cadastro de subordinado com MDR único.

PROPRIEDADE TIPO TAMANHO OBRIGATÓRIO DESCRIÇÃO
Agreements[].Percent Decimal - Sim, para requisições cujo acordo é MDR único. Porcentagem da taxa de desconto única (MDR único) que será aplicada para todos os acordos entre master e subordinado. 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 - Sim Produto do arranjo de pagamento da taxa de desconto do subordinado. Os produtos válidos são “CreditCard” e “DebitCard”.
Agreements[].MerchantDiscountRates[].PaymentArrangement.Brand Texto - Sim Bandeira do arranjo de pagamento da taxa de desconto do subordinado. As bandeiras válidas são Visa, Master, Amex, Elo, Diners, Discover e Hipercard.
Agreements[].MerchantDiscountRates[].InitialInstallmentNumber Número - Sim Número inicial do intervalo de parcelas da taxa de desconto do subordinado. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12.
Agreements[].MerchantDiscountRates[].FinalInstallmentNumber Número - Sim Número final do intervalo de parcelas da taxa de desconto do subordinado. 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 subordinado. Valor com até duas casas decimais.

Propriedades dos Anexos

Cadastro de subordinado pelo CPF: é obrigatório enviar pelo menos um arquivo comprovando o ramo de atividade (AttachmentType igual a “ProofBusinessActivity”);
Cadastro de subordinado pelo CNPJ: o envio de anexos é opcional.

PROPRIEDADE TIPO TAMANHO OBRIGATÓRIO DESCRIÇÃO
Attachments[].AttachmentType Texto - Sim*, quando DocumentType for “CPF”. Tipo do documento anexo do subordinado. Os tipos válidos são “ProofOfBankDomicile” (comprovante de domicílio bancário), “ModelOfAdhesionTerm” (modelo de termo de adesão) e “ProofBusinessActivity” (comprovante do ramo de atividade).
Attachments[].File.Name Texto 50 Sim*, quando DocumentType for “CPF”. Nome do arquivo do documento anexo do subordinado.
Attachments[].File.FileType Texto - Sim*, quando DocumentType for “CPF”. Tipo do arquivo do documento anexo do subordinado. Os tipos de arquivos válidos são “pdf”, “png” e “jpg”.
Attachments[].File.Data Texto - Sim*, quando DocumentType for “CPF”. Documento convertido para Base64.

Resposta

{
    "Id": "5dcee8e4-f432-42e4-a2a6-5a30c8ce2ca5",
    "Type": "Subordinate",
    "MasterMerchantId": "2b8e9c38-0d9e-4f30-adac-fef3601632e4",
    "CorporateName": "Corporate Name Subordinate",
    "FancyName": "Fancy Name Subordinate",
    "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 Subordinate",
        "City": "My City Master",
        "Neighborhood": "My Neighborhood Subordinate",
        "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 subordinado 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
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
BankAccount.Bank Número - Identificação da conta bancária
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 15 Número da agência
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
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 subordinado
Agreements[].MerchantDiscountRates[].PaymentArrangement.Brand Texto - Bandeira do arranjo de pagamento da taxa de desconto do subordinado
Agreements[].MerchantDiscountRates[].InitialInstallmentNumber Número - Número inicial do intervalo de parcelas da taxa de desconto do subordinado
Agreements[].MerchantDiscountRates[].FinalInstallmentNumber Número - Número final do intervalo de parcelas da taxa de desconto do subordinado
Agreements[].MerchantDiscountRates[].Percent Decimal - Porcentagem da taxa de desconto do subordinado
Links - - Links para navegação

Exemplos dos Acordos de Taxas

Acordo de taxas não informado no cadastro

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 subordinado 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 Subordinado",
    "ContactPhone": "11987654321",
    "CorporateName": "Subordinado Corporativo Ltda",
    "DocumentNumber": "96462142000140",
    "DocumentType": "CNPJ",
    "FancyName": "Subordinado 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.

MDR por arranjo de pagamento e intervalo de parcelas

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 subordinado precisam ser iguais aos acordos entre master e Braspag.

Exemplo

MDR do master com subordinado igual a 4%.

ACORDO SUBADQUIRENTE (BRASPAG) 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 SUBORDINADO 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 subordinado 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 Subordinado",
    "ContactPhone": "11987654321",
    "CorporateName": "Nome do Subordinado",
    "DocumentNumber": "91205046089",
    "DocumentType": "CPF",
    "FancyName": "Nome do Subordinado",
    "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.

MDR único para todos os acordos

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 Subordinado",
    "ContactPhone": "11987654321",
    "CorporateName": "Subordinado Corporativo Ltda",
    "DocumentNumber": "96462142000140",
    "DocumentType": "CNPJ",
    "FancyName": "Subordinado 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.

Cadastro de subordinados 1.0 - DEPRECATED

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 Subordinados 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 subordinado.

Para a definição de acordos entre o master e seus subordinados, o Split de Pagamentos dispõe de duas possibilidades:

  1. É possível definir a porcentagem do MDR (Merchant Discount Rate) cobrado por transação por Arranjos de Pagamento e intervalo de parcelas.
  2. Caso o master não queira definir a porcentagem do MDR para cada Arranjo de Pagamento e intervalo de parcelas, o Split de Pagamentos irá replicar os mesmos acordos do master com a Subadquirente (Braspag), para o master com o Subordinado. Dessa forma, o master deverá informar apenas um MDR único, que será aplicado para todos os acordos.

Exemplo:

MDR do master com subordinado igual a 4%

ACORDO SUBADQUIRENTE e MASTER Visa Master Elo Diners Amex Hiper
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 SUBORDINADO Visa Master Elo Diners Amex Hiper
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%

Informando a porcentagem do MDR por Arranjos de Pagamento e intervalo de parcelas

Requisição

--header "Authorization: Bearer {access_token}"
{
    "CorporateName":"Subordinado Corporativo Ltda",
    "FancyName":"Subordinado Nome Fantasia",
    "DocumentNumber":"96462142000140",
    "DocumentType":"CNPJ",
    "MerchantCategoryCode":"5719",
    "ContactName":"Nome do Contato do Subordinado",
    "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 subordinado. 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 subordinado. As bandeiras válidas são Visa, Master, Amex, Elo, Diners, Discover e Hipercard
Agreement.MerchantDiscountRates[].InitialInstallmentNumber Número - Sim Número inicial do intervalo de parcelas da taxa de desconto do subordinado. 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 subordinado. 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 subordinado. 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 subordinado. 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 subordinado
Attachments[].File.FileType Texto - Não Tipo do arquivo do documento em anexo do subordinado. Os tipos de arquivos válidos são pdf, png, jpg e jpeg
Attachments[].File.Data Texto - Não Documento convertido para Base64

Resposta

--header "Authorization: Bearer {access_token}"
{
    "MasterMerchantId": "665a33c5-0022-4a40-a0bd-daad04eb3236",
    "MerchantId": "b8ccc729-a874-4b51-a5a9-ffeb5bd98878",
    "CorporateName":"Subordinado Corporativo Ltda",
    "FancyName":"Subordinado Nome Fantasia",
    "DocumentNumber":"96462142000140",
    "DocumentType":"CNPJ",
    "MerchantCategoryCode":"5719",
    "ContactName":"Nome do Contato do Subordinado",
    "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 subordinado
MerchantId GUID 36 Sim Identificação do subordinado
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 subordinado 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 subordinado
Agreement.MerchantDiscountRates[].PaymentArrangement.Product Texto - Sim Produto do arranjo de pagamento da taxa de desconto do subordinado. 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 subordinado. As bandeiras válidas são Visa, Master, Amex, Elo, Diners, Discover e Hipercard
Agreement.MerchantDiscountRates[].InitialInstallmentNumber Número - Sim Número inicial do intervalo de parcelas da taxa de desconto do subordinado. 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 subordinado. 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 subordinado. 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 subordinado. 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 subordinado
Attachments[].File.FileType Texto - Não Tipo do arquivo do documento em anexo do subordinado. Os tipos de arquivos válidos são pdf, png, jpg e jpeg

Informando a porcentagem do MDR único aplicado para todos os acordos

Requisição

--header "Authorization: Bearer {access_token}"
{
    "CorporateName":"Subordinado Corporativo Ltda",
    "FancyName":"Subordinado Nome Fantasia",
    "DocumentNumber":"96462142000140",
    "DocumentType":"CNPJ",
    "MerchantCategoryCode":"5719",
    "ContactName":"Nome do Contato do Subordinado",
    "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 Subordinado. 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 subordinado. 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 subordinado
Attachments[].File.FileType Texto - Não Tipo do arquivo do documento em anexo do subordinado. Os tipos de arquivos válidos são pdf, png, jpg e jpeg
Attachments[].File.Data Texto - Não Documento convertido para Base64

Resposta

--header "Authorization: Bearer {access_token}"
{
    "MasterMerchantId": "665a33c5-0022-4a40-a0bd-daad04eb3236",
    "MerchantId": "b8ccc729-a874-4b51-a5a9-ffeb5bd98878",
    "CorporateName":"Subordinado Corporativo Ltda",
    "FancyName":"Subordinado Nome Fantasia",
    "DocumentNumber":"96462142000140",
    "DocumentType":"CNPJ",
    "MerchantCategoryCode":"5719",
    "ContactName":"Nome do Contato do Subordinado",
    "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 subordinado
MerchantId GUID 36 Sim Identificação do subordinado
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 subordinado 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 subordinado
Agreement.MerchantDiscountRates[].PaymentArrangement.Product Texto - Sim Produto do arranjo de pagamento da taxa de desconto do subordinado. 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 subordinado. As bandeiras válidas são Visa, Master, Amex, Elo, Diners, Discover e Hipercard
Agreement.MerchantDiscountRates[].InitialInstallmentNumber Número - Sim Número inicial do intervalo de parcelas da taxa de desconto do subordinado. 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 subordinado. 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 subordinado. 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 subordinado. 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 subordinado
Attachments[].File.FileType Texto - Não Tipo do arquivo do documento em anexo do subordinado. Os tipos de arquivos válidos são pdf, png, jpg e jpeg

Consulta de Subordinados

A API de onboarding do Split de Pagamentos permite a consulta de um subordinado específico através do MerchantId do subordinado.

Requisição

Resposta

--header "Authorization: Bearer {access_token}"
{
    "MasterMerchantId": "665a33c5-0022-4a40-a0bd-daad04eb3236",
    "MerchantId": "b8ccc729-a874-4b51-a5a9-ffeb5bd98878",
    "CorporateName":"Subordinado Corporativo Ltda",
    "FancyName":"Subordinado Nome Fantasia",
    "DocumentNumber":"96462142000140",
    "DocumentType":"CNPJ",
    "MerchantCategoryCode":"5719",
    "ContactName":"Nome do Contato do Subordinado",
    "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 subordinado
MerchantId GUID 36 Sim Identificação do subordinado
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 Booleano - Sim Flag para indicar se o subordinado 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 subordinado
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 subordinado
Agreement.MerchantDiscountRates[].PaymentArrangement.Product Texto - Sim Produto do arranjo de pagamento da taxa de desconto do subordinado. 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 subordinado. As bandeiras válidas são Visa, Master, Amex, Elo, Diners, Discover e Hipercard
Agreement.MerchantDiscountRates[].InitialInstallmentNumber Número - Sim Número inicial do intervalo de parcelas da taxa de desconto do subordinado. 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 subordinado. 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 subordinado. 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 subordinado. 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 subordinado
Attachments[].File.FileType Texto - Não Tipo do arquivo do documento em anexo do subordinado. Os tipos de arquivos válidos são pdf, png, jpg e jpeg

Notificação de KYC

Para receber a notificação de alteração de status da análise de KYC, é 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).

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 subordinado 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 subordinado.
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

É 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 do Post de Notificação.

Criação de usuário para o subordinado

Caso ache necessário, o master pode permitir o acesso do subordinado ao backoffice do Split. Para isso, o master precisa enviar para o suporte Braspag:

ANEXOS

Lista de status do KYC

Status Nome do Status Descrição
1 UnderAnalysis Análise de KYC em andamento.
2 Approved Subordinado aprovado na análise de KYC.
3 ApprovedWithRestriction Subordinado aprovado com restrições na análise de KYC.
4 Rejected Subordinado não aprovado na análise de KYC.

Lista de Ramos de Atividades

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

Lista de Códigos de Compensação

Código de Compensação Banco
001 Banco do Brasil
003 Amazônia - BASA
004 BNB
021 Est. ES - Banestes
025 Alfa
033 Santander
041 Est. RS - Banrisul
047 Est. SE - Banese
069 Banco Crefisa
070 BRB - Banco de Brasília
077 Banco Inter
084 CC Uniprime Norte do Paraná
085 CC Cecred
094 Banco Finaxis
097 CC Centralcredi
099 CC Uniprime Central
104 Caixa Econômica Federal
107 BBM
133 CRESOL CONFEDERAÇÃO
136 CC Unicred do Brasil
197 STONE PAGAMENTOS S.A
212 Banco Original
218 Banco BS2
237 Bradesco
246 ABC - Brasil
260 NU PAGAMENTOS S.A (NUBANK)
301 Bpp Instituição De Pagamentos S.A
318 BCO BMG S.A.
323 Mercado Pago
336 Banco C6 S.A
341 Itaú Unibanco
376 J. P. Morgan
389 Mercantil do Brasil
422 Safra
600 Luso Brasileiro
604 Indl. do Brasil
623 BANCO PAN
637 Sofisa
654 Banco Digimais
655 Votorantim
743 Semear
745 Citibank S. A.
748 Sicredi
755 Bank of America Merrill Lynch
756 Bancoob - Banco Cooperativo do Brasil (Sicoob)
757 BCO KEB HANA DO BRASIL S.A.