Skip to main content

Sicoob

Integração com as APIs Sicoob (Cobrança Bancária, Conta Corrente, Poupança, Pix, Investimentos, SPB e Convênios).

Sicoob 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 115 actions:

ActionPurposeParameters
cobranca/post_boletosServiço para a inclusão de boletos. É possível a inclusão de 1 boleto por requisição.data: {
. numeroCliente (integer)
. codigoModalidade (integer)
. numeroContaCorrente (integer)
. codigoEspecieDocumento (string)
. dataEmissao (string)
. nossoNumero (integer)
. seuNumero (string)
. identificacaoBoletoEmpresa (string)
. identificacaoEmissaoBoleto (integer)
. identificacaoDistribuicaoBoleto (integer)
. valor (number)
. dataVencimento (string)
. dataLimitePagamento (string)
. valorAbatimento (number)
. tipoDesconto (integer)
. dataPrimeiroDesconto (string)
. valorPrimeiroDesconto (number)
. dataSegundoDesconto (string)
. valorSegundoDesconto (number)
. dataTerceiroDesconto (string)
. valorTerceiroDesconto (number)
. tipoMulta (integer)
. dataMulta (string)
. valorMulta (number)
. tipoJurosMora (integer)
. dataJurosMora (string)
. valorJurosMora (number)
. numeroParcela (integer)
. aceite (boolean)
. codigoNegativacao (integer)
. numeroDiasNegativacao (integer)
. codigoProtesto (integer)
. numeroDiasProtesto (integer)
. pagador (object)
. beneficiarioFinal (object)
. mensagensInstrucao (array)
. gerarPdf (boolean)
. rateioCreditos (array)
. codigoCadastrarPIX (integer)
. numeroContratoCobranca (integer)
} (object) required
cobranca/get_boletosServiço para consulta de um boleto bancário. Utiliza as informações do beneficiário logado número da cooperativa, número identificador do beneficiário e conta corrente, juntamente com a informação do identificador do boleto nosso número, ou da linha digitável ou do código de barras.numeroCliente (integer) required
codigoModalidade (integer) required
nossoNumero (integer)
linhaDigitavel (string)
codigoBarras (string)
numeroContratoCobranca (integer)
cobranca/get_pagadores_by_numero_cpf_cnpj_boletosServiço para listagem de boletos por Pagador.numeroCpfCnpj (string)
numeroCliente (integer) required
codigoSituacao (integer)
dataInicio (string)
dataFim (string)
cobranca/get_boletos_segunda_viaServiço para emissão da segunda via de boleto já registrado. Utiliza as informações do beneficiário logado número da cooperativa, número identificador do beneficiário e conta corrente, juntamente com a informação do identificador do boleto nosso número, ou da linha digitável ou do código de barras. Quando informados código de barras ou linha digitável, a pesquisa é realizada prioritariamente por estes parâmetros.numeroCliente (integer) required
codigoModalidade (integer) required
nossoNumero (integer)
linhaDigitavel (string)
codigoBarras (string)
gerarPdf (boolean)
numeroContratoCobranca (integer)
cobranca/get_boletos_faixas_nosso_numeroServiço para consulta de dados de faixas de nosso número disponíveis. Quando o campo validaDigitoVerificadorNossoNumero retornar o valor 'false' a faixa 'numeroInicial' e 'numeroFinal' refere-se a numeração final exemplo: 10 e 15 - utilização: 1-0 1-1 1-2 1-3 1-4 1-5. Mas se o campo validaDigitoVerificadorNossoNumero retornar o valor 'true' a faixa 'numeroInicial' e 'numeroFinal' deverá ser calculado o DV exemplo: 10 e 15 - utilização: 10-4 11-8 12-0 13-1 14-7 15-9.numeroCliente (integer) required
codigoModalidade (integer) required
quantidade (integer) required
numeroContratoCobranca (integer)
cobranca/patch_boletos_by_nosso_numeroServiço para alteração de dados de boleto já registrado. Deve ser feita a alteração de somente um objeto do boleto por requisição. Objetos de alteração do boleto: - seuNumero - desconto - abatimento - multa - jurosMora - rateioCredito - pix - prorrogacaoVencimento - prorrogacaoLimitePagamentonossoNumero (integer)
data: {
. numeroCliente (integer)
. codigoModalidade (integer)
. numeroContratoCobranca (integer)
. especieDocumento (object)
. seuNumero (object)
. desconto (object)
. abatimento (object)
. multa (object)
. jurosMora (object)
. rateioCredito (object)
. pix (object)
. prorrogacaoVencimento (object)
. prorrogacaoLimitePagamento (object)
. valorNominal (object)
} (object) required
cobranca/post_boletos_by_nosso_numero_baixarServiço para comandar a baixa de boletos informados.nossoNumero (integer)
data: {
. numeroCliente (integer)
. codigoModalidade (integer)
} (object) required
cobranca/put_pagadoresServiço para alterar informações do cadastro do pagador.data: {
. numeroCliente (integer)
. numeroCpfCnpj (string)
. nome (string)
. endereco (string)
. bairro (string)
. cidade (string)
. cep (string)
. uf (string)
. email (string)
} (object) required
cobranca/post_boletos_by_nosso_numero_negativacoesServiço para indicar a negativação de pagadores de boletos informados. A negativação é o registro de pendências ou restrições nos órgãos de proteção ao crédito. No Sicoob, o parceiro para este serviço é o SERASA.nossoNumero (integer)
data: {
. numeroCliente (integer)
. codigoModalidade (number)
. numeroContratoCobranca (integer)
} (object) required
cobranca/patch_boletos_by_nosso_numero_negativacoesServiço para cancelar o apontamento da negativação de pagadores de boletos informados. O boleto não será enviado ao serviço de proteção ao crédito.nossoNumero (integer)
data: {
. numeroCliente (integer)
. codigoModalidade (number)
. numeroContratoCobranca (integer)
} (object) required
cobranca/delete_boletos_by_nosso_numero_negativacoesServiço para comandar uma baixa da negativação de pagadores de boletos informados. Será enviado um pedido de baixa para o serviço de proteção ao crédito.nossoNumero (integer)
data: {
. numeroCliente (integer)
. codigoModalidade (number)
. numeroContratoCobranca (integer)
} (object) required
cobranca/post_boletos_by_nosso_numero_protestosEste serviço registra a indicação a protesto de boletos informados. Os boletos vencidos e não pagos podem ser protestados e registrados em cartório.nossoNumero (integer)
data: {
. numeroCliente (integer)
. codigoModalidade (number)
. numeroContratoCobranca (integer)
} (object) required
cobranca/patch_boletos_by_nosso_numero_protestosEste serviço realiza a indicação de cancelamento de protesto de boletos informados. Os boletos em atraso e não pagos podem ser indicados a protesto. Caso seja realizado no mesmo dia, pode-se cancelar o apontamento a protesto.nossoNumero (integer)
data: {
. numeroCliente (integer)
. codigoModalidade (number)
. numeroContratoCobranca (integer)
} (object) required
cobranca/delete_boletos_by_nosso_numero_protestosEste serviço realiza o pedido de desistência do protesto de boletos informados. O pedido de desistência não garante que o protesto será retirado. Deve-se aguardar o retorno do cartório. O pedido de desistência pode ser realizado a qualquer momento, desde que haja um apontamento prévio.nossoNumero (integer)
data: {
. numeroCliente (integer)
. codigoModalidade (number)
. numeroContratoCobranca (integer)
} (object) required
cobranca/post_boletos_movimentacoesServiço para solicitar a movimentação da carteira de cobrança registrada para beneficiário informado. Os movimentos disponíveis para solicitação são 1. Entrada 2. Prorrogação 3. A Vencer 4. Vencido 5. Liquidação 6. Baixa 7. Vinculado Operações Crédito As consultas estão limitadas em um período máximo de 2 dias.data: {
. numeroCliente (integer)
. tipoMovimento (integer)
. dataInicial (string)
. dataFinal (string)
} (object) required
cobranca/get_boletos_movimentacoesServiço para consultar a situação da solicitação da movimentação.numeroCliente (integer) required
codigoSolicitacao (integer) required
cobranca/get_boletos_movimentacoes_downloadServiço para obter um arquivo de movimentação.numeroCliente (integer) required
codigoSolicitacao (integer) required
idArquivo (integer) required
cobranca/post_webhooksEste serviço permite cadastrar uma URL que será notificada sempre que ocorrer um evento associado a um tipo de movimento. O webhook pode ser configurado para o período de movimentação atual D0.data: {
. url (string)
. codigoTipoMovimento (integer)
. codigoPeriodoMovimento (integer)
. email (string)
} (object) required
cobranca/get_webhooksServiço para consultar os detalhes dos webhooks cadastrados.idWebhook (string)
codigoTipoMovimento (string)
cobranca/patch_webhooks_by_id_webhookServiço de atualização de webhook. Ao modificar a URL, a situação do webhook será automaticamente alterada para '1 - Aguardando validação' e permanecerá assim até que a nova URL seja validada com sucesso.idWebhook (string)
data: {
. url (string)
. email (string)
} (object) required
cobranca/delete_webhooks_by_id_webhookServiço responsável por remover permanentemente um webhook registrado, encerrando o envio de notificações para a URL vinculada.'idWebhook (string)
cobranca/patch_webhooks_by_id_webhook_reativarServiço de reativação de webhook desativado, restabelecendo o recebimento de notificações. A situação do webhook será atualizada para '1 - Aguardando validação' e permanecerá assim até que a URL seja validada com sucesso.idWebhook (string)
cobranca/get_webhooks_by_id_webhook_solicitacoesConsulta as solicitações de notificação para um webhook com base na data de solicitação informada. Retorna o histórico das tentativas de notificação, incluindo o status e a resposta da requisição.idWebhook (string)
dataSolicitacao (string) required
pagina (string)
codigoSolicitacaoSituacao (string)
codigoBarras (string)
nossoNumero (string)
cobranca/get_healthServiço para verificar a disponibilidade da API.No parameters
cobranca_pagamentos/get_boletosServiço para consultar boletos DDA de uma conta corrente.client_id (string) required
numeroConta (integer) required
dataInicial (string) required
dataFinal (string) required
situacao (integer) required
tipoData (integer) required
cobranca_pagamentos/get_boletos_by_codigo_barrasServiço para consultar boleto.codigoBarras (string)
client_id (string) required
numeroConta (integer) required
dataPagamento (string)
cobranca_pagamentos/post_boletos_pagamentos_by_codigo_barrasServiço para efetuar o pagamento ou agendamento de boleto.codigoBarras (string)
client_id (string) required
x-idempotency-key (string) required
data: {
. identificadorConsulta (string)
. valorBoleto (number)
. valorDescontoAbatimento (number)
. valorMultaMora (number)
. descricaoObservacao (string)
. aceitaValorDivergente (boolean)
. numeroCpfCnpjPortador (string)
. nomePortador (string)
. amount (number)
. date (string)
. debtorAccount
} (object) required
cobranca_pagamentos/get_boletos_pagamentos_by_id_pagamento_comprovantesServiço para consultar um comprovante de um pagamento efetuado.idPagamento (integer)
client_id (string) required
numeroConta (integer) required
cobranca_pagamentos/delete_boletos_pagamentos_agendamentos_by_id_pagamentoServiço para cancelar um agendamento de pagamento.idPagamento (integer)
client_id (string) required
data: {
. numeroConta (integer)
} (object) required
cobranca_pagamentos/get_boletos_pagamentos_by_idempotency_idempotency_comprovantesServiço para consultar um comprovante de um pagamento efetuado através do Idempotency.idempotency (string)
client_id (string) required
consentimento_pagamento/get_consentsOperação para listar os consentimentos de pagamento.cnpj (string)
cpf (string) required
account-numbe (string)
page (integer)
page-size (integer)
status (string) required
client_id (string) required
consentimento_pagamento/post_consentsMétodo de criação do consentimento para a iniciação de pagamento.client_id (string) required
data: {
. brandId (string)
. data
} (object) required
consentimento_pagamento/put_consents_callbackCallback para consulta do status do consentimento de pagamento.client_id (string) required
data: {
. code (string)
. errorDescription (string)
. error (string)
. state (string)
. idToken (string)
} (object) required
consentimento_pagamento/get_consents_by_consent_idOperação para buscar o consentimento de pagamento.consent-id (string)
cnpj (string)
cpf (string) required
client_id (string) required
conta_corrente/get_extrato_by_mes_by_anoExtrato bancariomes (integer)
ano (integer)
client_id (string) required
diaInicial (integer)
diaFinal (integer)
agruparCNAB (boolean)
numeroContaCorrente (integer) required
conta_corrente/get_saldoSaldo bancarioclient_id (string) required
numeroContaCorrente (integer)
conta_corrente/post_transferenciasMétodo que transfere os valores entre contas.client_id (string) required
id_token (string) required
x-idempotency-key (string) required
data: {
. amount (number)
. date (string)
. debtorAccount (object)
. creditorAccount (object)
} (object) required
convenios_pagamentos/get_arrecadacao_on_line_by_ufEste serviço tem como objetivo a consulta de informações para arrecadação de pagamentos on-line de bdébitos pendentes, multas, licenciamento e IPVA/b. Serviço destinado aos parceiros do Sicoob.uf (string)
servico (string) required
instituicao (integer) required
unidade (integer)
renavam (string)
anoExercicio (integer)
placa (string)
convenios_pagamentos/post_arrecadacao_on_line_by_uf_by_servico_pagamentosEste serviço tem como objetivo realizar arrecadação de pagamentos on-line por meio da unidade federativa informada 'UF' para os tipos de serviço como débitos pendentes, multas, licenciamento e IPVA para todos os parceiros.uf (string)
servico (string)
data: {
. identificacao (object)
. veiculo (object)
. transacao (object)
. receberEmCasa (boolean)
. valorTotal (number)
. identificadores (array)
. despachante (object)
} (object) required
convenios_pagamentos/get_arrecadacao_on_line_by_uf_comprovanteEste serviço tem como objetivo o retorno de um comprovante das informações de uma arrecadação de pagamento on-line, sendo a segunda via do comprovante.uf (string)
nsu (number) required
instituicao (integer) required
unidade (integer)
convenios_pagamentos/get_arrecadacao_on_line_by_uf_conciliacoesRealiza a consulta das conciliações de arrecadações provenientes de operações online, retornando informações consolidadas de acordo com a Unidade Federativa UF informada.uf (string)
instituicao (integer) required
unidade (integer)
dataMovimento (string) required
convenios_pagamentos/post_debito_automatico_optantesRealiza o cadastramento de optantes para débitos automático, padrão FEBRABAN registro B.data: {
. optante (object)
. transacao (number)
} (object) required
convenios_pagamentos/post_debito_automatico_optantes_validacoesRealiza o validação das informações de optantes para débitos automático, padrão FEBRABAN registro B.data: {
. optante (object)
. transacao (number)
} (object) required
convenios_pagamentos/post_debito_automatico_optantes_ocorrenciasCadastramento de ocorrências de alteração do cadastro do cliente para débito automático, padrão FEBRABAN registro H.data: {
. ocorrencia (object)
. transacao (number)
} (object) required
convenios_pagamentos/get_debito_automatico_optantes_alteracoesConsulta as alterações da identificação do cliente realizado pela Empresa para o Banco, conforme padrão Febraban Registro Dtransacao (number) required
data (string)
convenios_pagamentos/get_healthHealth Check APINo parameters
convenios_pagamentos/get_debito_automatico_optantes_recusasConsulta as recusas dos cadastros de optantes, registro enviado da Empresa para o Banco, conforme padrão Febraban Registro Ctransacao (number) required
data (string)
convenios_pagamentos/get_debito_automatico_optantes_conveniosLista os convênios que estão aptos a trabalhar com débito automático.transacao (number) required
todosConvenios (boolean)
convenios_pagamentos/get_debito_automatico_debitos_movimentacoesConsulta as informações de movimentação dos débitos automáticos por data de movimento.transacao (number) required
pagina (number) required
data (string) required
convenios_pagamentos/post_debito_automatico_debitos_movimentacoesServiço para o envio de registros tipo F padrão FEBRABAN de débitos automáticos em lote. Com um limite de 100 registros por requisição.data: {
. debitos (array)
. transacao (number)
} (object) required
convenios_pagamentos/get_debito_automatico_debitosConsulta os débitos em conta gerados pela Empresa para o Banco, conforme padrão Febraban Registro Etransacao (number) required
pagina (number) required
data (string)
convenios_pagamentos/post_debito_automatico_debitosCadastramento de retorno do débito automático enviado pela empresa tipo E, padrão FEBRABAN registro F.data: {
. debito (object)
. transacao (number)
} (object) required
convenios_pagamentos/get_debito_automatico_debitos_by_autenticacaoConsulta os dados de retorno de um débito automático usando a chave de autenticação.autenticacao (string)
transacao (number) required
convenios_pagamentos/get_debito_automatico_debitos_conciliacoesRetorna as informações de conciliação das arrecadações por data de movimento.transacao (number) required
data (number) required
convenios_pagamentos/get_debito_automatico_optantes_historicoRetorna as informações de registros B, C, E e F código de registros segundo o leiaute FEBRABAN de optantes. As informações serão retornadas por ano. Exemplo: Ano igual 2021 retornará os registros de Janeiro a Dezembro de 2021.transacao (number) required
identificadorClienteEmpresa (string) required
convenio (string) required
identificadorClienteBanco (string)
ano (number)
convenios_pagamentos/post_arrecadacao_codigo_barras_by_codigo_barras_pagamentosEste serviço tem como objetivo a arrecadação de convênios por meio de código de barras. Recomendação: - Consultar o serviço '/arrecadacao/convenios-habilitados' para verificar quais convênios estão disponíveis através desta API. Exclusivo para o perfil 'Parceiro Banco Sicoob': - O atributo nsu Número Sequencial Único, obrigatório para a execução deste serviço. - Deverá consultar o serviço '/arrecadacao/codigo-barras/codigoBarras' - O atributo 'recebimentoViaCaixa' somente poderá sercodigoBarras (string)
data: {
. identificacao (object)
. pagamento (object)
. transacao (number)
} (object) required
convenios_pagamentos/get_arrecadacao_codigo_barras_by_codigo_barras_pagamentosEste serviço tem como objetivo a consulta de informações de um código de barras. Para parceiros do 'Parceiro Banco Sicoob', o atributo nsu Número Sequencial Único, obrigatório para a transação de pagamento. Exclusivo para o perfil 'Parceiro Banco Sicoob': - O atributo 'recebimentoViaCaixa' uso exclusivo por este perfil.codigoBarras (string)
instituicao (number) required
transacao (number)
dataMovimento (string) required
convenios_pagamentos/get_arrecadacao_codigo_barras_by_codigo_barrasEste serviço tem como objetivo a consulta de informações de um código de barras e data de pagamento. Exclusivo para o perfil 'Parceiro Banco Sicoob': - O atributo 'recebimentoViaCaixa' somente poderá ser informado por este perfil.codigoBarras (string)
dataPagamento (string) required
recebimentoViaCaixa (boolean)
convenios_pagamentos/get_arrecadacao_pagamentos_by_nsu_comprovanteEste serviço tem como objeto o retorno das informações de uma arrecadação contendo a segunda via do comprovante. Exclusivo para o perfil 'Parceiro Banco Sicoob': - O atributo 'recebimentoViaCaixa' uso exclusivo por este perfil.nsu (number)
instituicao (number) required
convenios_pagamentos/get_arrecadacao_conciliacoesEste serviço tem como objeto a consulta de informações sintéticas das arrecadações realizadas em uma data de movimento.dataMovimento (string) required
instituicao (number) required
unidade (integer)
convenios_pagamentos/get_arrecadacao_convenios_habilitados'Este serviço tem como objetivo retornar uma listagem contendo os convênios habilitados para arrecadação nesta API'.transacao (number) required
instituicao (number) required
investimentos/get_renda_fixa_saldosRetorna sumarizado todos os investimentos LCA, RDC e DAP do cliente juntos.client_id (string) required
numeroCooperativa (integer) required
numeroContaCorrente (integer) required
investimentos/get_renda_fixa_carteirasRetorna sumarizado todos os investimentos LCA, RDC e DAP do cliente separado por carteiraclient_id (string) required
numeroCooperativa (integer) required
numeroContaCorrente (integer) required
investimentos/get_renda_fixa_carteiras_by_id_carteira_modalidadesRetorna todos os investimentos de uma determinada carteira do clienteidCarteira (integer)
client_id (string) required
numeroCooperativa (integer) required
numeroContaCorrente (integer) required
investimentos/get_renda_fixa_carteiras_by_id_carteira_modalidades_by_id_modalidade_aplicacoesRetorna todas as aplicações de uma determinada carteira e modalidade do clienteidCarteira (integer)
idModalidade (integer)
client_id (string) required
numeroCooperativa (integer) required
numeroContaCorrente (integer) required
investimentos/get_renda_fixa_extrato_by_numero_conta_corrente_by_id_aplicacao_by_id_modalidadeRetorna o extrato da aplicaçãonumeroContaCorrente (integer)
idModalidade (integer)
idAplicacao (integer)
client_id (string) required
numeroCooperativa (integer) required
dataLote (string) required
investimentos/post_renda_fixa_resgatesA partir da cooperativa, conta da pessoa logada e valor passado é realizado um resgaste inteligente.client_id (string) required
data: {
. valor (number)
} (object) required
investimentos/get_renda_fixa_modalidadesRealiza uma busca de modalidades ativas para a instituição e conta-corrente da pessoa logada considerando canal SISBR.client_id (string) required
investimentos/post_renda_fixa_aportesA partir da cooperativa, conta da pessoa logada e da modalidade e valor informados é realizado uma aplicação.client_id (string) required
data: {
. modalidade (number)
. valor (number)
} (object) required
pagamentos_pix/get_pagamentos_by_idEndpoint para consultar um pagamento Pix através de um e2eid.id (string)
pagamentos_pix/post_pagamentosIniciar pagamento por meio de chave DICTdata: {
. chave (string)
. dataAgendamento (string)
} (object) required
pagamentos_pix/post_pagamentos_qrcodeRealiza o pagamento de Pix Copia e Cola Imediato ou Vencimento com execução direta. O processamento dispensa confirmação adicional ao validar automaticamente se: 1. O valor original coincide com o valor decodificado sem juros/multa ou desconto. 2. A aplicação de juros/multa está autorizada. 3. O CNPJ do favorecido é idêntico ao registrado no payload.data: {
. qrcode (string)
. codMun (string)
. repeticao (boolean)
. dataVencimento (string)
. dataAgendamento (string)
. valor (string)
. pagarComJurosMulta (boolean)
. origem (object)
. destino (object)
} (object) required
pagamentos_pix/post_pagamentos_confirmacaoEfetivar um pagamento iniciado pela API de pagamentosdata: {
. endToEndId
. valor (string)
. descricao (string)
. repeticao (boolean)
. meioIniciacao (string)
. dataAgendamento (string)
. origem
. destino
} (object) required
pagamentos_pix/put_pagamentos_webhookEndpoint para configuração do serviço de notificações acerca de Pix enviados.data (undefined) required
pagamentos_pix/get_pagamentos_webhookEndpoint para recuperação de informações sobre o Webhook Pix.No parameters
pagamentos_pix/delete_pagamentos_webhookEndpoint 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.No parameters
poupanca/post_resgatesRealiza um resgate de uma conta poupança para uma conta corrente vinculadas com os parametros informados.client_id (string) required
data: {
. date (string)
. amount (number)
. debtorAccount (object)
. creditorAccount (object)
. idUsuario (string)
. idProduto (number)
. codCanal (integer)
. valor (number)
. dataLancamento (string)
. numeroCooperativaMovimento (integer)
. numeroCooperativaDebito (integer)
. numeroContaDebito (number)
. numeroCooperativaCredito (integer)
. numeroContaCredito (number)
. nomeArquivoCNAB (string)
. autenticacao (string)
. ObservacaoLancamento (string)
. descricaoObservacaoComplementar (string)
. numeroCpfCnpjRemetente (string)
. numeroCpfCnpjFavorecido (string)
. descAutenticacaoDigital (string)
} (object) required
poupanca/post_aplicacoesRealiza uma aplicacao de uma conta corrente vinculada para uma conta conta poupança com os parametros informados.client_id (string) required
data: {
. date (string)
. amount (number)
. debtorAccount (object)
. creditorAccount (object)
. idUsuario (string)
. idProduto (number)
. codCanal (integer)
. valor (number)
. dataLancamento (string)
. numeroCooperativaMovimento (integer)
. numeroCooperativaDebito (integer)
. numeroContaDebito (number)
. numeroCooperativaCredito (integer)
. numeroContaCredito (number)
. nomeArquivoCNAB (string)
. autenticacao (string)
. ObservacaoLancamento (string)
. descricaoObservacaoComplementar (string)
. numeroCpfCnpjRemetente (string)
. numeroCpfCnpjFavorecido (string)
. descAutenticacaoDigital (string)
} (object) required
poupanca/get_contas_by_conta_poupanca_saldoConsulta o saldo atual de uma conta poupança.contaPoupanca (integer)
client_id (string) required
poupanca/get_contas_by_conta_poupanca_extratoConsulta o extrato de um mês e ano de uma conta poupança.contaPoupanca (integer)
mes (integer) required
ano (integer) required
client_id (string) required
poupanca/get_contasPesquisa as contas de poupança que pertencem a um CPF ou CNPJ.client_id (string) required
recebimentos_pix/put_cob_by_txidEndpoint para criar uma cobrança imediata.txid (string)
data (undefined) required
recebimentos_pix/patch_cob_by_txidEndpoint para revisar uma cobrança imediata.txid (string)
data (undefined) required
recebimentos_pix/get_cob_by_txidEndpoint para consultar uma cobrança através de um determinado txid.txid (string)
revisao (integer)
recebimentos_pix/get_cob_by_txid_imagemEndpoint para gerar a imagem qrcode de uma cobrança através de um determinado txid.txid (string)
revisao (integer)
largura (integer)
recebimentos_pix/post_cobEndpoint para criar uma cobrança imediata, neste caso, o txid deve ser definido pelo PSP.data (undefined) required
recebimentos_pix/get_cobEndpoint para consultar cobranças imediatas através de parâmetros como início, fim, cpf, cnpj e status.inicio (string) required
fim (string) required
cpf (string)
cnpj (string)
locationPresente (boolean)
status (string)
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
recebimentos_pix/put_cobv_by_txidEndpoint para criar uma cobrança com vencimento.txid (string)
data (undefined) required
recebimentos_pix/patch_cobv_by_txidEndpoint para revisar uma cobrança com vencimento.txid (string)
data (undefined) required
recebimentos_pix/get_cobv_by_txidEndpoint para consultar uma cobrança com vencimento através de um determinado txid.txid (string)
revisao (integer)
recebimentos_pix/get_cobv_by_txid_imagemEndpoint para gerar a imagem qrcode de uma cobrança através de um determinado txid.txid (string)
revisao (integer)
largura (integer)
recebimentos_pix/get_cobvEndpoint para consultar cobranças com vencimento através de parâmetros como início, fim, cpf, cnpj e status.inicio (string) required
fim (string) required
cpf (string)
cnpj (string)
locationPresente (boolean)
status (string)
loteCobVId (integer)
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
recebimentos_pix/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)
data (undefined) required
recebimentos_pix/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)
data (undefined) required
recebimentos_pix/get_lotecobv_by_idEndpoint para consultar um lote de cobranças com vencimento.id (string)
recebimentos_pix/get_lotecobvEndpoint para consultar lista de lotes de cobranças com vencimento.inicio (string) required
fim (string) required
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
recebimentos_pix/post_locCriar location do payloaddata (undefined) required
recebimentos_pix/get_locEndpoint para consultar locations cadastradasinicio (string) required
fim (string) required
txIdPresente (boolean)
tipoCob (string)
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
recebimentos_pix/get_loc_by_idRecupera a location do payloadid (string)
recebimentos_pix/get_loc_by_id_imagemRecupera a imagem da location do payloadid (string)
largura (integer)
recebimentos_pix/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)
recebimentos_pix/get_pix_by_e2eidEndpoint para consultar um Pix através de um e2eid.e2eid (string)
recebimentos_pix/get_pixEndpoint para consultar Pix recebidosinicio (string) required
fim (string) required
txid (undefined)
txIdPresente (boolean)
devolucaoPresente (boolean)
cpf (string)
cnpj (string)
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
recebimentos_pix/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)
id (string)
data (undefined) required
recebimentos_pix/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)
id (string)
recebimentos_pix/get_by_pix_url_access_tokenEndpoint location que serve um payload que representa uma cobrança imediata. No momento que o usuário devedor efetua a leitura de um QR Code dinâmico gerado pelo recebedor, esta URL será acessada e seu conteúdo consiste em uma estrutura JWS. As informações sobre a segurança no acesso às urls encontram-se no Manual de Segurança do Pix disponível em nesse linkhttps://www.bcb.gov.br/estabilidadefinanceira/comunicacaodados.pixUrlAccessToken (string)
recebimentos_pix/get_by_cobvpix_url_access_tokenEndpoint location que serve um payload que representa uma cobrança com vencimento. No momento que o usuário devedor efetua a leitura de um QR Code dinâmico gerado pelo recebedor, esta URL será acessada e seu conteúdo consiste em uma estrutura JWS. As informações sobre a segurança no acesso às urls encontram-se no Manual de Segurança do Pix disponível em nesse linkhttps://www.bcb.gov.br/estabilidadefinanceira/comunicacaodados.cobvpixUrlAccessToken (string)
recebimentos_pix/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)
data (undefined) required
recebimentos_pix/get_webhook_by_chaveEndpoint para recuperação de informações sobre o Webhook Pix.chave (string)
recebimentos_pix/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)
recebimentos_pix/get_webhookEndpoint para consultar Webhooks cadastradosinicio (string)
fim (string)
paginacao.paginaAtual (integer)
paginacao.itensPorPagina (integer)
spb_transferencias/post_transferenciasEnvio de TED entre clientes.client_id (string) required
x-idempotency-key (string) required
id_token (string) required
data: {
. debtorAccount (object)
. creditorAccount (object)
. creditor (object)
. date (string)
. amount (number)
. finalidade (string)
. numeroPa (string)
. historico (string)
} (object) required
spb_transferencias/get_transferencias_by_codigoRetorna as informações de uma TED.codigo (string)
client_id (string) required
id_token (string) required
spb_transferencias/delete_transferencias_agendamentos_by_id_agendamentoCancela uma TED com o status de agendada.idAgendamento (integer)
client_id (string) required
x-idempotency-key (string) required
id_token (string) required
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)

Webhook Events​

This connector emits 1 event back to your workflow. To receive one, create a hook whose path is <connection-name>/<event> — the connection name you configured plus the event from the table below.

EventDescription
pagamentoBaixa operacional de boleto codigoTipoMovimento=7. É o único tipo de movimento atualmente suportado pela API de Cobrança do Sicoob.