Criar Contrato

Inicia a formalização contratual a partir de uma proposta previamente criada. O payload define dados financeiros, forma de desembolso, endereço e informações complementares necessárias para assinatura e integração.

Dados obrigatórios

Campo	Tipo	Descrição
contractAmount	decimal	Valor principal do contrato em reais
installments	integer	Número de parcelas
contractDate	datetime	Data/hora do contrato (ISO-8601, UTC)
address	object	Endereço residencial do trabalhador (ver tabela abaixo)
attendantName	string	Nome do atendente/vendedor responsável pela venda
attendantCpf	string	CPF do atendente/vendedor responsável

Dados opcionais

Campo	Tipo	Descrição
firstInstallmentDueDate	string	Data do primeiro vencimento (YYYY-MM-DD)
lastInstallmentDueDate	string	Data do último vencimento (YYYY-MM-DD)
pix	object	Dados para desembolso via chave PIX (ver tabela abaixo)
bankAccount	object	Dados para desembolso via conta bancária (ver tabela abaixo)
redirectUrl	string	URL de redirecionamento após assinatura digital
contractInfo	object	Informações contratuais complementares (multa, juros, seguro, garantias)

Deve ser informado pix ou bankAccount, mas não ambos. Um dos dois é obrigatório para definir a conta de desembolso.

Desembolso via PIX (pix)

Campo	Tipo	Descrição
keyType	string	Tipo da chave PIX (CPF, CNPJ, EMAIL, PHONE, RANDOM)
key	string	Valor da chave PIX

Desembolso via conta bancária (bankAccount)

Campo	Tipo	Obrigatório	Descrição
bankNumber	string	Sim	Código COMPE/ISPB do banco
agency	string	Sim	Número da agência
agencyDigit	string	Não	Dígito verificador da agência
accountNumber	string	Sim	Número da conta
accountDigit	string	Não	Dígito verificador da conta
type	string	Sim	Tipo da conta (CHECKING, SAVINGS)

Endereço (address)

Campo	Tipo	Obrigatório	Descrição
street	string	Sim	Logradouro
number	string	Não	Número
complement	string	Não	Complemento
neighborhood	string	Sim	Bairro
city	string	Sim	Cidade
state	string	Sim	UF (2 caracteres)
zipCode	string	Sim	CEP

Comportamento

Após a criação, o contrato é gerado com status CREATED. O fluxo seguinte depende da estratégia de assinatura configurada:

Estratégia GIRO

1. O PDF da CCB é gerado automaticamente

2. O trabalhador recebe um link para assinatura digital (e-mail/SMS)

3. Após assinatura, o contrato segue para averbação no Dataprev

4. Averbado, o valor é desembolsado na conta informada

Estratégia ORIGINATOR_MANAGED

Certifique-se de que os dados de desembolso (PIX ou conta bancária) pertencem ao trabalhador. Dados incorretos podem causar falha no desembolso.

Criar Contrato

post

https://consignado.staging.giro.techhttps://consignado.giro.tech

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

Inicia a formalização contratual a partir de uma proposta previamente criada. O payload define dados financeiros, forma de desembolso, endereço e informações complementares necessárias para assinatura e integração.

Autorizações

BearerAuth

AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota

proposalIdinteger · int64Obrigatório

ID da proposta

Corpo

application/json

contractAmountnumber · decimal · mín: 0.01Obrigatório

Valor principal do contrato em reais (decimal com 2 casas decimais).

installmentsinteger · mín: 1Obrigatório

Quantidade total de parcelas do contrato.

contractDatestring · date-timeObrigatório

Data e hora da contratação da operação (UTC).

firstInstallmentDueDatestring · dateOpcional

Data do primeiro vencimento. Deve respeitar as regras de carência e calendário da operação.

lastInstallmentDueDatestring · dateOpcional

Data prevista para vencimento da última parcela.

redirectUrlstring · máx: 1000Opcional

URL de redirecionamento após o fluxo de assinatura digital.

attendantNamestring · máx: 150Obrigatório

Nome do atendente ou vendedor responsável pela venda.

attendantCpfstring · máx: 14Obrigatório

CPF do atendente ou vendedor responsável.

Respostas

201

Contrato criado com sucesso

application/json

idinteger · int64Opcional

Identificador interno do contrato.

Example: 156

requestNumberstringOpcional

Número da requisição (GT + 10 alfanuméricos maiúsculos). Ex. GTAB12CD34EF

Example: GTAB12CD34EF

contractNumberstringOpcional

Número do contrato (8 dígitos com zero à esquerda). Ex. 00345678

Example: 345678

employeeIdinteger · int64Opcional

Identificador interno do trabalhador vinculado ao contrato.

Example: 15

proposalIdinteger · int64Opcional

Identificador da proposta que originou o contrato.

Example: 23

statusstring · enumOpcional

Ciclo de vida do contrato.

Valor	Significado
CREATED	Contrato criado, aguardando assinatura
SIGNED	Assinado pelo trabalhador
ENDORSED	Averbação consignada confirmada
FORMALIZED	Formalizado no sistema de pagamento
COMPLETED	Operação concluída (desembolsado)
CANCELLED	Cancelado

Example: CREATEDValores possíveis:

endorsementStatusstring · enumOpcional

Situação da averbação no convênio.

Valor	Significado
PENDING	Aguardando averbação
PROCESSING	Em processamento no convênio
ENDORSED	Averbação confirmada
FAILED	Falha na averbação
RETRYING	Nova tentativa em andamento

Example: PENDINGValores possíveis:

endorsementProtocolstringOpcional

Protocolo retornado pelo provedor de averbação, quando disponível.

contractAmountnumber · decimalOpcional

Valor principal do contrato em reais (decimal com 2 casas decimais).

Example: 5750

installmentsintegerOpcional

Quantidade de parcelas definida no contrato.

Example: 12

contractDatestring · date-timeOpcional

Data e hora de contratação registradas (UTC).

Example: 2024-02-01T10:00:00Z

firstInstallmentDueDatestring · dateOpcional

Data de vencimento da primeira parcela.

Example: 2024-04-25

lastInstallmentDueDatestring · dateOpcional

Data de vencimento da última parcela.

Example: 2025-03-25

signedAtstring · date-timeOpcional

Data e hora em que o contrato foi assinado (UTC).

formalizedAtstring · date-timeOpcional

Data e hora em que a formalização foi concluída (UTC).

paidAtstring · date-timeOpcional

Data e hora de liquidação/desembolso do contrato (UTC).

endorsedAtstring · date-timeOpcional

Data e hora de confirmação da averbação (UTC).

createdDatestring · date-timeOpcional

Data e hora de criação do contrato no sistema (UTC).

attendantNamestringOpcional

Nome do atendente/vendedor responsável.

attendantCpfstringOpcional

CPF do atendente/vendedor responsável.

400

Dados inválidos

401

Não autenticado

403

Permissão insuficiente

post

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

HTTPcURLJavaScriptPython

POST /api/v1/originator/proposals/{proposalId}/contracts HTTP/1.1
Host: consignado.staging.giro.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 355

{
  "contractAmount": 5750,
  "installments": 12,
  "contractDate": "2024-02-01T10:00:00Z",
  "firstInstallmentDueDate": "2024-04-25",
  "lastInstallmentDueDate": "2025-03-25",
  "pix": {
    "keyType": "CPF",
    "key": "12345678901"
  },
  "address": {
    "street": "Rua das Flores",
    "number": "123",
    "complement": "Apto 101",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "zipCode": "01234567"
  }
}

{
  "id": 156,
  "requestNumber": "GTAB12CD34EF",
  "contractNumber": 345678,
  "employeeId": 15,
  "proposalId": 23,
  "status": "CREATED",
  "endorsementStatus": "PENDING",
  "contractAmount": 5000,
  "installments": 12,
  "contractDate": "2025-01-15T10:00:00Z",
  "firstInstallmentDueDate": "2025-04-25",
  "lastInstallmentDueDate": "2026-03-25",
  "attendantName": "Maria Atendente",
  "attendantCpf": "98765432100",
  "createdDate": "2025-01-15T10:00:00Z"
}

Central de Atendimento | Giro.TechGiro.Tech