> For the complete documentation index, see [llms.txt](https://docs.giro.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.giro.tech/desenvolvedores/api-gtpayroll.md).

# API GTPayroll

API REST do GTPayroll para originadores operarem o crédito consignado privado, do cadastro do trabalhador à formalização do contrato.

Especificação OpenAPI 3.0:

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

Coleções Postman (homologação):

{% file src="/files/29YjXyqQrkO9nCHKsO82" %}
GTPayroll — coleção Postman (API REST do originator, todos os endpoints).
{% endfile %}

{% file src="/files/bhmU88oYaPQncUW4ZQlI" %}
GTPayroll — exemplos de payload de webhook (todos os eventos de margem, autorização, averbação, pagamento, contrato e leilão).
{% endfile %}

Para testar o receptor de webhook, use a coleção de eventos em [Webhooks](/desenvolvedores/api-gtpayroll/webhooks.md#collection-postman).

***

## Principais capacidades

* Cadastro de trabalhadores (employees)
* [Autorização](/desenvolvedores/api-gtpayroll/api-reference/autorizacao.md) da consulta de dados na Dataprev
* Consulta de margem consignável, inclusive [por vínculo](/desenvolvedores/api-gtpayroll/api-reference/margem/consultas-dataprev.md) (`bondPublicId`)
* Simulação com cálculo de parcelas, taxas e CET
* Propostas, [leilão de propostas (CTPS)](/desenvolvedores/api-gtpayroll/api-reference/leilao.md) e contratos (CCB) com assinatura digital
* Desembolso, [escriturações e repasses](/desenvolvedores/api-gtpayroll/api-reference/consulta-de-escrituracoes.md) e [término de vínculo](/desenvolvedores/api-gtpayroll/api-reference/termino-de-vinculo.md)

***

## Fluxo de Originação

Cada etapa depende da anterior:

| Etapa              | Endpoint                                                                                                      | Descrição                                                                                                                                                    |
| ------------------ | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **1. Employee**    | `POST /api/v1/originator/employees`                                                                           | Cadastra o trabalhador com CPF, nome, data de nascimento e dados de contato                                                                                  |
| **2. Autorização** | `POST .../employees/{publicId}/signed-authorizations` ou `POST .../employees/{publicId}/authorization-trails` | Autoriza a consulta de dados na Dataprev, por termo em PDF ou trilha opt-in — ver [Autorização](/desenvolvedores/api-gtpayroll/api-reference/autorizacao.md) |
| **3. Margem**      | `GET /api/v1/originator/employees/{publicId}/margin`                                                          | Retorna a margem consignável disponível do trabalhador                                                                                                       |
| **4. Simulação**   | `POST /api/v1/originator/employees/{publicId}/simulations`                                                    | Calcula parcelas, juros, IOF e CET para o valor e prazo desejados                                                                                            |
| **5. Proposta**    | `POST /api/v1/originator/employees/{publicId}/proposals`                                                      | Gera a proposta com os dados financeiros da simulação escolhida                                                                                              |
| **6. Contrato**    | `POST /api/v1/originator/proposals/{proposalPublicId}/contracts`                                              | Cria o contrato: dados de desembolso, endereço e assinatura digital                                                                                          |

{% hint style="info" %}
Todos os endpoints exigem `Authorization: Bearer {token}`. Ver [Ambientes e Autenticação](/desenvolvedores/api-gtpayroll/guias/ambientes-e-autenticacao.md).
{% endhint %}

***

## Estratégias de Assinatura

Na autorização Dataprev, a assinatura é sempre coletada pelo originador. A CCB tem duas estratégias: **GIRO** (a Giro conduz a assinatura) e **ORIGINATOR\_MANAGED** (você coleta a assinatura no seu provedor). Ver [Estratégias de Assinatura](/desenvolvedores/api-gtpayroll/guias/estrategias-de-assinatura.md).

***

## Integração Embedded

Um **widget embedded** leva o fluxo de originação para dentro do seu site ou app, sem redirecionamento: [Integração Embedded](/desenvolvedores/api-gtpayroll/guias/integracao-embedded.md) (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](/desenvolvedores/api-gtpayroll/guias/estrategias-de-assinatura.md)
3. [Cadastrar um employee](/desenvolvedores/api-gtpayroll/api-reference/employees/criar-employee.md)
4. [Autorizar na Dataprev](/desenvolvedores/api-gtpayroll/api-reference/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="https://978140111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF6l1W0qI0y7eF7f0QRDC%2Fuploads%2Fgit-blob-f5d2064d02c970341ca52b2c083eb1f585bc436a%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

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