Iniciar onboarding de Pessoa Jurídica

POST https://sandbox.tbanks.com.br/onboarding/v3/legal-person/simple

Este endpoint permite iniciar o processo de onboarding de novas contas para pessoas jurídicas.

Descrição:

Através deste endpoint, é possível iniciar o processo de onboarding de novas contas para pessoas jurídicas. Caso a requisição seja bem-sucedida, você receberá um identificador único gerado para aquele onboarding. Caso exista alguma falha na requisição, você receberá um retorno 400 com os erros detectados.

Uma vez que a conta foi recebida, iremos fazer uma transação teste para verificar se os dados bancários informados para o repasse estão corretos. Essa verificação será um crédito de R$ 0.01 via PIX. Se essa transação der errado, o onboarding será automaticamente rejeitado.

Se a verificação dos dados bancários for bem-sucedida, o onboarding passará por outras avaliações internas. Se tudo estiver certo, a conta será credenciada e você receberá um webhook com as informações da conta, onde o identificador da conta será o mesmo retornado na abertura do onboarding. Caso o partner opte por realizar a criação automática da chave PIX para a conta, a mesma será criada antes do envio do webhook. Consulte a página "Webhook de confirmação de conta" para mais detalhes.

Importante:

O identificador retornado pertence à conta que foi credenciada (caso aprovada). Ele será necessário posteriormente para realizar as requisições nas APIs do sistema. O campo chamado accountIdentifier no cabeçalho é obrigatório.

Corpo da Requisição

Campo	Tipo	Obrigatório	Descrição
documentNumber	String	Sim	Número do documento
tradingName	String	Sim	Nome fantasia da empresa
openCompanyDate	String	Sim	Data de abertura da empresa
email	String	Sim	Endereço de e-mail da empresa
mobilePhone	String	Sim	Número de telefone da empresa
representative	Object	Sim	Dados do representante da empresa
└── cpf	String	Sim	CPF do representante
└── name	String	Sim	Nome do representante
└── email	String	Sim	E-mail do representante
└── mobilePhone	String	Sim	Telefone do representante
destinationAccount	Object	Sim	Conta de destino do repasse
└── bankNumber	String	Sim	Número do banco da conta
└── branch	String	Sim	Número da agência da conta
└── number	String	Sim	Número da conta da empresa
fees	Object	Sim	Dados de taxas a serem cobrados da conta
└── bankSlip	Double	Não	Taxa cobrada no pagamento do boleto. Esta taxa não pode ser menor do que a negociada para o partner. (Obrigatório se o pixCashIn não for informado)
└── pixCashIn	Double	Não	Taxa cobrada para recebimento de pagamento com pix. Esta taxa não pode ser menor do que a negociada para o partner. (Obrigatório se o bankSlip não for informado)
plan	Object	Não	Dados de taxas a serem cobradas da conta
└─pixPlan	Object	Sim	Dados de taxas do Pix
└─└─staticPlan	Object	Sim	Dados de taxa do Qr Code Estático
└─└─└─ fee	Double	Sim	Valor da taxa em reais (R$) ou percentual (de 0.01 sendo 1% até 1 sendo 100%)
└─└─└─ minValue	Double	Não	Necessário informar só em caso de taxa percentual, sendo o valor minimo a ser cobrado de taxa.
└─└─└─ maxValue	Double	Não	Necessário informar só em caso de taxa percentual, sendo o valor máximo a ser cobrado de taxa.
└─└─└─ type	Enum(FiXED ou PERCENTAGE)	Sim	Define como será cobrada a taxa, valor fixo ou percentual.
└─└─ immediate	Object	Sim	Dados de taxa do Qr Code Imediato
└─└─└─ fee	Double	Sim	Valor da taxa em reais (R$) ou percentual (de 0.01 sendo 1% até 1 sendo 100%)
└─└─└─ minValue	Double	Não	Necessário informar só em caso de taxa percentual, sendo o valor minimo a ser cobrado de taxa.
└──└──maxValue	Double	Não	Necessário informar só em caso de taxa percentual, sendo o valor máximo a ser cobrado de taxa.
└─└─└─ type	Enum(FiXED ou PERCENTAGE)	Sim	Define como será cobrada a taxa, valor fixo ou percentual.
└─└─ dueDate	Object	Sim	Dados de taxa do Qr Code Com Vencimento
└─└─└─ fee	Double	Sim	Valor da taxa em reais (R$) ou percentual (de 0.01 sendo 1% até 1 sendo 100%)
└─└─└─ minValue	Double	Não	Necessário informar só em caso de taxa percentual, sendo o valor minimo a ser cobrado de taxa.
└─└─└─ maxValue	Double	Não	Necessário informar só em caso de taxa percentual, sendo o valor máximo a ser cobrado de taxa.
└─└─└─ type	Enum(FiXED ou PERCENTAGE)	Sim	Define como será cobrada a taxa, valor fixo ou percentual.
└─└─ immediateSplit	Object	Sim	Dados de taxa do Qr Code Imediato Com Split
└─└─└─ fee	Double	Sim	Valor da taxa em reais (R$) ou percentual (de 0.01 sendo 1% até 1 sendo 100%)
└─└─└─ minValue	Double	Não	Necessário informar só em caso de taxa percentual, sendo o valor minimo a ser cobrado de taxa.
└─└─└─ maxValue	Double	Não	Necessário informar só em caso de taxa percentual, sendo o valor máximo a ser cobrado de taxa.
└─└─└─ type	Enum(FiXED ou PERCENTAGE)	Sim	Define como será cobrada a taxa, valor fixo ou percentual.
└─└─ dueDateSplit	Object	Sim	Dados de taxa do Qr Code Com Vencimento Com Split
└─└─└─ fee	Double	Sim	Valor da taxa em reais (R$) ou percentual (de 0.01 sendo 1% até 1 sendo 100%)
└─└─└─ minValue	Double	Não	Necessário informar só em caso de taxa percentual, sendo o valor minimo a ser cobrado de taxa.
└─└─└─ maxValue	Double	Não	Necessário informar só em caso de taxa percentual, sendo o valor máximo a ser cobrado de taxa.
└─└─└─ type	Enum(FiXED ou PERCENTAGE)	Sim	Define como será cobrada a taxa, valor fixo ou percentual.
└─└─ cashout	Object	Sim	Dados de taxa de cashout
└─└─└─ fee	Double	Sim	Valor da taxa em reais (R$) ou percentual (de 0.01 sendo 1% até 1 sendo 100%)
└─└─└─ minValue	Double	Não	Necessário informar só em caso de taxa percentual, sendo o valor minimo a ser cobrado de taxa.
└─└─└─ maxValue	Double	Não	Necessário informar só em caso de taxa percentual, sendo o valor máximo a ser cobrado de taxa.
└─└─└─ type	Enum(FiXED ou PERCENTAGE)	Sim	Define como será cobrada a taxa, valor fixo ou percentual.
└─└─ remittance	Object	Sim	Dados de taxa da antecipação de repasse.
└─└─└─ fee	Double	Sim	Valor da taxa em reais (R$) ou percentual (de 0.01 sendo 1% até 1 sendo 100%)
└─└─└─ minValue	Double	Não	Necessário informar só em caso de taxa percentual, sendo o valor minimo a ser cobrado de taxa.
└─└─└─ maxValue	Double	Não	Necessário informar só em caso de taxa percentual, sendo o valor máximo a ser cobrado de taxa.
└─└─└─ type	Enum(FiXED ou PERCENTAGE)	Sim	Define como será cobrada a taxa, valor fixo ou percentual.
└─ bankSlipPlan	Object	Sim	Dados de taxa do boleto.
└─└─ monetizationFee	Double	Sim	Valor da taxa em reais (R$) ou percentual (de 0.01 sendo 1% até 1 sendo 100%)
└─└─ splitMonetizationFee	Double	Sim	Valor da taxa Split em reais (R$) ou percentual (de 0.01 sendo 1% até 1 sendo 100%)
└─└─ planType	Enum(FiXED ou PERCENTAGE)	Sim	Define como será cobrada a taxa, valor fixo ou percentual.

Exemplo de requisição

json

{
    "documentNumber": "12345678900",
    "tradingName": "Empresa ABC",
    "openCompanyDate": "2023-05-10",
    "email": "[email protected]",
    "mobilePhone": "11999895929",
    "urlNotification": "webhook.com",
    "representative": {
        "cpf": "98765432100",
        "name": "João da Silva",
        "email": "[email protected]",
        "mobilePhone": "11987654321"
    },
    "destinationAccount": {
        "bankNumber": "001",
        "branch": "1234",
        "number": "5678901"
    },
    "fees": {
        "bankSlip": 1.20,
        "pixCashIn": 0.5
    },
		"plan": {
        "pixPlan": {
            "staticPlan": {
                "fee": 0.0,
                "minValue": 2,
                "maxValue": 5000,
                "type": "PERCENTAGE"
            },
            "immediate": {
                "type": "FIXED",
                "fee": 2.00
            },
            "dueDate": {
                "type": "PERCENTAGE",
                "fee": 10.00
            },
            "immediateSplit": {
                "type": "PERCENTAGE",
                "fee": 4.00
            },
            "dueDateSplit": {
                "type": "PERCENTAGE",
                "fee": 5.00
            },
            "cashout": {
                "type": "FIXED",
                "fee": 6.00
            },
            "remittance": {
                "type": "FIXED",
                "fee": 6.00
            }
        },
        "bankSlipPlan": {
            "monetizationFee": 1.2,
            "splitMonetizationFee": 0.8,
            "planType": "FIXED"
        },
        "hybridBillPlan": {
            "monetizationFee": 1.0,
            "splitMonetizationFee": 0.6,
            "dueDate": {
                "type": "FIXED",
                "fee": 10.00
            },
            "dueDateSplit": {
                "type": "PERCENTAGE",
                "fee": 20.00
            }
        }
}

Corpo da Resposta de Sucesso

Campo	Tipo	Descrição
identifier	String	Identificador único gerado para o onboarding

Resposta de Sucesso

JSON

{
    "identifier": "d4f290b4-9bdb-4695-bcdb-c4ccc921b5ff"
}

Resposta em Caso de Erro

Campo	Tipo	Descrição
path	String	Caminho do erro
error	String	Tipo de erro
message	String	Mensagem de erro
errors	Array	Lista de erros adicionais
└── field	String	Campo que causou o erro
└── value	String	Valor que causou o erro
└── message	String	Mensagem descrevendo o erro ocorrido
timestamp	String	Carimbo de data/hora do erro
status	Number	Código de status HTTP do erro

Exemplo erro

JSON

{
    "path": "/onboarding/v3/legal-person/simple",
    "error": "Bad Request",
    "message": "Erro ao validar a requisição",
    "errors": [
        {
            "field": "mobilePhone",
            "value": "11999895929",
            "message": "O número deve ter dez dígitos"
        }
    ],
    "timestamp": "2024-03-21T15:07:35.910736",
    "status": 400
}