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

Token

Token
- Access Token/RefreshTokenpost

API COBRANÇA

Boletos

api boleto híbrido

BoletosHibridos

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 - WEBHOOK

Correntistas
Configuração de certificado
- Realiza a adição de um certificado para a configuração de webhook.post

Onboarding PJ

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

Onboarding CI PF

Onboarding CI PF

API Pix

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 INDIRETO - PAGAMENTOS

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 INDIRETO - WEBHOOKS

ParticipantesIndiretos

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 PIX INDIRETO - CONTRATO

DevolucaoFinalizadoWebhook
- Endpoint para receber Webhook de Devolução Finalizadapost
PagamentoFinalizadoWebhook
- Endpoint para receber Webhook de Pagamento Finalizadopost
RecebimentoFinalizadoWebhook
- Endpoint para receber Webhook de Recebimento Finalizadopost
RestituicaoFinalizadaWebhook
- Endpoint para receber Webhook de Restituição do Pagamento Finalizadapost
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

Recebimento - Consultar por RecebimentoId

get https://example.com/pix/direto/forintegration/v1/recebimentos/{recebimentoId}

Language

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