Documentação para integrações para operações de crédito
Assinaturas Eletrônicas Avançada e Qualificada
Padrão ICP-Brasil
Integração de operações via Web API (RESTful)
Caso necessite de algum suporte sobre esta documentação fale com o seu consultor.
Introdução
Este manual de integração define as especificações e critérios técnicos necessários para integração entre o serviço assinaturas da plataforma Finanblue Digital e qualquer sistema de informação que possibilite o consumo de Web APIs baseados no protocolo HTTP (RESTful).
Através desta integração as empresas poderão automatizar o processo de assinatura eletrônica para documentos e operações.
Integração de operações de crédito
A plataforma da Finanblue Digital provê um serviço Web baseado no protocolo HTTP (RESTful) para integração de operações específicas, inclusive de fomento mercantil, antecipação de recebíveis, financiamentos, empréstimos, transações comerciais e afins.
O serviço esta exposto para consumo através dos Endpoints:
Web API - Restful:
Endpoint URL: https://www.gtidigital.com.br/api/Operacao
Swagger: https://www.gtidigital.com.br/swagger/ui/index#/Operacao
Webservice - SOAP:
Endpoint URL: https://www.gtidigital.com.br/webservices/processoassinatura.asmx
WSDL: https://www.gtidigital.com.br/webservices/processoassinatura.asmx?WSDL
A estrutura de dados esperados para requisição destes serviços está descrita a seguir:
Estrutura dos dados da requisição à API
Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
token | Texto | 64 | Sim | Token de validação gerado pela Finanblue Digital. |
versao | Texto | 8 | Não | Versão do sistema para controle interno pela Finanblue Digital. |
operador | Texto | 32 | Sim | Dados do Responsável pelo envio da operação. |
cnpj | Texto | 18 | Sim | CNPJ da sua empresa cadastrada no portal Assina Digital (com máscara). |
operacao | Objeto | - | Sim | Dados da operação. |
numero | Texto | 64 | Sim | Código alfanumérico para identificação da operação, gerado pela sua aplicação. |
titulo | Texto | 64 | Sim | Informação definida no seu sistema para identificar a finalidade da operação. |
descricao | Texto | 2048 | Sim | Informações para descrever a finalidade da operação. |
observacoes | Texto | 2048 | Não | Observações e comentários pertinentes à operação. |
data | Data | - | Não | Data de criação da operação no seu sistema (formato dd/MM/yyyy). |
notificacao | Booleano | - | Não | Define se os signatários do processo serão notificados por e-mail após a integração da operação. |
valorBruto | Decimal | 18,2 | Não | Valor Bruto (Valor de Face) da operação. |
valorLiquido | Decimal | 18,2 | Não | Valor Líquido da operação. |
valorRecompra | Decimal | 18,2 | Não | Valor de Recompra da operação. |
cedente | Objeto | - | Sim | Seção para definição dos dados do cedente da operação. |
cnpj | Texto | 18 | Sim | CNPJ do Cedente (com máscara). |
razaoSocial | Texto | 256 | Sim | Razão Social do Cedente. |
nomeFantasia | Texto | 256 | Não | Nome Fantasia do Cedente. |
Texto | 150 | Sim | E-mail da empresa Cedente. | |
telefone | Texto | 20 | Não | Telefone da empresa Cedente. |
endereco | Texto | 256 | Não | Endereço da empresa Cedente. |
bairro | Texto | 64 | Não | Bairro da empresa Cedente. |
cidade | Texto | 64 | Não | Cidade da empresa Cedente. |
uf | Texto | 2 | Não | UF da empresa Cedente. |
cep | Texto | 10 | Não | CEP da empresa Cedente. |
inscricaoEstadual | Texto | 25 | Não | Inscrição Estadual da empresa Cedente. |
inscricaoMunicipal | Texto | 25 | Não | Inscrição Municipal da empresa Cedente. |
participantes | Lista | - | Sim | Lista de Participantes da empresa Cedente. |
participante | Objeto | - | Não | Participante da empresa Cedente. |
nome | Texto | 150 | Sim | Nome do participante. |
cpf | Texto | 18 | Sim | CPF ou CNPJ do participante (com máscara). |
Texto | 150 | Sim | E-mail do participante. | |
perfil | Perfis | - | Sim | Perfil do participante. Ver detalhes na seção Lista de Perfis. |
assinaDocumentos | Booleano | - | Sim | Define se o participante assina o documento. |
assinaDuplicatas | Booleano | - | Sim | Define se o participante assina duplicatas/títulos. |
assinaPelaEmpresa | Texto | 1 | Não | Define se o Participante Assina Individualmente ou Em Conjunto. Ver detalhes na seção Tipos de Assinaturas. |
duplicatas | Lista | - | Não | Lista de Duplicatas/Títulos da operação. |
duplicata | Objeto | - | Não | Duplicata/Título da operação. |
idDocumento | Inteiro | - | Sim | Identificador único da Duplicata/Título no seu sistema. |
numero | Texto | 128 | Sim | Identificador alfanumérico da Duplicata/Título. |
tipodoc | Títulos | - | Sim | Tipo de Título. Ver Lista de Títulos. |
dataEmissao | Texto | 10 | Sim | Data de Emissão da Duplicata/Título. |
dataVencimento | Texto | 10 | Sim | Data de Vencimento da Duplicata/Título. |
valorBruto | Decimal | 18,2 | Sim | Valor Bruto da Duplicata/Título. |
valorLiquido | Decimal | 18,2 | Sim | Valor Líquido da Duplicata/Título. |
numeroNfe | Texto | 32 | Não | Número da Nota Fiscal Eletrônica associada à Duplicata/Título. |
numeroNfe | Texto | 4 | Não | Série da Nota Fiscal Eletrônica associada à Duplicata/Título. |
chaveNfe | Texto | 64 | Não | Chave da Nota Fiscal Eletrônica associada à Duplicata/Título. |
sacado | Objeto | - | Sim | Dados do Sacado relacionado à Duplicata/Título. |
cnpjCpf | Texto | 18 | Sim | CNPJ ou CPF do Sacado (com máscara). |
nome | Texto | 256 | Sim | Nome do Sacado. |
Texto | 150 | Não | E-mail do Sacado. | |
telefone | Texto | 20 | Não | Telefone do Sacado. |
endereco | Texto | 256 | Não | Endereço do Sacado. |
bairro | Texto | 64 | Não | Bairro do Sacado. |
cidade | Texto | 64 | Não | Cidade do Sacado. |
uf | Texto | 2 | Não | UF do Sacado. |
cep | Texto | 10 | Não | CEP do Sacado. |
inscricaoEstadual | Texto | 32 | Não | Inscrição Estadual do Sacado. |
inscricaoMunicipal | Texto | 32 | Não | Inscrição Municipal do Sacado. |
arquivo | Objeto | - | Não | Arquivo da duplicata/título que será assinado. |
nome | Texto | 128 | Sim | Nome do arquivo com extensão (Ex: duplicata.pdf). |
conteudo | Base64 | - | Sim | Arquivo convertido para o formato Base64. |
arquivos | Lista | - | Sim | Lista de Arquivos da Operação. |
arquivo | Objeto | - | Sim | Arquivo da Operação. |
nome | Texto | 128 | Sim | Nome do arquivo com extensão (Ex: arquivo.pdf). |
conteudo | Base64 | - | Sim | Arquivo convertido para o formato Base64. |
tipo | Arquivos | - | Sim | Tipo de Arquivo. Ver Lista de tipos de Arquivos. |
assinaturaEmpresa | Boleano | - | Não | Define se o Arquivo pode ser assinado pela Empresa. |
assinaturaCedente | Boleano | - | Não | Define se o Arquivo pode ser assinado pela Cedente. |
Estrutura do JSON de Requisição
{
"token": "string",
"versao": "string",
"operador": "string",
"cnpj": "string",
"operacao": {
"numero": 0,
"titulo": "string",
"descricao": "string",
"observacoes": "string",
"data": "string",
"notificacao": true,
"valorBruto": "string",
"valorLiquido": "string",
"valorRecompra": "string",
"cedente": {
"cnpj": "string",
"razaoSocial": "string",
"nomeFantasia": "string",
"email": "string",
"telefone": "string",
"endereco": "string",
"bairro": "string",
"cidade": "string",
"uf": "string",
"cep": "string",
"inscricaoEstadual": "string",
"inscricaoMunicipal": "string",
"participantes": [
{
"email": "string",
"perfil": 0,
"assinaDocumentos": true,
"assinaPelaEmpresa": "string",
"assinaDuplicatas": true,
"nome": "string",
"cpf": "string",
"procuradores": [
{
"nome": "string",
"cpf": "string",
"email": "string",
"perfil": 0
}
]
}
],
"duplicatas": [
{
"idDocumento": 0,
"numero": "string",
"tipodoc": 0,
"dataEmissao": "string",
"dataVencimento": "string",
"valorBruto": "string",
"valorLiquido": "string",
"numeroNfe": "string",
"serieNfe": "string",
"chaveNfe": "string",
"sacado": {
"cnpjCpf": "string",
"nome": "string",
"email": "string",
"telefone": "string",
"endereco": "string",
"bairro": "string",
"cidade": "string",
"uf": "string",
"cep": "string",
"inscricaoEstadual": "string",
"inscricaoMunicipal": "string"
},
"arquivo": {
"nome": "string",
"conteudo": "string"
}
}
]
},
"arquivos": [
{
"nome": "string",
"conteudo": "string",
"tipo": 0,
"assinaturaEmpresa": true,
"assinaturaCedente": true
}
]
}
}
Dados retornados pela API
Propriedade | Tipo | Tamanho | Descrição |
|---|---|---|---|
sucesso | Boleano | - | Indica se o retorno foi bem sucedido. |
mensagem | Texto | - | Exibe uma mensagem contendo a descrição dos erros. |
processoId | Guid | 36 | Retorna o Id do processo criado na plataforma da Finanblue Digital. |
Estrutura do JSON de resposta
{
"sucesso": true,
"mensagem": "string",
"processoId": "string"
}
Mensagens de Resposta
Mensagem | Sucesso |
|---|---|
Sucesso - Processo de assinaturas enviado com sucesso | true |
Falha - Token incorreto! Favor comunicar-se com administrador do sistema. | false |
Falha - Empresa não possui participantes ativos que assinam e/ou acompanham processos. | false |
Falha - Razão social do Cedente é inválida. | false |
Falha - CNPJ do Cedente é inválido. | false |
Falha - Empresa Cedente não possui participantes. | false |
Falha - Empresa Cedente cadastrada no portal não possui participantes com privilégios de assinante. | false |
Falha - Nome do participante é inválido. CPF: *** | false |
Falha - E-mail do participante é inválido. CPF: *** | false |
Falha - CPF: *** do participante é inválido. | false |
Falha - O Documento *** não está parametrizado para assinaturas de Empresa e/ou Cedente. | false |
Falha - O Conteúdo do arquivo *** é inválido. | false |
Falha - Duplicata *** com valor bruto é inválido. | false |
Falha - Duplicata *** com Sacado inválido. | false |
Falha - Duplicata *** com Data Vencimento inválida. | false |
Falha - Duplicata *** com Data Emissão inválida. | false |
Falha - Duplicata *** com CNPJ/CPF inválido para o Sacado ***. | false |
Falha - Erro interno ao incluir processo de assinaturas! | false |
TIPOS ESPECÍFICOS
Lista de Perfis
Perfil | Chave |
|---|---|
Colaborador | 0 |
Representante | 1 |
Fiador/Avalista | 2 |
Responsável Solidário | 3 |
Procurador | 4 |
Fiel Depositário | 5 |
Presidente | 6 |
Diretor | 7 |
Devedor Solidário | 8 |
Interveniente Garantidor Solidário | 9 |
Testemunha | 10 |
Sócio | 11 |
Inventor Judicial | 12 |
Avalista | 13 |
Endossante | 14 |
Emitente | 15 |
Administrador | 16 |
Representante de Administradora | 30 |
Representante do Sacado | 31 |
Gestor | 41 |
Convidado | 42 |
Validador | 43 |
Representante Legal | 44 |
Procurador/Consultoria | 45 |
Interveniente | 49 |
Investidor | 96 |
Advogado | 97 |
Contador | 98 |
Outro | 99 |
Lista de tipos de Arquivos
Arquivo | Chave | Assinável |
|---|---|---|
Documento Principal | 1 | Sim |
Anexo | 2 | Não |
Carta de Endosso | 3 | Sim |
Contrato | 4 | Sim |
Lista de títulos
Título | Chave |
|---|---|
Duplicata | 1 |
Cheque | 2 |
Nota Promissória | 3 |
Recibo | 4 |
Nota Fiscal | 5 |
Nota de Seguro | 6 |
Título | 7 |
Boleto | 8 |
Outro | 9 |
Duplicata de Serviço | 20 |
Contrato Físico | 21 |
Duplicata Intercompany | 30 |
Duplicata Comissária | 31 |
Cheque Comissária | 32 |
Duplicata Serviço Intercompany | 33 |
Duplicata Serviço Comissária | 34 |
Triplicata | 39 |
Cartão Crédito Subadquirente | 40 |
Cartão Crédito TR | 41 |
Lista de títulos
Tipo Assinatura | Chave | Descrição |
|---|---|---|
Assina em Conjunto (Padrão) | C | A conclusão dos processos depende das assinaturas de todos os participantes definidos como Assina em conjunto na mesma empresa. |
Assina Individualmente | I | As assinaturas dos participantes que Assinam Individualmente podem concluir os processos, dispensando as assinaturas dos demais participantes da empresa. |
Envie uma mensagem
Preencha o formulário para que o nosso time comercial responda o mais rápido possível.