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

post

https://api.staging.scd.giro.tech/integration/v3https://api.scd.giro.tech/integration/v3

/operations

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

Autorizações

TokenAuth

AuthorizationstringObrigatório

Parâmetros de cabeçalho

OrigemstringObrigatório

Originador da operação.

Identificador-ProgramastringObrigatório

Identificador do Programa.

Corpo

application/json

numero_ccbstring · máx: 8Obrigatório

Número da CCB que será formalizada.

data_liberacaostring · dateObrigatório

Data da liberação da CCB. Deve ser posterior a data de empréstimo (emprestimo.data_emprestimo). Deve ser anterior a data de vencimento da primeira parcela (emprestimo.data_primeiro_vencimento_parcela).

produtostring · enumObrigatório

Produto utilizado na CCB.

Default: CREDITO_DIREITO_CONSUMIDORValores possíveis:

modalidadestring · enumOpcional

Modalidade da operação. Para CCB com produto CREDITO_DIRETO_CONSUMIDOR, utiliza por padrão a modalidade FINANCIAMENTO. Para CCB com produto CREDITO_PESSOAL, utiliza por padrão a modalidade EMPRESTIMO. Para demais produtos, modalidade é obrigatório.

Valores possíveis:

periodicidadestring · enumOpcional

Periodicidade da cobrança nos vencimentos.

Default: MENSALValores possíveis:

tipo_documentostring · enumOpcional

Tipo do documento para pagamento.

Valores possíveis:

sub_tipo_ativostring · máx: 10Opcional

Subtipo do ativo financeiro para envio de remessa.

Respostas

200

Requisição processada com sucesso

Sem conteúdo

400

Algum dado informado não pôde ser processado. Revise os dados e tente novamente a requisição.

application/json

401

Não autorizado.

500

Erro interno do servidor.

post

/operations

HTTPcURLJavaScriptPython

POST /integration/v3/operations HTTP/1.1
Host: api.staging.scd.giro.tech
Authorization: YOUR_API_KEY
Origem: text
Identificador-Programa: text
Content-Type: application/json
Accept: */*
Content-Length: 1296

{
  "numero_ccb": "112233",
  "data_liberacao": "2024-04-12",
  "produto": "CREDITO_DIREITO_CONSUMIDOR",
  "modalidade": "FINANCIAMENTO",
  "periodicidade": "MENSAL",
  "tipo_documento": "BOLETO",
  "sub_tipo_ativo": "subtipoativo",
  "emprestimo": {
    "data_emprestimo": "2024-04-12",
    "numero_parcelas": 1,
    "taxa_juros_mensal": 5,
    "data_primeiro_vencimento_parcela": "2024-05-12",
    "valor_primeira_parcela": 1000,
    "valor_tarifas": 4,
    "valor_iof": 1.5,
    "valor_desembolso": 100,
    "valor_juros": 1.3,
    "valor_financiado": 1000,
    "valor_emprestimo": 1000,
    "valor_retencao": 50,
    "percentual_retencao": 1.9,
    "custo_efetivo_total_mensal": 1.8,
    "custo_efetivo_total_anual": 10.8,
    "parcelas": [
      {
        "numero_parcela": 1,
        "dias_compensar": 30,
        "data_vencimento": "2024-04-12",
        "valor_parcela": 1000,
        "valor_juros": 5,
        "saldo_devedor": "1000.00",
        "numero_documento": "112233-1",
        "valor_tarifa_parcela": 5,
        "capital_amortizado": 10,
        "valor_iof_parcela": 0.3
      }
    ]
  },
  "agente": {
    "documento": "12345678901234",
    "nome": "Agente Teste"
  },
  "endereco": {
    "cep": "12345678",
    "logradouro": "Rua Teste",
    "numero": "123",
    "complemento": "Sala 1",
    "bairro": "Centro",
    "cidade": "São Paulo",
    "uf": "SP"
  },
  "tomador": {
    "documento": "12345678901",
    "nome": "Tomador Teste",
    "data_nascimento": "1990-01-01",
    "endereco": {
      "cep": "12345678",
      "logradouro": "Rua Teste",
      "numero": "123",
      "complemento": "Sala 1",
      "bairro": "Centro",
      "cidade": "São Paulo",
      "uf": "SP"
    }
  }
}

Sem conteúdo