Split de Pagamentos - Onboarding

Introdução

O Split de Pagamentos fornece uma API de Onboarding para possibilitar ao Master o gerenciamento de seus subordinados na plataforma. O Master deverá coletar as informações do subordinado, para utilizar no processo de Onboarding.

Assim como o Master, os subordinados também irão passar pelo processo de KYC (Know Your Customer) 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 Onboarding: https://splitonboardingsandbox.braspag.com.br

Produção

API Onboarding: https://splitonboarding.braspag.com.br

Cadastro de Subordinados

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 porcetagem do MDR para cada Arranjo de Pagamento e intervalor de parcelas, o Split de Pagamentos irá replicar os mesmos acordos do Master com a Subadquirente, para o Master com o Subordinado. Dessa forma, o Master deverá informar apenas um MDR único, que erá aplicado para todos os acordos. Exemplo:

MDR do Master com Subordinado: 4%

ACORDO SUBADQUIRENTE - 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 - 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%

Request

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

--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 Guid 36 Sim Razão social
FancyName String 50 Sim Nome fantasia
DocumentNumber String 14 Sim Número do documento (Apenas números)
DocumentType String - Sim Tipo do documento. Os tipos válidos são Cpf, Cnpj
MerchantCategoryCode String 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. Lista de Merchant Category Codes
ContactName String 100 Sim Nome do contato responsável
ContactPhone String 11 Sim Número do telefone do contato responsável (Apenas números)
MailAddress String 50 Sim Endereço de e-mail
Website String 200 Não Endereço do website
BankAccount.Bank String 3 Sim Código de compensação do banco. Lista de Códigos de compensação
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 20 Sim Número da conta
BankAccount.Operation String 10 Não Operação da conta
BankAccount.VerifierDigit Char 1 Sim Dígito verificador da conta
BankAccount.AgencyNumber String 15 Sim Número da agência
BankAccount.AgencyDigit Char 1 Sim Dígito da agência. Caso a agência não tenha dígito, informar o numeral 0
BankAccount.DocumentNumber String 14 Sim Número do documento da conta (Apenas números)
BankAccount.DocumentType String - Sim Tipo do documento. Os tipos válidos são Cpf, Cnpj
Address.Street String 100 Sim Rua do endereço
Address.Number String 15 Sim Número do endereço
Address.Complement String 80 Não Complemento do endereço
Address.Neighborhood String 50 Sim Bairro
Address.City String 50 Sim Cidade
Address.State String 2 Sim Sigla do estado
Address.ZipCode String 9 Sim CEP (Apenas números)
Agreement.Fee Int - Sim Taxa fixa por transação. Valor em centavos. Ex: R$ 1,00 = "Fee" : 100
Agreement.MerchantDiscountRates[].PaymentArrangement.Product String - 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 String - 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 Int - 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 Int - 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 String 200 Sim Url de notificação de mudança de status da análise do processo de KYC
Notification.Headers[].Key String 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 String 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 String - 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 String 50 Não Nome do arquivo do documento em anexo do subordinado
Attachments[].File.FileType String - 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 String - Não Documento convertido para Base64

Response

--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 Guid 36 Sim Razão social
FancyName String 50 Sim Nome fantasia
DocumentNumber String 14 Sim Número do documento
DocumentType String - Sim Tipo do documento. Os tipos válidos são Cpf, Cnpj
MerchantCategoryCode String 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. Lista de Merchant Category Codes
ContactName String 100 Sim Nome do contato responsável
ContactPhone String 11 Sim Número do telefone do contato responsável (Apenas números)
MailAddress String 50 Sim Endereço de e-mail
Website String 200 Não Endereço do website
Blocked Boolean - Sim Flag para indicar se o subordinado está bloqueado para participar da transação
Analysis.Status String - Sim Status da análise do processo de KYC. Os Status válidos são Approved, ApprovedWithRestriction e Rejected
BankAccount.Bank String 3 Sim Código de compensação do banco. Lista de Códigos de compensação
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 20 Sim Número da conta
BankAccount.Operation String 10 Não Operação da conta
BankAccount.VerifierDigit Char 1 Sim Dígito verificador da conta
BankAccount.AgencyNumber String 15 Sim Número da agência
BankAccount.AgencyDigit Char 1 Sim Dígito da agência. Caso a agência não tenha dígito, informar o numeral 0
BankAccount.DocumentNumber String 14 Sim Número do documento da conta
BankAccount.DocumentType String - Sim Tipo do documento. Os tipos válidos são Cpf, Cnpj
Address.Street String 100 Sim Rua do endereço
Address.Number String 15 Sim Número do endereço
Address.Complement String 80 Não Complemento do endereço
Address.Neighborhood String 50 Sim Bairro
Address.City String 50 Sim Cidade
Address.State String 2 Sim Sigla do estado
Address.ZipCode String 9 Sim CEP
Agreement.Fee Int - 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 String - 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 String - 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 Int - 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 Int - 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 String 200 Sim Url de notificação de mudança de status da análise do processo de KYC
Notification.Headers[].Key String 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 String 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 String - 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 String 50 Não Nome do arquivo do documento em anexo do subordinado
Attachments[].File.FileType String - 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

--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 Guid 36 Sim Razão social
FancyName String 50 Sim Nome fantasia
DocumentNumber String 14 Sim Número do documento (Apenas números)
DocumentType String - Sim Tipo do documento. Os tipos válidos são Cpf, Cnpj
MerchantCategoryCode String 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. Lista de Merchant Category Codes
ContactName String 100 Sim Nome do contato responsável
ContactPhone String 11 Sim Número do telefone do contato responsável (Apenas números)
MailAddress String 50 Sim Endereço de e-mail
Website String 200 Não Endereço do website
BankAccount.Bank String 3 Sim Código de compensação do banco. Lista de Códigos de compensação
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 20 Sim Número da conta
BankAccount.Operation String 10 Não Operação da conta
BankAccount.VerifierDigit Char 1 Sim Dígito verificador da conta
BankAccount.AgencyNumber String 15 Sim Número da agência
BankAccount.AgencyDigit Char 1 Sim Dígito da agência. Caso a agência não tenha dígito, informar o numeral 0
BankAccount.DocumentNumber String 14 Sim Número do documento da conta (Apenas números)
BankAccount.DocumentType String - Sim Tipo do documento. Os tipos válidos são Cpf, Cnpj
Address.Street String 100 Sim Rua do endereço
Address.Number String 15 Sim Número do endereço
Address.Complement String 80 Não Complemento do endereço
Address.Neighborhood String 50 Sim Bairro
Address.City String 50 Sim Cidade
Address.State String 2 Sim Sigla do estado
Address.ZipCode String 9 Sim CEP (Apenas números)
Agreement.Fee Int - 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 String 200 Sim Url de notificação de mudança de status da análise do processo de KYC
Notification.Headers[].Key String 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 String 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 String - 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 String 50 Não Nome do arquivo do documento em anexo do subordinado
Attachments[].File.FileType String - 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 String - Não Documento convertido para Base64

Response

--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 Guid 36 Sim Razão social
FancyName String 50 Sim Nome fantasia
DocumentNumber String 14 Sim Número do documento
DocumentType String - Sim Tipo do documento. Os tipos válidos são Cpf, Cnpj
MerchantCategoryCode String 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. Lista de Merchant Category Codes
ContactName String 100 Sim Nome do contato responsável
ContactPhone String 11 Sim Número do telefone do contato responsável (Apenas números)
MailAddress String 50 Sim Endereço de e-mail
Website String 200 Não Endereço do website
Blocked Boolean - Sim Flag para indicar se o subordinado está bloqueado para participar da transação
Analysis.Status String - Sim Status da análise do processo de KYC. Os Status válidos são Approved, ApprovedWithRestriction e Rejected
BankAccount.Bank String 3 Sim Código de compensação do banco. Lista de Códigos de compensação
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 20 Sim Número da conta
BankAccount.Operation String 10 Não Operação da conta
BankAccount.VerifierDigit Char 1 Sim Dígito verificador da conta
BankAccount.AgencyNumber String 15 Sim Número da agência
BankAccount.AgencyDigit Char 1 Sim Dígito da agência. Caso a agência não tenha dígito, informar o numeral 0
BankAccount.DocumentNumber String 14 Sim Número do documento da conta
BankAccount.DocumentType String - Sim Tipo do documento. Os tipos válidos são Cpf, Cnpj
Address.Street String 100 Sim Rua do endereço
Address.Number String 15 Sim Número do endereço
Address.Complement String 80 Não Complemento do endereço
Address.Neighborhood String 50 Sim Bairro
Address.City String 50 Sim Cidade
Address.State String 2 Sim Sigla do estado
Address.ZipCode String 9 Sim CEP
Agreement.Fee Int - 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 String - 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 String - 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 Int - 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 Int - 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 String 200 Sim Url de notificação de mudança de status da análise do processo de KYC
Notification.Headers[].Key String 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 String 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 String - 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 String 50 Não Nome do arquivo do documento em anexo do subordinado
Attachments[].File.FileType String - 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 de sua identificação.

Response

--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 Guid 36 Sim Razão social
FancyName String 50 Sim Nome fantasia
DocumentNumber String 14 Sim Número do documento
DocumentType String - Sim Tipo do documento. Os tipos válidos são Cpf, Cnpj
MerchantCategoryCode String 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. Lista de Merchant Category Codes
ContactName String 100 Sim Nome do contato responsável
ContactPhone String 11 Sim Número do telefone do contato responsável (Apenas números)
MailAddress String 50 Sim Endereço de e-mail
Website String 200 Não Endereço do website
Blocked Boolean - Sim Flag para indicar se o subordinado está bloqueado para participar da transação
Analysis.Status String - Sim Status da análise do processo de KYC. Os Status válidos são Approved, ApprovedWithRestriction e Rejected
Analysis.Score Int - Não Score da análise do processo de KYC. Range de 1 a 100
Analysis.DenialReason String - Não Motivo de reprovação do subordinado
BankAccount.Bank String 3 Sim Código de compensação do banco. Lista de Códigos de compensação
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 20 Sim Número da conta
BankAccount.Operation String 10 Não Operação da conta
BankAccount.VerifierDigit Char 1 Sim Dígito verificador da conta
BankAccount.AgencyNumber String 15 Sim Número da agência
BankAccount.AgencyDigit Char 1 Sim Dígito da agência. Caso a agência não tenha dígito, informar o numeral 0
BankAccount.DocumentNumber String 14 Sim Número do documento da conta
BankAccount.DocumentType String - Sim Tipo do documento. Os tipos válidos são Cpf, Cnpj
Address.Street String 100 Sim Rua do endereço
Address.Number String 15 Sim Número do endereço
Address.Complement String 80 Não Complemento do endereço
Address.Neighborhood String 50 Sim Bairro
Address.City String 50 Sim Cidade
Address.State String 2 Sim Sigla do estado
Address.ZipCode String 9 Sim CEP
Agreement.Fee Int - 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 String - 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 String - 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 Int - 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 Int - 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 String 200 Sim Url de notificação de mudança de status da análise do processo de KYC
Notification.Headers[].Key String 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 String 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 String - 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 String 50 Não Nome do arquivo do documento em anexo do subordinado
Attachments[].File.FileType String - 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

Ao final do processo de KYC, o Master receberá a notificação com o resultado da análise. Será feito uma requisição com os cabeçalhos na URL de notificação informados na criação do subordinado.

{
    "MerchantId": "b8ccc729-a874-4b51-a5a9-ffeb5bd98878",
    "Status": "Approved",
    "Score", 89,
    "DenialReason": null
}
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificação do subordinado
Analysis.Status String - Sim Status da análise do processo de KYC. Os Status válidos são Approved, ApprovedWithRestriction e Rejected
Analysis.Score Int - Não Score da análise do processo de KYC. Range de 1 a 100
Analysis.DenialReason String - Não Motivo de reprovação do subordinado