> 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-formalizacao-de-credito/api-reference/formalizacao-da-ccb.md).

# Formalização da CCB

## Headers e Parâmetros

URL da requisição e Headers necessários

#### Parâmetros

| Parâmetro       | Valor                                                         |
| --------------- | ------------------------------------------------------------- |
| URL Homologação | <https://api.staging.scd.giro.tech/integration/v3/operations> |
| Método          | `HTTP POST`                                                   |
| Header          | `Authorization {{token}}`                                     |
| Header          | `Origem {{origem}}`                                           |
| Header          | `Identificador-Programa {{identificador-programa}}`           |
| Content-Type    | `application/json; charset=UTF-8`                             |

#### Headers Adicionais

* `Origem`
  * Chave de origem (ou originador) criado para a integração. O valor é informado pelo time de integração da Giro.Tech após a liberação do ambiente.
* `Identificador-Programa`
  * Chave do programa que a CCB irá ser vinculada. O programa é utilizado quando existem mais de uma modalidade de crédito para sua integração. A Giro.Tech irá informar qual são os valores informados em cada modalidade

## Formalização da CCB na Giro.Tech

> Realiza a formalização da CCB na API da Giro.Tech.

```json
{"openapi":"3.0.0","info":{"title":"API de Formalização de Crédito","version":"1.0.0"},"servers":[{"url":"https://api.staging.scd.giro.tech/integration/v3","description":"Ambiente de Staging"},{"url":"https://api.scd.giro.tech/integration/v3","description":"Ambiente de Produção"}],"security":[{"TokenAuth":[]}],"components":{"securitySchemes":{"TokenAuth":{"type":"apiKey","in":"header","name":"Authorization"}}},"paths":{"/operations":{"post":{"summary":"Formalização da CCB na Giro.Tech","description":"Realiza a formalização da CCB na API da Giro.Tech.","tags":["CCB"],"parameters":[{"name":"Origem","in":"header","required":true,"schema":{"type":"string"},"description":"Originador da operação."},{"name":"Identificador-Programa","in":"header","required":true,"schema":{"type":"string"},"description":"Identificador do Programa."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["numero_ccb","data_liberacao","produto","emprestimo","agente","endereco","tomador"],"properties":{"numero_ccb":{"type":"string","maxLength":8,"description":"Número da CCB que será formalizada."},"data_liberacao":{"type":"string","format":"date","description":"Data da liberação da CCB. <br> Deve ser posterior a data de empréstimo (emprestimo.data_emprestimo). <br> Deve ser anterior a data de vencimento da primeira parcela (emprestimo.data_primeiro_vencimento_parcela)."},"produto":{"type":"string","enum":["CREDITO_DIRETO_CONSUMIDOR","CREDITO_PESSOAL","CARTAO_CREDITO","CREDITO_PESSOAL_CONSIGNADO_PRIVADO","CREDITO_PESSOAL_CONSIGNADO_MUNICIPAL","CREDITO_PESSOAL_CONSIGNADO_ESTADUAL"],"description":"Produto utilizado na CCB.","default":"CREDITO_DIRETO_CONSUMIDOR"},"modalidade":{"type":"string","enum":["FINANCIAMENTO","EMPRESTIMO"],"description":"Modalidade da operação. <br> Para CCB com produto CREDITO_DIRETO_CONSUMIDOR, utiliza por padrão a modalidade FINANCIAMENTO. <br> Para CCBs com os produtos CREDITO_PESSOAL, CREDITO_PESSOAL_CONSIGNADO_PRIVADO, CREDITO_PESSOAL_CONSIGNADO_MUNICIPAL e CREDITO_PESSOAL_CONSIGNADO_ESTADUAL, utilizar por padrão a modalidade EMPRESTIMO. <br> Para os demais produtos, a modalidade é obrigatória."},"periodicidade":{"type":"string","enum":["MENSAL","DIARIO","QUINZENAL","SEMANAL"],"description":"Periodicidade da cobrança nos vencimentos.","default":"MENSAL"},"tipo_documento":{"type":"string","enum":["BOLETO","CHEQUE","DUPLICATE","CREDIT_RIGHTS"],"description":"Tipo do documento para pagamento."},"sub_tipo_ativo":{"type":"string","maxLength":255,"description":"Subtipo do ativo financeiro para envio de remessa."},"id_ccb_contratante":{"type":"string","maxLength":255,"description":"Identificador da CCB contratante."},"emprestimo":{"type":"object","required":["numero_parcelas","data_emprestimo","data_primeiro_vencimento_parcela","taxa_juros_mensal","valor_iof","valor_primeira_parcela","valor_tarifas","valor_juros","valor_desembolso","valor_financiado","valor_emprestimo","custo_efetivo_total_mensal","custo_efetivo_total_anual","parcelas"],"properties":{"data_emprestimo":{"type":"string","format":"date","description":"Data do empréstimo. <br> Deve ser anterior ou igual a data da formalização ( data do envio a Giro ), a formalização de CCBs com datas futuras será recusada."},"numero_parcelas":{"type":"integer","format":"int32","description":"Total de parcelas (vencimentos) para o pagamento da CCB.","maximum":99,"minimum":1},"taxa_juros_mensal":{"type":"number","format":"double","description":"Taxa de juros ao mês do empréstimo, expressa em percentual.","maximum":99.99999999,"minimum":0},"data_primeiro_vencimento_parcela":{"type":"string","format":"date","description":"Data do primeiro vencimento da parcela. <br> Deve ser posterior a data do empréstimo (emprestimo.data_primeiro_vencimento_parcela). <br> Deve ser igual a menor data de vencimento das parcelas do empréstimo (emprestimo.parcelas[*].data_vencimento)."},"valor_primeira_parcela":{"type":"number","format":"double","description":"Valor da primeira parcela.","maximum":999999999.99,"minimum":0},"valor_tarifas":{"type":"number","format":"double","description":"Valor de tarifas que serão aplicadas na CCB.","maximum":999999.99,"minimum":0},"valor_iof":{"type":"number","format":"double","description":"Valor de IOF. <br> Deve ser de no mínimo um centavo.","maximum":999999.99,"minimum":0.01},"tipo_aliquota_iof":{"type":"string","enum":["EMPRESAS_NO_GERAL","PESSOA_FISICA","MEI_COM_ALIQUOTA_REDUZIDA","MEI_ACIMA_DO_LIMITE","SIMPLES_COM_ALIQUOTA_REDUZIDA","SIMPLES_ACIMA_DO_LIMITE"],"description":"Este campo deve refletir o enquadramento fiscal informado na etapa de simulação, considerando regimes como MEI, Simples Nacional ou outros.<br/>\nAs alíquotas de IOF informadas no empréstimo devem levar em conta o tipo de pessoa do tomador (tomador.documento), o enquadramento fiscal e o valor do empréstimo (emprestimo.valor_emprestimo), conforme a regulamentação vigente.<br/>\nO preenchimento é obrigatório para tomadores do tipo Pessoa Jurídica (tomador.documento).\n"},"valor_desembolso":{"type":"number","format":"double","description":"Valor desembolsado.","maximum":999999999.99,"minimum":0},"valor_juros":{"type":"number","format":"double","description":"Valor dos impostos.","maximum":9999999.99,"minimum":0},"valor_financiado":{"type":"number","format":"double","description":"Valor do financiamento.","maximum":999999999.99,"minimum":0.01},"valor_emprestimo":{"type":"number","format":"double","description":"Valor do empréstimo.","maximum":999999999.99,"minimum":0.01},"valor_retencao":{"type":"number","format":"double","description":"Valor de retenção.","maximum":999999999.99,"minimum":0},"percentual_retencao":{"type":"number","format":"double","description":"Porcentagem de retenção.","maximum":99.999999,"minimum":0},"custo_efetivo_total_mensal":{"type":"number","format":"double","description":"Taxa do custo efetivo total mensal, expressa em percentual.","maximum":99.999999,"minimum":0},"custo_efetivo_total_anual":{"type":"number","format":"double","description":"Taxa do custo efetivo total anual, expressa em percentual.","maximum":9999.999999,"minimum":0},"parcelas":{"type":"array","description":"Deve possuir os vencimentos distintos.","items":{"type":"object","required":["numero_parcela","dias_compensar","data_vencimento","valor_parcela","valor_juros","saldo_devedor","valor_iof_parcela"],"properties":{"numero_parcela":{"type":"integer","format":"int32","description":"Número da parcela.","minimum":1,"maximum":99},"dias_compensar":{"type":"integer","format":"int32","description":"Dias a compensar a parcela.","minimum":0,"maximum":999},"data_vencimento":{"type":"string","format":"date","description":"Data de vencimento da parcela. <br> Deve ser única dentre todas as datas de vencimento."},"valor_parcela":{"type":"number","format":"double","description":"Valor da parcela.","maximum":999999999.99,"minimum":0},"valor_juros":{"type":"number","format":"double","description":"Valor de juros da parcela.","maximum":999999.99,"minimum":0},"saldo_devedor":{"type":"number","description":"Saldo devedor após o pagamento da parcela.","maximum":999999999.99,"minimum":0},"valor_tarifa_parcela":{"type":"number","format":"double","description":"Valor da tarifa.","maximum":999999.99,"minimum":0},"capital_amortizado":{"type":"number","format":"double","description":"Capital amortizado.","maximum":999999999.99,"minimum":0},"valor_iof_parcela":{"type":"number","format":"double","description":"Valor do IOF.","maximum":999999.99,"minimum":0},"numero_documento":{"type":"string","maxLength":10,"description":"Número identificador do vencimento."},"nosso_numero":{"type":"string","maxLength":32,"description":"Número do banco."},"banco_nosso_numero":{"type":"string","maxLength":3,"description":"Código do número do banco do documento."},"participante_controle":{"type":"string","maxLength":25,"description":"Controle do participante."}}}}}},"agente":{"type":"object","required":["documento","nome"],"properties":{"documento":{"type":"string","maxLength":14,"description":"Documento do agente."},"nome":{"type":"string","maxLength":255,"description":"Nome do agente."}}},"endereco":{"type":"object","required":["rua","numero","bairro","cidade","estado","cep"],"properties":{"rua":{"type":"string","maxLength":255,"description":"Rua do endereço."},"numero":{"type":"string","maxLength":10,"pattern":"^(\\d+|SN)$","description":"Número do endereço. Quando não houver número, utilizar `SN`. O valor `S/N` não é aceito."},"complemento":{"type":"string","maxLength":255,"description":"Complemento do endereço."},"bairro":{"type":"string","maxLength":255,"description":"Bairro do endereço."},"cidade":{"type":"string","maxLength":30,"description":"Cidade do endereço."},"estado":{"type":"string","maxLength":2,"description":"Estado do endereço."},"cep":{"type":"string","minLength":8,"maxLength":8,"description":"CEP do endereço."}}},"tomador":{"type":"object","required":["documento","nome"],"properties":{"documento":{"type":"string","maxLength":14,"description":"Documento do tomador."},"nome":{"type":"string","maxLength":255,"description":"Nome do tomador."},"email":{"type":"string","maxLength":60,"description":"Email do tomador."},"telefone":{"type":"string","maxLength":15,"description":"Telefone do tomador."},"genero":{"type":"string","description":"Gênero do tomador."},"data_nascimento":{"type":"string","format":"date","description":"Data de nascimento do tomador."}}},"pix":{"type":"object","description":"Não deve ser enviado caso o objeto `conta_bancaria` também esteja preenchido. A API da Giro.Tech somente aceitará um dos campos preenchidos, caso os dois objetos (`pix` + `conta_bancaria`) sejam enviados, a requisição retornará um erro.","required":["chave_pix","tipo_chave_pix"],"properties":{"chave_pix":{"type":"string","maxLength":255,"description":"Chave PIX, deve seguir o formato definido pelo Banco Central."},"tipo_chave_pix":{"type":"string","enum":["EVP","CPF","CNPJ","EMAIL","PHONE"],"description":"Tipo da chave PIX, deve seguir definições do Banco Central."}}},"conta_bancaria":{"type":"object","description":"Não deve ser enviado caso o objeto `pix` também esteja preenchido. A API da Giro.Tech somente aceitará um dos campos preenchidos, caso os dois objetos (`pix` + `conta_bancaria`) sejam enviados, a requisição retornará um erro.","required":["codigo_banco","numero_conta","numero_agencia","tipo"],"properties":{"codigo_banco":{"type":"string","maxLength":3,"description":"Código do banco. Utilizar sempre o código com 3 dígitos."},"numero_conta":{"type":"string","maxLength":20,"description":"Número da conta bancária."},"digito_conta":{"type":"string","maxLength":2,"description":"Dígito da conta bancária."},"numero_agencia":{"type":"string","maxLength":4,"description":"Número da Agência."},"digito_agencia":{"type":"string","maxLength":2,"description":"Dígito da agência bancária."},"tipo":{"type":"string","enum":["CORRENTE","POUPANCA"],"description":"Tipo de conta, Corrente ou Poupança."},"documento_favorecido":{"type":"string","maxLength":14,"description":"Documento do titular da conta."}}},"conveniado":{"description":"Empresa ou Instituição conveniada. Obrigatório quando o produto for CONSIGNADO_PRIVADO, CONSIGNADO_MUNICIPAL ou CONSIGNADO_ESTADUAL. Opcional para os demais produtos.","type":"object","required":["documento","nome"],"properties":{"documento":{"type":"string","maxLength":14,"description":"Documento do conveniado (empresa ou instituição conveniada)."},"nome":{"type":"string","maxLength":255,"description":"Nome do conveniado."}}}}}}}},"responses":{"201":{"description":"Requisição processada com sucesso","content":{"application/json":{"schema":{"type":"object","required":["numero_ccb"],"properties":{"numero_ccb":{"type":"string","maxLength":8,"description":"Número da CCB formalizada."}}}}}},"400":{"description":"Algum dado informado não pôde ser processado. Revise os dados e tente novamente a requisição.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"status":{"type":"integer","format":"int32"},"path":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}}}}}}}}},"401":{"description":"Não autorizado."},"500":{"description":"Erro interno do servidor."}}}}}}
```
