Jump to Content
Home
Guides
API Reference
Changelog
bs2
API Reference
Moon (Dark Mode)
Sun (Light Mode)
Home
Guides
API Reference
Changelog
Listar Usuarios
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
Webhook - Movimentação de Conta
Obter assinatura
get
Criar assinatura
post
Cadastrar certificado
post
Excluir assinatura
delete
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 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
BoletosHibridos
Emissão de boleto híbrido
post
Listagem de boletos híbridos
get
Consulta de boleto híbrido
get
Cancelamento de boleto híbrido
post
Obtenção do PDF do boleto híbrido
get
Solicita uma devolução de valor para boleto hibrido liquidado via Pix.
post
API BOLETO HÍBRIDO - WEBHOOK
Correntistas
Cadastro de webhook por evento
post
Atualização de webhook
put
Remoção de webhook
post
Configuração de certificado
Adição de certificado para o 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 DIRETO
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 DIRETO - WEBHOOK
DevolucaoEfetuada
Endpoint para receber Webhook de Devolução Efetuada
post
FalhaPagamentoAsync
Endpoint para receber Webhook de Falha de pagamento realizado no fluxo assíncrono
post
Pagamento
Endpoint para receber Webhook de Pagamento efetivado no fluxo síncrono
post
PagamentoRetidoParaAnalise
Endpoint para receber Webhook de Pagamento em analise
post
Recebimento
Endpoint para receber Webhook de Recebimento
post
SolicitarComprovante
Endpoint para receber Webhook de comprovante
post
TokenBucketLimit
Endpoint para receber Webhook de limite do TokenBucket
post
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 indiretos - contrato
DevolucaoFinalizadoWebhook
Endpoint para receber Webhook de Devolução Finalizada
post
NotificacaoInfracao
Endpoint para receber Webhook de atualizações na notificação de infração
post
PagamentoFinalizadoWebhook
Endpoint para receber Webhook de Pagamento Finalizado
post
RecebimentoFinalizadoWebhook
Endpoint para receber Webhook de Recebimento Finalizado
post
ReivindicacaoChave
Endpoint para receber Webhook de atualizações na reivindicação de chave
post
RestituicaoFinalizadaWebhook
Endpoint para receber Webhook de Restituição do Pagamento Finalizada
post
SincronismoChaves
Endpoint para receber Webhook de atualizações no sincronismo de chave
post
SolicitacaoDevolucao
Endpoint para receber Webhook de atualizações na solicitacao de devolução (MED)
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
API PIX INDIRETO - PAGAMENTO
ObterRestituicao
Listar restituições
get
Obter restituição
get
Pagamento
Iniciação de pagamento por chave Pix.
post
Iniciação de pagamento por chave pix manual.
post
Iniciação de pagamento open finance.
post
Iniciação de pagamento open finance manual.
post
Iniciação de pagamento por dados manuais.
post
Iniciação de pagamento por QRCode.
post
Iniciação de pagamento por QRCode manual.
post
Confirmação de um pagamento
post
Cancelamento de uma iniciação de pagamento
patch
Obter pagamento
get
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 Portal Admin
Geracao Token de Acesso Paycore
Token de Acesso
post
Lançamento para Parceiros
Inserir Lançamento
post
App Lojista
Somatória de vendas e valores pagos no período
post
Campanha
Adicionar Campanha
post
Campanha SubSeller
Campanha SubSeller
post
Cancelamento de transações
Obter HTML da carta de cancelamento
get
Tabela de Preço
Lista de Tabela de Preço
post
Criar Tabela de Preço
post
Configuração de Conexão
Lista de Configuração de Conexão
post
Criar Configuração de Conexão
post
Perfil Conexão
Lista de Perfil Conexão
post
Criar Perfil Conexão
post
Tabelas de Domínio
Lista de Tipos de Agenda
get
Lista de Tipos de Lançamento
get
Lista de Tipos de Movimento
get
Lista de Tabelas de Preços
get
Lista de Planos de Pagamento
get
Listar status da liquidação
get
Listar tipos de transação
get
Listar CNAE
get
Listar Natureza Jurídica
get
Listar Portes de Empresa
get
Listar bancos
get
Listar CBO
get
Listar Modelo Terminal
get
Listar tipos de descontos de tarifa
get
Listar tipos de isenção de tarifa
get
Listar tipos de tarifa
get
Listar tipos de contas bancárias
get
Listar tipos de Bandeira por Produto
get
Listar tipos de Bandeira por Produto
get
Listar tipos de Operadora de Terminais
get
Listar Bandeiras
get
Status da Transação
get
Categoria da Transação
get
Lista de Tipos de MCC
get
Listar todos os tipos de sócios
get
Listar todos os usuários responsáveis
get
Equipamento
Lista de Equipamento
post
Criar Equipamento
post
Manutenção de Equipamentos
Vincular Equipamento
post
Vincular Equipamento
post
Desvincular Equipamento
post
Desvincular Equipamento
post
Efetuar Troca de Equipamento
post
Efetuar Troca de Equipamento
post
Efetuar Troca de SIM Card (Chip)
post
Efetuar Troca de SIM Card (Chip)
post
Facilitador
Lista de Facilitador
post
Atualizar Facilitador
post
Taxa do Facilitador
Lista de Taxa do Facilitador
post
Criar Taxa do Facilitador
post
Taxa da Loja
Lista de Taxas da Loja
post
Criar Taxa da Loja
post
Personalização de Taxa
Lista de Personalização de Taxa
post
Criar Personalização de Taxa
post
Taxa do Subadquirente
Lista de Taxa do Subadquirente
post
Criar Taxa do Subadquirente
post
Pré Cadastro
Lista de Pré Cadastro
post
Terminais do Pré Cadastro
Lista de terminais do pré cadastro
post
Onboarding
Listar Taxas por CNAE
post
Listar Pré-cadastro Loja
post
Pré-Cadastrar Loja PJ
post
Pré-Cadastrar Loja PF
post
Pré-Cadastrar Taxas Personalizadas
post
Concluir Cadastro
post
Pedido
Lista de Pedido
post
Plano de Pagamento
Lista de Plano de Pagamento
post
Criar Plano de Pagamento
post
Transações
Lista de Transações
post
Lista de Pagamentos
post
Cancelamento de transação
post
Cancelamento de transação por PaymentID
post
Recebe os Domicílios Bancários
Recebe os Domicílios Bancários
post
Recebe Credenciais
Credenciais E-Commerce
post
Recebe os Equipamento
Webhook Equipamento
post
Recebe as Taxas de Lojas
Recebe as Taxas das Lojas
post
Webhook de Personalizações de Taxas de Lojas
Recebe as Taxas das Lojas
post
Recebe os terminais do pré cadastro
Webhook dos cadastros de terminais do pré cadastro
post
Recebe os Pagamentos
Transação
post
Recebe as Agendas
Recebe Agendas
post
Recebe as Lojas
Recebe as Lojas
post
Recebe os Terminais Credenciados
Webhook dos cadastros de terminal
post
Webhook das Relações entre Terminais e Equipamentos
Webhook das relações de terminais com equipamento
post
Simulador de Vendas
Simulador de vendas
post
Agenda de Recebíveis
Extrato Sintético de Recebíveis - Pré Processado e Paginado
post
Extrato Analítico de Recebíveis
post
Extrato Sintético de Recebíveis
post
Gera Valores Pré Transferência
post
Listar Valores Gerados na Pré transferência
post
Efetiva Transferência
post
Gera Valores Pre Antecipacao
post
Listar Valores Gerados Na Pre Antecipacao
post
Efetivar Antecipação
post
Agendas
post
Loja
Lista de Loja
post
Lista de Taxas da Loja
post
Atualizar Taxas e Combos
post
Atualizar Loja
post
Obter lojas por responsável comercial
post
Dados Bancários Subseller
Lista de Dados Bancários Subseller
post
Atualiza Dados Bancários da Loja
post
Sócio da Loja
Lista de Sócio da Loja
post
Atualizar Sócio da Loja
post
Autenticação Transparente para Loja
Autenticação Transparente da Loja
post
Valida Autenticação
post
Terminal
Lista de Terminal
post
Criar Terminal
post
Terminal Equipamento
Lista de Terminal - Equipamento
post
Associa Terminal com Equipamento
post
Modelo
Lista de Modelo
post
Criar Modelo
post
Usuário
Obter Parâmetros usuário
get
Listar Usuarios
post
Lista de Usuarios Responsavel Comercial
get
Listar Usuarios
post
https://example.com/v1/user/list
Utilize esse endpoint para listar os usuários:
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!