Banrisul
Connect to Banrisul banking services including PIX, payments, billing and loans.
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 75 actions:
| Action | Purpose | Parameters |
|---|---|---|
| pix/put_cob_by_txid | Endpoint para criar uma cobrança imediata. | txid (string) data (undefined) required |
| pix/patch_cob_by_txid | Revisar cobrança imediata. | txid (string) data (undefined) required |
| pix/get_cob_by_txid | Endpoint para consultar uma cobrança através de um determinado txid. | txid (string) revisao (integer) |
| pix/post_cob | Endpoint para criar uma cobrança imediata, neste caso, o txid deve ser definido pelo PSP. | data (undefined) required |
| pix/get_cob | Endpoint 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) |
| pix/put_cobv_by_txid | Endpoint para criar uma cobrança com vencimento. | txid (string) data (undefined) required |
| pix/patch_cobv_by_txid | Revisar cobrança com vencimento. | txid (string) data (undefined) required |
| pix/get_cobv_by_txid | Endpoint para consultar uma cobrança com vencimento através de um determinado txid. | txid (string) revisao (integer) |
| pix/get_cobv | Endpoint 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) |
| pix/put_lotecobv_by_id | Endpoint 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. Em | id (string) data (undefined) required |
| pix/patch_lotecobv_by_id | Endpoint 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 |
| pix/get_lotecobv_by_id | Endpoint para consultar um lote de cobranças com vencimento. | id (string) |
| pix/get_lotecobv | Endpoint para consultar lista de lotes de cobranças com vencimento. | inicio (string) required fim (string) required paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) |
| pix/post_locrec | Criar location do payload | No parameters |
| pix/get_locrec | Endpoint para consultar locations cadastradas | inicio (string) required fim (string) required idRecPresente (boolean) convenio (string) paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) |
| pix/get_locrec_by_id | Recupera a location do payload | id (string) |
| pix/delete_locrec_by_id_id_rec | Endpoint utilizado para desvincular uma recorrência de uma location. Se executado com sucesso, a entidade loc não apresentará mais uma recorrência, se apresentava anteriormente à chamada. Adicionalmente, a entidade associada ao recurso desvinculado também passará a não mais apresentar um location. Esta operação não altera o status do recurso em questão. | id (string) |
| pix/post_loc | Criar location do payload | data (undefined) required |
| pix/get_loc | Endpoint para consultar locations cadastradas | inicio (string) required fim (string) required txIdPresente (boolean) tipoCob (string) paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) |
| pix/get_loc_by_id | Recupera a location do payload | id (string) |
| pix/delete_loc_by_id_txid | Endpoint 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) |
| pix/get_pix_by_e2eid | Endpoint para consultar um Pix através de um e2eid. | e2eid (string) |
| pix/get_pix | Endpoint para consultar Pix recebidos | inicio (string) required fim (string) required txid (undefined) txIdPresente (boolean) devolucaoPresente (boolean) cpf (string) cnpj (string) paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) |
| pix/put_pix_by_e2eid_devolucao_by_id | Endpoint 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 |
| pix/get_pix_by_e2eid_devolucao_by_id | Endpoint para consultar uma devolução através de um End To End ID do Pix e do ID da devolução | e2eid (string) id (string) |
| pix/get_by_pix_url_access_token | Endpoint 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) |
| pix/get_cobv_by_pix_url_access_token | Endpoint 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. | pixUrlAccessToken (string) |
| pix/get_rec_by_rec_url_access_token | Endpoint location que serve um payload que representa uma recorrência. No momento em que o usuário pagador efetua a leitura de um QR Code composto 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 nesse linkhttps://www.bcb.gov.br/estabilidadefinanceira/comunicacaodados. | recUrlAccessToken (string) |
| pix/put_webhook_by_chave | Endpoint 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 |
| pix/get_webhook_by_chave | Endpoint para recuperação de informações sobre o Webhook Pix. | chave (string) |
| pix/delete_webhook_by_chave | Endpoint 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) |
| pix/get_webhook | Endpoint para consultar Webhooks cadastrados | inicio (string) fim (string) paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) |
| pix/put_webhookrec | Endpoint para configuração do serviço de notificações acerca de recorrências. Somente recorrências associadas ao usuário recebedor serão notificadas. | data (undefined) required |
| pix/get_webhookrec | Endpoint para recuperação de informações sobre o Webhook. | No parameters |
| pix/delete_webhookrec | Endpoint para cancelamento do webhook. Não é a única forma pela qual um webhook pode ser removido. | No parameters |
| pix/put_webhookcobr | Endpoint para configuração do serviço de notificações acerca de cobranças recorrentes. Somente cobranças recorrentes associadas ao usuário recebedor serão notificadas. | data (undefined) required |
| pix/get_webhookcobr | Endpoint para recuperação de informações sobre o Webhook. | No parameters |
| pix/delete_webhookcobr | Endpoint para cancelamento do webhook. Não é a única forma pela qual um webhook pode ser removido. | No parameters |
| pix/get_rec_by_id_rec | Consultar recorrência. | idRec (string) txid (string) |
| pix/patch_rec_by_id_rec | Revisar recorrência. | idRec (string) data (undefined) required |
| pix/get_rec | Consultar lista de recorrências. | inicio (string) required fim (string) required cpf (string) cnpj (string) locationPresente (boolean) status (string) convenio (string) paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) |
| pix/post_rec | Criar recorrência | data (undefined) required |
| pix/post_solicrec | Criar solicitação de confirmação de recorrência. | data (undefined) required |
| pix/get_solicrec_by_id_solic_rec | Consultar solicitação. | idSolicRec (string) |
| pix/patch_solicrec_by_id_solic_rec | Revisar solicitação de confirmação de recorrência. | idSolicRec (string) data (undefined) required |
| pix/put_cobr_by_txid | Endpoint para criar uma cobrança recorrente. | txid (string) data (undefined) required |
| pix/patch_cobr_by_txid | Revisar cobrança recorrente. | txid (string) data (undefined) required |
| pix/get_cobr_by_txid | Endpoint para consultar uma cobrança recorrente através de um determinado txid. | txid (string) |
| pix/post_cobr | Endpoint para criar uma cobrança recorrente, neste caso, o txid deve ser definido pelo PSP. | data (undefined) required |
| pix/get_cobr | Endpoint para consultar cobranças recorrentes através de parâmetros como início, fim, idRec, cpf, cnpj, status e convênio. | inicio (string) required fim (string) required idRec (string) cpf (string) cnpj (string) status (string) convenio (string) paginacao.paginaAtual (integer) paginacao.itensPorPagina (integer) |
| pix/post_cobr_by_txid_retentativa_by_data | Endpoint para solicitar retentativa de uma cobrança recorrente. | txid (string) data (string) |
| pagamentos/get_titulos_by_codigo_barra | Permite ao parceiro consultar os dados de um título a ser pago, a partir do seu código de barras. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. | codigo_barra (number) Partner-Id (string) required Co-Partner-Id (string) agencia_origem (integer) required tipo_codigo_barra (integer) required |
| pagamentos/post_titulos_by_codigo_barra | Permite ao parceiro solicitar o pagamento de um título, enviando os dados solicitados. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. | codigo_barra (number) Partner-Id (string) required Co-Partner-Id (string) data: { . numero_origem (string) . agencia_origem (integer) . cod_forma_pagamento (integer) . valor_movimento (number) . titulo_barra (object) } (object) required |
| pagamentos/patch_titulos_by_codigo_barra | Permite ao parceiro confirmar o pagamento de um título, enviando os dados solicitados. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. | codigo_barra (number) Partner-Id (string) required Co-Partner-Id (string) data: { . numero_banrisul (string) . data_pagamento (string) . cod_forma_pagamento (integer) . id_rastreabilidade (string) . ind_confirma (string) . titulo_barra (object) } (object) required |
| pagamentos/post_arrecadacoes_by_codigo_barra | Permite ao parceiro solicitar o pagamento de uma arrecadação, enviando os dados solicitados. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. | codigo_barra (number) Partner-Id (string) required Co-Partner-Id (string) data: { . numero_origem (string) . agencia_origem (integer) . cod_forma_pagamento (integer) . valor_movimento (number) . arrecadacao (object) } (object) required |
| pagamentos/patch_arrecadacoes_by_codigo_barra | Permite ao parceiro confirmar o pagamento de uma arrecadação, enviando os dados solicitados. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. | codigo_barra (number) Partner-Id (string) required Co-Partner-Id (string) data: { . numero_banrisul (string) . data_pagamento (string) . cod_forma_pagamento (integer) . id_rastreabilidade (string) . ind_confirma (string) . arrecadacao (object) } (object) required |
| pagamentos/get_status_by_id_documento | Permite ao parceiro consultar o status do pagamento de um título, a partir do NSU. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. | id_documento (string) Partner-Id (string) required Co-Partner-Id (string) tipo_id_documento (string) data_pagamento (string) required |
| pagamentos/get_debitos | Endpoint para consulta de débitos referentes a pagamentos realizados em uma data determinada. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. | Partner-Id (string) required Co-Partner-Id (string) codigo_agregador (number) required codigo_tipo_documento (number) required data_pagamento (string) required |
| cobranca/post_boletos | Registro de um boleto bancário. | bergs-beneficiario (string) required data: { . ambiente (string) . titulo } (object) required |
| cobranca/get_boletos | Listagem de boletos bancários. O campo situacao_titulo é obrigatório para definir os filtros que podem ser utilizados, infromando A para listar Títulos Ativos e B para Títulos Baixados/Liquidados. No caso de chamadas para listagem de Títulos Baixados/Liquidados situacao_titulo=B é possível informar um intervalo de data de baixa data_baixa_inicial e data_baixa_final, contudo nas chamadas de listagens de Títulos Ativos situacao_titulo=A, estes campos não devem ser informados. Sempre que for inform | bergs-beneficiario (string) required situacao_titulo (string) required situacao_pagamento (string) data_vencimento_inicial (string) data_vencimento_final (string) data_registro_inicial (string) data_registro_final (string) data_baixa_inicial (string) data_baixa_final (string) nosso_numero_inicial (string) nosso_numero_final (string) pagador.cpf_cnpj (string) ordenacao (string) tipo_ordenacao (string) paginacao.pagina_atual (number) paginacao.itens_por_pagina (number) paginacao.proximo_nosso_numero (string) |
| cobranca/get_boletos_by_id_boleto | Consulta detalhes de um boleto bancário que ainda está ativo ou que já foi baixado. | idBoleto (number) tipo_id (string) bergs-beneficiario (string) required |
| cobranca/patch_boletos_by_id_boleto | Altera detalhes de um boleto bancário que ainda está ativo. Tipos de alterações: - 04 - Concessão de Abatimento: Concede abatimento ao título. Se abatimento já concedido anteriormente, soma-se ao novo valor; - 06 - Data de Vencimento: Altera a data de vencimento de um título ativo, respeitando as permissões do beneficiário e do título. Se título possuir instruções de juros e multa sem indicação de data, a data das instruções acompanhará o novo vencimento automaticamente. Se título possuir ins | idBoleto (number) tipo_id (string) tipo_alteracao (string) required bergs-beneficiario (string) required bergs-ambiente (string) required data: { . titulo } (object) required |
| cobranca/post_boletos_by_id_boleto_baixar | Cancelamento de um boleto bancário por instrução do Beneficiário. | idBoleto (number) tipo_id (string) bergs-beneficiario (string) required bergs-ambiente (string) required |
| cobranca/get_boletos_by_id_boleto_emitir | Emissão de um boleto bancário em PDF codificado em Base64. | idBoleto (number) tipo_id (string) bergs-beneficiario (string) required bergs-ambiente (string) required |
| cobranca/post_boletos_testar_webhook | Endpoint disponibiliado no Sandbox para testar o envio de webhook de alteração na situação de títulos.br / Importante: Este endpoint está disponível somente no Sandbox para fins de teste da aplicação do cliente. Todas as requisições de sucesso terão o mesmo retorno bem como o mesmo conteúdo enviado via Webhook, conforme apresentado no callback deste endpoint. | data: { . url_destino (string) } (object) required |
| consignado/get_impedimentos_by_cpf | Esta consulta é online e requer apenas o CPF de um cliente para verificar, se existe ou não, alguma restrição ativa que impeça, no momento, a aquisição de Crédito Consignado RS. Esta chamada está disponível apenas para parceiros do conglomerado Banrisul. Em caso de dúvidas, contate nosso suporte para parceiros. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. | cpf (string) Partner-Id (string) required Co-Partner-Id (string) |
| consignado/post_consultas_srcc_by_cpf | Esta consulta é online e informa se existem registros ativos na lista do SRCC da Núclea para um determinado cliente. Esse registro não é impeditivo para a aquisição de Crédito Consignado RS, porém inviabiliza o pagamento de comissão ao Parceiro pela Operação. Esta chamada exige que um Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. Este serviço é construído com base na especificação técnica fornecida pela Núclea, de onde alguns retornos são encapsulados no padrão da p | cpf (string) Partner-Id (string) required Co-Partner-Id (string) data: { . data_base_consulta (string) . matricula (string) . tipo_empregador (integer) } (object) required |
| consignado/post_simulacoes_by_cpf | Esta consulta é online e realiza uma simulação de Crédito Consignado RS junto ao Banrisul. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. Esta consulta faz um calculo rápido e aproximado do valor final, porem somente a proposta ou a simulacao online que retorna valores precisos. | cpf (string) Partner-Id (string) required Partner-Agent-Id (string) required Co-Partner-Id (string) data: { . data_nascimento (string) . nome (string) . plano_banrisul (string) . valor_emprestimo (number) } (object) required |
| consignado/post_propostas_by_cpf | Esta chamada é online e dá início a uma proposta de Crédito Consignado RS junto ao Banrisul, para um determinado cliente, valor e plano informados. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. | cpf (string) Partner-Id (string) required Partner-Agent-Id (string) required Co-Partner-Id (string) data: { . plano_banrisul (string) . matricula (string) . valor_emprestimo (number) . banco (string) . agencia (string) . conta (string) . tipo_conta (string) . vinculo (integer) . mes_referencia_renda (string) . email (string) . celular (string) . cod_autenticidade (string) . data_nascimento (string) . cod_convenio (integer) . cod_operacao_refin (array) } (object) required |
| consignado/get_propostas_by_cpf_by_protocolo | Esta consulta é online e requer apenas o CPF de um cliente e um protocolo ID de requisição para consultar o andamento de uma proposta de Crédito Consignado RS junto ao Banrisul. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. Obs.: Para o retorno OK, os dados retornados nos campos 'status_proposta' e 'detalhamento_status_proposta' podem conter valores diversos, conforme andamento do processo de contratação. | cpf (string) protocolo (string) Partner-Id (string) required Partner-Agent-Id (string) required Co-Partner-Id (string) |
| consignado/delete_propostas_by_cpf_by_protocolo | Esta operação é online e requer o CPF de um cliente e um ID de Requisição para cancelar uma proposta de Crédito Consignado RS que ainda não esteja contratada via plataforma de Parceiros Estratégicos. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. Obs: Cabe reforçar que este endpoint não consegue encaminhar o cancelamento de uma proposta já concluída, assinada e averbada. | cpf (string) protocolo (string) Partner-Id (string) required Partner-Agent-Id (string) required Co-Partner-Id (string) |
| consignado/post_listarpropostasrefinanciamento_by_cpf | Esta consulta é online e requer apenas o CPF de um cliente para listar os contratos que estão aptos para serem refinanciadas do Crédito Consignado RS junto ao Banrisul. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. | cpf (string) Partner-Id (string) required Partner-Agent-Id (string) required Co-Partner-Id (string) data: { . matricula (string) . agencia (string) . conta (string) . mes_referencia_renda (string) . cod_autenticidade (string) . cod_convenio (integer) } (object) required |
| consignado/post_simulacoes_com_margem_by_cpf | Esta consulta é online e requer apenas o CPF de um cliente para realizar simulação completa, incluindo retorno de margem e validações para esteira de Crédito Consignado RS. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. | cpf (string) Partner-Id (string) required Partner-Agent-Id (string) required Co-Partner-Id (string) data: { . matricula (string) . agencia (string) . conta (string) . mes_referencia_renda (string) . cod_autenticidade (string) . plano_banrisul (string) . cod_convenio (integer) . valor_emprestimo (number) . cod_operacao_refin (array) } (object) required |
| consignado/get_propostas_relatorios | Esta consulta é online e tem por finalidade listar as propostas de Crédito Consignado RS realizadas junto ao Banrisul. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. Obs.: Para o retorno OK, os dados retornados nos campos 'status_proposta' e 'detalhamento_status_proposta' podem conter valores diversos, conforme andamento do processo de contratação. | Partner-Id (string) required Partner-Agent-Id (string) required Co-Partner-Id (string) data_inicio (string) required data_fim (string) required cpf (string) id_requisicao (string) |
| consignado/post_simulacoes_por_parcela_by_cpf | Esta consulta é online e requer o CPF de um cliente para realizar simulação por valor de parcela ou retornar o valor máximo de margem para contratação do Crédito Consignado RS. Observação: Ao não informar o valor da parcela, o endpoint retorna a margem total disponível para o cliente. Esta chamada exige que o Token Oauth2 seja informado no cabeçalho 'Authorization' da requisição. | cpf (string) Partner-Id (string) required Partner-Agent-Id (string) required Co-Partner-Id (string) data: { . matricula (string) . cod_convenio (string) . cod_autenticidade (string) . plano_banrisul (string) . valor_parcela (string) } (object) required |