Sicredi
Acesse a API de Cobrança do Sicredi e dados públicos de produtos e serviços através do Open Finance Brasil.
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 44 actions:
| Action | Purpose | Parameters |
|---|---|---|
| cobranca/post_auth_openapi_token | Cria uma chave criptografada access_token usando OAuth2/JWT. Também utilizado para refresh do token. | x-api-key (string) required context (string) required |
| cobranca/post_cobranca_boleto_v1_boletos | Gera boletos individuais de Cobrança Tradicional, Híbrido ou com Distribuição de Crédito. | x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required data: { . tipoCobranca (string) . codigoBeneficiario (string) . pagador . beneficiarioFinal . especieDocumento (string) . nossoNumero (string) . seuNumero (string) . idTituloEmpresa (string) . dataVencimento (string) . diasProtestoAuto (integer) . diasNegativacaoAuto (integer) . validadeAposVencimento (integer) . valor (number) . tipoDesconto (string) . valorDesconto1 (number) . dataDesconto1 (string) . valorDesconto2 (number) . dataDesconto2 (string) . valorDesconto3 (number) . dataDesconto3 (string) . descontoAntecipado (number) . tipoJuros (string) . tipoJurosPercentual (string) . juros (number) . dataInicioJuros (string) . tipoMulta (string) . multa (number) . dataInicioMulta (string) . informativos (array) . mensagens (array) . splitBoleto } (object) required |
| cobranca/get_cobranca_boleto_v1_boletos | Consulta um único boleto através do Nosso Número. | x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required nossoNumero (string) required |
| cobranca/get_cobranca_boleto_v2_boletos | Consulta um único boleto v2 com data-movimento ou boleto com distribuição de crédito split. | x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required data-movimento (boolean) codigoBeneficiario (string) required nossoNumero (string) required retornaDadosSplit (string) |
| cobranca/get_cobranca_boleto_v1_boletos_pdf | Gera impressão ou reimpressão 2ª via do boleto em formato PDF. | x-api-key (string) required Authorization (string) required linhaDigitavel (string) required |
| cobranca/patch_cobranca_boleto_v1_boletos_by_nosso_numero_baixa | Solicita a baixa de um boleto. | nossoNumero (string) x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required data (object) required |
| cobranca/patch_cobranca_boleto_v1_boletos_by_nosso_numero_data_vencimento | Altera a data de vencimento de um boleto. Quando o boleto possui carência para juros/multa, as datas são ajustadas proporcionalmente. | nossoNumero (string) x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required data: { . dataVencimento (string) } (object) required |
| cobranca/patch_cobranca_boleto_v1_boletos_by_nosso_numero_desconto | Altera o valor/percentual de desconto de um boleto. | nossoNumero (string) x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required data: { . valorDesconto1 (number) . valorDesconto2 (number) . valorDesconto3 (number) } (object) required |
| cobranca/patch_cobranca_boleto_v1_boletos_by_nosso_numero_data_desconto | Altera a data de desconto de um boleto. | nossoNumero (string) x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required data: { . data1 (string) . data2 (string) . data3 (string) } (object) required |
| cobranca/patch_cobranca_boleto_v1_boletos_by_nosso_numero_juros | Altera o valor/percentual de juros de um boleto. Apenas o valor pode ser alterado; o tipo permanece inalterado. | nossoNumero (string) x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required data: { . valorOuPercentual (number) } (object) required |
| cobranca/patch_cobranca_boleto_v1_boletos_by_nosso_numero_seu_numero | Altera o Seu Número de um boleto. | nossoNumero (string) x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required data: { . seuNumero (string) } (object) required |
| cobranca/patch_cobranca_boleto_v1_boletos_by_nosso_numero_conceder_abatimento | Concede um valor de abatimento para um boleto. | nossoNumero (string) x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required data: { . valorAbatimento (string) } (object) required |
| cobranca/patch_cobranca_boleto_v1_boletos_by_nosso_numero_cancelar_abatimento | Cancela o abatimento concedido para um boleto. | nossoNumero (string) x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required data (object) required |
| cobranca/patch_cobranca_boleto_v1_boletos_by_nosso_numero_protesto | Solicita o protesto de um boleto vencido. | nossoNumero (string) x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required data (object) required |
| cobranca/patch_cobranca_boleto_v1_boletos_by_nosso_numero_sustar_protesto_baixar_titulo | Susta o protesto e realiza a baixa do boleto. | nossoNumero (string) x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required data (object) required |
| cobranca/patch_cobranca_boleto_v1_boletos_by_nosso_numero_sustar_protesto_manter_titulo | Susta o protesto e mantém o boleto em carteira. | nossoNumero (string) x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required data (object) required |
| cobranca/patch_cobranca_boleto_v1_boletos_by_nosso_numero_negativacao | Inclui pedido de negativação para um boleto vencido. | nossoNumero (string) x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required data (object) required |
| cobranca/patch_cobranca_boleto_v1_boletos_by_nosso_numero_sustar_negativacao_baixar_titulo | Susta o pedido de negativação e realiza a baixa do boleto. | nossoNumero (string) x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required data (object) required |
| cobranca/patch_cobranca_boleto_v1_boletos_by_nosso_numero_cancelar_protesto_automatico | Cancela o protesto automático de um título que possui protesto vinculado. | nossoNumero (string) x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required data (object) required |
| cobranca/get_cobranca_boleto_v1_boletos_liquidados_dia | Consulta boletos liquidados em uma data específica. Retorna até 500 registros por página. | x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required dia (string) required cpfCnpjBeneficiarioFinal (string) pagina (integer) |
| cobranca/get_cobranca_boleto_v1_boletos_cadastrados | Verifica se já existe um título cadastrado com determinado idTituloEmpresa ou seuNumero. | x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required codigoBeneficiario (string) required seuNumero (string) idTituloEmpresa (string) |
| cobranca/get_cobranca_v1_cobranca_financeiro_movimentacoes | Consulta movimentações financeiras Crédito, Débito ou Ambas de uma data específica. Retorna até 1000 registros por página. | x-api-key (string) required Authorization (string) required beneficiario (string) required agencia (string) required dataLancamento (string) required tipoMovimento (string) required pagina (integer) |
| cobranca/patch_cobranca_boleto_v1_boletos_split_cancelar_split | Cancela uma ou mais parcelas da distribuição de crédito de um boleto. | x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required data: { . codigoBeneficiario (string) . nossoNumero (string) . numeroParcelas (array) } (object) required |
| cobranca/patch_cobranca_boleto_v1_boletos_split_liberar_repasse | Libera o repasse do crédito das parcelas de um boleto com Split. Necessário apenas quando repasseAutomaticoSplit = NAO. | x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required data: { . codigoBeneficiario (string) . nossoNumero (string) } (object) required |
| cobranca/post_cobranca_boleto_v1_webhook_contrato | Cria um novo contrato Webhook para receber eventos de movimentações dos títulos. | x-api-key (string) required Authorization (string) required data: { . cooperativa (string) . posto (string) . codBeneficiario (string) . eventos (array) . url (string) . urlStatus (string) . contratoStatus (string) . nomeResponsavel (string) . email (string) . telefone (string) . enviarIdTituloEmpresa (boolean) . header (string) . token (string) } (object) required |
| cobranca/get_cobranca_boleto_v1_webhook_contratos | Consulta dados de contratos Webhook de um beneficiário. | x-api-key (string) required Authorization (string) required cooperativa (string) required posto (string) required beneficiario (string) required |
| cobranca/put_cobranca_boleto_v1_webhook_contrato_by_id | Altera dados de um contrato Webhook existente. | id (string) x-api-key (string) required Authorization (string) required data: { . cooperativa (string) . posto (string) . codBeneficiario (string) . eventos (array) . url (string) . urlStatus (string) . contratoStatus (string) . nomeResponsavel (string) . email (string) . telefone (string) . enviarIdTituloEmpresa (boolean) . header (string) . token (string) } (object) required |
| produtos_servicos/get_personal_accounts | Obtém dados das contas | page (integer) page-size (integer) |
| produtos_servicos/get_business_accounts | Obtém dados das contas pessoa jurídica | page (integer) page-size (integer) |
| produtos_servicos/get_personal_loans | Obtém dados sobre empréstimos pessoa natural | page (integer) page-size (integer) |
| produtos_servicos/get_business_loans | Obtém dados sobre empréstimos pessoa jurídica | page (integer) page-size (integer) |
| produtos_servicos/get_personal_credit_cards | Obtém dados sobre cartões de crédito pessoa natural | page (integer) page-size (integer) |
| produtos_servicos/get_business_credit_cards | Obtém dados sobre cartões de crédito pessoa jurídica | page (integer) page-size (integer) |
| produtos_servicos/get_personal_financings | Obtém a lista de Financiamentos de Pessoa Natural | page (integer) page-size (integer) |
| produtos_servicos/get_business_financings | Obtém a lista de Financiamentos de Pessoa Jurídica. | page (integer) page-size (integer) |
| produtos_servicos/get_personal_invoice_financings | Obtém a lista de Adiantamento de Recebíveis de Pessoa Natural. | page (integer) page-size (integer) |
| produtos_servicos/get_business_invoice_financings | Obtém a lista de Adiantamento de Recebíveis de Pessoa Jurídica. | page (integer) page-size (integer) |
| produtos_servicos/get_personal_unarranged_account_overdraft | Obtém a lista de adiantamento de depositante de Pessoa Natural. | page (integer) page-size (integer) |
| produtos_servicos/get_business_unarranged_account_overdraft | Obtém a lista de adiantamento de depositante de Pessoa Jurídica. | page (integer) page-size (integer) |
| atendimento/get_banking_agents | Método para obter a lista de correspondentes bancários da instituição financeira. | page (integer) page-size (integer) |
| atendimento/get_branches | Método para obter a lista de dependências próprias da instituição financeira. | page (integer) page-size (integer) |
| atendimento/get_electronic_channels | Método para obter a lista de canais eletrônicos de atendimento da instituição financeira. | page (integer) page-size (integer) |
| atendimento/get_phone_channels | Método para obter a lista de canais telefônicos de atendimento da instituição financeira. | page (integer) page-size (integer) |
| atendimento/get_shared_automated_teller_machines | Método para obter a lista de terminais compartilhados de autoatendimento da instituição financeira. | page (integer) page-size (integer) |