Jump to Content

Home Guides API Reference Changelog

API Reference

Home Guides API Reference Changelog

All

Pages

Start typing to search…

API Conta Corrente

Conta Corrente
Transferência
Pagamento
Comprovantes
- Consultar comprovantesget
- Gerar comprovante em PDF.get
Webhook - Movimentação de Conta

Token

Token
- Access Token/RefreshTokenpost

API COBRANÇA

Boletos

API Emissão de boleto com faixas de desconto

Emissão de boleto
- Emissão de boleto com faixas de descontopost

api boleto híbrido

BoletosHibridos

API BOLETO HÍBRIDO - WEBHOOK

Correntistas
Configuração de certificado
- Adição de certificado para o webhookpost

Onboarding PJ

CadastrarClienteParceiro
- Pré-cadastro de Clientespost
CadastrarEmBackground
- Cadastro Completo de Clientespost
ConsultarStatusClienteParceiro
- Consulta de Statusget
UploadArquivoParceiro
- Upload Arquivopost

onboarding CI PF

Clientes

API Pix DIRETO

Autenticação
- Autenticação - Gerar Access Tokenpost
Cobrança - Cliente
Devoluções - Cliente
Pagamentos - Cliente
QR Code - Cliente
Recebimentos - Cliente
Webhook - Cliente
TokenBucket - Cliente
- TokenBucket - Obterget
Comprovantes
- Comprovantes - Solicitar Comprovantespost

API PIX DIRETO - WEBHOOK

DevolucaoEfetuada
- Endpoint para receber Webhook de Devolução Efetuadapost
FalhaPagamentoAsync
- Endpoint para receber Webhook de Falha de pagamento realizado no fluxo assíncronopost
Pagamento
- Endpoint para receber Webhook de Pagamento efetivado no fluxo síncronopost
PagamentoRetidoParaAnalise
- Endpoint para receber Webhook de Pagamento em analisepost
Recebimento
- Endpoint para receber Webhook de Recebimentopost
SolicitarComprovante
- Endpoint para receber Webhook de comprovantepost
TokenBucketLimit
- Endpoint para receber Webhook de limite do TokenBucketpost

API PIX INDIRETO - PAGAMENTO

ObterRestituicao
- Listar restituiçõesget
- Obter restituiçãoget
Pagamento

API PIX INDIRETO - QR CODE

QrCode
SPIQrCode
- Recupera um documento de cobrança a partir de um GUIDget
- Recupera um documento de cobrança com vencimento a partir de um GUIDget

API PIX INDIRETO - RECEBIMENTOS

ObterDevolucao
- Listar devoluçõesget
- Obter devoluçãoget
SolicitarDevolucao
- Solicitar uma devoluçãopost
ObterRecebimento
- Obter recebimentoget

api pix indiretos - contrato

DevolucaoFinalizadoWebhook
- Endpoint para receber Webhook de Devolução Finalizadapost
NotificacaoInfracao
- Endpoint para receber Webhook de atualizações na notificação de infraçãopost
PagamentoFinalizadoWebhook
- Endpoint para receber Webhook de Pagamento Finalizadopost
RecebimentoFinalizadoWebhook
- Endpoint para receber Webhook de Recebimento Finalizadopost
ReivindicacaoChave
- Endpoint para receber Webhook de atualizações na reivindicação de chavepost
RestituicaoFinalizadaWebhook
- Endpoint para receber Webhook de Restituição do Pagamento Finalizadapost
SincronismoChaves
- Endpoint para receber Webhook de atualizações no sincronismo de chavepost
SolicitacaoDevolucao
- Endpoint para receber Webhook de atualizações na solicitacao de devolução (MED)post
ValidacaoRecebimento
- Webhook validação Recebimento - Clientepost
ValidacaoRecebimentoCanalSecundario
- Webhook validação Recebimento - Clientepost
ValidacaoRestituicaoWebhook
- Validação Síncrona da(s) Restituição(s) (Pagamento Restituido)post

API PIX INDIRETO - DICT

AntiFraude
Chave
- Consulta a existência de um conjunto de chaves no diretório de identificadores.post
Devolucao
Diretorio
NotificacoesInfracao
PoliticaLimitacao
- Obtém a lista de políticas de limitação de acesso ao DICT para o participante requisitante.get
- Obtém o estado atual do balde do participante para a política informada.get
Reconciliacao
Reivindicacao

API Portal Admin

Geracao Token de Acesso Paycore
- Token de Acessopost
Lançamento para Parceiros
- Inserir Lançamentopost
App Lojista
- Somatória de vendas e valores pagos no períodopost
Campanha
- Adicionar Campanhapost
Campanha SubSeller
- Campanha SubSellerpost
Cancelamento de transações
- Obter HTML da carta de cancelamentoget
Tabela de Preço
- Lista de Tabela de Preçopost
- Criar Tabela de Preçopost
Configuração de Conexão
- Lista de Configuração de Conexãopost
- Criar Configuração de Conexãopost
Perfil Conexão
- Lista de Perfil Conexãopost
- Criar Perfil Conexãopost
Tabelas de Domínio
Equipamento
- Lista de Equipamentopost
- Criar Equipamentopost
Manutenção de Equipamentos
Facilitador
- Lista de Facilitadorpost
- Atualizar Facilitadorpost
Taxa do Facilitador
- Lista de Taxa do Facilitadorpost
- Criar Taxa do Facilitadorpost
Taxa da Loja
- Lista de Taxas da Lojapost
- Criar Taxa da Lojapost
Personalização de Taxa
- Lista de Personalização de Taxapost
- Criar Personalização de Taxapost
Taxa do Subadquirente
- Lista de Taxa do Subadquirentepost
- Criar Taxa do Subadquirentepost
Pré Cadastro
- Lista de Pré Cadastropost
Terminais do Pré Cadastro
- Lista de terminais do pré cadastropost
Onboarding
Pedido
- Lista de Pedidopost
Plano de Pagamento
- Lista de Plano de Pagamentopost
- Criar Plano de Pagamentopost
Transações
Recebe os Domicílios Bancários
- Recebe os Domicílios Bancários post
Recebe Credenciais
- Credenciais E-Commercepost
Recebe os Equipamento
- Webhook Equipamentopost
Recebe as Taxas de Lojas
- Recebe as Taxas das Lojaspost
Webhook de Personalizações de Taxas de Lojas
- Recebe as Taxas das Lojaspost
Recebe os terminais do pré cadastro
- Webhook dos cadastros de terminais do pré cadastropost
Recebe os Pagamentos
- Transaçãopost
Recebe as Agendas
- Recebe Agendas post
Recebe as Lojas
- Recebe as Lojaspost
Recebe os Terminais Credenciados
- Webhook dos cadastros de terminalpost
Webhook das Relações entre Terminais e Equipamentos
- Webhook das relações de terminais com equipamentopost
Simulador de Vendas
- Simulador de vendaspost
Agenda de Recebíveis
Loja
Dados Bancários Subseller
- Lista de Dados Bancários Subsellerpost
- Atualiza Dados Bancários da Lojapost
Sócio da Loja
- Lista de Sócio da Lojapost
- Atualizar Sócio da Lojapost
Autenticação Transparente para Loja
- Autenticação Transparente da Lojapost
- Valida Autenticaçãopost
Terminal
- Lista de Terminalpost
- Criar Terminalpost
Terminal Equipamento
- Lista de Terminal - Equipamentopost
- Associa Terminal com Equipamentopost
Modelo
- Lista de Modelopost
- Criar Modelopost
Usuário

Obter detalhe do boleto pelo campo nosso numero

get

https://example.com/pj/forintegration/cobranca/v1/boletos/{nossoNumero}

Language

Click Try It! to start a request and see the response here!