Pagamento BankPlus v3

O módulo de Pagamento na API v3 gerencia a saída de recursos e a liquidação de compromissos financeiros. Diferente das versões anteriores, a v3 foca na segurança e no controle, introduzindo um fluxo onde as intenções de pagamento podem ser aprovadas ou reprovadas por usuários autorizados, garantindo total conformidade com as alçadas de decisão da empresa.

Para baixar o arquivo com os métodos dessa função, clique em Métodos - Pagamento v3.

1. Configuração e Acesso (InventApps)

O acesso ao módulo de pagamento segue o padrão de segurança Bearer Token da V3.

• Autenticação: Utilize seu Client ID e Client Secret no InventApps para gerar o token de acesso.

• Identificação: O sistema identifica as permissões do usuário aprovador diretamente pelo token e pelos parâmetros da URL.

• Importante: A porta e o endereço configurados no InventApps direcionam a requisição para a base correta, eliminando a necessidade de apelidos na URL.

2. Métodos de Consulta (GET)

Listar PagamentosRetorna a lista de pagamentos registrados, permitindo acompanhar o status de cada transação (Aguardando, Aprovado ou Reprovado).

• Endpoint: GET /api/v3/Pagamento

• Como usar: Ideal para painéis de gestão financeira que precisam monitorar o fluxo de caixa e as saídas pendentes de autorização.

3. Workflow de Aprovação (POST)

A principal mudança na V3 é a centralização das decisões de pagamento através de endpoints que identificam o responsável pela ação diretamente na rota.

Aprovar PagamentoEste método efetiva a intenção de pagamento, autorizando a saída do recurso e a respectiva baixa no SAP Business One.

• Endpoint: POST /api/v3/Pagamento/{usuarioAprovador}/aprovar

• Como usar: Na URL, substitua {usuarioAprovador} pelo identificador ou login do usuário responsável pela aprovação. No corpo (Body) da requisição, envie os IDs dos pagamentos que devem ser liberados.

Reprovar PagamentoCancela a intenção de pagamento, impedindo a saída do recurso e mantendo o título em aberto para futuras ações.

• Endpoint: POST /api/v3/Pagamento/{usuarioAprovador}/reprovar

• Uso: Similar ao método de aprovação, este endpoint exige a identificação do usuário que está negando a transação, sendo fundamental para o histórico de auditoria.