Skip to main content

Total Bank

Manage your company's or your clients' bank account through TotalBank

Total Bank 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 54 actions:

ActionPurposeParameters
get_rest_admin_convenios_pesquisaPesquisa de convênios de cobrança, pagamentos e PIX.br/brImportante: convênios em modo de operação consulta podem ser utilizados apenas em métodos de consulta @GET.tipoServico (array)
codigoBanco (string)
post_rest_cobranca_anexo_adicionaAdiciona anexos a títulos.br/brbr/brPara adicionar anexos de uso futuro...data: {
. beneficiario
. filtro
. anexo
} (object) required
get_rest_cobranca_anexo_pesquisaPesquisa de anexos.codigoBancoBeneficiario (string) required
codigoBeneficiario (string) required
cnpjBeneficiario (string) required
cpfCnpjPagador (string)
nossoNumero (string)
seuNumero (string)
usoEmpresa (string)
dataVencimento (string)
valorNominal (number)
situacaoTitulo (array)
post_rest_cobranca_imprime_boletoImpressão de boleto, limitada a 20 títulos.data: {
. beneficiario
. titulos (array)
} (object) required
get_rest_cobranca_imprime_carneImpressão de carnê, limitada a 1 carnê com suas respectivas parcelas.codigoBeneficiario (string) required
cpfCnpjPagador (string) required
nossoNumero (string) required
dataVencimento (string) required
get_rest_cobranca_pagador_consultaConsulta cadastro do pagador. Necessário informar o CPF/CNPJ ou o nome do pagadorcpfCnpjPagador (string)
nomePagador (string)
put_rest_cobranca_pagador_atualizaAtualiza cadastro do pagador.data: {
. pessoa
. endereco
. telefone (string)
. email (string)
. senha (string)
} (object) required
post_rest_cobranca_titulo_movimento_abatimento_alterarMovimento de alteração de abatimento de títulosdata: {
. beneficiario
. titulos (array)
. valorAbatimento (number)
} (object) required
post_rest_cobranca_titulo_movimento_abatimento_cancelarMovimento de cancelamento de abatimento de títulosdata: {
. beneficiario
. titulos (array)
} (object) required
post_rest_cobranca_titulo_movimento_abatimento_concederMovimento de concessão de abatimento de títulosdata: {
. beneficiario
. titulos (array)
. valorAbatimento (number)
} (object) required
post_rest_cobranca_titulo_movimento_baixaMovimenta pedido de baixa títulos.data: {
. beneficiario
. titulos (array)
} (object) required
post_rest_cobranca_titulo_movimento_desconto_alterarMovimento de desconto do título.data: {
. beneficiario
. titulos (array)
. desconto1
. desconto2
. desconto3
} (object) required
post_rest_cobranca_titulo_movimento_desconto_cancelarMovimento de cancelar desconto do título.data: {
. beneficiario
. titulos (array)
} (object) required
post_rest_cobranca_titulo_movimento_desconto_concederMovimento de desconto do título.data: {
. beneficiario
. titulos (array)
. desconto1
. desconto2
. desconto3
} (object) required
post_rest_cobranca_titulo_movimento_negativarMovimenta a negativação de títulos.data: {
. beneficiario
. titulos (array)
} (object) required
post_rest_cobranca_titulo_movimento_protestarMovimenta protesta de títulos.data: {
. beneficiario
. titulos (array)
. diasProtesto (integer)
} (object) required
post_rest_cobranca_titulo_movimento_valor_nominalMovimenta alteração do valor nominal de títulos.data: {
. beneficiario
. titulos (array)
. valorNominal (number)
} (object) required
post_rest_cobranca_titulo_movimento_vencimentoMovimenta a alteração do vencimento dos títulos.data: {
. beneficiario
. titulos (array)
. novaDataVencimento (string)
} (object) required
get_rest_cobranca_titulo_pesquisaPesquisa de títulos, limitada a 100 títulos, mas pode-se buscar a próxima página de acordo com o parâmetro pagina. O resultado da consulta retorna as informações da paginação quantidade de registros e páginas.br/brÉ obrigatório filtrar pelos dados do beneficiário codigoBancoBeneficiario, cnpjBeneficiario e codigoBeneficiario preenchidos ou pelo CPF/CNPJ do pagador cpfCnpjPagador.codigoBancoBeneficiario (string)
codigoBeneficiario (string)
cnpjBeneficiario (string)
cpfCnpjPagador (string)
nossoNumero (string)
seuNumero (string)
usoEmpresa (string)
dataVencimento (string)
valorNominal (number)
situacaoTitulo (array)
pagina (integer)
get_rest_cobranca_titulo_pesquisa_ocorrenciaPesquisa de ocorrências dos títulos, limitada a 100 ocorrências, mas pode-se buscar a próxima página de acordo com o parâmetro pagina. O resultado da consulta retorna as informações da paginação quantidade de registros e páginas.br/brÉ obrigatório filtrar pelos dados do beneficiário codigoBancoBeneficiario, cnpjBeneficiario e codigoBeneficiario preenchidos ou pelo CPF/CNPJ do pagador cpfCnpjPagador.br/brÉ obrigatório filtrar por um título nossoNumero, seuNumero, usoEmpresa preenchidos ou por umcodigoBancoBeneficiario (string)
codigoBeneficiario (string)
cnpjBeneficiario (string)
cpfCnpjPagador (string)
tipoOcorrencia (string)
dataOcorrenciaInicial (string)
dataOcorrenciaFinal (string)
nossoNumero (string)
seuNumero (string)
usoEmpresa (string)
dataVencimento (string)
valorNominal (number)
situacaoTitulo (array)
pagina (integer)
post_rest_cobranca_titulo_registroRegistro de título.data: {
. beneficiario
. contaBeneficiario
. titulo
} (object) required
get_rest_conta_corrente_lancamento_pesquisaPesquisa de lançamentos, limitada a 30 lançamentos, mas pode-se buscar a próxima página de acordo com o parâmetro 'pagina'. O resultado da consulta retorna as informações da paginação quantidade de registros e páginas.br/brImportante:br/brOs campos com informações da origem do lançamento serão retornados na API se o banco fornecer esses dados.dataInicial (string) required
dataFinal (string) required
codigoBanco (string) required
agencia (string) required
conta (string) required
pagina (integer)
get_rest_conta_corrente_saldo_pesquisaPesquisa de saldocodigoBanco (string) required
agencia (string) required
conta (string) required
dataSaldo (string)
somenteComMovimentacao (boolean)
get_rest_crm_titular_pesquisaEndpoint para consultar os titulares.nome (string)
cpfCnpjTitular (string)
pagina (integer)
tamanhoPagina (integer)
get_rest_crm_relacionamento_pesquisa_by_codigo_relacionamentoEndpoint para consultar um relacionamento por Id.codigoRelacionamento (integer)
get_rest_crm_relacionamento_pesquisaEndpoint para consultar os relacionamentos.cnpj (string)
razaoSocial (string)
codigoRelacionamento (integer)
hubId (integer)
criacaoInicial (string)
criacaoFinal (string)
tecnico (integer)
codigoConvenio (string)
apelido (string)
cnpjTitularConvenio (string)
titularConvenio (string)
pagina (integer)
tamanhoPagina (integer)
post_rest_crm_titular_registroRegistro de titular.data: {
. cpfCnpjTitular (string)
. nome (string)
. nomeFantasia (string)
} (object) required
get_rest_pagamento_dda_pesquisaPesquisa de obrigações DDA, limitada a 10 obrigações. Pode-se buscar a próxima página de acordo com o parametro pagina.dataUltimaAlteracao (string)
cpfCnpjBeneficiario (string)
cpfCnpjPagador (string)
dataVencimentoInicial (string)
dataVencimentoFinal (string)
valorDocumentoInicial (number)
valorDocumentoFinal (number)
status (array)
pagina (integer)
get_rest_detran_sp_pesquisaConsulta de débitos veiculares no Detran em SP.br/brImportante: todos os parâmetros são obrigatórios.codigoConvenio (string) required
cnpjPagador (string) required
codigoRenavam (integer) required
agenciaDebito (string) required
contaCorrenteDebito (string) required
dvContaCorrenteDebito (string) required
tributo (string) required
get_rest_detran_sp_comprovantesPesquisa de comprovantes, limitada a 10 movimentações, mas pode-se buscar a próxima página de acordo com o parametro pagina.br/brImportante: esta consulta tem obrigatoriedade do CPF/CNPJ do titular do convênio pagador cpfCnpjPagador e de pelo menos uma das datas dataAgendamento ou dataVencimentocnpjPagador (string) required
dataVencimento (string)
dataVencimentoFinal (string)
dataAgendamento (string)
dataAgendamentoFinal (string)
valorDocumento (number)
valorDocumentoFinal (number)
valorPagamento (number)
valorPagamentoFinal (number)
status (array)
codigoRenavam (integer)
informacaoComplementar (string)
pagina (integer)
post_rest_detran_sp_pagamentoPedido de inclusão de pagamentos de débitos veiculares em SPdata: {
. dataPagamento (string)
. convenioPagador
. tributo (string)
. codigoRenavam (integer)
. codigoPlaca (string)
. cpfCnpjProprietario (string)
. nomeProprietario (string)
. codigoMunicipio (string)
. codigoUF (string)
. debitos (array)
. respostaImediata (boolean)
} (object) required
post_rest_pagamento_favorecido_alterarAlterar um favorecido.data: {
. cpfCnpj (string)
. nomeRazaoSocial (string)
. valor (number)
. numeroEmpresa (string)
. responsavel (string)
. email (string)
. telefone (string)
. endereco
. dadosBancarios (array)
} (object) required
post_rest_pagamento_favorecido_cadastrarCadastrar um favorecido.data: {
. cpfCnpj (string)
. nomeRazaoSocial (string)
. valor (number)
. numeroEmpresa (string)
. responsavel (string)
. email (string)
. telefone (string)
. endereco
. dadosBancarios (array)
} (object) required
post_rest_pagamento_favorecido_excluirExcluir um favorecido.data: {
. cpfCnpj (string)
} (object) required
post_rest_pagamento_favorecido_excluir_dados_bancariosExcluir dados bancários de um favorecido.data: {
. cpfCnpj (string)
. codigoBanco (string)
. tipoConta (string)
. agencia (string)
. conta (string)
} (object) required
post_rest_pagamento_funcionario_alterarAlterar um funcionário.data: {
. cpfCnpj (string)
. nomeRazaoSocial (string)
. numeroEmpresa (string)
. responsavel (string)
. email (string)
. telefone (string)
. endereco
. dadosBancarios (array)
. salario (number)
} (object) required
post_rest_pagamento_funcionario_cadastrarCadastrar um funcionário.data: {
. cpfCnpj (string)
. nomeRazaoSocial (string)
. numeroEmpresa (string)
. responsavel (string)
. email (string)
. telefone (string)
. endereco
. dadosBancarios (array)
. salario (number)
} (object) required
post_rest_pagamento_funcionario_excluirExcluir um funcionário.data: {
. cpfCnpj (string)
} (object) required
post_rest_pagamento_funcionario_excluir_dados_bancariosExcluir dados bancários de um funcionário.data: {
. cpfCnpj (string)
. codigoBanco (string)
. tipoConta (string)
. agencia (string)
. conta (string)
} (object) required
get_rest_pagamento_comprovantesPesquisa de comprovantes, limitada a 100 comprovantes, mas pode-se buscar a próxima página, de acordo com o parametro pagina. O resultado da consulta retorna as informações da paginação quantidade de registros e páginas.br/brImportante: esta consulta tem obrigatoriedade do CPF/CNPJ do titular do convênio pagador cpfCnpjPagador e de pelo menos uma das datas de agendamento ou vencimento dataAgendamento, dataAgendamentoFinal, dataVencimento ou dataVencimentoFinal.cpfCnpjBeneficiario (string)
cpfCnpjPagador (string) required
documentoEmpresa (string)
documentoBanco (string)
dataVencimento (string)
dataVencimentoFinal (string)
dataAgendamento (string)
dataAgendamentoFinal (string)
valorDocumento (number)
valorDocumentoFinal (number)
valorPagamento (number)
valorPagamentoFinal (number)
status (array)
informacaoComplementar (string)
pagina (integer)
get_rest_pagamento_pesquisaPesquisa de pagamentos, limitada a 100 movimentações, mas pode-se buscar a próxima página de acordo com o parametro pagina. O resultado da consulta retorna as informações da paginação quantidade de registros e páginas.br/brImportante: esta consulta tem obrigatoriedade do CPF/CNPJ do titular do convênio pagador cpfCnpjPagador e de pelo menos uma das datas de agendamento ou vencimento dataAgendamento, dataAgendamentoFinal, dataVencimento ou dataVencimentoFinal.cpfCnpjBeneficiario (string)
cpfCnpjPagador (string) required
documentoEmpresa (string)
documentoBanco (string)
dataVencimento (string)
dataVencimentoFinal (string)
dataAgendamento (string)
dataAgendamentoFinal (string)
valorDocumento (number)
valorDocumentoFinal (number)
valorPagamento (number)
valorPagamentoFinal (number)
status (array)
informacaoComplementar (string)
pagina (integer)
post_rest_pagamento_codigo_barrasPedido de inclusão de pagamentos através de código de barras.br/brImportante: caso encontremos erro de validação em algum pagamento do lote, o erro é impeditivo. Nenhum pagamento será acatado e o erro será retornado em cada pagamento do lote, no campo msgValidacao. Se houver erro, este campo estará preenchido.data: {
. pagador
. dataPagamento (string)
. informacaoComplementar (string)
. tipoServico (string)
. pagamentos (array)
} (object) required
post_rest_pagamento_darfPedido de inclusão de pagamentos de Documento de Arrecadação de Receitas Federais DARF.br/brImportante: caso encontremos erro de validação em algum pagamento do lote, o erro é impeditivo. Nenhum pagamento será acatado e o erro será retornado em cada pagamento do lote, no campo msgValidacao. Se houver erro, este campo estará preenchido.data: {
. pagador
. dataPagamento (string)
. informacaoComplementar (string)
. pagamentos (array)
} (object) required
post_rest_pagamento_gpsPedido de inclusão de pagamentos de Guias da Previdência Social GPS.br/brImportante: caso encontremos erro de validação em algum pagamento do lote, o erro é impeditivo. Nenhum pagamento será acatado e o erro será retornado em cada pagamento do lote, no campo msgValidacao. Se houver erro, este campo estará preenchido.data: {
. pagador
. dataPagamento (string)
. informacaoComplementar (string)
. pagamentos (array)
} (object) required
post_rest_pagamento_pixPedido de inclusão de pagamentos através de PIX.br/brImportante: caso encontremos erro de validação em algum pagamento do lote, o erro é impeditivo. Nenhum pagamento será acatado e o erro será retornado em cada pagamento do lote, no campo msgValidacao. Se houver erro, este campo estará preenchido.data: {
. pagador
. dataPagamento (string)
. informacaoComplementar (string)
. pix (array)
} (object) required
post_rest_pagamento_transferenciaPedido de inclusão de transferências em lote de pagamento de qualquer tipo fornecedores, salário ou diversos, por transferência bancária.br/brImportante: caso encontremos erro de validação em algum pagamento do lote, o erro é impeditivo. Nenhum pagamento será acatado e o erro será retornado em cada pagamento do lote, no campo msgValidacao. Se houver erro, este campo estará preenchido.data: {
. pagador
. dataPagamento (string)
. informacaoComplementar (string)
. tipoServico (string)
. transferencias (array)
} (object) required
post_rest_pagamento_exclusaoPedido de exclusão em lote de pagamentos.br/brImportante:br/brO pagamento precisa existir para que a exclusão seja realizada.br/brCaso o pagamento já tenha sido autorizado, não seja registro por API, e esteja nos status agendado ou enviado, será gerada uma remessa de exclusão.br/brCaso o pagamento ainda não tenha sido autorizado, o pagamento será cancelado.data: {
. pagador
. pagamentos (array)
} (object) required
get_rest_pix_cob_qrcode_by_txidEndpoint para baixar o qrcode.txid (string)
width (string)
height (string)
get_rest_pix_cob_by_txidEndpoint para consultar cobrança imediata.txid (string)
get_rest_pix_cobv_by_txidEndpoint para consultar cobranças com vencimento.txid (string)
get_rest_pix_devolucao_by_idEndpoint para consultar solicitação de devolução de pix.id (string)
post_rest_pix_cobEndpoint para criar uma cobrança imediata.No parameters
post_rest_pix_cobvEndpoint para criar uma cobrança com vencimento.No parameters
post_rest_pix_devolucaoEndpoint para solicitar devolução de pix.No parameters