API GTPayroll
API pública do GTPayroll para parceiros (originators) gerenciarem o fluxo completo de empréstimo consignado — do cadastro do trabalhador até a formalização do contrato.
O arquivo completo em formato OpenApi 3.0 está disponível no link abaixo:
Visão Geral
O GTPayroll oferece uma API RESTful para originação de crédito consignado privado. A integração permite que parceiros (originators) realizem todo o ciclo de vida de uma operação de empréstimo via API, de forma programática e segura.
Principais capacidades
Cadastro e gestão de trabalhadores (employees)
Autorização de consulta de dados junto ao Dataprev
Consulta de margem consignável
Simulação de empréstimo com cálculo de parcelas, taxas e CET
Criação de propostas formais
Formalização e assinatura digital de contratos (CCB)
Acompanhamento de desembolso e dados Dataprev
Fluxo de Originação
O fluxo de originação segue uma sequência obrigatória de etapas. Cada etapa depende da anterior:
1. Employee
POST /employees
Cadastra o trabalhador com CPF, nome, data de nascimento e dados de contato
2. Autorização
POST /employees/{cpf}/authorization
Envia autorização para consulta de dados no Dataprev via assinatura digital
3. Margem
GET /employees/{cpf}/margin
Retorna a margem consignável disponível do trabalhador
4. Simulação
POST /employees/{publicId}/simulations
Calcula parcelas, juros, IOF e CET para o valor e prazo desejados
5. Proposta
POST /employees/{publicId}/proposals
Gera proposta formal com os dados financeiros da simulação escolhida
6. Contrato
POST /proposals/{proposalId}/contracts
Inicia a formalização — dados de desembolso, endereço e assinatura digital
Todos os endpoints exigem autenticação via JWT no header Authorization: Bearer {token}. Consulte a página Ambientes e Autenticação para detalhes.
Estratégias de Assinatura
O GTPayroll suporta duas estratégias de assinatura para autorização e contratos:
GIRO
A Giro.Tech gerencia o fluxo completo de assinatura digital (GTSign/ScoreHub)
ORIGINATOR_MANAGED
O originador gerencia a assinatura externamente com seu próprio provedor
Consulte a página Estratégias de Assinatura para detalhes sobre cada estratégia, comparativo e recomendações.
Integração Embedded
Além da API, o GTPayroll oferece um widget embedded que permite integrar o fluxo completo de originação diretamente no seu site ou aplicativo, sem redirecionamentos externos.
Consulte a página Integração Embedded para instruções de integração via iframe, WebView (Android/iOS) e React Native.
Próximos passos
Atualizado