Conectores
Finança e Conta

Santander

20min

Objetivo

O Conector Santander permite a integração com as principais operações financeiras da API do Banco Santander. Ele possibilita a execução de pagamentos, consultas e gestão de transações diretamente na Fluid API.



Funcionalidades

  • Execução de Pagamentos: Permite realizar pagamentos de boletos, PIX e transferências bancárias.
  • Consulta de Status: Verifique o status de transações, boletos e pagamentos efetuados.
  • Gerenciamento de Workspaces: Organize pagamentos por ambientes de trabalho distintos.
  • Segurança e Autenticação: Utiliza autenticação baseada em API Key e certificados para garantir conexões seguras.


Configuração

Parâmetros de conexão

Estes são os parâmetros necessários para configurar a conexão com o Banco Santander:

Parâmetro

Descrição

Nome (obrigatório)

Identificação única para a conexão.

Descrição (opcional)

Texto explicativo sobre a conexão.

ID do Cliente (obrigatório)

Identificador único da aplicação no Santander.

Chave Secreta do Cliente (obrigatório)

Client secret da aplicação.

Certificado Público

Certificado público da aplicação.

Certificado Privado

Certificado privado associado à aplicação.

Escopo

Escopo de permissões associado à aplicação.

Ambiente (obrigatório)

Define se a conexão será usada em ambiente de produção ou homologação.

URL do Ambiente (obrigatório)

Endereço base da API do Santander.



Módulos disponíveis

Os módulos representam categorias de funcionalidades dentro do Conector Santander. Para cada módulo, há recursos e operações disponíveis.

1. Módulo: Cobrança

Gerenciamento de boletos e faturas.

🔹 Recurso: Workspaces

  • [GET] Listar Workspaces → Retorna todos os workspaces de cobrança.
  • [GET] Consultar Workspace → Obtém detalhes de um workspace específico.
  • [POST] Criar um Workspace → Registra um novo workspace de cobranças.

🔹 Recurso: Boletos de cobrança

  • [GET] Consultar Boleto → Obtém dados detalhados de um boleto.
  • [GET] Listar Boletos → Retorna uma lista de boletos cadastrados.
  • [POST] Registrar um Boleto → Cria um novo boleto de cobrança.
  • [PATCH] Atualizar um Boleto → Permite alterar status e valores de um boleto existente.


2. Módulo: Pagamentos

Gerenciamento de pagamentos e transações.

🔹 Recurso: Workspaces

  • [GET] Listar Workspaces → Retorna os workspaces de pagamentos.
  • [GET] Consultar Workspace → Obtém dados de um workspace específico.
  • [POST] Criar um Workspace → Registra um novo workspace de pagamentos.

🔹 Recurso: Código de barras

  • [GET] Consultar Pagamento por Código de Barras → Obtém status e detalhes de um pagamento via código de barras.
  • [GET] Listar Pagamentos por Código de Barras → Retorna uma lista de pagamentos registrados.
  • [POST] Iniciar Pagamento → Efetua um pagamento via código de barras.
  • [PATCH] Confirmar Pagamento → Atualiza status de um pagamento pendente.

🔹 Recurso: PIX Payments

  • [GET] Consultar Pagamento PIX → Obtém detalhes de um pagamento PIX realizado.
  • [POST] Criar Pagamento PIX → Efetua uma transferência PIX via QR Code ou chave PIX.
  • [PATCH] Confirmar Pagamento PIX → Atualiza status de uma transação PIX.


Autenticação

A Fluid API requer autenticação baseada em API Key para acessar o conector Santander. As credenciais devem ser configuradas corretamente para garantir a segurança das requisições.

Como usar

  1. Configure sua conexão no painel da Fluid API.
  2. Selecione o módulo desejado (Cobrança, Pagamentos).
  3. Escolha um recurso e operação compatível com sua necessidade.
  4. Envie os dados conforme os exemplos de payload disponíveis.

Caso de Uso: Fluxo de Pagamentos PIX com o Conector Santander

Visão Geral

Document image


Esse fluxo automatiza a jornada completa de um pagamento via PIX utilizando o Conector Santander na plataforma Fluid. Ele cobre desde a listagem de pagamentos PIX cadastrados até a efetivação e consulta do status final da transação.

Etapas do Fluxo

1️⃣ Listagem de Pagamentos PIX Cadastrados

  • O primeiro passo (Santander - get-pix-payments) recupera a lista de pagamentos PIX existentes dentro do ambiente do usuário.
  • Isso pode ser útil para verificar transações pendentes ou consultar um pagamento já iniciado anteriormente.

2️⃣ Iniciação do Pagamento PIX

  • O usuário escolhe o tipo de pagamento desejado, podendo optar por três variações diferentes:
    • DICT (Diretório de Identificadores de Contas Transacionais) → Utiliza uma chave PIX para iniciar o pagamento.
    • QR Code → Faz a leitura e pagamento via QR Code PIX.
    • Beneficiário → Inicia um pagamento informando diretamente os dados bancários do beneficiário.
  • Dependendo do tipo de pagamento, o fluxo se ramifica para um dos três passos de iniciação:
    • Santander - inicia-pix-payment-dict
    • Santander - inicia-pix-payment-qrcode
    • Santander - inicia-pix-payment-beneficiary

3️⃣ Consulta do Pagamento Iniciado

  • Após iniciar o pagamento, o passo (Santander - get-pix-payment) verifica o status da transação.
  • Isso garante que os dados do pagamento foram processados corretamente antes de sua efetivação.

4️⃣ Efetivação do Pagamento PIX

  • O passo (Santander - efetiva-pix-payment) confirma o pagamento iniciado.
  • Nesta etapa, a transação é oficialmente processada pelo banco.

5️⃣ Consulta Final da Transação

  • O passo (Santander - get-pix-payment-efetivado) verifica se o pagamento foi efetivado com sucesso ou se há alguma pendência.
  • Essa validação é importante para garantir que o valor foi debitado e recebido corretamente.

Principais benefícios

Automação Completa: O fluxo cobre todas as etapas de um pagamento PIX, reduzindo ações manuais. ✅ Flexibilidade: O usuário pode escolher entre diferentes métodos de pagamento (DICT, QR Code ou Beneficiário). ✅ Maior Segurança: A consulta antes da efetivação garante que a transação está correta antes de ser concluída. ✅ Monitoramento em Tempo Real: O fluxo acompanha o status do pagamento desde a iniciação até a conclusão.

Quando usar esse fluxo?

  • Para empresas que realizam pagamentos PIX em larga escala e precisam de um processo automatizado.
  • Para casos em que é necessário validar um pagamento antes da efetivação, reduzindo erros operacionais.
  • Para integração de sistemas financeiros que exigem acompanhamento detalhado de transações.