Jump to Content
Home
Guides
API Reference
Changelog
bs2
API Reference
Moon (Dark Mode)
Sun (Light Mode)
Home
Guides
API Reference
Changelog
QR Code - Desativar
Search
All
Pages
Start typing to search…
JUMP TO
API Conta Corrente
Conta Corrente
Obter o saldo da conta
get
Obtém o extrato analítico
get
Obtém o extrato sintético
get
Obter o extrato da conta (Legado)
get
Obter dados da conta baseado na autenticação
get
Transferência
Efetuar transferência para qualquer titularidade sem cadastro do favorecido
post
Consultar os dados da transferência realizada
get
Consultar o status da solicitação de transferência
get
Pagamento
Efetuar pagamento de título de cobrança/arrecadação pelo código de barras ou pela linha digitável
post
Consultar título de cobrança/arrecadação pelo código de barras ou pela linha digitável
get
Consultar o status da solicitação de pagamento
get
Comprovantes
Consultar comprovantes
get
Gerar comprovante em PDF.
get
Token
Token
Access Token/RefreshToken
post
API COBRANÇA
Boletos
Emitir e registro do boleto na CIP.
post
Realizar a busca de boletos gerados a partir de uma série de filtros.
get
Obter detalhe do boleto pelo código de identificação.
get
Obter detalhe do boleto pelo campo nosso numero
get
Obter boleto imprimível pelo código de identificação.
get
Obter boleto imprimível pelo campo nosso número.
get
Solicitar novo vencimento do boleto pelo nosso número.
post
Solicitar novo vencimento do boleto pelo código identificador.
post
Obter detalhe da solicitação de novo vencimento do boleto pelo nosso número do boleto e código da solicitação.
get
Obter detalhe da solicitação de novo vencimento do boleto pelo código identificador do boleto e código da solicitação.
get
Solicitar o cancelamento do boleto pelo código identificador.
post
Solicitar o cancelamento do boleto pelo campo nosso número.
post
Obter detalhe da solicitação de cancelamento do boleto pelo código identificador do boleto e o código da solicitação.
get
Obter detalhe da solicitação de cancelamento do boleto pelo nosso número do boleto e código da solicitação.
get
api boleto híbrido
BoletosHibridos
Registra uma nova solicitação para geração de boleto híbrido.
post
Obtém a relação dos boletos híbridos com base nos filtros informados.
get
Obtém as informações detalhadas para o boleto híbrido com base no identificador fornecido.
get
Envia solicitação de cancelamento para o boleto híbrido existente.
post
Obtém o pdf do boleto hibrido.
get
API Emissão de boleto com faixas de desconto
Emissão de boleto
Emissão de boleto com faixas de desconto
post
API BOLETO HÍBRIDO - WEBHOOK
Correntistas
Adiciona uma nova configuração de webhook para notificar o cliente por tipo de evento.
post
Realiza a atualização de uma configuração de webhook.
put
Realiza a remoção de uma configuração de webhook.
post
Configuração de certificado
Realiza a adição de um certificado para a configuração de webhook.
post
Onboarding PJ
CadastrarClienteParceiro
Pré-cadastro de Clientes
post
CadastrarEmBackground
Cadastro Completo de Clientes
post
ConsultarStatusClienteParceiro
Consulta de Status
get
UploadArquivoParceiro
Upload Arquivo
post
Onboarding CI PF
Onboarding CI PF
Verificar se um cliente está apto a abrir conta no BS2.
get
Cadastra um cliente no BS2.
post
Verificar status da proposta.
get
API Pix
Autenticação
Autenticação - Gerar Access Token
post
Cobrança - Cliente
Cobrança com vencimento - Criar cobrança
put
Cobrança com vencimento - Revisar
patch
Cobrança - Revisar
patch
Cobrança - Criar por Id da transação
put
Cobrança - Consultar por TxId
get
Cobrança - Criar cobrança
post
Cobrança - Consultar lista de cobranças
get
Devoluções - Cliente
Devolução - Solicitar
put
Devolução - Consultar
get
Recebimento - Consultar por e2eid
get
Recebimento - Consultar
get
Pagamentos - Cliente
Pagamento - Consultar
get
Pagamento - Consultar - PagamentoId
get
Pagamento - Consultar - EndToEndId
get
Pagamento - Iniciar - QrCodes
post
Pagamento - Iniciar - Chaves
post
Pagamento - Iniciar - Manual
post
Pagamento - Confirmar
post
Pagamento - Cancelar
patch
Pagamento - Solicitar pagamento
post
Pagamento - Consultar solicitacao por SolicitacaoId
get
Pagamentos - Consultar - Restituições
get
Pagamentos - Consultar - Restituição
get
QR Code - Cliente
QR Code - Consultar
get
Qr Code - Estático - Criar
post
Qr Code - Dinâmico - Criar
post
Qr Code - Dinâmico com Vencimento - Criar
post
Qr Code - Dinâmico com Vencimento - Criar
post
QR Code - Desativar
delete
QR Code - Dinâmico com Vencimento - Alterar.
put
QR Code - Dinâmico - Alterar.
put
Recebimentos - Cliente
Recebimento - Consultar por parâmetros
get
Recebimento - Consultar por EndToEndId
get
Recebimento - Consultar por RecebimentoId
get
Recebimento - Consultar por QrCodeId
get
Webhook - Cliente
Webhook - Obter
get
Webhook - Criar/Atualizar
put
Webhook - Certificado - Inclusão/Atualização
put
Webhook - Certificado - Inclusão/Atualização
put
Webhook - Excluir
delete
TokenBucket - Cliente
TokenBucket - Obter
get
Comprovantes
Comprovantes - Solicitar Comprovantes
post
API PIX INDIRETO - PAGAMENTOS
ObterRestituicao
Listar restituições
get
Obter restituição
get
Pagamento
Iniciação de pagamento por chave Pix
post
Iniciação de pagamento por dados manuais
post
Iniciação de pagamento por QRCode
post
Confirmação de um pagamento
post
Cancelamento de uma iniciação de pagamento
patch
Obter pagamento
get
API PIX INDIRETO - QR CODE
QrCode
Listar QRCodes/cobranças
get
Criar Qr Code Estático
post
Criar Qr Code Dinâmico
post
Criar Qr Code Dinâmico com Vencimento
post
Desativar um Qr Code
delete
Alterar informações de um Qr Code com vencimento
put
Alterar informações de um Qr Code
put
SPIQrCode
Recupera um documento de cobrança a partir de um GUID
get
Recupera um documento de cobrança com vencimento a partir de um GUID
get
API PIX INDIRETO - RECEBIMENTOS
ObterDevolucao
Listar devoluções
get
Obter devolução
get
SolicitarDevolucao
Solicitar uma devolução
post
ObterRecebimento
Obter recebimento
get
API PIX INDIRETO - WEBHOOKS
ParticipantesIndiretos
Permite listar as configurações de rotas para recebimento de webhooks.
get
Permite cadastrar configurações de rotas para recebimento de webhooks de pagamento, recebimento, devolução e restituição.
post
Permite alterar uma configuração de rota para recebimento de webhooks.
put
Permite excluir uma configuração de webhook.
delete
Permite incluir um certificado X.509
put
API PIX INDIRETO - DICT
AntiFraude
Cria uma marcação de fraude.
post
Obtém detalhes de uma marcação de fraude.
get
Cancela uma marcação de fraude.
post
Obtém dados estatísticos de um usuário final (liquidações, fraudes reportadas e fraudes confirmadas)
get
Obtém dados estatísticos relacionados a chaves registradas
get
Chave
Consulta a existência de um conjunto de chaves no diretório de identificadores.
post
Devolucao
Cria uma Solicitação de devolução.
post
Obtém lista de solicitações de devolução em que o participante é parte.
get
Obtém detalhes de uma solicitação de devolução.
get
Cancela a Solicitação de devolução. Só pode ser realizada pelo participante que criou a solicitação.
post
Fecha a solicitação de devolução.
post
Diretorio
Obtém um vínculo contendo os detalhes de conta transacional associados a uma chave de endereçamento.
get
Atualiza um vínculo.
put
Cria um novo vínculo de chave com uma conta transacional.
post
Remove um vínculo de chave com conta.
post
NotificacoesInfracao
Cria uma notificação de infração.
post
Obtém lista de notificações de infração em que o participante é parte.
get
Obtém detalhes de uma notificação de infração.
get
Notifica recebimento da notificação pelo participante contraparte.
post
Cancela a notificação de infração.
post
Fecha a notificação de infração.
post
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
Cria uma verificação de sincronismo para um participante e tipo de chave.
post
Cria um arquivo contendo todos os CIDs de um determinado tipo de chave do participante.
post
Obtém detalhes do arquivo de CIDs requisitado.
get
Lista os eventos de CIDs para um tipo de chave do participante, ordenados de forma crescente por `Timestamp`.
get
Obtém detalhes de um vínculo ativo identificado pelo CID.
get
Reivindicacao
Cria uma nova reivindicação.
post
Obtém uma lista de reivindicações, ordenada de forma crescente pelo campo ModificadaDepoisDe, de acordo com os filtros passados.
get
Obtém detalhes de uma reivindicação.
get
Notifica recebimento pelo participante doador de reivindicação com status OPEN.
post
Confirma a operação de reivindicação.
post
Cancela uma reivindicação.
post
Conclui reivindicação pelo reivindicador.
post
API PIX INDIRETO - CONTRATO
DevolucaoFinalizadoWebhook
Endpoint para receber Webhook de Devolução Finalizada
post
PagamentoFinalizadoWebhook
Endpoint para receber Webhook de Pagamento Finalizado
post
RecebimentoFinalizadoWebhook
Endpoint para receber Webhook de Recebimento Finalizado
post
RestituicaoFinalizadaWebhook
Endpoint para receber Webhook de Restituição do Pagamento Finalizada
post
ValidacaoRecebimento
Webhook validação Recebimento - Cliente
post
ValidacaoRecebimentoCanalSecundario
Webhook validação Recebimento - Cliente
post
ValidacaoRestituicaoWebhook
Validação Síncrona da(s) Restituição(s) (Pagamento Restituido)
post
QR Code - Desativar
delete
https://example.com/pix/direto/forintegration/v1/qrcodes/
{qrCodeId}
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!