Pular para o conteúdo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Contratos

O contrato é a CCB (Cédula de Crédito Bancário) do empréstimo consignado. É criado a partir de uma proposta.

Ciclo de vida do contrato

Status (API)
Descrição

CREATED

Contrato gerado, aguardando assinatura do trabalhador

SIGNED

Trabalhador assinou digitalmente

PENDING_PAYMENT_APPROVAL

Averbação concluída, aguardando confirmação do originador para formalização (apenas quando requiresPaymentApproval = true + formalizationStrategy = GTBANKER)

ENDORSED

Contrato registrado (averbado) no Dataprev — ou liberado após aprovação de pagamento

FORMALIZED

Contrato formalizado junto ao banco

COMPLETED

Fluxo completo — valor desembolsado

CANCELLED

Contrato cancelado

O cancelamento só é possível enquanto o contrato não entrou em assinatura/averbação/formalização.

Estratégias de assinatura

Detalhes em Estratégias de Assinatura.

Criar Contrato → PDF gerado → Link enviado → Trabalhador assina → Averbação → Desembolso

A Giro gera a CCB e envia o link de assinatura ao trabalhador por WhatsApp.

Criar Contrato → Originador assina externamente → Upload assinado → Averbação → Desembolso

A Giro gera a CCB mas não envia para assinatura. Você coleta a assinatura no seu provedor e faz upload do contrato assinado; só então o fluxo prossegue.

Estratégias de formalização

Estratégia
Descrição

GTBANKER

Formalização da CCB e desembolso automáticos pela Giro

ORIGINATOR_MANAGED

Originador gerencia a formalização externamente

Para originadores GTBANKER com requiresPaymentApproval = true, há um passo de confirmação de pagamento entre a averbação e a formalização. Veja Confirmar Aprovação de Pagamento.

Identificadores do contrato

Identificador
Descrição
Quando usar

requestNumber

Número da requisição (ex.: GTAB12CD34EF)

Comunicação com o trabalhador, reenvio de links, upload de assinado e download do documento

nsu

NSU do documento do contrato

Rastreio e referência; retornado na resposta do contrato e em Baixar Documento do Contrato

documentStatus

Status do documento (PENDING, GENERATED, SIGNED, FAILED)

Saber se o PDF está disponível para download ou upload de assinado

Operações disponíveis

Criar e consultar

Operação
Método
Endpoint

POST

/api/v1/originator/proposals/{proposalPublicId}/contracts

GET

/api/v1/originator/contracts/by-request-number/{requestNumber}

GET

/api/v1/originator/contracts/ccb/{ccbNumber}

Assinatura do contrato

Fluxo
Quando usar
Página

Gerenciada pela Giro (contractSignatureStrategy = GIRO)

A Giro gera a CCB e coleta a assinatura; você só acompanha o status

Gerenciada pelo originador (contractSignatureStrategy = ORIGINATOR_MANAGED)

Você baixa a CCB, coleta a assinatura e sobe o contrato assinado

Ciclo de vida

Operação
Método
Endpoint

POST

/api/v1/originator/contracts/{contractNumber}/payment-approval

POST

/api/v1/originator/contracts/cancel

POST

/api/v1/originator/contracts/exclude

Atualizado