Skip to main content

BS2

Gerencie suas contas e pagamentos com o BS2.

BS2 Logo

Authentication​

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use​

Using the Smart Chat​

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor​

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions​

This connector provides 282 actions:

ActionPurposeParameters
boleto_hibrido_webhook/post_pj_apibanking_forintegration_v1_contexto_correntistas_webhookCadastra uma nova configuração de webhook para notificar sistemas externos sobre eventos específicos relacionados a boletos híbridos. Permite definir URL, tipo de evento, tentativas de reenvio e autenticação.data: {
. url (string)
. quantidadeRetentativas (integer)
. tipoEvento (string)
. intervaloEntreRetentativas (integer)
. usuarioCriacao (object)
. autenticacao (object)
} (object) required
boleto_hibrido_webhook/put_pj_apibanking_forintegration_v1_contexto_correntistas_webhook_by_configuracao_idAtualiza os dados de uma configuração de webhook já cadastrada, permitindo alterar URL, tentativas, intervalo, autenticação e dados do usuário responsável pela alteração.configuracaoId (string)
data: {
. url (string)
. quantidadeRetentativas (integer)
. intervaloEntreRetentativas (integer)
. usuarioAlteracao (object)
. autenticacao (object)
. configuracaoId (string)
} (object) required
boleto_hibrido_webhook/post_pj_apibanking_forintegration_v1_contexto_correntistas_webhook_by_configuracao_id_removerRemove uma configuração de webhook cadastrada, desabilitando notificações automáticas para o evento correspondente. Permite registrar o usuário responsável pela remoção.configuracaoId (string)
data: {
. usuarioRemocao (object)
. configuracaoId (string)
} (object) required
boleto_hibrido_webhook/post_pj_apibanking_forintegration_v1_contexto_correntistas_webhook_certificadoAdiciona um certificado digital à configuração de webhook, garantindo segurança e autenticação nas notificações enviadas para sistemas externos.data: {
. ContentType (string)
. ContentDisposition (string)
. Headers (object)
. Length (string)
. Name (string)
. FileName (string)
} (object) required
boleto_hibrido/post_pj_apibanking_forintegration_v1_boletos_hibridosCria um novo boleto híbrido que combina cobrança tradicional via código de barras com pagamento instantâneo via PIX. Este endpoint permite gerar um documento único que oferece ao pagador flexibilidade na escolha do método de pagamento, aumentando as chances de conversão e melhorando a experiência do cliente.data: {
. dadosCobranca (object)
. dadosPagador (object)
} (object) required
boleto_hibrido/get_pj_apibanking_forintegration_v1_boletos_hibridosConsulta e filtra boletos híbridos existentes com opções avançadas de busca. Permite filtrar por situação, período, documento do pagador e número identificador, facilitando a gestão e controle das cobranças emitidas.Situacoes (array)
DataInicio (string)
DataFim (string)
DocumentoPagador (string)
SeuNumero (string)
PaginaAtual (integer)
QuantidadePorPagina (integer)
boleto_hibrido/get_pj_apibanking_forintegration_v1_boletos_hibridos_by_idObtém informações detalhadas de um boleto híbrido específico, incluindo status atual, dados do pagador, valor, datas de vencimento e histórico de transações. Essencial para acompanhar o ciclo de vida da cobrança.id (string)
boleto_hibrido/post_pj_apibanking_forintegration_v1_boletos_hibridos_by_idCancela um boleto híbrido não pago, impedindo futuras tentativas de pagamento. Útil para casos de cancelamento de compra, erro na emissão ou mudança nas condições da cobrança antes do pagamento.id (string)
data: {
. id (string)
} (object) required
boleto_hibrido/get_pj_apibanking_forintegration_v1_boletos_hibridos_by_id_pdfGera e retorna o arquivo PDF formatado do boleto híbrido, pronto para download, impressão ou envio ao cliente. O documento inclui código de barras, QR Code PIX e todas as informações necessárias para pagamento.id (string)
boleto_hibrido/post_pj_apibanking_forintegration_v1_boletos_hibridos_by_id_devolucaoProcessa solicitação de estorno parcial ou total para boletos híbridos que foram pagos via PIX. Permite devolver valores ao cliente em casos de cancelamento pós-pagamento, pagamento em duplicidade ou ajustes comerciais.id (string)
data: {
. valor (number)
. id (string)
} (object) required
cobranca/post_pj_forintegration_cobranca_v2_boletos_simplificadoCria e registra boleto bancário simplificado na CIP Câmara Interbancária de Pagamentos, permitindo cobrança via código de barras com processamento automatizado. Ideal para cobranças recorrentes e em larga escala.data: {
. seuNumero (string)
. beneficiarioFinal (object)
. cliente (object)
. sacadorAvalista (object)
. vencimento (string)
. valor (number)
. canal (string)
. multa (object)
. desconto (object)
. mensagem (object)
. aceite (boolean)
. especie (string)
. dataLimitePagamento (string)
} (object) required
cobranca/get_pj_forintegration_cobranca_v1_boletosConsulta boletos com filtros avançados por período, status, valor e dados do pagador. Permite paginação para gerenciar grandes volumes de cobranças. Essencial para relatórios financeiros e acompanhamento de recebíveis.inicio (string)
limite (string)
emissaoInicial (string)
emissaoFinal (string)
vencimentoInicial (string)
vencimentoFinal (string)
status (integer)
documentoSacado (string)
canal (string)
seuNumero (string)
nossoNumero (string)
cobranca/get_pj_forintegration_cobranca_v1_boletos_by_boleto_idCódigo do boleto. Exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxboletoId (string)
cobranca/get_pj_forintegration_cobranca_v1_boletos_by_nosso_numeroNosso número do boleto. Exemplo: 123456789nossoNumero (string)
cobranca/get_pj_forintegration_cobranca_v1_boletos_by_boleto_id_imprimivelCódigo do boleto. Exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxboletoId (string)
cobranca/get_pj_forintegration_cobranca_v1_boletos_by_nosso_numero_imprimivelNosso número do boleto. Exemplo: 123456789nossoNumero (string)
cobranca/post_pj_forintegration_cobranca_v1_boletos_by_nosso_numero_solicitacoes_novosvencimentosNosso número do boleto.nossoNumero (string)
data: {
. vencimento (string)
. nossoNumero (string)
} (object) required
cobranca/post_pj_forintegration_cobranca_v1_boletos_by_boleto_id_solicitacoes_novosvencimentosThe boleto identifier.boletoId (string)
data: {
. vencimento (string)
. boletoId (string)
} (object) required
cobranca/get_pj_forintegration_cobranca_v1_boletos_by_nosso_numero_solicitacoes_novosvencimentos_by_solicitacao_idNosso número.nossoNumero (string)
solicitacaoId (string)
cobranca/get_pj_forintegration_cobranca_v1_boletos_by_boleto_id_solicitacoes_novosvencimentos_by_solicitacao_idThe boleto identifier.boletoId (string)
solicitacaoId (string)
cobranca/post_pj_forintegration_cobranca_v1_boletos_by_boleto_id_solicitacoes_cancelamentosCódigo do boleto. exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxboletoId (string)
data: {
. justificativa (string)
. boletoId (string)
} (object) required
cobranca/post_pj_forintegration_cobranca_v1_boletos_by_nosso_numero_solicitacoes_cancelamentosNosso número do boleto. Exemplo: 123456789nossoNumero (string)
data: {
. justificativa (string)
. nossoNumero (string)
} (object) required
cobranca/get_pj_forintegration_cobranca_v1_boletos_by_boleto_id_solicitacoes_cancelamentos_by_solicitacao_idCódigo do boleto. Exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxboletoId (string)
solicitacaoId (string)
cobranca/get_pj_forintegration_cobranca_v1_boletos_by_nosso_numero_solicitacoes_cancelamentos_by_solicitacao_idCampo nosso número do boleto. Exemplo: 123456789nossoNumero (string)
solicitacaoId (string)
conta_corrente/get_pj_apibanking_forintegration_v1_contascorrentes_saldoConsulta saldo atual e disponível da conta corrente em tempo real. Retorna informações sobre limite disponível, saldo bloqueado e data/hora da última atualização. Essencial para controle de fluxo de caixa.No parameters
conta_corrente/get_pj_apibanking_forintegration_v1_contascorrentes_extrato_analiticoRecupera extrato detalhado da conta corrente com todas as movimentações no período especificado. Permite filtros por tipo de operação crédito/débito e códigos específicos de movimentação. Fundamental para conciliação contábil.dataInicial (string) required
dataFinal (string) required
naturezaMovimentacao (string)
tipoMovimentacoes (integer)
ordemBusca (string)
pagina (integer)
itensPorPagina (integer)
conta_corrente/get_pj_apibanking_forintegration_v1_contascorrentes_extrato_sinteticoRecupera extrato resumido da conta corrente com informações consolidadas das movimentações. Apresenta dados simplificados ideais para relatórios executivos e visões gerais do fluxo financeiro.dataInicial (string) required
dataFinal (string) required
naturezaMovimentacao (string)
tipoMovimentacoes (integer)
ordemBusca (string)
pagina (integer)
itensPorPagina (integer)
conta_corrente/get_pj_apibanking_forintegration_v1_contascorrentes_extratoData inicial para filtro do períodomovimentoInicial (string) required
movimentoFinal (string) required
inicio (integer)
limite (integer)
conta_corrente/get_pj_apibanking_forintegration_v1_contascorrentes_dados_autenticacaoSuccessNo parameters
conta_corrente/post_pj_apibanking_forintegration_v1_transferencias_simplificadoValor da transferênciadata: {
. favorecido (object)
. valor (number)
. efetuarEm (string)
} (object) required
conta_corrente/get_pj_apibanking_forintegration_v1_transferencias_by_solicitacao_idSuccesssolicitacaoId (string)
conta_corrente/get_pj_apibanking_forintegration_v1_transferencias_solicitacoes_by_solicitacao_idSuccesssolicitacaoId (string)
conta_corrente/post_pj_apibanking_forintegration_v1_pagamentosCódigo de barras ou linha digitável do pagamentodata: {
. codigoIdentificacao (string)
. valor (number)
. efetuarEm (string)
. vencimentoEm (string)
} (object) required
conta_corrente/get_pj_apibanking_forintegration_v1_pagamentos_by_codigo_identificacaoSuccesscodigoIdentificacao (string)
conta_corrente/get_pj_apibanking_forintegration_v1_pagamentos_solicitacoes_by_solicitacao_idSuccesssolicitacaoId (string)
conta_corrente/get_pj_banking_forintegration_v2_comprovantesData inicial para filtro do períododataInicial (string)
dataFinal (string)
tipoFiltro (integer)
inicio (string)
limite (string)
conta_corrente/get_pj_banking_forintegration_v2_comprovantes_by_comprovante_id_imprimivelO response é um bytecomprovanteId (string)
tipoComprovante (integer) required
conta_corrente/get_pj_apibanking_forintegration_v1_contascorrentes_webhookSuccessAuthorization (string) required
conta_corrente/post_pj_apibanking_forintegration_v1_contascorrentes_webhookSuccessdata: {
. url (string)
. autorizacao (object)
. Authorization (string)
} (object) required
conta_corrente/post_pj_apibanking_forintegration_v1_contascorrentes_webhook_by_assinatura_id_certificadoSuccessassinaturaId (string)
data: {
. certificado (string)
. Authorization (string)
. assinaturaId (string)
} (object) required
conta_corrente/delete_pj_apibanking_forintegration_v1_contascorrentes_webhook_by_assinatura_idSuccessassinaturaId (string)
Authorization (string) required
emissao_de_boleto_com_faixas_de_desconto/post_pj_forintegration_cobranca_v3_boletos_simplificadoCria boletos bancários com múltiplas faixas de desconto progressivo, incentivando o pagamento antecipado. Permite configurar diferentes percentuais ou valores fixos de desconto baseados em datas limite, otimizando o fluxo de caixa e reduzindo inadimplência.data: {
. seuNumero (string)
. cliente (object)
. sacadorAvalista (object)
. vencimento (string)
. valor (number)
. canal (string)
. multa (object)
. desconto (object)
. mensagem (object)
. aceite (boolean)
. especie (string)
. dataLimitePagamento (string)
. carteira (integer)
} (object) required
onboarding_ci_pf/get_pj_apibanking_forintegration_v1_onboarding_parceiros_v1_clientes_verificar_documento_by_documentoVerifica elegibilidade de pessoa física para abertura de conta digital no BS2, consultando CPF nas bases de dados internas e órgãos de proteção. Retorna se o cliente pode prosseguir com o onboarding ou se há impedimentos.documento (string)
x-bs2-correlation-id (string) required
apiKey (string) required
onboarding_ci_pf/post_pj_apibanking_forintegration_v1_onboarding_parceiros_v1_clientes_cadastrarRealiza cadastro completo de pessoa física no BS2, coletando dados pessoais, endereço, informações de renda e documentos necessários. Inicia processo de análise para aprovação da conta digital.data: {
. cpf (string)
. apelido (string)
. nomeCompleto (string)
. nomeMae (string)
. dataNascimento (string)
. nacionalidade (string)
. naturalidadeUF (string)
. naturalidade (string)
. usPerson (boolean)
. email (string)
. tipDocumento (string)
. numeroDocumento (string)
. orgaoExpedidor (string)
. dataExpedicao (string)
. ufExpedicao (string)
. cep (string)
. logradouro (string)
. numero (integer)
. complemento (string)
. bairro (string)
. cidade (string)
. uf (string)
. ddi (string)
. ddd (string)
. telefone (integer)
. trabalha (boolean)
. profissao (string)
. renda (string)
. x-bs2-client-id (string)
. x-partner (string)
. x-bs2-correlation-id (string)
. apiKey (string)
} (object) required
onboarding_ci_pf/get_pj_apibanking_forintegration_v1_onboarding_parceiros_v1_clientes_status_proposta_by_documentoNúmero do CPF do clientedocumento (string)
x-bs2-client-id (string) required
x-partner (string) required
x-bs2-correlation-id (string) required
apiKey (string) required
onboarding_pj/post_pj_onboarding_v1_fluxos_bs2pj_parceiros_cadastros_clientesInicia o processo de abertura de conta para pessoa jurídica, coletando dados empresariais completos, informações dos representantes legais e documentação necessária. Permite customizar se o cliente será notificado sobre o início do processo.data: {
. notificarCliente (boolean)
. empresa (object)
. x-bs2-correlation-id (string)
. apikey (string)
} (object) required
onboarding_pj/post_pj_onboarding_v1_fluxos_bs2pj_parceiros_cadastrosBody para ser enviado.data: {
. notificarCliente (boolean)
. empresa (object)
. x-bs2-correlation-id (string)
. apikey (string)
} (object) required
onboarding_pj/get_pj_onboarding_v1_fluxos_bs2pj_parceiros_cadastros_clientes_by_cliente_id_statusIdentificador do Cliente.clienteId (string)
x-bs2-correlation-id (string) required
apikey (string) required
onboarding_pj/post_pj_onboarding_v1_fluxos_bs2pj_parceiros_cadastros_clientes_by_cliente_id_documentosIdentificador do ClienteclienteId (string)
data: {
. x-bs2-correlation-id (string)
. apikey (string)
. clienteId (string)
} (object) required
pix_direto_webhook/post_bs2_pix_direto_webhook_mock_devolucaoRecebe notificações automáticas de devoluções PIX efetuadas, informando status, valor, motivo, participantes e dados de liquidação. Permite integração para atualização de sistemas internos e conciliação financeira.data: {
. dataHoraCriacao (string)
. idDevolucao (string)
. valorDevolucao (number)
. codigoMotivo (string)
. motivoDevolucao (string)
. e2Eoriginal (string)
. bancoRecebedor (string)
. bancoPagador (string)
. recebedor (object)
. pagador (object)
. chaveIdempotencia (string)
} (object) required
pix_direto_webhook/post_bs2_pix_direto_webhook_mock_falha_pagamento_asyncRecebe notificações de falha em pagamentos PIX realizados de forma assíncrona, detalhando motivo, mensagem, identificadores e dados do pagador. Auxilia na automação de tratamento de erros e reprocessamento.data: {
. chave (string)
. mensagem (string)
. documento (string)
. solicitacaoId (string)
. pagamentoId (string)
. chaveIdempotencia (string)
} (object) required
pix_direto_webhook/post_bs2_pix_direto_webhook_mock_pagamentoRecebe notificações de pagamentos PIX efetivados no fluxo síncrono, informando status, valor, participantes, erros e dados de reenvio. Permite atualização automática de sistemas de contas a pagar e conciliação de recebimentos.data: {
. pagamentoId (string)
. status (integer)
. erro (object)
. endToEndId (string)
. endToEndIdOrigem (string)
. valor (number)
. data (string)
. campoLivre (string)
. pagador (object)
. recebedor (object)
. solicitacaoId (string)
. reenvio (object)
. chaveIdempotencia (string)
. isReenvio (boolean)
} (object) required
pix_direto_webhook/post_bs2_pix_direto_webhook_mock_pagamento_retido_para_analiseRecebe notificações de pagamentos PIX retidos para análise, detalhando motivo, valor, status, participantes e dados de reenvio. Permite integração para automação de processos de análise e liberação.data: {
. endToEndId (string)
. pagamentoId (string)
. txId (string)
. solicitacaoId (string)
. valor (number)
. mensagem (string)
. dataHoraRetencao (string)
. chaveIdempotencia (string)
. erro (object)
. reenvio (object)
} (object) required
pix_direto_webhook/post_bs2_pix_direto_webhook_mock_recebimentoRecebe notificações de recebimentos PIX, informando dados da transação, valor, participantes e chave de idempotência. Permite atualização automática de sistemas de controle de recebíveis.data: {
. pix (array)
. chaveIdempotencia (string)
} (object) required
pix_direto_webhook/post_bs2_pix_direto_webhook_mock_solicitar_comprovanteRecebe notificações de solicitação de comprovante PIX, detalhando arquivo, identificadores e campos adicionais. Permite automação do envio e controle de comprovantes de pagamento.data: {
. arquivo (string)
. camposAdicionais (object)
. chaveIdempotencia (string)
} (object) required
pix_direto_webhook/post_bs2_pix_direto_webhook_mock_token_bucket_limitRecebe notificações sobre limites de TokenBucket aplicados a transações PIX, informando chave, identificadores, situação e mensagem. Auxilia no monitoramento e controle de limites operacionais.data: {
. chave (string)
. piPayerId (string)
. msg (string)
. documentoClienteConsulta (string)
. criadoEm (string)
. situacao (integer)
. chaveIdempotencia (string)
} (object) required
pix_direto/post_auth_oauth_v2_tokenGera token de acesso para autenticação nas APIs PIX Direto usando OAuth 2.0 Client Credentials. Este token é obrigatório para todas as operações PIX e deve ser incluído no header Authorization de todas as requisições subsequentes.data: {
. grant_type (string)
. scope (string)
. Authorization (string)
} (object) required
pix_direto/put_pix_direto_forintegration_v1_cobv_by_tx_idCria uma cobrança PIX com data de vencimento definida, permitindo pagamentos até a data limite com possibilidade de multas e juros após o vencimento. Ideal para faturas e cobranças recorrentes que precisam de prazo para pagamento.txId (string)
data: {
. calendario (object)
. devedor (object)
. loc (string)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
. infoAdicionais (array)
. txId (string)
} (object) required
pix_direto/patch_pix_direto_forintegration_v1_cobv_by_tx_idPermite editar dados de uma cobrança com vencimento já criada, incluindo valor, data de vencimento, informações do devedor e parâmetros de multa/juros. Útil para correções ou ajustes antes do pagamento.txId (string)
data: {
. calendario (object)
. devedor (object)
. loc (string)
. status (string)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
. infoAdicionais (array)
. txId (string)
} (object) required
pix_direto/patch_pix_direto_forintegration_v1_cob_by_tx_idAtualiza dados de uma cobrança PIX imediata existente, permitindo alterar valor, tempo de expiração, dados do devedor e informações adicionais. Essencial para corrigir informações ou ajustar condições antes do pagamento.txId (string)
data: {
. calendario (object)
. devedor (object)
. loc (object)
. status (string)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
. infoAdicionais (array)
. txId (string)
} (object) required
pix_direto/put_pix_direto_forintegration_v1_cob_by_tx_idCria uma cobrança PIX imediata com ID personalizado para pagamentos instantâneos. Permite definir valor, tempo de expiração e dados do devedor. Nota: O QR Code deve ser gerado separadamente seguindo padrões do BACEN.txId (string)
data: {
. calendario (object)
. devedor (object)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
. infoAdicionais (array)
. txId (string)
} (object) required
pix_direto/get_pix_direto_forintegration_v1_cob_by_tx_idConsulta detalhes de uma cobrança PIX específica usando o identificador da transação. Retorna status atual, dados do pagamento, histórico e informações completas da cobrança para controle e conciliação.txId (string)
revisao (integer)
pix_direto/post_pix_direto_forintegration_v1_cobGera uma nova cobrança PIX imediata com ID automático para recebimento de pagamentos instantâneos. Define valor, prazo de expiração e dados opcionais do devedor. O QR Code deve ser gerado conforme padrões BACEN.data: {
. calendario (object)
. devedor (object)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
. infoAdicionais (array)
} (object) required
pix_direto/get_pix_direto_forintegration_v1_cobLista cobranças PIX com filtros avançados por período, CPF/CNPJ do pagador e status. Inclui paginação para gerenciar grandes volumes de dados. Ideal para relatórios, conciliação e acompanhamento de recebimentos.Inicio (string) required
Fim (string) required
CPF (string)
CNPJ (string)
Status (string)
Paginacao.PaginaAtual (integer)
Paginacao.ItensPorPagina (integer)
pix_direto/put_pix_direto_forintegration_v1_pix_by_e2eid_devolucao_by_id_externoPré-requisitos:e2eid (string)
idExterno (string)
data: {
. valor (number)
. e2eid (string)
. idExterno (string)
} (object) required
pix_direto/get_pix_direto_forintegration_v1_pix_by_e2eid_devolucao_by_id_externoEndToEndId - Numero do protocolo do recebimento.e2eid (string)
idExterno (string)
pix_direto/get_pix_direto_forintegration_v1_pix_by_e2eidEndToEndIdentification que transita na PACS002, PACS004 e PACS008.e2eid (string)
pix_direto/get_pix_direto_forintegration_v1_pixFiltra os registros cuja data de criação seja maior ou igual a data de início.Inicio (string) required
Fim (string) required
TxId (string)
CPF (string)
CNPJ (string)
Paginacao.PaginaAtual (integer)
Paginacao.ItensPorPagina (integer)
pix_direto/get_pix_direto_forintegration_v1_pagamentosCaracterísticas:Inicio (string) required
Fim (string) required
Status (string)
Tipo (string)
Paginacao.PaginaAtual (integer)
Paginacao.ItensPorPagina (integer)
pix_direto/get_pix_direto_forintegration_v1_pagamentos_by_pagamento_idPré-requisitos: Um pagamentoId gerado por um dos seguintes fluxos de iniciação de pagamentos:pagamentoId (string)
pix_direto/get_pix_direto_forintegration_v1_pagamentos_end_to_end_id_by_end_to_end_idPré-requisitos: Um EndToEndId gerado por um dos seguintes fluxos de iniciação de pagamentos:endToEndId (string)
pix_direto/post_pix_direto_forintegration_v1_pagamentos_qrcodesInicia um pagamento PIX através da leitura de QR Code. Processa automaticamente os dados do destinatário e valor, facilitando pagamentos rápidos e seguros em estabelecimentos ou cobranças digitais.data: {
. qrCode (string)
. pagamentoId (string)
} (object) required
pix_direto/post_pix_direto_forintegration_v1_pagamentos_chaveInicia pagamento PIX usando chave PIX do destinatário CPF, CNPJ, e-mail, telefone ou chave aleatória. Permite enviar dinheiro de forma simples e instantânea usando apenas a chave do beneficiário.data: {
. chave (object)
. pagamentoId (string)
} (object) required
pix_direto/post_pix_direto_forintegration_v1_pagamentos_manualInicia pagamento PIX informando manualmente dados bancários completos do destinatário banco, agência, conta e dados pessoais. Útil quando não há chave PIX disponível ou para maior controle dos dados do recebedor.data: {
. recebedor (object)
. pagamentoId (string)
} (object) required
pix_direto/post_pix_direto_forintegration_v1_pagamentos_by_pagamento_id_confirmacaoPré-requisitos: Uma solicitação de pagamento iniciada em algum dos seguintes procedimentos:pagamentoId (string)
data: {
. recebedor (object)
. valor (number)
. campoLivre (string)
. efetuarEm (string)
. validarRecebedor (object)
. pagamentoId (string)
} (object) required
pix_direto/patch_pix_direto_forintegration_v1_pagamentos_by_pagamento_id_cancelarPré-requisitos: Um pagamento retido para análise, com status CONFIRMADO.pagamentoId (string)
data: {
. api-version (string)
. pagamentoId (string)
} (object) required
pix_direto/post_pix_direto_forintegration_v1_pagamentos_chave_solicitacoesSolicitar pagamento assíncronodata: {
. solicitacoes (array)
} (object) required
pix_direto/get_pix_direto_forintegration_v1_pagamentos_chave_solicitacoes_by_solicitacao_idObtém detalhes de uma solicitacao de pagamentosolicitacaoId (string)
pix_direto/get_pix_direto_forintegration_v1_pagamentos_by_end_to_end_id_origem_restituicoesSuccessEndToEndIdOrigem (string)
pix_direto/get_pix_direto_forintegration_v1_pagamentos_restituicoes_by_rtr_idSuccessRtrId (string)
pix_direto/get_pix_direto_forintegration_v1_qrcodesFiltro pelo tipo do QR Code.Tipo (string) required
TxId (string)
Status (string)
Inicio (string) required
Fim (string) required
Paginacao.PaginaAtual (integer)
Paginacao.ItensPorPagina (integer)
pix_direto/post_pix_direto_forintegration_v1_qrcodes_estaticoRealiza a criação de um novo qr code estático. Caracteristicas:data: {
. chave (string)
. valor (number)
. campoLivre (string)
. txId (string)
} (object) required
pix_direto/post_pix_direto_forintegration_v1_qrcodes_dinamicoRealiza a criação de um novo qr code dinâmico. Caracteristicas:data: {
. txId (string)
. cobranca (object)
. validaPagador (boolean)
} (object) required
pix_direto/post_pix_direto_forintegration_v1_qrcodes_dinamico_vencimento_by_tx_idRealiza a criação de um novo qr code dinâmico. Caracteristicas:txId (string)
data: {
. calendario (object)
. devedor (object)
. loc (string)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
. infoAdicionais (array)
. txId (string)
} (object) required
pix_direto/post_pix_direto_forintegration_v1_qrcodes_dinamico_vencimentoRealiza a criação de um novo qr code dinâmico. Caracteristicas:data: {
. txId (string)
. calendario (object)
. devedor (object)
. loc (string)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
. infoAdicionais (array)
} (object) required
pix_direto/delete_pix_direto_forintegration_v1_qrcodes_by_qr_code_idIdentificador de QrCode para cancelamento. Pode ser obtido através da consulta em Qr Code - Consultar.qrCodeId (string)
pix_direto/put_pix_direto_forintegration_v1_qrcodes_by_tx_id_dinamico_vencimentoDados para geração de um QR code dinâmico com vencimento.txId (string)
data: {
. cobranca (object)
. status (string)
. txId (string)
} (object) required
pix_direto/put_pix_direto_forintegration_v1_qrcodes_by_qr_code_id_dinamicoIdentificador de QrCode.qrCodeId (string)
data: {
. cobranca (object)
. qrCodeId (string)
} (object) required
pix_direto/get_pix_direto_forintegration_v1_recebimentosPré-requisitos:Inicio (string) required
Fim (string) required
TxId (string)
Paginacao.PaginaAtual (integer)
Paginacao.ItensPorPagina (integer)
pix_direto/get_pix_direto_forintegration_v1_recebimentos_by_end_to_end_id_recebimentoFiltra os registros cuja data de criação seja maior ou igual a data de início.EndToEndId (string)
Inicio (string) required
Fim (string) required
TxId (string)
Paginacao.PaginaAtual (integer)
Paginacao.ItensPorPagina (integer)
pix_direto/get_pix_direto_forintegration_v1_recebimentos_by_recebimento_idIdentificador de Recebimento.recebimentoId (string)
pix_direto/get_pix_direto_forintegration_v1_recebimentos_qrcode_by_qr_code_idQrCode IdqrCodeId (integer)
pix_direto/get_pix_direto_forintegration_v1_webhook_bs2Pré-requisitos:No parameters
pix_direto/put_pix_direto_forintegration_v1_webhook_bs2Pré-requisitos:data (object) required
pix_direto/put_pix_direto_forintegration_v1_webhook_bs2_certificadoPré-requisitos:data: {
. certificado (string)
} (object) required
pix_direto/put_pix_direto_forintegration_v1_webhook_bs2_by_configuracao_id_certificadoPré-requisitos:configuracaoId (string)
data: {
. certificado (string)
. configuracaoId (string)
} (object) required
pix_direto/delete_pix_direto_forintegration_v1_webhook_bs2_by_configuracao_idPré-requisitos:configuracaoId (string)
pix_direto/get_pix_direto_forintegration_v1_chaves_token_bucket_situacaoEndpoint para verificar a posição atual do meu balde de fichas.No parameters
pix_direto/post_pix_direto_forintegration_v1_pix_comprovantesAPI assíncrona para solicitação de comprovantes .data: {
. IdTransacao (array)
} (object) required
pix_indireto_dict/post_pix_indireto_dict_marcacao_fraudePermite ao participante registrar uma marcação de fraude associada a uma chave Pix, informando os dados relevantes para análise e controle antifraude. Útil para reportar suspeitas ou ocorrências confirmadas de fraude no sistema Pix.data: {
. documento (string)
. tipoFraude (string)
. chave (string)
. requestId (string)
. api-version (string)
. Authorization (string)
} (object) required
pix_indireto_dict/get_pix_indireto_dict_marcacao_fraude_by_idRetorna informações completas sobre uma marcação de fraude específica, incluindo status, dados da chave Pix e histórico de ações. Use para auditoria ou acompanhamento de casos reportados.id (string)
api-version (string) required
Authorization (string) required
pix_indireto_dict/post_pix_indireto_dict_marcacao_fraude_by_id_cancelarPermite ao participante remover ou invalidar uma marcação de fraude associada a uma chave Pix, caso tenha sido registrada por engano ou a situação tenha sido resolvida. Forneça o identificador da marcação para efetuar o cancelamento.id (string)
data: {
. api-version (string)
. Authorization (string)
. id (string)
} (object) required
pix_indireto_dict/get_pix_indireto_dict_pessoa_by_documentoRetorna dados estatísticos sobre liquidações, fraudes reportadas e fraudes confirmadas para o usuário identificado pelo documento informado. Útil para análise de risco e monitoramento de comportamento suspeito.documento (string)
api-version (string) required
Authorization (string) required
pix_indireto_dict/get_pix_indireto_dict_chaves_by_chaveRetorna informações sobre liquidações, fraudes reportadas e confirmadas associadas à chave Pix informada. Auxilia no monitoramento e prevenção de fraudes por chave.chave (string)
api-version (string) required
Authorization (string) required
pix_indireto_dict/post_pix_indireto_dict_chave_existenciaPermite consultar se um conjunto de chaves Pix está registrado no diretório de identificadores DICT. Útil para validação em massa e integração de sistemas.data: {
. chaves (array)
. api-version (string)
. Authorization (string)
} (object) required
pix_indireto_dict/post_pix_indireto_dict_devolucaoPermite ao participante debitado iniciar uma solicitação de devolução de valores em transações Pix, informando os dados necessários para análise e processamento da devolução.data: {
. idTransacao (string)
. razao (string)
. valor (number)
. comentario (string)
. api-version (string)
. Authorization (string)
} (object) required
pix_indireto_dict/get_pix_indireto_dict_devolucaoRetorna todas as solicitações de devolução em que o participante está envolvido, incluindo as de participantes indiretos. Permite filtrar por status, papel, datas e outros critérios para facilitar o acompanhamento e gestão de devoluções.IncluirParticipantesIndiretos (boolean) required
PapelParticipante (string) required
Status (array)
IncluirDetalhes (boolean)
ModificadoDepoisDe (string)
ModificadoAntesDe (string)
Limite (integer)
api-version (string) required
Authorization (string) required
pix_indireto_dict/get_pix_indireto_dict_devolucao_by_uuidRetorna informações completas sobre uma solicitação de devolução específica, incluindo status, valores, participantes e histórico de ações. Use para auditoria ou acompanhamento de casos.uuid (string)
api-version (string) required
Authorization (string) required
pix_indireto_dict/post_pix_indireto_dict_devolucao_by_uuid_cancelamentoPermite ao participante que criou a solicitação cancelar o pedido de devolução, caso necessário. A operação é idempotente e retorna o mesmo resultado se já tiver sido cancelada anteriormente.uuid (string)
data: {
. api-version (string)
. Authorization (string)
. uuid (string)
} (object) required
pix_indireto_dict/post_pix_indireto_dict_devolucao_by_uuid_fechamentoPermite ao participante contestado encerrar uma solicitação de devolução com status OPEN. A operação é idempotente e retorna o mesmo resultado se já tiver sido finalizada anteriormente.uuid (string)
data: {
. resultadoAnalise (string)
. detalhesAnalise (string)
. razaoRejeicao (string)
. idTransacao (string)
. api-version (string)
. Authorization (string)
. uuid (string)
} (object) required
pix_indireto_dict/get_pix_indireto_dict_vinculo_by_chaveRetorna os dados completos do vínculo entre uma chave Pix e a conta transacional associada, incluindo informações antifraude se solicitado. Útil para validação, auditoria e integração de sistemas.chave (string)
incluirEstatisticas (boolean)
documento (string) required
endToEndId (string)
api-version (string) required
Authorization (string) required
pix_indireto_dict/put_pix_indireto_dict_vinculo_by_chavePermite atualizar dados da conta, nome e nome fantasia do cliente associados a uma chave Pix, desde que permaneça no mesmo PSP. Outras alterações exigem operações específicas como portabilidade ou reivindicação de posse.chave (string)
data: {
. contaTransacional (object)
. participante (object)
. razao (string)
. api-version (string)
. Authorization (string)
. chave (string)
} (object) required
pix_indireto_dict/post_pix_indireto_dict_vinculoPermite registrar um novo vínculo entre uma chave Pix e uma conta transacional. A operação é idempotente, garantindo segurança em tentativas repetidas. O campo RequestId UUID v4 identifica a requisição e vincula ao CID gerado.data: {
. vinculo (object)
. razao (string)
. requestId (string)
. api-version (string)
. Authorization (string)
} (object) required
pix_indireto_dict/post_pix_indireto_dict_vinculo_by_chave_removerPermite ao participante responsável remover o vínculo entre uma chave Pix e a conta transacional associada, invalidando a associação no DICT.chave (string)
data: {
. razao (string)
. api-version (string)
. Authorization (string)
. chave (string)
} (object) required
pix_indireto_dict/post_pix_indireto_dict_infracaoPermite ao participante registrar uma infração ex: solicitação de devolução ou cancelamento relacionada a uma transação Pix. O PSP do pagador ou recebedor deve criar conforme o objetivo da notificação.data: {
. notificacaoInfracao (object)
. api-version (string)
. Authorization (string)
} (object) required
pix_indireto_dict/get_pix_indireto_dict_infracaoRetorna todas as notificações de infração em que o participante está envolvido, ordenadas por data de modificação. Permite filtrar por status, participantes indiretos, detalhes e datas para facilitar o acompanhamento.IncluirParticipantesIndiretos (boolean)
Status (array)
IncluirDetalhes (boolean)
ModificadoDepoisDe (string)
ModificadoAntesDe (string)
Limite (integer)
api-version (string) required
Authorization (string) required
pix_indireto_dict/get_pix_indireto_dict_infracao_by_uuidRetorna informações completas sobre uma notificação de infração específica, incluindo status, participantes, histórico e dados associados. Use para auditoria ou acompanhamento de casos.uuid (string)
api-version (string) required
Authorization (string) required
pix_indireto_dict/post_pix_indireto_dict_infracao_by_uuid_recebimentoPermite ao participante contraparte confirmar o recebimento da notificação de infração. A operação é idempotente e retorna o mesmo resultado se já tiver sido confirmada anteriormente.uuid (string)
data: {
. api-version (string)
. Authorization (string)
. uuid (string)
} (object) required
pix_indireto_dict/post_pix_indireto_dict_infracao_by_uuid_cancelamentoPermite ao participante que criou a notificação cancelar o registro de infração, desde que o status seja OPEN ou ACKNOWLEDGED. A operação é idempotente e retorna o mesmo resultado se já tiver sido cancelada anteriormente.uuid (string)
data: {
. api-version (string)
. Authorization (string)
. uuid (string)
} (object) required
pix_indireto_dict/post_pix_indireto_dict_infracao_by_uuid_fechamentoPermite ao participante encerrar uma notificação de infração. Se o resultado for AGREED, uma marcação de fraude é gerada automaticamente. A operação é idempotente e retorna o mesmo resultado se já tiver sido finalizada anteriormente.uuid (string)
data: {
. resultadoAnalise (string)
. detalhesAnalise (string)
. tipoFraude (string)
. api-version (string)
. Authorization (string)
. uuid (string)
} (object) required
pix_indireto_dict/get_pix_indireto_dict_limitesRetorna todas as políticas de limitação de acesso ao DICT para o participante requisitante, incluindo categoria e estado atual dos baldes. Útil para monitoramento de limites e conformidade regulatória.api-version (string) required
Authorization (string) required
pix_indireto_dict/get_pix_indireto_dict_limites_politica_by_politicaRetorna o status atual do balde de limitação de acesso ao DICT para a política informada, permitindo acompanhamento de uso e restrições.politica (string)
api-version (string) required
Authorization (string) required
pix_indireto_dict/post_pix_indireto_dict_reconciliacaoPermite ao participante verificar a sincronização de chaves Pix de determinado tipo, garantindo integridade e atualização dos registros no DICT.data: {
. tipoChave (string)
. verificadorSincronismoParticipante (string)
. api-version (string)
. Authorization (string)
} (object) required
pix_indireto_dict/post_pix_indireto_dict_reconciliacao_arquivoPermite ao participante solicitar a geração de um arquivo contendo todos os CIDs de um tipo de chave Pix, para fins de reconciliação e auditoria. O arquivo é gerado de forma assíncrona, com um CID por linha.data: {
. tipoChave (string)
. api-version (string)
. Authorization (string)
} (object) required
pix_indireto_dict/get_pix_indireto_dict_reconciliacao_arquivo_by_idRetorna informações sobre o arquivo de CIDs solicitado, incluindo status, dados e identificador. Use para acompanhamento de processos de reconciliação.id (string)
api-version (string) required
Authorization (string) required
pix_indireto_dict/get_pix_indireto_dict_reconciliacao_eventosRetorna todos os eventos de CIDs para o tipo de chave informado, ordenados por timestamp. A atualização dos dados é assíncrona, podendo haver pequeno retardo na consulta após inclusão ou alteração de registros.TipoChave (string)
DataInicio (string)
DataFim (string)
Limite (integer)
api-version (string) required
Authorization (string) required
pix_indireto_dict/get_pix_indireto_dict_reconciliacao_vinculo_by_cidRetorna informações completas sobre o vínculo ativo identificado pelo CID, incluindo dados da chave, conta associada e status. Útil para auditoria e validação de registros.cid (string)
api-version (string) required
Authorization (string) required
pix_indireto_dict/post_pix_indireto_dict_reivindicacaoPermite ao participante reivindicador iniciar uma reivindicação de posse ou portabilidade de chave Pix, a pedido do usuário final. O vínculo atual permanece inalterado até confirmação pelo PSP doador. Nem todo tipo de chave pode ser reivindicado ou portado.data: {
. tipo (string)
. vinculo (object)
. api-version (string)
. Authorization (string)
} (object) required
pix_indireto_dict/get_pix_indireto_dict_reivindicacaoRetorna todas as reivindicações em que o participante está envolvido, ordenadas por data de modificação. Permite filtrar por status, tipo, participantes e datas. A atualização dos dados é assíncrona, podendo haver pequeno retardo na consulta.IncluirParticipantesIndiretos (boolean)
SomenteDoadores (boolean)
SomenteReivindicadores (boolean)
Situacao (array)
Tipo (string)
ModificadaAntesDe (string)
ModificadaDepoisDe (string)
Limite (integer)
api-version (string) required
Authorization (string) required
pix_indireto_dict/get_pix_indireto_dict_reivindicacao_by_uuidRetorna informações completas sobre uma reivindicação específica, incluindo status, participantes, histórico e dados associados. Use para auditoria ou acompanhamento de casos.uuid (string)
api-version (string) required
Authorization (string) required
pix_indireto_dict/post_pix_indireto_dict_reivindicacao_by_uuid_recebimentoPermite ao participante doador confirmar o recebimento da reivindicação com status OPEN. A operação é idempotente e retorna o mesmo resultado se já tiver sido confirmada anteriormente.uuid (string)
data: {
. api-version (string)
. Authorization (string)
. uuid (string)
} (object) required
pix_indireto_dict/post_pix_indireto_dict_reivindicacao_by_uuid_confirmacaoPermite ao participante confirmar a reivindicação, removendo o vínculo da chave com o doador. Status deve estar em WAITING_RESOLUTION. A operação é idempotente e retorna o mesmo resultado se já tiver sido confirmada anteriormente.uuid (string)
data: {
. motivo (string)
. api-version (string)
. Authorization (string)
. uuid (string)
} (object) required
pix_indireto_dict/post_pix_indireto_dict_reivindicacao_by_uuid_cancelamentoPermite ao participante cancelar uma reivindicação de posse ou portabilidade de chave Pix, conforme regras de status e prazos. A operação é idempotente e retorna o mesmo resultado se já tiver sido cancelada anteriormente.uuid (string)
data: {
. motivo (string)
. api-version (string)
. Authorization (string)
. uuid (string)
} (object) required
pix_indireto_dict/post_pix_indireto_dict_reivindicacao_by_uuid_conclusaoPermite ao participante reivindicador concluir a reivindicação, criando o vínculo da chave Pix com o novo participante. Status deve ser CONFIRMED e prazos atendidos conforme regras. A operação é idempotente e segue as mesmas considerações da criação de vínculo.uuid (string)
data: {
. idRequisicao (string)
. api-version (string)
. Authorization (string)
. uuid (string)
} (object) required
pix_indireto_pagamento/get_core2_pix_indireto_pagamentos_by_end_to_end_id_restituicoesLista todas as restituições realizadas para um pagamento PIX específico, filtrando por identificador da transação. Permite acompanhamento detalhado dos estornos e conciliação financeira.endToEndId (string)
Authorization (string) required
pix_indireto_pagamento/get_core2_pix_indireto_pagamentos_by_end_to_end_id_restituicoes_by_return_idConsulta os detalhes de uma restituição PIX específica, incluindo status, valor, motivo e informações de liquidação. Permite rastrear o ciclo completo do estorno.endToEndId (string)
returnId (string)
Authorization (string) required
pix_indireto_pagamento/post_core2_pix_indireto_pagamentos_chave_pixInicia pagamento PIX utilizando chave do destinatário CPF, CNPJ, e-mail, telefone ou chave aleatória. Permite agendamento, definição de valor, dados do pagador e controle total do fluxo de pagamento.data: {
. pagador (object)
. chave (object)
. openFinance (object)
. campoLivre (string)
. dataAgendamento (string)
. endToEndId (string)
. Authorization (string)
} (object) required
pix_indireto_pagamento/post_core2_pix_indireto_pagamentos_servico_iniciacaoA data de agendamento será utilizada para criação do EndToEndId e deve conter Ano, Mês, Dia, Hora e Minuto e estar em formato UTC.data: {
. pagador (object)
. chave (object)
. openFinance (object)
. transactionId (string)
. campoLivre (string)
. dataAgendamento (string)
. endToEndId (string)
. Authorization (string)
} (object) required
pix_indireto_pagamento/post_core2_pix_indireto_pagamentos_dados_manuaisA data de agendamento será utilizada para criação do EndToEndId e deve conter Ano, Mês, Dia, Hora e Minuto e estar em formato UTC.data: {
. pagador (object)
. recebedor (object)
. openFinance (object)
. campoLivre (string)
. dataAgendamento (string)
. endToEndId (string)
. Authorization (string)
} (object) required
pix_indireto_pagamento/post_core2_pix_indireto_pagamentos_qr_codeA data de agendamento será utilizada para criação do EndToEndId e deve conter Ano, Mês, Dia, Hora e Minuto e estar em formato UTC.data: {
. pagador (object)
. openFinance (object)
. qrCode (string)
. transactionId (string)
. campoLivre (string)
. dataAgendamento (string)
. endToEndId (string)
. Authorization (string)
} (object) required
pix_indireto_pagamento/post_core2_pix_indireto_pagamentos_by_pagamento_id_confirmacaoPara pagamentos agendados a confirmação do pagamento deve ser realizada somente no dia do agendamento/liquidação.pagamentoId (string)
data: {
. recebedor (object)
. retirada (object)
. valor (number)
. descricaoPagamento (string)
. tipoPrioridade (string)
. Authorization (string)
. pagamentoId (string)
} (object) required
pix_indireto_pagamento/patch_core2_pix_indireto_pagamentos_by_pagamento_id_cancelamentoId do pagamento a ser canceladopagamentoId (string)
data: {
. motivo (string)
. Authorization (string)
. pagamentoId (string)
} (object) required
pix_indireto_pagamento/get_core2_pix_indireto_pagamentosId do Pagamento É obrigatório caso o EndToEndId não seja informadoId (string)
EndToEndId (string)
Authorization (string) required
pix_indireto_qr_code/get_pix_indireto_qrcodeLista QR Codes PIX e cobranças geradas com filtros por período e Transaction ID. Permite acompanhar status, valores e histórico de todas as cobranças criadas, facilitando gestão financeira e conciliação.DataInicio (string)
DataFim (string)
TransactionId (string)
PaginaAtual (integer)
QuantidadePorPagina (integer)
Authorization (string) required
pix_indireto_qr_code/post_pix_indireto_qrcode_estaticoGera QR Code PIX estático para recebimentos fixos ou recorrentes. Pode ser reutilizado múltiplas vezes e permite definir valor fixo ou variável. Ideal para pontos de venda, doações ou cobranças padronizadas.data: {
. valor (number)
. campoLivre (string)
. reutilizavel (boolean)
. transactionId (string)
. chave (object)
. recebedor (object)
. retirada (object)
. chaveIdempotencia (string)
. Authorization (string)
} (object) required
pix_indireto_qr_code/post_pix_indireto_qrcode_dinamicoRealiza a criação de um novo qr code dinâmicoCaracteristicas:data: {
. recebedor (object)
. cobranca (object)
. retirada (object)
. chaveIdempotencia (string)
. Authorization (string)
} (object) required
pix_indireto_qr_code/post_pix_indireto_qrcode_dinamico_vencimentoRealiza a criação de um novo qr code dinâmicoCaracteristicas:data: {
. cobranca (object)
. recebedor (object)
. chaveIdempotencia (string)
. Authorization (string)
} (object) required
pix_indireto_qr_code/delete_pix_indireto_qrcode_by_qr_code_id_desativarIdentificador de QrCode para cancelamentoqrCodeId (string)
Authorization (string) required
pix_indireto_qr_code/put_pix_indireto_qrcode_by_transaction_id_dinamico_vencimentoAuthtransactionId (string)
data: {
. cobranca (object)
. Authorization (string)
. transactionId (string)
} (object) required
pix_indireto_qr_code/put_pix_indireto_qrcode_by_qr_code_id_dinamicoId do Qr CodeqrCodeId (string)
data: {
. cobranca (object)
. Authorization (string)
. qrCodeId (string)
} (object) required
pix_indireto_qr_code/get_pix_indireto_spi_qrcode_by_identificador_locationGuid de identificação de um QRCode dinâmicoidentificadorLocation (string)
Authorization (string) required
pix_indireto_qr_code/get_pix_indireto_spi_qrcode_cobv_by_identificador_locationGuid de identificação de um QRCode dinâmico com vencimentoidentificadorLocation (string)
codMunicipio (string)
dataPrevistaPagamento (string)
Authorization (string) required
pix_indireto_recebimentos/get_pix_indireto_recebimentos_by_end_to_end_id_devolucoesLista todas as devoluções realizadas para um recebimento PIX específico, filtrando por status e identificador da transação. Permite acompanhamento detalhado dos estornos e conciliação financeira.endToEndId (string)
status (string)
Authorization (string) required
pix_indireto_recebimentos/post_pix_indireto_recebimentos_by_end_to_end_id_devolucoesSolicita devolução parcial ou total de um recebimento PIX, informando valor, motivo e prioridade. Ideal para casos de pagamento indevido, duplicidade ou ajuste comercial.endToEndId (string)
data: {
. idExterno (string)
. valor (number)
. motivo (string)
. codigo (string)
. prioridadeTransacao (string)
. Authorization (string)
. endToEndId (string)
} (object) required
pix_indireto_recebimentos/get_pix_indireto_recebimentos_by_end_to_end_id_devolucoes_by_return_idConsulta os detalhes de uma devolução PIX específica, incluindo status, valor, motivo e informações de liquidação. Permite rastrear o ciclo completo do estorno.endToEndId (string)
returnId (string)
Authorization (string) required
pix_indireto_recebimentos/get_pix_indireto_recebimentosConsulta recebimentos PIX realizados, filtrando por EndToEndId ou TransactionId. Retorna informações completas sobre o pagamento, status, valores e participantes envolvidos. Essencial para conciliação e controle de recebíveis.EndToEndId (string)
TransactionId (string)
Authorization (string) required
pix_indiretos_contrato/post_bs2_pix_indireto_webhook_mock_devolucaoRecebe notificações automáticas de devoluções PIX finalizadas, informando status, valores, motivos de rejeição e dados de liquidação. Permite integração para atualização de sistemas internos e conciliação financeira.data: {
. chaveIdempotencia (string)
. idExterno (string)
. endToEndId (string)
. returnId (string)
. valor (number)
. solicitadoEmUtc (string)
. dataContabil (string)
. liquidadoEmUtc (string)
. status (string)
. motivoRejeicao (object)
. erroDescricao (string)
. apikey (string)
} (object) required
pix_indiretos_contrato/post_bs2_pix_indireto_webhook_mock_notificacao_infracaoRecebe notificações sobre atualizações em infrações relacionadas a transações PIX, incluindo status, análise de fraude, detalhes e participantes envolvidos. Facilita monitoramento e resposta a eventos suspeitos.data: {
. id (string)
. razao (string)
. transacaoId (string)
. causaFraude (string)
. detalhes (string)
. status (string)
. ispbSolicitante (string)
. ispbContraparte (string)
. marcadorFraudeId (string)
. resultadoAnalise (string)
. detalheAnalise (string)
. dataCriacao (string)
. dataUltimaModificacao (string)
. apikey (string)
} (object) required
pix_indiretos_contrato/post_bs2_pix_indireto_webhook_mock_pagamentoRecebe notificações de pagamentos PIX finalizados, informando status, valores, rejeições e dados de liquidação. Permite atualização automática de sistemas de contas a pagar e conciliação de recebimentos.data: {
. chaveIdempotencia (string)
. pagamentoId (string)
. endToEndId (string)
. valor (number)
. status (string)
. solicitadoEmUtc (string)
. dataContabil (string)
. liquidadoEmUtc (string)
. rejeicao (object)
. erroDescricao (string)
. apikey (string)
} (object) required
pix_indiretos_contrato/post_bs2_pix_indireto_webhook_mock_recebimentoRecebe notificações de recebimentos PIX concluídos, detalhando valores, status, motivos de rejeição e informações de liquidação. Ideal para automação de processos financeiros e atualização de saldo em tempo real.data: {
. chaveIdempotencia (string)
. endToEndId (string)
. transactionId (string)
. valor (number)
. solicitadoEmUtc (string)
. dataContabil (string)
. liquidadoEmUtc (string)
. status (string)
. motivoRejeicao (object)
. erroDescricao (string)
. apikey (string)
} (object) required
pix_indiretos_contrato/post_bs2_pix_indireto_webhook_mock_reivindicacao_chaveRecebe notificações sobre reivindicações de chaves PIX, incluindo status, motivos, participantes e datas relevantes. Permite acompanhamento do ciclo de vida da solicitação e integração com sistemas antifraude.data: {
. correlationId (string)
. tipo (string)
. tipoChave (string)
. status (string)
. ispbDoador (string)
. chave (string)
. contaSolicitante (object)
. solicitante (object)
. abertoEmUtc (string)
. aguardandoResolucaoEmUtc (string)
. confirmadaEmUtc (string)
. canceladaEmUtc (string)
. completaEmUtc (string)
. fimPeriodoResolucao (string)
. fimPeriodoEncerramento (string)
. ultimaModificacao (string)
. motivoSolicitacao (string)
. motivoCancelamento (string)
. canceladoPor (string)
. participanteIndiretoReivindicador (boolean)
. participanteIndiretoDoador (boolean)
. apikey (string)
} (object) required
pix_indiretos_contrato/post_bs2_pix_indireto_webhook_mock_restituicaoRecebe notificações de restituições de pagamentos PIX finalizadas, detalhando valores, status, motivos de rejeição e informações de liquidação. Auxilia na automação de estornos e controle de fluxo financeiro.data: {
. chaveIdempotencia (string)
. returnId (string)
. endToEndId (string)
. valor (number)
. solicitadoEmUtc (string)
. dataContabil (string)
. liquidadoEmUtc (string)
. status (string)
. motivoRejeicao (object)
. erroDescricao (string)
. apikey (string)
} (object) required
pix_indiretos_contrato/post_bs2_pix_indireto_webhook_mock_sincronismo_chaveRecebe notificações sobre sincronização de chaves PIX entre participantes, informando ações realizadas e status. Garante atualização consistente das chaves em sistemas integrados.data: {
. chave (string)
. tipoAcao (string)
. apikey (string)
} (object) required
pix_indiretos_contrato/post_bs2_pix_indireto_webhook_mock_solicitacao_devolucaoRecebe notificações sobre solicitações de devolução PIX, detalhando valores, status, motivos, participantes e resultados de análise. Permite acompanhamento do processo de devolução e integração com sistemas de atendimento.data: {
. id (string)
. razao (string)
. valor (number)
. comentario (string)
. status (string)
. ispbSolicitante (string)
. ispbContestado (string)
. criadoEm (string)
. modificadoEm (string)
. idInfracao (string)
. resultadoAnalise (string)
. detalhesAnalise (string)
. razaoRejeicao (string)
. idTransacao (string)
. idTransacaoDevolucao (string)
. apikey (string)
} (object) required
pix_indiretos_contrato/post_bs2_pix_indireto_webhook_mock_recebimento_validacaoRecebe notificações de validação de recebimentos PIX, informando dados do pagador, recebedor, valores, status e finalidade. Auxilia na automação de validação e controle de recebimentos em tempo real.data: {
. data (string)
. endToEndId (string)
. transactionId (string)
. campoLivre (string)
. cnpjIniciadorPagamento (string)
. status (string)
. tipoIniciacao (string)
. finalidade (string)
. valor (number)
. recebedor (object)
. pagador (object)
. chaveDict (string)
. prioridadeTransacao (string)
. tipoPrioridadeTransacao (string)
. valorSaqueOuTroco (number)
. ispbFacilitadorServicoSaqueOuTroco (string)
. modalidadeAgente (string)
. apikey (string)
} (object) required
pix_indiretos_contrato/post_bs2_pix_indireto_webhook_mock_recebimento_validacao_csmRecebe notificações de validação de recebimentos PIX para clientes CSM, detalhando dados do pagador, recebedor, valores, status e finalidade. Permite integração para validação automática e controle de recebimentos.data: {
. data (string)
. endToEndId (string)
. transactionId (string)
. campoLivre (string)
. cnpjIniciadorPagamento (string)
. status (string)
. tipoIniciacao (string)
. finalidade (string)
. valor (number)
. recebedor (object)
. pagador (object)
. chaveDict (string)
. prioridadeTransacao (string)
. tipoPrioridadeTransacao (string)
. valorSaqueOuTroco (number)
. ispbFacilitadorServicoSaqueOuTroco (string)
. modalidadeAgente (string)
. apikey (string)
} (object) required
pix_indiretos_contrato/post_bs2_pix_indireto_webhook_mock_restituicao_validacaoRecebe notificações de validação síncrona de restituições PIX, informando valores, status, motivos e participantes. Permite automação do processo de validação e integração com sistemas de controle financeiro.data: {
. solicitadoEmUtc (string)
. returnId (string)
. endToEndId (string)
. valor (number)
. codigoDevolucao (string)
. tipoDevolucao (string)
. prioridadeTransacao (string)
. campoLivre (string)
. motivo (string)
. isbpPagador (string)
. isbpRecebedor (string)
. apikey (string)
} (object) required
portal_admin/post_v1_auth_oauth2Gera token de acesso para autenticação no Portal Administrativo BS2. Este token é necessário para acessar funcionalidades de gestão, relatórios e configurações avançadas da conta empresarial.data: {
. username (string)
. password (string)
. access_type_id (integer)
} (object) required
portal_admin/post_v1_accounting_posting_createRegistra lançamento contábil manual para estabelecimentos comerciais. Permite inserir débitos, créditos e ajustes diretamente no sistema, facilitando controle financeiro e conciliação de vendas.data: {
. facilitator_id (integer)
. seller_id (integer)
. accounting_posting_type_code (string)
. movement_type_code (string)
. date (string)
. amount (number)
. reason (string)
} (object) required
portal_admin/post_v1_appseller_totalUtilize esse endpoint para listar os totais do lojista para o período selecionado: pbOBSERVAÇÃO/b p Intervalo máximo de 90 dias entre a data de inicio e a data fim. p Será substituido pela data de hoje caso passe uma data maior que a data de hoje na data fim.data: {
. Cod_Acquirer (string)
. Seql_SubAcquirer (string)
. user_id (string)
. facilitator_id (string)
. seller_id (string)
. date_init (string)
. date_end (string)
} (object) required
portal_admin/post_v1_campanha_addUtilize esse endpoint para gravar uma campanha:data: {
. facilitator_id (integer)
. name_campaign (string)
. date_start_accession (string)
. date_end_accession (string)
. date_start (string)
. date_end (string)
. enable_mdr (string)
. perc_debit_mdr (string)
. perc_credit_mdr (string)
. perc_credit_mdr2a6 (string)
. perc_credit_mdr7a12 (string)
. enable_rent (string)
. perc_debit_rent (string)
. enable_anticipation (string)
. perc_anticipation (string)
. create_user_code (integer)
. term_accession (string)
} (object) required
portal_admin/post_v1_campanha_subseller_updateUtilize esse endpoint para gerenciar campanha da loja:data: {
. code_campaign (integer)
. cpf_cnpj (string)
. seller_person_type (string)
} (object) required
portal_admin/get_v1_cancellation_paramsUtilize esse endpoint para o arquivo HTML da carta de cancelamento:No parameters
portal_admin/post_v1_combo_listUtilize esse endpoint para listar a Tabela de Preço:data: {
. facilitator_id (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_combo_createUtilize esse endpoint para criar a Tabela de Preço:data: {
. acquirer_code (string)
. subacquirer_code (string)
. facilitator_id (string)
. price_table_name (number)
. register_status_code (string)
. is_default_onboarding (string)
. change_control (string)
} (object) required
portal_admin/post_v1_connection_listUtilize esse endpoint para listar a Configuração de Conexão:data: {
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_connection_createUtilize esse endpoint para criar a Configuração de Conexão:data: {
. subacquirer_code (string)
. acquirer_code (string)
. connection_type_code (string)
. encryption_type_code (string)
. trm_connection_name (string)
. ip (string)
. cudniu (string)
. port_number (number)
. dte (string)
. subnet (number)
. ddd (number)
. carrier_code (number)
. telephone_number (number)
. enable_osi (string)
. register_status_code (string)
. change_control (string)
} (object) required
portal_admin/post_v1_connection_profile_listUtilize esse endpoint para listar os Perfis de Conexão:data: {
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_connection_profile_createUtilize esse endpoint para criar os Perfis Conexão:data: {
. terminal_profile_name (string)
. acquirer_code (string)
. subacquirer_code (string)
. timeout_idle (number)
. timeout_p2 (number)
. register_status_code (string)
. change_control (string)
. TrmPerfilConexao_Seql_TrmPerfil (string)
} (object) required
portal_admin/get_v1_domain_tables_schedule_type_listUtilize esse endpoint para listar os tipos de Agenda:No parameters
portal_admin/get_v1_domain_tables_accounting_posting_type_listUtilize esse endpoint para listar os tipos de Lançamento:No parameters
portal_admin/get_v1_domain_tables_movement_type_listUtilize esse endpoint para listar os tipos de Movimento:No parameters
portal_admin/get_v1_domain_tables_comboUtilize esse endpoint para listar as tabelas de preços:No parameters
portal_admin/get_v1_domain_tables_paymentplanUtilize esse endpoint para listar os planos:No parameters
portal_admin/get_v1_domain_tables_liquid_statusUtilize esse endpoint para listar os status da Liquidação:No parameters
portal_admin/get_v1_domain_tables_transaction_type_listUtilize esse endpoint para listar os tipos de transações:No parameters
portal_admin/get_v1_domain_tables_cnae_listUtilize esse endpoint para listar as Classificações Nacionais de Atividades Econômicas:No parameters
portal_admin/get_v1_domain_tables_legal_nature_listUtilize esse endpoint para listar as Naturezas Jurídicas:No parameters
portal_admin/get_v1_domain_tables_company_formation_listUtilize esse endpoint para listar os Portes de Empresa:No parameters
portal_admin/get_v1_domain_tables_bank_listUtilize esse endpoint para listar os Bancos:No parameters
portal_admin/get_v1_domain_tables_cbo_listUtilize esse endpoint para listar os CBOs:No parameters
portal_admin/get_v1_domain_tables_terminal_model_listUtilize esse endpoint para listar os modelos de terminais:No parameters
portal_admin/get_v1_domain_tables_discount_type_listUtilize esse endpoint para listar os tipos de desconto de tarifa:No parameters
portal_admin/get_v1_domain_tables_exemption_type_listUtilize esse endpoint para listar os tipos de isenção de tarifa:No parameters
portal_admin/get_v1_domain_tables_fare_type_listUtilize esse endpoint para listar os tipos de tarifa:No parameters
portal_admin/get_v1_domain_tables_bank_account_type_listUtilize esse endpoint para listar os tipos de contas bancárias:No parameters
portal_admin/get_v1_domain_tables_brand_product_listUtilize esse endpoint para listar os tipos de Bandeira por Produto para Onboarding:No parameters
portal_admin/get_v1_domain_tables_brand_product_listallUtilize esse endpoint para listar os tipos de Bandeira por Produto:No parameters
portal_admin/get_v1_domain_tables_operator_listUtilize esse endpoint para listar tipos de Operadora de Terminais:No parameters
portal_admin/get_v1_domain_tables_brand_listUtilize esse endpoint para listar as Bandeiras :No parameters
portal_admin/get_v1_domain_tables_transaction_status_listUtilize esse endpoint para listar os status das transações:No parameters
portal_admin/get_v1_domain_tables_transaction_category_listUtilize esse endpoint para listar as categorias das transações:No parameters
portal_admin/get_v1_domain_tables_mccUtilize esse endpoint para listar os tipos de MCC:No parameters
portal_admin/get_v1_domain_tables_partner_type_listUtilize esse endpoint para listar todos os tipos de sócios:No parameters
portal_admin/get_v1_domain_tables_cod_name_commercialUtilize esse endpoint para listar todos os usuários responsáveis:No parameters
portal_admin/post_v1_equipment_listUtilize esse endpoint para listar os Equipamentos:data: {
. serial_number (string)
. type_equipment_code (string)
. manufacturer_code (string)
. terminal_model_code (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_equipment_createUtilize esse endpoint para criar os Equipamentos:data: {
. terminal_model_code (string)
. type_equipment_code (string)
. equipment_status_code (string)
. serial_number (string)
. change_control (string)
} (object) required
portal_admin/post_v2_equipment_maintenance_link_terminal_seller_documentVincular um equipamento para uma loja, informando o Documento da Loja:data: {
. facilitator_id (integer)
. user_group_id (integer)
. user_id (integer)
. service_order_external_id (integer)
. seller_person_type (string)
. seller_document_number (integer)
. equipment_serial_number (string)
. sim_card_serial_number (string)
} (object) required
portal_admin/post_v2_equipment_maintenance_link_terminal_seller_idVincular um equipamento para uma loja, informando o ID da Loja:data: {
. facilitator_id (integer)
. user_group_id (integer)
. user_id (integer)
. service_order_external_id (integer)
. seller_id (integer)
. equipment_serial_number (string)
. sim_card_serial_number (string)
} (object) required
portal_admin/post_v2_equipment_maintenance_untie_terminal_seller_documentDesvincular um equipamento de uma loja, informando o Documento da Loja:data: {
. facilitator_id (integer)
. user_group_id (integer)
. user_id (integer)
. service_order_external_id (integer)
. seller_person_type (string)
. seller_document_number (integer)
. equipment_serial_number (string)
} (object) required
portal_admin/post_v2_equipment_maintenance_untie_terminal_seller_idDesvincular um equipamento de uma loja informando o ID da Loja:data: {
. facilitator_id (integer)
. user_group_id (integer)
. user_id (integer)
. service_order_external_id (integer)
. seller_id (integer)
. equipment_serial_number (string)
} (object) required
portal_admin/post_v2_equipment_maintenance_change_terminal_seller_documentEfetuar uma troca de equipamento para uma loja informando o Documento da Loja:data: {
. facilitator_id (integer)
. user_group_id (integer)
. user_id (integer)
. service_order_external_id (integer)
. seller_person_type (string)
. seller_document_number (integer)
. previous_equipment_serial_number (string)
. new_equipment_serial_number (string)
} (object) required
portal_admin/post_v2_equipment_maintenance_change_terminal_seller_idEfetuar uma troca de equipamento para uma loja informando o ID da Loja:data: {
. facilitator_id (integer)
. user_group_id (integer)
. user_id (integer)
. service_order_external_id (integer)
. seller_id (integer)
. previous_equipment_serial_number (string)
. new_equipment_serial_number (string)
} (object) required
portal_admin/post_v2_equipment_maintenance_change_sim_card_seller_documentEfetuar uma troca de SIM Card Chip para um equipamento informando o Documento da Loja:data: {
. facilitator_id (integer)
. user_group_id (integer)
. user_id (integer)
. service_order_external_id (integer)
. seller_person_type (string)
. seller_document_number (integer)
. equipment_serial_number (string)
. sim_card_serial_number (string)
. new_sim_card_serial_number (string)
} (object) required
portal_admin/post_v2_equipment_maintenance_change_sim_card_seller_idEfetuar uma troca de SIM Card Chip para um equipamento informando o ID da Loja:data: {
. facilitator_id (integer)
. user_group_id (integer)
. user_id (integer)
. service_order_external_id (integer)
. seller_id (integer)
. equipment_serial_number (string)
. sim_card_serial_number (string)
. new_sim_card_serial_number (string)
} (object) required
portal_admin/post_v1_facilitator_listUtilize esse endpoint para listar os Facilitadores:data: {
. cnpj (string)
. facilitator_id (number)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_facilitator_updateUtilize esse endpoint para atualizar os dados do Facilitador:data: {
. acquirer_code (string)
. subacquirer_code (string)
. facilitator_name (string)
. business_name (string)
. seller_id (string)
. merchant_id (string)
. cnpj (string)
. schedule_calculate_mode (string)
. own_store_code (string)
. order_item_mode (string)
. rate_mode (string)
. is_closed_base (string)
} (object) required
portal_admin/post_v1_fee_facilitator_listUtilize esse endpoint para listar as Taxas do Facilitador:data: {
. facilitator_id (string)
. cod_plan (string)
. mcc_code (string)
. product_id (string)
. transaction_type (string)
. status_name (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_fee_facilitator_createUtilize esse endpoint para criar a Taxa do Facilitador:data: {
. acquirer_code (string)
. subacquirer_code (string)
. facilitator_id (string)
. cod_plan (string)
. mcc_code (string)
. product_id (string)
. transaction_type (string)
. installments (number)
. date_init (string)
. date_end (string)
. mdr_facility_percent (string)
. fee_plataform_percent (string)
. mdr_facility_value (string)
. fee_plataform_value (string)
. max_mdr_facility_value (string)
. fee_plataform_ (string)
. mrd_facility_percent_month (string)
. fee_plataform_percent_month (string)
. change_control (string)
. register_status_code (string)
} (object) required
portal_admin/post_v2_fee_seller_listUtilize esse endpoint para listar as Taxas da Loja:data: {
. seller_id (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v2_fee_seller_createUtilize esse endpoint para criar a Taxa da Loja:data: {
. acquirer_code (string)
. subacquirer_code (string)
. facilitator_id (string)
. combo_cod (string)
. cod_plan (string)
. mcc_code (string)
. product_id (string)
. transaction_type (string)
. installments (number)
. date_init (string)
. date_end (string)
. mdr_percentage (string)
. mdr_percentage_min (string)
. mdr_percentage_max (string)
. mdr_value (string)
. mdr_value_min (string)
. mdr_value_max (string)
. mdr_max_value (string)
. mdr_max_value_min (string)
. mdr_max_value_max (string)
. mdr_percentage_month (string)
. mdr_percentage_month_min (string)
. mdr_percentage_month_max (string)
. change_control (string)
. register_status_code (string)
} (object) required
portal_admin/post_v1_fee_seller_custom_listUtilize esse endpoint para listar a Personalização de Taxa:data: {
. seller_id (string)
. combo_cod (string)
. cod_plan (string)
. mcc_code (string)
. product_id (string)
. transaction_type (string)
. status_name (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_fee_seller_custom_createUtilize esse endpoint para criar a Personalização de Taxa:data: {
. acquirer_code (string)
. subacquirer_code (string)
. seller_id (string)
. product_id (string)
. transaction_type (string)
. installments (number)
. date_init (string)
. date_end (string)
. mdr_percentage (string)
. mdr_value (string)
. mdr_max_value (string)
. mdr_percentage_month (string)
. register_status_code (string)
} (object) required
portal_admin/post_v1_fee_subacquirer_listUtilize esse endpoint para listar as Taxas do Subadquirente:data: {
. facilitator_id (string)
. mcc_code (string)
. product_id (string)
. transaction_type (string)
. status_name (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_fee_subacquirer_createUtilize esse endpoint para criar as Taxas do Subadquirente:data: {
. acquirer_code (string)
. subacquirer_code (string)
. facilitator_id (string)
. mcc_code (string)
. product_id (string)
. transaction_type (string)
. installments (number)
. date_init (string)
. date_end (string)
. mdr_acquirer_percent (string)
. mdr_acquirer_value (string)
. mdr_acquirer_maxvalue (string)
. register_status_code (string)
. change_control (string)
} (object) required
portal_admin/post_v1_lead_seller_listUtilize esse endpoint para listar os Pré Cadastros:data: {
. cpf_cnpj (string)
. status_lead_seller_code (string)
. facilitator_id (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_lead_seller_terminal_listUtilize esse endpoint para listar os terminais do pré cadastro:data: {
. mid (string)
. seller_id (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v5_onboarding_cnae_fees_listUtilize esse endpoint para listar as taxas pelo CNAE:data: {
. facilitator_id (string)
. cnae (integer)
. param (string)
} (object) required
portal_admin/post_v5_onboarding_listUtilize esse endpoint para listar os pré-cadastros das lojas:data: {
. type_person (string)
. document (string)
. status_code (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v5_onboarding_pjUtilize esse endpoint para pré-cadastro de pessoa jurídica: Para credenciamento de Lojas Presenciais deve ser preenchido o list de list_equipment_registerdata: {
. contact_name (string)
. cnpj (string)
. social_name (string)
. business_name (string)
. cnae_code (string)
. combo_code (string)
. document_number (string)
. monthly_average (string)
. use_same_tax_address (boolean)
. list_bankaddress (array)
. list_members (array)
. list_terminal_pricing (array)
. list_equipment_register (array)
. cod_name_commercial (string)
} (object) required
portal_admin/post_v5_onboarding_pfUtilize esse endpoint para pré-cadastro de pessoa física. Para credenciamento de Lojas Presenciais deve ser preenchido o list de list_equipment_register. Para precificação de terminal deve ser preenchido o list list_terminal_pricing. Para caso de endereço de Entrega diferente do Fiscal, os campos de endereço de entrega devem ser preenchidos.data: {
. contact_name (string)
. cpf (string)
. name (string)
. cnae_code (string)
. combo_code (string)
. document_number (string)
. legal_nature_code (string)
. monthly_average (number)
. identification_document (string)
. email (string)
. birth_date (string)
. fiscal_address (string)
. fiscal_address_complement (string)
. fiscal_address_number (string)
. fiscal_address_neighborhood (string)
. fiscal_address_city (string)
. fiscal_address_state (string)
. fiscal_address_cep (string)
. use_same_tax_address (boolean)
. delivery_address (string)
. delivery_address_number (string)
. delivery_address_complement (string)
. delivery_address_neighborhood (string)
. delivery_address_city (string)
. delivery_address_state (string)
. delivery_address_cep (string)
. telephone_ddd (string)
. telephone_number (string)
. celular_ddd (string)
. celular_number (string)
. procurator_name (string)
. procurator_birth_date (string)
. procurator_cpf (string)
. nacionality_procurator_name (string)
. politically_exposed_persons (boolean)
. occupation_code (string)
. company_formation_code (string)
. re_registration (boolean)
. list_bankaddress (array)
. list_members (array)
. list_terminal_pricing (array)
. list_equipment_register (array)
. cod_name_commercial (string)
} (object) required
portal_admin/post_v5_onboarding_persontaxUtilize esse endpoint para solicitar taxas personalizadas:data: {
. param (string)
. brand_product_code (string)
. mcc_code (string)
. transaction_type_code (string)
. date_init (string)
. date_end (string)
. number_installments (number)
. percent_mdr (string)
. value_mdr (string)
. value_max_mdr (string)
. payment_plan_code (string)
. combo_code (string)
. seller_id (string)
} (object) required
portal_admin/post_v5_onboarding_confirmUtilize esse endpoint para concluir o cadastro e enviar para análise:data: {
. param (string)
. document (string)
. type_person (string)
} (object) required
portal_admin/post_v1_order_listUtilize esse endpoint para listar os Pedidos:data: {
. order_init_date (string)
. facilitator_id (string)
. order_number (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_payment_plan_listUtilize esse endpoint para listar os Planos de Pagamentos:data: {
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_payment_plan_createUtilize esse endpoint para criar os Planos de Pagamentos:data: {
. acquirer_code (string)
. subacquirer_code (string)
. pay_plan_name (string)
. allows_anticipate (string)
} (object) required
portal_admin/post_v1_payments_listUtilize esse endpoint para listar as transações :data: {
. date_init (string)
. seller_id (string)
. transaction_status_code (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_transacao_listUtilize esse endpoint para listar os Pagamentos:data: {
. facilitator_id (string)
. seller_id (string)
. transaction_date_init (string)
. authorization_code (string)
. serial_number (string)
. terminal_nsu (string)
. product_id (string)
. transaction_type (string)
. transaction_status_code (string)
. transaction_id (number)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_transacao_cancellationUtilize esse endpoint para cancelar uma transação parcialmente ou integralmente:data: {
. seqlTransaction (number)
. amount (string)
. cancelType (number)
} (object) required
portal_admin/post_v1_transacao_cancellation2Utilize esse endpoint para cancelar uma transação parcialmente ou integralmente por PaymentID:data: {
. numPaymentID (string)
. amount (string)
. cancelType (number)
} (object) required
portal_admin/post_v1_receive_bank_account_receiveImplemente essa interface em seu sistema para receber os domicílios bancários via webhook:data: {
. bank_account_id (integer)
. seller_id (integer)
. product_id (integer)
. bank_code (integer)
. agency (integer)
. agency_dv (string)
. account (integer)
. account_dv (string)
. account_type_code (string)
. create_date (string)
. information_date (string)
} (object) required
portal_admin/post_v1_receive_credentials_credentialsImplemente essa interface em seu sistema para receber as credenciais do e-commerce para loja:data: {
. seller_id (integer)
. seller_name (string)
. document (string)
. client_id (string)
. client_secret (string)
. merchant_id (string)
} (object) required
portal_admin/post_v1_receive_equipament_seller_receiveStatusdata: {
. facilitator_id (integer)
. register_status_code (string)
. type_equipment_code (string)
. create_date (string)
. update_date (string)
. serial_number (string)
. responsible_user_code (string)
. responsible_group_code (integer)
. equipment_code (number)
. manufacturer_code (string)
. terminal_model_code (string)
. create_user_code (string)
. alter_user_code (string)
. change_control (string)
. equipment_status_code (string)
. delete_date (string)
} (object) required
portal_admin/post_v1_receive_fee_seller_receiveImplemente essa interface em seu sistema para receber as taxas para lojas via webhook:data: {
. fee_seller_code (number)
. acquirer_code (string)
. subacquirer_code (string)
. partner_code (integer)
. mcc_code (string)
. product_id (string)
. register_status_code (string)
. transaction_type (string)
. date_init (string)
. date_end (string)
. create_date (string)
. update_date (string)
. status_name (string)
. installments (number)
. mdr_percentage (string)
. mdr_percentage_min (string)
. mdr_percentage_max (string)
. mdr_percentage_month (string)
. mdr_percentage_month_max (string)
. mdr_percentage_month_min (string)
. cod_plan (string)
. combo_cod (string)
. create_user_code (integer)
. create_user_name (string)
. alter_user_code (integer)
. alter_user_name (string)
. change_control (string)
. mdr_max_value (string)
. mdr_max_value_min (string)
. mdr_max_value_max (string)
. mdr_value (string)
. mdr_value_min (string)
. mdr_value_max (string)
} (object) required
portal_admin/post_v1_receive_fee_seller_custom_receiveImplemente essa interface em seu sistema para receber as personalizações de taxas para lojas via webhook:data: {
. fee_seller_custom_code (number)
. acquirer_code (string)
. subacquirer_code (string)
. partner_code (integer)
. seller_id (string)
. cod_plan (string)
. mcc_code (string)
. product_id (string)
. register_status_code (string)
. transaction_type (string)
. date_init (string)
. date_end (string)
. create_date (string)
. update_date (string)
. status_name (string)
. installments (number)
. mdr_percentage (string)
. mdr_percentage_month (string)
. combo_cod (string)
. create_user_code (string)
. create_user_name (string)
. alter_user_code (string)
. alter_user_name (string)
. mdr_max_value (string)
. mdr_value (string)
} (object) required
portal_admin/post_v1_receive_lead_seller_terminal_receiveImplemente essa interface em seu sistema para receber os terminais do pré cadastro via webhook:data: {
. facilitator_id (integer)
. seller_terminal_id (number)
. seller_id (string)
. mid (string)
. tid (string)
. create_date (string)
. update_date (string)
. create_user_code (string)
. create_user_name (string)
. alter_user_code (string)
. alter_user_name (string)
. delete_date (string)
} (object) required
portal_admin/post_v2_receive_payments_receiveImplemente essa interface em seu sistema para receber as transações via push:data: {
. acquirer_code (string)
. order_id (string)
. soft_version (string)
. authorization_code (string)
. brand_code (string)
. product_id (string)
. transaction_category_code (string)
. reason_code (string)
. transaction_status_code (string)
. transaction_type (string)
. confirm_date (string)
. transaction_date (string)
. card_mask_number (string)
. reason_message (string)
. installments (integer)
. nsu_eyeson (integer)
. seller_id (integer)
. transaction_id (integer)
. transaction_ref (integer)
. transaction_amount (string)
. terminal_nsu (string)
. acquirer_nsu (string)
. terminal_id (integer)
. serial_number (string)
. terminal_transaction_date (string)
. eyeson_in_transaction_date (string)
. eyeson_out_transaction_date (string)
. transaction_currency (string)
. cod_plan (integer)
. payment_id (string)
. mcc (string)
. transaction_orign (string)
. merchant_id (string)
. capture_method (string)
. entry_mode (string)
. 3ds_indicator (string)
. anti_fraud_indicator (string)
. reversal_indicator (string)
. cvv_present (string)
. pin_present (string)
. terminal_name (string)
} (object) required
portal_admin/post_v1_receive_schedule_receiveImplemente essa interface em seu sistema para receber as agendas via push:data: {
. schedule_id (integer)
. schedule_type_code (integer)
. transaction_id (integer)
. seller_id (integer)
. product_id (integer)
. create_date (string)
. schedule_installment (integer)
. schedule_total_installments (integer)
. net_schedule_amount (string)
. schedule_efetive_date (string)
. unlock_payment_date (string)
. information_date (string)
. payment_date (string)
. gross_schedule_amount (string)
. discount_schedule_amount (string)
. contract_cnpj_institute (integer)
. contract_document (integer)
. contract_banking (integer)
. contract_agency (integer)
. contract_agency_dv (string)
. contract_account (integer)
. contract_account_dv (string)
} (object) required
portal_admin/post_v1_receive_seller_receiveImplemente essa interface em seu sistema para receber as lojas via webhook:data: {
. acquirer_code (integer)
. subacquirer_code (integer)
. partner_code (integer)
. partner_name (string)
. merchant_id (string)
. seller_id (integer)
. seller_name (string)
. type (string)
. cpf_cnpj (integer)
. email (string)
. business_name (string)
. state_registration (integer)
. legal_nature_code (string)
. cnae (integer)
. mcc_code (integer)
. nationality (string)
. father_name (string)
. mother_name (string)
. foundation_birth_date (string)
. birth_city (string)
. address_state_birth (string)
. monthly_average (string)
. equity_value (string)
. type_document (string)
. document_number (integer)
. date_exped_document (string)
. valid_document_date (string)
. dispatching_body (string)
. address_state_exped (string)
. fiscal_address (string)
. fiscal_address_number (integer)
. fiscal_address_complement (string)
. fiscal_address_neighborhood (string)
. fiscal_address_city (string)
. fiscal_address_state (string)
. fiscal_address_cep (integer)
. telephone_ddd (integer)
. telephone_number (integer)
. cellphone_ddd (integer)
. cellphone_number (integer)
. contact_name (string)
. procurator_name (string)
. procurator_cpf (integer)
. procurator_birth_date (string)
. occupation_code (string)
. is_ppe (string)
. ppe_name (string)
. cod_plan (integer)
. combo_code (integer)
. register_date (string)
. daily_limit_value (string)
. monthly_limit_value (string)
. capture_block_date (string)
. schedule_block_date (string)
. status_seller (string)
. url_callback (string)
. use_limit (string)
. accepted_contract (string)
. ind_billing (string)
. anticipation_of_receivables (string)
. limit_anticip_percent (integer)
. create_date (string)
. update_date (string)
. register_status_code (string)
. create_user_code (integer)
. create_user_name (string)
. alter_user_code (integer)
. alter_user_name (string)
. liability_chargeback (string)
. takes_on_commission (string)
. is_seller_owner (string)
. disaccreditation_reason_code (string)
. information_date (string)
} (object) required
portal_admin/post_v1_receive_terminal_receiveImplemente essa interface em seu sistema para receber os terminais credenciados via webhook:data: {
. subacquirer_code (string)
. terminal_code (number)
. facilitator_id (integer)
. seller_id (string)
. enable_termcredit_adm (string)
. enable_termcredit_merchant (string)
. enable_creditsight (string)
. enable_debit (string)
. acquirer_code (string)
. register_status_code (string)
. terminal_paramreset_code (string)
. type_terminal_code (string)
. create_date (string)
. disabled_date (string)
. update_date (string)
. terminal_id (string)
. terminal_profile_code (string)
. create_user_code (string)
. create_user_name (string)
. alter_user_code (string)
. alter_user_name (string)
. terminal_status_code (string)
. serial_number (string)
. delete_date (string)
} (object) required
portal_admin/post_v1_receive_terminal_equipament_receiveImplemente essa interface em seu sistema para receber as relações de terminais com equipamento via webhook:data: {
. facilitator_id (integer)
. terminal_equipment_code (number)
. equipment_code (string)
. terminal_code (string)
. is_identifier (string)
. typesingle_equipment (string)
. register_status_code (string)
. type_equipment_code (string)
. type_terminal_code (string)
. create_date (string)
. update_date (string)
. create_user_code (string)
. create_user_name (string)
. alter_user_code (string)
. alter_user_name (string)
. delete_date (string)
} (object) required
portal_admin/post_v1_sales_simulator_get_transaction_informationUtilize esse endpoint para simular uma venda:data: {
. facilitator_id (integer)
. seller_id (integer)
. cod_type_tran (string)
. cod_brand (string)
. number_of_installments (string)
. transaction_value (string)
} (object) required
portal_admin/post_v1_schedule_ec_synthetic_statementUtilize esse endpoint para listar o resumo de recebíveis das lojas:data: {
. schedule_date_init (string)
. schedule_date_end (string)
. seller_id (integer)
. start (integer)
. length (integer)
. Cod_Acquirer (string)
. Seql_SubAcquirer (string)
} (object) required
portal_admin/post_v1_schedule_receivables_analytic_statementUtilize esse endpoint para listar o extrato analítico de recebíveis da loja : pbINSTRUÇÕES/b p Utilize o filtro date_init / date_end ou schedule_date_init / schedule_date_end ou transaction_id p p Caso seja fornecido date_init / date_end span _ngcontent-c12='' class='param-required'Máximo de 3 meses/span será retornado apenas agendas relacionadas a transações p p Caso seja fornecido schedule_date_init / schedule_date_end span _ngcontent-c12='' class='param-required'Máximo de 3 meses/spanserádata: {
. date_init (string)
. date_end (string)
. schedule_date_init (string)
. schedule_date_end (string)
. seller_id (integer)
. transaction_id (integer)
. Cod_Acquirer (string)
. Seql_SubAcquirer (string)
. TipoRelatorio (string)
. Bit_ExibeQtde (string)
. start (integer)
. length (integer)
} (object) required
portal_admin/post_v1_schedule_receivables_synthetic_statementUtilize esse endpoint para listar o resumo de recebíveis das lojas:data: {
. schedule_date_init (string)
. schedule_date_end (string)
. seller_id (integer)
. Cod_Acquirer (string)
. Seql_SubAcquirer (string)
} (object) required
portal_admin/post_v1_schedule_receivables_transfer_generateUtilize esse endpoint para gerar valores de pré transferência de agenda 1ª Etapa da Transferência de Agenda:data: {
. source_seller_id (integer)
. destination_seller_id (integer)
. terms_of_acceptance (string)
} (object) required
portal_admin/post_v1_schedule_receivables_transfer_listUtilize esse endpoint para listar valores gerados na pré transferência de agenda2ª Etapa da Transferência de Agenda:data: {
. pre_schedule_transfer_id (integer)
. facilitador_id (integer)
} (object) required
portal_admin/post_v1_schedule_receivables_transfer_effectiveUtilize esse endpoint para efetiva a transferência de agenda com as datas selecionadas 3ª Etapa da Transferência de Agenda:data: {
. source_seller_id (integer)
. destination_seller_id (integer)
. pre_schedule_transfer_id (integer)
. requested_amount (number)
. list_pre_schedule_transfer_detail (string)
. terms_of_accept_transf (string)
. ind_apiadmin (string)
} (object) required
portal_admin/post_v1_schedule_receivables_anticipation_generateUtilize esse endpoint para gerar valores de antecipação 1ª Etapa da Antecipação:data: {
. seller_id (integer)
. facilitador_id (integer)
} (object) required
portal_admin/post_v1_schedule_receivables_anticipation_listUtilize esse endpoint para listar valores gerados na pré antecipação. 2ª Etapa da Antecipação:data: {
. facilitador_id (integer)
. pre_anticipation_id (integer)
} (object) required
portal_admin/post_v1_schedule_receivables_anticipation_effectiveUtilize esse endpoint para efetivar a antecipação selecionada 3ª Etapa da Antecipação:data: {
. seller_id (integer)
. requested_amount (number)
. pre_anticipation_id (integer)
. list_pre_anticipation_detail_id (string)
. terms_of_accept_anticipation (string)
} (object) required
portal_admin/post_v1_schedule_receivables_schedule_listListagem das agendas:data: {
. seller_id (string)
. schedule_date_init (string)
. schedule_date_end (string)
. transaction_id (number)
. schedule_type_code (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_seller_listUtilize esse endpoint para listar as Lojas:data: {
. status_seller (string)
. cpf_cnpj (string)
. seller_id (number)
. facilitator_id (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_seller_mdrUtilize esse endpoint para listar as taxas da loja:data: {
. seller_id (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_seller_update_fee_comboUtilize esse endpoint para atualizar cadastro da loja preço, plano, valor diário, valor mensal, bloquear captura e habilitar limite mensal diário. : pbINSTRUÇÕES/b p loja seller_id é obrigatório. p Caso seja fornecido combo_cod tem que ser de uma tabela de preço que exista, será alterado a tabela de preço. P Caso seja fornecido cod_plan tem que ser de uma tabela de plano que exista, será alterado a tabela plano de pagamento. P Caso seja fornecido monthly_limit_value será alterado o valor limitedata: {
. param (string)
. seller_id (integer)
. combo_cod (integer)
. cod_plan (integer)
. monthly_limit_value (string)
. daily_limit_value (string)
. is_block_capture (string)
. is_use_limit (string)
} (object) required
portal_admin/post_v1_seller_updateUtilize esse endpoint para atualizar os dados da loja:data: {
. param (string)
. seller_id (string)
. seller_name (string)
. email (string)
. business_name (string)
. foundation_date (string)
. legal_nature_code (string)
. monthly_average (string)
. equity_value (string)
. fiscal_address (string)
. fiscal_address_number (integer)
. fiscal_address_complement (string)
. fiscal_address_neighborhood (string)
. fiscal_address_city (string)
. fiscal_address_state (string)
. fiscal_address_cep (string)
. telephone_ddd (integer)
. telephone_number (integer)
. celular_ddd (integer)
. celular_number (string)
. contact_name (string)
. cod_name_commercial (integer)
. vlr_fat_prom (string)
. perc_fat_prom (string)
. num_month_fat_prom (integer)
. ind_enable_fat_prom (string)
} (object) required
portal_admin/post_v1_seller_seller_responsable_commercialUtilize esse endpoint para listar as lojas vinculadas a um responsável comercial:data: {
. nom_login (string)
} (object) required
portal_admin/post_v1_seller_bank_account_listUtilize esse endpoint para listar os Dados Bancários Subseller:data: {
. seller_id (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_seller_bank_account_updateUtilize esse endpoint para criar os Dados Bancários da Loja:data: {
. seller_id (string)
. product_id (string)
. bank (string)
. agency (number)
. digit_agency (string)
. bank_account_type (string)
. account (number)
. account_digit (string)
} (object) required
portal_admin/post_v1_seller_partner_listUtilize esse endpoint para listar os Sócio da Loja:data: {
. seller_id (string)
. cpf_cnpj (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_seller_partner_updateUtilize esse endpoint para atualizar os Sócio da Loja:data: {
. seller_id (string)
. cpf_cnpj (string)
. type (string)
. seller_partner_name (string)
. state_registration (number)
. started_relationship_date (string)
. participation (string)
. legal_nature_code (string)
. cnae (string)
. type_document (string)
. document_number (number)
. date_exped_ducument (string)
. valid_document_date (string)
. dispatching_body (string)
. address_state_exped (string)
. nationality (string)
. father_name (string)
. mother_name (string)
. foundation_date (string)
. address_state_birth (string)
. is_ppe (string)
. ppe_name (string)
. email (string)
. contact_name (string)
. telephone_ddd (number)
. telephone_number (number)
. celular_ddd (number)
. celular_number (number)
. monthly_average (string)
. equity_value (string)
. change_control (string)
} (object) required
portal_admin/post_v1_seller_sso_createUtilize esse endpoint para retornar uma url de redirecionamento para login transparente da loja:data: {
. user_id (string)
. facilitator_id (string)
. seller_id (string)
. url_redirect (string)
} (object) required
portal_admin/post_v1_seller_sso_validateUtilize esse endpoint para validar o token para login transparente da loja:data: {
. token (string)
} (object) required
portal_admin/post_v1_terminal_listUtilize esse endpoint para listar os Terminais:data: {
. type_terminal_code (string)
. serial_number (string)
. seller_id (string)
. terminal_id (string)
. terminal_status_code (string)
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_terminal_createUtilize esse endpoint para criar os Terminais:data: {
. seller_id (string)
. terminal_profile_code (string)
. type_terminal_code (string)
. terminal_id (string)
. terminal_paramreset_code (string)
. terminal_status_code (string)
. enable_termcredit_adm (string)
. enable_creditsight (string)
. enable_termcredit_merchant (string)
. enable_debit (string)
. change_control (string)
} (object) required
portal_admin/post_v1_terminal_equipment_listUtilize esse endpoint para listar as associações de terminal com equipamento:data: {
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_terminal_equipment_createUtilize esse endpoint para criar assuciação de terminal com equipamento:data: {
. terminal_code (string)
. equipment_code (string)
. change_control (string)
} (object) required
portal_admin/post_v1_terminal_model_listUtilize esse endpoint para listar os Modelos:data: {
. start (number)
. length (number)
} (object) required
portal_admin/post_v1_terminal_model_createUtilize esse endpoint para criar os Modelos:data: {
. terminal_model_name (string)
. manufacturer_code (string)
. change_control (string)
. TrmModeloPropriedade_Seql_TrmModelo (string)
} (object) required
portal_admin/get_v1_user_paramsUtilize esse endpoint para listar os parâmetros do usuário:No parameters
portal_admin/post_v1_user_listUtilize esse endpoint para listar os usuários:data: {
. group_id (string)
} (object) required
portal_admin/get_v1_user_userresponsiblecommercialUtilize esse endpoint para listar os usuarios responsavéis Comercial:No parameters