# 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:

{% file src="/files/e7RNF4UPEd4gy8uLNm5y" %}

***

## 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
* Catálogo de **pontos de venda** (alias único): consulta somente leitura pelo parceiro; cadastro pela operação via API Admin — ver [Pontos de venda (catálogo)](/desenvolvedores/api-gtpayroll/api-reference/contratos/pontos-de-venda.md)

***

## Fluxo de Originação

O fluxo de originação segue uma sequência obrigatória de etapas. Cada etapa depende da anterior:

```
1. Criar Employee
       ↓
2. Enviar Autorização Dataprev
       ↓
3. Consultar Margem
       ↓
4. Criar Simulação
       ↓
5. Criar Proposta
       ↓
6. Criar Contrato → Assinatura Digital → Desembolso
```

| Etapa              | Endpoint                                   | Descrição                                                                   |
| ------------------ | ------------------------------------------ | --------------------------------------------------------------------------- |
| **1. Employee**    | `POST /employees`                          | Cadastra o trabalhador com CPF, nome, data de nascimento e dados de contato |
| **2. Autorização** | `POST /employees/{publicId}/authorization` | Envia autorização para consulta de dados no Dataprev via assinatura digital |
| **3. Margem**      | `GET /employees/{publicId}/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  |

{% hint style="info" %}
Todos os endpoints exigem autenticação via JWT no header `Authorization: Bearer {token}`. Consulte a página [Ambientes e Autenticação](/desenvolvedores/api-gtpayroll/guias/ambientes-e-autenticacao.md) para detalhes.
{% endhint %}

***

## Estratégias de Assinatura

O GTPayroll suporta duas estratégias de assinatura para autorização e contratos:

| Estratégia              | Descrição                                                                     |
| ----------------------- | ----------------------------------------------------------------------------- |
| **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](/desenvolvedores/api-gtpayroll/guias/estrategias-de-assinatura.md) 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](/desenvolvedores/api-gtpayroll/guias/integracao-embedded.md) para instruções de integração via iframe, WebView (Android/iOS) e React Native.

***

## Próximos passos

1. [Configurar ambientes e autenticação](/desenvolvedores/api-gtpayroll/guias/ambientes-e-autenticacao.md)
2. [Entender as estratégias de assinatura](https://github.com/giro-tech/giro-tech-docs/blob/github-to-gitbook/desenvolvedores/api-gtpayroll/estrategias-de-assinatura.md)
3. [Cadastrar um employee](/desenvolvedores/api-gtpayroll/api-reference/employees/criar-employee.md)
4. [Enviar autorização Dataprev](/desenvolvedores/api-gtpayroll/api-reference/autorizacao/enviar-autorizacao.md)
5. [Consultar margem](/desenvolvedores/api-gtpayroll/api-reference/margem/consultar-margem.md)
6. [Criar uma simulação](/desenvolvedores/api-gtpayroll/api-reference/simulacoes/criar-simulacao.md)

<figure><img src="/files/2w5UtND9NaDvUw1Q4Yga" alt=""><figcaption></figcaption></figure>

{% embed url="<https://giro.tech/central-de-atendimento/>" %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.giro.tech/desenvolvedores/api-gtpayroll.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.