Skip to main content

Banco ABC

APIs de Pagamentos, Transferências, Pix, Bolepix, Comprovantes, Extrato, DDA, Boletos e Francesinha.

Banco ABC 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 77 actions:

ActionPurposeParameters
pagamentos/post_auth_realms_abcbrasil_externo_protocol_openid_connect_tokenAutenticacaoNo parameters
pagamentos/post_baas_pagamento_open_api_v1_payments_bar_code_previewbar-code-previewdata: {
. PaymentCode (string)
. Date (string)
} (object) required
pagamentos/post_baas_pagamento_open_api_v1_paymentspaymentsdata: {
. paymentCode (string)
. date (string)
. amount (string)
. payer (object)
. debtor (object)
} (object) required
pagamentos/get_baas_pagamento_open_api_v1_payments_by_idpaymentsid (string) required
data: {
. paymentCode (string)
. date (string)
. amount (string)
. payer (object)
. debtor (object)
} (object) required
pagamentos/patch_baas_pagamento_open_api_v1_payments_by_id_cancelcancelid (string) required
pagamentos/get_baas_pagamento_open_api_v1_payments_by_id_receiptsreceiptsid (string) required
pagamentos/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
transferencias/get_teds_by_id/teds/:idid (string) required
transferencias/patch_teds_by_id_cancel/teds/:id/cancelid (string) required
transferencias/post_teds/tedsdata: {
. date (string)
. amount (string)
. purpose (string)
. debtor (object)
. creditor (object)
} (object) required
transferencias/get_teds/tedsNo parameters
transferencias/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
pix_pagamentos/post_baas_pix_open_api_v1_pix/pixdata: {
. date (string)
. currency (string)
. amount (string)
. remittanceInformation (string)
. debtor (object)
. localInstrument (string)
. creditor (object)
} (object) required
pix_pagamentos/get_baas_pix_open_api_v1_pix/pix/searchcreatedAtStart (string)
createdAtEnd (string)
pix_pagamentos/get_baas_pix_open_api_v1_pix_by_id/pix/idId (string) required
pix_pagamentos/get_baas_pix_open_api_v1_pix_by_id_receipts/pix/id/receiptsId (string) required
pix_pagamentos/post_auth_realms_abcbrasil_externo_protocol_openid_connect_tokenAutenticacaoNo parameters
pix_pagamentos/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
pix_recebimentos/put_cob_by_txidEndpoint para criar uma cobrança imediata.txid (string) required
data: {
. calendario (object)
. devedor (object)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
. infoAdicionais (array)
} (object) required
pix_recebimentos/patch_cob_by_txidRevisar cobrança imediata.txid (string) required
data: {
. loc (object)
. devedor (object)
. valor (object)
. solicitacaoPagador (string)
} (object) required
pix_recebimentos/get_cob_by_txidEndpoint para consultar uma cobrança através de um determinado txid.txid (string) required
revisao (string)
pix_recebimentos/post_cobEndpoint para criar uma cobrança imediata, neste caso, o txid deve ser definido pelo PSP.data: {
. calendario (object)
. devedor (object)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
. infoAdicionais (array)
} (object) required
pix_recebimentos/get_cobEndpoint para consultar cobranças imediatas através de parâmetros como início, fim, cpf, cnpj e status.inicio (string)
fim (string)
cpf (string)
cnpj (string)
locationPresente (string)
status (string)
paginacao.paginaAtual (string)
paginacao.itensPorPagina (string)
pix_recebimentos/put_cobv_by_txidEndpoint para criar uma cobrança com vencimento.txid (string) required
data: {
. calendario (object)
. loc (object)
. devedor (object)
. valor (object)
. chave (string)
. solicitacaoPagador (string)
} (object) required
pix_recebimentos/patch_cobv_by_txidRevisar cobrança com vencimento.txid (string) required
data: {
. loc (object)
. devedor (object)
. valor (object)
. solicitacaoPagador (string)
} (object) required
pix_recebimentos/get_cobv_by_txidEndpoint para consultar uma cobrança com vencimento através de um determinado txid.txid (string) required
revisao (string)
pix_recebimentos/get_cobvEndpoint para consultar cobranças com vencimento através de parâmetros como início, fim, cpf, cnpj e status.inicio (string)
fim (string)
cpf (string)
cnpj (string)
locationPresente (string)
status (string)
loteCobVId (string)
paginacao.paginaAtual (string)
paginacao.itensPorPagina (string)
pix_recebimentos/put_lotecobv_by_idEndpoint utilizado para criar ou alterar um lote de cobranças com vencimento. Para o caso de uso de alteração de cobranças, o array a ser atribuído na requisicão deve ser composto pelas exatas requisições de criação de cobranças que constaram no array atribuído na requisição originária. Não se pode utilizar este endpoint para alterar um lote de cobranças com vencimento agregando ou removendo cobranças já existentes dentro do conjunto de cobranças criadas na requisição originária do lote. Emid (string) required
data: {
. descricao (string)
. cobsv (array)
} (object) required
pix_recebimentos/patch_lotecobv_by_idEndpoint utilizado para revisar cobranças específicas dentro de um lote de cobranças com vencimento. A diferença deste endpoint para o endpoint PUT correlato é que este endpoint admite um array cobsv com menos solicitações de criação ou alteração de cobranças do que o array atribuído na requisição originária do lote. Não se pode, entretanto, utilizar esse endpoint para agregar ou remover solicitações de alteração ou criação de cobranças conforme constam na requisição originária do lote.id (string) required
data: {
. cobsv (array)
} (object) required
pix_recebimentos/get_lotecobv_by_idEndpoint para consultar um lote de cobranças com vencimento.id (string) required
pix_recebimentos/get_lotecobvEndpoint para consultar lista de lotes de cobranças com vencimento.inicio (string)
fim (string)
paginacao.paginaAtual (string)
paginacao.itensPorPagina (string)
pix_recebimentos/get_loc_by_idRecupera a location do payloadid (string) required
pix_recebimentos/delete_loc_by_id_txidEndpoint utilizado para desvincular uma cobrança de uma location. Se executado com sucesso, a entidade loc não apresentará mais um txid, se apresentava anteriormente à chamada. Adicionalmente, a entidade cob ou cobv associada ao txid desvinculado também passará a não mais apresentar um location. Esta operação não altera o status da cob ou cobv em questão.id (string) required
pix_recebimentos/post_locCriar location do payloaddata: {
. tipoCob (string)
} (object) required
pix_recebimentos/get_locEndpoint para consultar locations cadastradasinicio (string)
fim (string)
txIdPresente (string)
tipoCob (string)
paginacao.paginaAtual (string)
paginacao.itensPorPagina (string)
pix_recebimentos/put_pix_by_e2eid_devolucao_by_idEndpoint para solicitar uma devolução através de um e2eid do Pix e do ID da devolução. O motivo que será atribuído à PACS.004 será 'MD06' ou 'SL02' de acordo com a aba RTReason da PACS.004 que consta no Catálogo de Mensagens do Pix a depender da natureza da devolução Vide a descrição deste campo.e2eid (string) required
id (string) required
data: {
. valor (string)
} (object) required
pix_recebimentos/get_pix_by_e2eid_devolucao_by_idEndpoint para consultar uma devolução através de um End To End ID do Pix e do ID da devoluçãoe2eid (string) required
id (string) required
pix_recebimentos/get_pix_by_e2eidEndpoint para consultar um Pix através de um e2eid.e2eid (string) required
pix_recebimentos/get_pixEndpoint para consultar Pix recebidosinicio (string)
fim (string)
value (string)
txIdPresente (string)
devolucaoPresente (string)
cpf (string)
cnpj (string)
paginacao.paginaAtual (string)
paginacao.itensPorPagina (string)
pix_recebimentos/put_webhook_by_chaveEndpoint para configuração do serviço de notificações acerca de Pix recebidos. Somente Pix associados a um txid serão notificados.chave (string) required
data (object) required
pix_recebimentos/get_webhook_by_chaveEndpoint para recuperação de informações sobre o Webhook Pix.chave (string) required
pix_recebimentos/delete_webhook_by_chaveEndpoint para cancelamento do webhook. Não é a única forma pela qual um webhook pode ser removido. O PSP recebedor está livre para remover unilateralmente um webhook que esteja associado a uma chave que não pertence mais a este usuário recebedor.chave (string) required
pix_recebimentos/get_webhookEndpoint para consultar Webhooks cadastradosinicio (string)
fim (string)
paginacao.paginaAtual (string)
paginacao.itensPorPagina (string)
pix_recebimentos/put_qrcode_by_txidEndpoint para criar um QRCode de cobrança imediata/com vencimento.txid (string) required
pix_recebimentos/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
bolepix/post_abcdigital_boleto_online_api_v1_0_boleto_simplificadoBoleto Simplificadodata: {
. codCliente (string)
. numContaHeader (string)
. numCarteira (string)
. nossoNumero (string)
. codBanco (string)
. codModalBancos (string)
. nossoNumeroBancos (string)
. codEspecieDoc (string)
. vlrNominal (integer)
. vlrAbatimento (integer)
. dataEmissao (string)
. dataVencimento (string)
. seuNumero (string)
. aceite (string)
. cnpjCPF (string)
. tipoPessoa (string)
. nome (string)
. endereco (string)
. bairro (string)
. cidade (string)
. uf (string)
. cep (string)
. email (string)
. ddd (string)
. telefone (string)
. campoLivre (string)
. tipoPessoaSacador (string)
. cnpjCPFSacador (string)
. nomeSacador (string)
. enderecoSacador (string)
. bairroSacador (string)
. cepSacador (string)
. cidadeSacador (string)
. ufSacador (string)
. mensagem1 (string)
. mensagem2 (string)
. mensagem3 (string)
. mensagem4 (string)
. mensagem5 (string)
. codDesconto1 (string)
. vlrDesconto1 (integer)
. txDesconto1 (integer)
. dataDesconto1 (string)
. codDesconto2 (string)
. vlrDesconto2 (integer)
. txDesconto2 (integer)
. dataDesconto2 (string)
. codDesconto3 (string)
. vlrDesconto3 (integer)
. txDesconto3 (integer)
. dataDesconto3 (string)
. codMulta (string)
. dataMulta (string)
. txMulta (integer)
. vlrMulta (integer)
. codMora (string)
. dataMora (string)
. txMora (integer)
. vlrMora (integer)
. possuiAgenda (string)
. tipoAgendamento (string)
. criterioDias (string)
. numDiasAgenda (integer)
. codIndice (string)
. indPagtoParcial (string)
. qtdPagtosParciais (string)
. tipoVlrPercMinimo (string)
. vlrPercMinimo (integer)
. tipoVlrPercMaximo (string)
. vlrPercMaximo (integer)
. tipoAutRecDivergente (string)
} (object) required
bolepix/post_abcdigital_boleto_online_api_v1_0_boleto_pdfBoleto PDFdata: {
. codCliente (string)
. numContaHeader (string)
. numCarteira (string)
. nossoNumero (string)
. codBanco (string)
. codModalBancos (string)
. nossoNumeroBancos (string)
. codEspecieDoc (string)
. vlrNominal (integer)
. vlrAbatimento (integer)
. dataEmissao (string)
. dataVencimento (string)
. seuNumero (string)
. aceite (string)
. cnpjCPF (string)
. tipoPessoa (string)
. nome (string)
. endereco (string)
. bairro (string)
. cidade (string)
. uf (string)
. cep (string)
. email (string)
. ddd (string)
. telefone (string)
. campoLivre (string)
. tipoPessoaSacador (string)
. cnpjCPFSacador (string)
. nomeSacador (string)
. enderecoSacador (string)
. bairroSacador (string)
. cepSacador (string)
. cidadeSacador (string)
. ufSacador (string)
. mensagem1 (string)
. mensagem2 (string)
. mensagem3 (string)
. mensagem4 (string)
. mensagem5 (string)
. codDesconto1 (string)
. vlrDesconto1 (integer)
. txDesconto1 (integer)
. dataDesconto1 (string)
. codDesconto2 (string)
. vlrDesconto2 (integer)
. txDesconto2 (integer)
. dataDesconto2 (string)
. codDesconto3 (string)
. vlrDesconto3 (integer)
. txDesconto3 (integer)
. dataDesconto3 (string)
. codMulta (string)
. dataMulta (string)
. txMulta (integer)
. vlrMulta (integer)
. codMora (string)
. dataMora (string)
. txMora (integer)
. vlrMora (integer)
. possuiAgenda (string)
. tipoAgendamento (string)
. criterioDias (string)
. numDiasAgenda (integer)
. codIndice (string)
. indPagtoParcial (string)
. qtdPagtosParciais (string)
. tipoVlrPercMinimo (string)
. vlrPercMinimo (integer)
. tipoVlrPercMaximo (string)
. vlrPercMaximo (integer)
. tipoAutRecDivergente (string)
} (object) required
bolepix/get_abcdigital_boleto_online_api_v1_0_consulta_enviados_by_data_inicio_by_data_termino_by_pagina_atualRelatório de BoletosdataInicio (string) required
dataTermino (string) required
paginaAtual (string) required
bolepix/post_abcdigital_boleto_online_api_v1_0_consulta_envia_titulosEnviar Titulos para Consultadata (object) required
bolepix/get_abcdigital_boleto_online_api_v1_0_consulta_consulta_protocolo_by_idBuscar Situacao Protocoloid (string) required
bolepix/get_abcdigital_boleto_online_api_v1_0_cip_24692994100009000000001144501938010003298282Consulta de dados do boleto na CIPNo parameters
bolepix/get_abcdigital_boleto_online_api_v1_0_boleto2ª via de BoletocodigoPagamento (string)
bolepix/post_abcdigital_boleto_online_api_v1_0_baixa_operacionalBaixaOperacional - Obter IDdata (object) required
bolepix/get_abcdigital_boleto_online_api_v1_0_baixa_operacional_by_idBaixaOperacional - Consultar IDid (string) required
bolepix/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
comprovantes/post_auth_realms_abcbrasil_externo_protocol_openid_connect_tokenAutenticacaoNo parameters
comprovantes/post_baas_comprovante_api_v1_receipts_listreceiptsLista de Comprovantesdata: {
. dateStart (string)
. dateEnd (string)
. dueDateStart (string)
. dueDateEnd (string)
. account (string)
. transactionType (array)
. pageNumber (integer)
. linesPerPage (integer)
} (object) required
comprovantes/get_baas_comprovante_api_v1_receiptsConsultar comprovanteid (string)
comprovantes/post_baas_comprovante_api_v1_receipts_batchgeração de comprovantesdata: {
. id (array)
} (object) required
comprovantes/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
extrato/get_v1_saldo_detalhado_by_agencia_by_contaSaldo Detalhadoagencia (string) required
conta (string) required
extrato/get_v1_extrato_situacao_by_protocolo_by_cod_clienteConsulta de Situação por ProtocoloProtocolo (string) required
CodCliente (string) required
extrato/post_v1_extrato_gerarGeração de Extratodata: {
. codCliente (integer)
. agencia (string)
. conta (string)
. dtInicio (string)
. dtFim (string)
. urlCallback (string)
} (object) required
extrato/get_v1_extrato_conciliacao_by_protocolo_by_cod_cliente_by_numero_da_paginaExtrato ConciliaçãoProtocolo (string) required
CodCliente (string) required
Numero_da_Pagina (string) required
extrato/get_v1_extrato_detalhado_by_protocolo_by_cod_cliente_by_numero_da_paginaExtrato DetalhadoProtocolo (string) required
CodCliente (string) required
Numero_da_Pagina (string) required
extrato/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
dda/get_abcbrasil_openbanking_debitodiretoautorizado_api_api_v1_titulo_titulossacadoRetorna uma lista das solicitações do sacado que foram realizadas de Inclusão e Exclusão ao DDA.CpfCnpjSacado (string)
DataVencimentoInicio (string)
DataVencimentoTermino (string)
CnpjCpfCedente (string)
dda/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
boletos/post_boleto_simplificadoBoleto Simplificadodata: {
. codCliente (string)
. numContaHeader (string)
. numCarteira (string)
. nossoNumero (string)
. codBanco (string)
. codModalBancos (string)
. nossoNumeroBancos (string)
. codEspecieDoc (string)
. vlrNominal (integer)
. vlrAbatimento (integer)
. dataEmissao (string)
. dataVencimento (string)
. seuNumero (string)
. aceite (string)
. cnpjCPF (string)
. tipoPessoa (string)
. nome (string)
. endereco (string)
. bairro (string)
. cidade (string)
. uf (string)
. cep (string)
. email (string)
. ddd (string)
. telefone (string)
. campoLivre (string)
. tipoPessoaSacador (string)
. cnpjCPFSacador (string)
. nomeSacador (string)
. enderecoSacador (string)
. bairroSacador (string)
. cepSacador (string)
. cidadeSacador (string)
. ufSacador (string)
. mensagem1 (string)
. mensagem2 (string)
. mensagem3 (string)
. mensagem4 (string)
. mensagem5 (string)
. codDesconto1 (string)
. vlrDesconto1 (integer)
. txDesconto1 (integer)
. dataDesconto1 (string)
. codDesconto2 (string)
. vlrDesconto2 (integer)
. txDesconto2 (integer)
. dataDesconto2 (string)
. codDesconto3 (string)
. vlrDesconto3 (integer)
. txDesconto3 (integer)
. dataDesconto3 (string)
. codMulta (string)
. dataMulta (string)
. txMulta (integer)
. vlrMulta (integer)
. codMora (string)
. dataMora (string)
. txMora (integer)
. vlrMora (integer)
. possuiAgenda (string)
. tipoAgendamento (string)
. criterioDias (string)
. numDiasAgenda (integer)
. codIndice (string)
. indPagtoParcial (string)
. qtdPagtosParciais (integer)
. tipoVlrPercMinimo (string)
. vlrPercMinimo (integer)
. tipoVlrPercMaximo (string)
. vlrPercMaximo (integer)
. tipoAutRecDivergente (string)
} (object) required
boletos/post_boleto_pdfBoleto PDFdata: {
. codCliente (string)
. numContaHeader (string)
. numCarteira (string)
. nossoNumero (string)
. codBanco (string)
. codModalBancos (string)
. nossoNumeroBancos (string)
. codEspecieDoc (string)
. vlrNominal (integer)
. vlrAbatimento (integer)
. dataEmissao (string)
. dataVencimento (string)
. seuNumero (string)
. aceite (string)
. cnpjCPF (string)
. tipoPessoa (string)
. nome (string)
. endereco (string)
. bairro (string)
. cidade (string)
. uf (string)
. cep (string)
. email (string)
. ddd (string)
. telefone (string)
. campoLivre (string)
. tipoPessoaSacador (string)
. cnpjCPFSacador (string)
. nomeSacador (string)
. enderecoSacador (string)
. bairroSacador (string)
. cepSacador (string)
. cidadeSacador (string)
. ufSacador (string)
. mensagem1 (string)
. mensagem2 (string)
. mensagem3 (string)
. mensagem4 (string)
. mensagem5 (string)
. codDesconto1 (string)
. vlrDesconto1 (integer)
. txDesconto1 (integer)
. dataDesconto1 (string)
. codDesconto2 (string)
. vlrDesconto2 (integer)
. txDesconto2 (integer)
. dataDesconto2 (string)
. codDesconto3 (string)
. vlrDesconto3 (integer)
. txDesconto3 (integer)
. dataDesconto3 (string)
. codMulta (string)
. dataMulta (string)
. txMulta (integer)
. vlrMulta (integer)
. codMora (string)
. dataMora (string)
. txMora (integer)
. vlrMora (integer)
. possuiAgenda (string)
. tipoAgendamento (string)
. criterioDias (string)
. numDiasAgenda (integer)
. codIndice (string)
. indPagtoParcial (string)
. qtdPagtosParciais (integer)
. tipoVlrPercMinimo (string)
. vlrPercMinimo (integer)
. tipoVlrPercMaximo (string)
. vlrPercMaximo (integer)
. tipoAutRecDivergente (string)
} (object) required
boletos/post_consulta_envia_titulosConsulta de Títulosdata: {
. codigoBarras (array)
. urlCallback (string)
} (object) required
boletos/get_consulta_enviados_by_data_inicio_by_data_termino_by_pagina_atualRelatório de BoletosdataInicio (string) required
dataTermino (string) required
paginaAtual (string) required
boletos/get_cip_by_codigo_pagamentoConsulta de Dados na CIPcodigoPagamento (string) required
boletos/get_consulta_consulta_protocolo_by_protocoloConsulta de Status por ProtocoloProtocolo (string) required
boletos/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
francesinha/get_abcbrasil_openbanking_cobranca_api_api_v1_francesinha_operationFrancesinhaDataInicio (string)
DataFim (string)
PaginaAtual (string)
francesinha/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)