Adicionando filtro de IP à sua API
Como forma de garantir uma melhor segurança no uso da sua API, você pode adicionar uma lista de permissões de IP à sua API.
Como forma de garantir uma melhor segurança no uso da sua API, você pode adicionar uma lista de permissões de IP à sua API.
Como dar cashback para um cliente via API?
Como dar cashback para um cliente via API?
Este documento irá ajuda-lo a entender os principais conçeitos de med e qual a sua relação com baas.
Este documento irá ajudá-lo a bloquear cobranças para serem pagas somente por 1 pagador.
Este documento irá ajudá-lo a entender como alguns campos retornados pela API funcionam.
Para a utilização dessa funcionalidade é necessário possuir a funcionalidade Split
Cliente
Cobrança
Integrando sua corrente do Banco Brasil na Woovi
Códigos de Erro de Pagamento PIX
Este documento irá ajudá-lo a começar a utilizar as APIs e Plugins da Woovi.
Criando uma nova chave de API/Plugin
1 Crie uma nova API
Como começar uma nova campanha?
Laravel é um poderoso framework em PHP com uma sintaxe elegante e expressiva, que permite avançar rapidamente em suas soluções, sem se preocupar com detalhes pequenos.
Temos um exemplo de integração com o SDK de PHP e Laravel preparado para você em nosso repositório do GitHub//github.com/Open-Pix/laravel-backend-integration
Criando o acesso via API
Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta
É possível alterar o dados de um cliente, tanto via api, quanto via plataforma e o objetivo dessa documentação é mostrar como fazer isso.
Para buscar todos os reembolsos de uma cobrança usando a API, você deverá fazer uma chamada GET para o endpoint /api/v1/charge//refund usando correlationID da cobrança.
Para buscar todos os reembolsos de uma cobrança usando a API, você deverá fazer uma chamada GET para o endpoint /api/v1/charge//refund usando correlationID da cobrança.
Para buscar uma assinatura usando a API, você deverá fazer uma chamada GET para o endpoint /api/v1/subscriptions/ usando o globalID da assinatura.
Endpoint
Instalando
Instalando
Instalando
Instalando
Contribuindo com o woovi Java SDK
Contribuindo com o woovi Ruby SDK
Para criar clientes em lote acesse o menu de Clientes
Para criar um pix Automático você utilizará o mesmo endpoint de assinatura que já existe, porém necessitará de enviar alguns campos adicionais.
Criando o webhook via API
Para criar uma nova assinatura com multa e juros usando a API, você deverá fazer uma chamada POST para o endpoint /api/v1/subscriptions.
Para criar uma nova assinatura usando a API, você deverá fazer uma chamada POST para o endpoint /api/v1/subscriptions.
1. Crie a cobrança seguindo o tutorial Como criar uma cobrança com informações adicionais?
Criando uma empresa afiliada
Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta
Para criar uma novo reembolso de uma cobrança usando a API, você deverá fazer uma chamada POST para o endpoint /api/v1/charge//refund usando correlationID da cobrança.
Para criar uma novo reembolso de uma cobrança usando a API, você deverá fazer uma chamada POST para o endpoint /api/v1/charge//refund usando correlationID da cobrança.
Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta
Endpoint
Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta
Como identificar no webhook de qual API veio a cobrança
Configurar os webhooks
Com a Openpix é possível criar webhooks para interceptar quando um Pix for realizado.
Paginação pela API de Transações
Relatório de Saque pela a API
Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta
Webhooks
Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta
Fazendo o registro das contas
Aprovando pagamentos com api
Aprovando pagamentos com api
Criando Pagamentos com a API
Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta
Para criar um cliente, você utiliza o endpoint /api/v1/customer da API.
Para criar uma QRCode estático Pix, você utiliza o endpoint /api/v1/pixQrCode da API.
Para criar uma cobrança Pix, você utiliza o endpoint /api/v1/charge da API.
Criar cobrança com descontos via API
Para a utilização desta funcionalidade é necessário possuir a funcionalidade BETA
Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta
Para a utilização dessa funcionalidade é necessário possuir a funcionalidade Split
Criar cobrança com uma subconta atrelada via API
Para criar uma cobrança Pix com vencimento, multa e juros, você utiliza o endpoint /api/v1/charge da API.
Para a ultilização dessa funcionalidade é necessário possuir a funcionalidade woovi Parcelado. Solicite o acesso via chat pela plataforma pelo link.
Para a utilização dessa funcionalidade é necessário possuir a funcionalidade BETA
Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta
1. É necessario que você tenha uma API
1. É necessario que você tenha uma API MASTER
Como verificar qual o tipo da conta que recebi o webhook?
Plugin JavaScript
Este documento irá ajuda-lo a entender os principais conçeitos de baas
Criando um novo cabeçalho HTTP pro meu webhook
Este documento irá ajudá-lo a entender como criar api's para as contas abertas no modo BAAS
Ao lidar com a comunicação entre sistemas distribuídos e serviços em uma aplicação, um aspecto crítico é a identificação e o rastreamento de transações específicas. O Correlation ID (ID de Correlação) desempenha um papel fundamental nesse processo. Vamos explorar a formatação adequada do Correlation ID e fornecer um exemplo prático para ilustrar sua implementação.
Criação manual de cobranças recorrentes
1. Para criar uma nova API MASTER
Criando uma aplicação para ser utilizado no Plugin JS
Pela Openpix é possível criar webhooks para interceptar quando um pix for realizado. Hoje, há duas maneiras de realizar a criação do mesmo: via plataforma ou API.
Pela Openpix é possível criar webhooks para interceptar quando um pix for realizado. Hoje, há duas maneiras de realizar a cria ção do mesmo: via plataforma ou API.
Você pode gerar novas Cobranças Pix usando a API Woovi em seu backend ou frontend
Endpoint
Erros relacionados a Cobrança
Aqui, temos 2 exemplos de como integrar a API Woovi em seu backend. Ele demonstra o seguinte:
Veja alguns exemplos de integrações com o SDK de PHP:
Como Utilizar o Plugin JavaScript dentro de um iframe?
Este documento irá ajuda-lo a entender o fluxo básico de baas
Fluxo básico de Pagamento
Criação de uma assinatura
Idempotência
O que é a woovi Bridge?
Pix Automátio WEB HOOKS
Ao utilizar o SDK de Node, espera-se que a integração seja robusta. Sendo assim, é fundamental lidar com possíveis imprevistos da API ou do transporte de dados na forma de exceptions.
Ao utilizar o SDK de PHP, espera-se que a integração seja robusta; sendo assim, é fundamental lidar com possíveis imprevistos da API ou do transporte de dados na forma de exceptions.
Como funciona a Máquina de Estados do Pagamento
Assinatura (Subscription)
O Pix Automático permite cobranças automáticas, diretamente da conta bancária do usuário. Sendo ideal para pagamentos recorrentes como assinaturas ou mensalidades.
O SDK de Java é um kit de ferramentas criado com o objetivo de integrar facilmente os serviços da woovi em suas aplicações Java.
O SDK de Node é um kit de ferramentas criado com o objetivo de integrar facilmente os serviços da woovi em suas aplicações construidas em NodeJs.
O SDK de PHP é um kit de ferramentas criado com o objetivo de integrar facilmente os serviços da woovi em suas aplicações PHP.
O SDK de Ruby é um kit de ferramentas criado com o objetivo de integrar facilmente os serviços da woovi em suas aplicações Ruby.
Payload de Cobrança Expirada
Payloads de Reembolso
Payloads de Reembolso
Disputa (DISPUTE_ACCEPTED)
Disputa (DISPUTE_CANCELED)
Disputa (DISPUTE_CREATE)
Disputa (DISPUTE_REJECTED)
Pagamento confirmado
Pix Avulso
Pix Cobrança
Pix QR Code
Payloads de Reembolso
Payloads de Reembolso
Payloads de Reembolso
Payload de transação recebida
Você também pode testar a API usando Woovi Postman
Em caso de dúvida sobre qual é a melhor jornada para seu negócio. Nós recomendamos escolher a jornada 3 (PAYMENTONAPPROVAL). Por que ela é mais simples de ser implementada e de ser compreendida. Uma vez que ao ler o QRCode o usuário já efeuta o pagamento e autoriza a cobrança, além de a assinatura entrar em vigor imediatamente.
Lista de recursos disponíveis
Conta
Clientes
Lista de recursos disponíveis
Reembolso
Para renderizar o QR Code de uma cobrança Pix em uma página da sua aplicação Laravel, acesse o template Blade que irá exibir a cobrança.
O SDK permite que seja enviado requisições customizadas para um cliente HTTP possivelmente customizado.
Horários retornados na API
Pix Automátio Rotas da API
Veja sobre os possíveis problemas que podem ocorrer ao utilizar nossa integração com o Laravel:
Este documento irá ajudá-lo a entender como configurar o split para a conta principal no modo BaaS.
Estrutura de Suporte e Ouvidoria BAAS
Transação
Verificação de Chave Pix
Este documento irá ajudá-lo a validar chave pix.
Como vincular o webhook à API?