Jump to Content
Home
Documentação
API Endpoints
Log In
API Endpoints
Log In
Home
Documentação
API Endpoints
Buscar um contrato
Search
All
Pages
Start typing to search…
JUMP TO
AUTENTICAÇÃO
Token
Token e Refresh Token
post
Empresas
Listar empresas
get
Selecionar empresas
post
FORNECEDOR
Dados Bancários
Buscar dados bancários
get
Atualizar dados bancários
put
Excluir dados bancários
delete
Listar dados bancários
get
Cadastrar dados bancários
post
Resumo dos Dados Bancários do Estabelecimento Comercial
get
Solicitações
Atualizar dados bancários do detalhe da solicitação
put
Simular operação
post
Buscar uma solicitação
get
Solicitar Antecipação
post
Listar solicitações
get
Listar cedentes da solicitação
get
Listar recebíveis da solicitação
get
Listar dados bancários do detalhe da solicitação
get
Acompanhar processo da operação
get
Operação Automática
Listar Configurações
get
Criar Configuração
post
Excluir Configuração
delete
Listagem de Taxas
get
Mercado
Horário de funcionamento para operações
get
Documentos
Download de Arquivo
get
Operações
Listar operações
get
Buscar uma operação
get
Listar itens de uma operação
get
Buscar um item de uma operação
get
Dashboards
Listar Dashboards
get
Dashboard de limite aprovado
get
Dashboard de Conciliação
get
Dashboard de Valores disponíveis
get
Dashboard de credenciadoras disponíveis
get
Dashboard de Valores em Carteira e Elegível por Credenciadora
get
Assinaturas
Listar assinaturas
get
Listar uma assinatura
get
Download do Termo de cessão
get
Download do Termo de adesão
get
Conciliação
Listagem das Unidades de Recebíveis conciliadas.
get
Detalhe da Unidade de Recebível conciliada.
get
Recomposição
Listagem das Unidades de Recebíveis recompostas.
get
Detalhe da Unidade de Recebível recomposta.
get
Relatórios
Criar relatório
post
Buscar um relatório
get
Download de relatório
get
Processamento de relatórios
Acompanhar processo assíncrono
get
Histórico de Eventos
Listar eventos
get
Buscar evento por id
get
Detalhe do evento recebido
get
Cadastro de Imagem
Detalhe
get
Atualizar
put
Cadastrar
post
Cadastro Telefônico
Detalhe
get
Atualizar
put
Cadastrar
post
Cadastro de Representantes Legais
Detalhe
get
Atualizar
put
Cadastrar
post
Cadastro de Documentos
Detalhe
get
Atualizar
put
Cadastrar
post
Cadastro de Empresa
Detalhe
get
Atualizar
put
Cadastrar
post
Cadastro de Endereço
Detalhe
get
Atualizar
put
Cadastrar
post
Cadastro de Dados Bancários
Detalhe
get
Cadastrar
post
Upload de Documento
Download
get
Upload
post
Excluir
delete
Upload Documento do Responsável Legal
Download
get
Upload
post
Excluir
delete
Etapas do Cadastro
Detalhe
get
Excluir
delete
INVESTIDOR
Solicitações por Atacado
Atualizar dados bancários do detalhe da solicitação
put
Simular operação
post
Simular operação
post
Buscar uma solicitação
get
Solicitar Antecipação
post
Estabelecimentos Comerciais com Recebíveis Disponíveis
get
Estabelecimentos Comerciais do CNPJ Raiz
get
Download da Prévia do Termo de Cessão
get
Listar cedentes da solicitação
get
Listar recebíveis da solicitação
get
Listar dados bancários do detalhe da solicitação
get
Acompanhar processo da operação
get
Dono do Programa
Buscar taxa de rebate por Estabelecimento Comercial
get
Atualizar taxa de rebate por Estabelecimento Comercial
put
Operação Automática Atacado
Listar Configurações
get
Criar Configuração
post
Excluir Configuração
delete
Operações
Reprovar operação
post
Aprovar operação
post
Reprovar todos os itens operação
post
Aprovar todos os itens da operação
post
Baixa de contratos em lote
post
Listar contratos
get
Buscar um contrato
get
Buscar itens de um contrato
get
Buscar um item de um contrato
get
Processamento de registros do Agente Financeiro.
Este endpoint permite obter informações sobre os processos referente aos registros do Agente Financeiro
get
Este endpoint permite obter informações sobre o processo referente ao registro do Agente Financeiro
get
Este endpoint permite obter informações sobre os itens dos processos referente aos registros do Agente Financeiro
get
Este endpoint permite obter informações sobre o item do processo referente ao registro do Agente Financeiro
get
Mercado
Horário de funcionamento para operações
get
Contestações do Agente Financeiro
Listar Contestações do Agente Financeiro
get
Buscar Contestação do Agente Financeiro
get
Dashboards Atacado do Estabelecimento Comercial
Listar Dashboards
get
Listar informações consolidadas do Estabelecimento Comercial do Atacado para um único CNPJ.
get
Dashboards Atacado
Listar Dashboards
get
Listar informações consolidadas do Estabelecimento Comercial do Atacado
get
Operações do Investidor
Listagem das Operações do Investidor
get
Dashboards Investidor
Listar Dashboards
get
Dashboard de Valores Diários Acumulados por Status
get
Dashboard de Indicadores Médios dos Contratos
get
Dashboard de Conciliação
get
Dashboard do Limite Disponível das Credenciadoras
get
Dashboard de Total do Limite Disponível das Credenciadoras
get
Dashboards da Situação dos Estabelecimentos Comerciais
get
Assinantes do Agente Financeiro
Buscar configuração
get
Atualizar configuração
put
Criar configuração
post
Excluir configuração
delete
Assinaturas
Reprovar termo de cessão
post
Assinar termo de cessão
post
Reprovar termos da operação
post
Assinar termos da operação
post
Listar assinaturas
get
Listar uma assinatura
get
Download do Termo de cessão
get
Download do Termo de adesão
get
WebHooks enviados
Reenvio de webhooks
put
Listar WebHooks enviados
get
Configuração de WebHook
Buscar uma configuração de WebHook
get
Atualizar configuração de WebHook
put
Excluir configuração de WebHook
delete
Listar as configurações de WebHook
get
Cadastrar configuração de WebHook
post
Recomposições
Detalhe da Configuração de Recomposições.
get
Atualizar Configuração de Recomposições.
put
Cadastrar Configuração de Recomposições.
post
Estabelecimentos Comerciais Bloqueados para Recomposição
Desbloquear Estabelecimento Comercial para Recomposição
post
Bloquear Estabelecimento Comercial para Recomposição
post
Listagem de Estabelecimentos Comerciais bloqueados para Recomposição.
get
Detalhe de Estabelecimento Comercial Bloqueado para Recomposição.
get
Steps do Processamento
Steps
get
Processamento
Detalhe do processamento
get
Conciliação
Listagem das Unidades de Recebíveis conciliadas.
get
Detalhe da Unidade de Recebível conciliada.
get
Recomposição
Listagem das Unidades de Recebíveis recompostas.
get
Detalhe da Unidade de Recebível recomposta.
get
Relatórios
Criar relatório
post
Buscar um relatório
get
Download de relatório
get
Processamento de relatórios
Acompanhar processo assíncrono
get
Configuração de Limite
Buscar limite de um Estabelecimento Comercial
get
Atualizar limite de um Estabelecimento Comercial
put
Configurar limite por Estabelecimento Comercial
post
Dados Bancários
Buscar conta bancária
get
Atualizar conta bancária
put
Excluir conta bancária
delete
Listar contas bancárias
get
Cadastrar conta bancária
post
Configuração de Limite por Credenciadora
Buscar limite de uma Credenciadora
get
Atualizar limite de uma Credenciadora
put
Configurar limite por Credenciadora
post
Listar limites de Credenciadora
get
Planilha de Taxas
Upload
post
Download
get
Taxas
Listar taxas de um estabelecimento comercial
get
Cadastrar taxas para um estabelecimento comercial
post
Configuração de Operação Automática
Reprovar Configuração de Operação Automática
post
Aprovar Configuração de Operação Automática
post
Listar Configurações de Operações Automáticas
get
Buscar Configuração de Operação Automática
get
Estabelecimento Comercial
Reprovar Estabelecimento Comercial
post
Aprovar Estabelecimento Comercial
post
Listar Estabelecimentos Comerciais
get
Atualizar Todos os Estabelecimentos Comerciais
patch
Buscar um Estabelecimento Comercial
get
Download da documentação do Estabelecimento Comercial
get
Detalhes do Estabelecimento Comercial
get
Processamento de Taxas
Listar Processos
get
Visualizar Processamento
get
Dados Bancários do Estabelecimento Comercial
Listar dados bancários de um Estabelecimento Comercial
get
Buscar dados bancários de um Estabelecimento Comercial
get
Gestão de Opt-Ins
Retentar Opt-In
put
Cadastrar Opt-Ins em Lote
post
Realizar Opt-Outs em Lote
post
Listar Opt-Ins
get
Buscar um Opt-In
get
Processamento de opt-ins
Este endpoint permite obter informações sobre os processos referente aos opt-ins
get
Este endpoint permite obter informações sobre o processo referente aos opt-ins
get
Este endpoint permite obter informações sobre os itens dos processos referente aos opt-ins
get
Este endpoint permite obter informações sobre o item do processo de opt-in
get
Cadastro Telefônico
Buscar os Dados Telefônicos.
get
Atualizar Dados Telefônicos.
put
Cadastrar Dados Telefônicos.
post
Cadastro de Representantes Legais
Buscar os Representantes Legais.
get
Atualizar Representantes Legais.
put
Cadastrar Representantes Legais.
post
Cadastro de Documentos
Buscar os Documentos.
get
Atualizar Documentos.
put
Cadastrar Documentos.
post
Cadastro de Empresa
Buscar os Dados de uma Empresa.
get
Atualizar uma Empresa.
put
Cadastrar uma Empresa.
post
Cadastro de Endereço
Buscar os Dados de Endereço.
get
Atualizar um Endereço.
put
Cadastrar um Endereço.
post
Upload de Documentos
Download
get
Upload
post
Delete
delete
Agente Financeiro
Buscar um Agente Financeiro.
get
Etapas do Cadastro
Buscar Etapas.
get
Histórico de Eventos
Listar eventos
get
Buscar evento por id
get
Detalhe do evento recebido
get
Buscar um contrato
get
https://gateway.hmg.spike.cash/v1/buyers/
{governmentId}
/contracts/
{contractId}
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
https://gateway.hmg.spike.cash
/v1/buyers/{governmentId}/contracts/{contractId}
RESPONSE
Click
Try It!
to start a request and see the response here!