175 docs tagged with "api"

Para aumentar a segurança das suas integrações, você pode restringir um AppID para que ele tenha acesso apenas às rotas da API que ele realmente precisa, atribuindo escopos (scopes) a ele.

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 mostra como habilitar o modo BaaS na sua conta Woovi e deixar tudo pronto para criar as contas dos seus clientes.

Este documento irá ajudá-lo a entender os principais conceitos 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.

Endpoint público que retorna a chave usada para verificar o header x-webhook-signature

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

Registro datado das mudanças relevantes da API pública. Mudanças aditivas (novos

Cada conta precisa de ao menos uma chave Pix — é a chave default da conta que as cobranças usam. Gerencie as chaves de uma conta com o AppID da própria conta.

Cliente

Cobrança

Integrando sua corrente do Banco Brasil na Woovi

Códigos de Erro de Pagamento PIX

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

Para abrir uma recuperação de fundos (MED) usando a API, você deverá fazer uma chamada POST para o endpoint /api/v1/funds-recovery, autenticando com o seu AppID no header Authorization.

Criando o acesso via API

Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta

Quando a empresa pagadora exige aprovação, cada antecipação solicitada pelo

Você pode ativar ou desativar um beneficiário pelo seu taxID (a chave de

É 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 uma assinatura usando a API, você deverá fazer uma chamada GET para o endpoint /api/v1/subscriptions/ usando o globalID da assinatura.

Para cadastrar um beneficiário na Antecipação você utiliza o endpoint

Endpoint

Para cancelar uma recuperação de fundos (MED) usando a API, você deverá fazer uma chamada POST para o endpoint /api/v1/funds-recovery//cancel, usando o dictId retornado na criação.

Instalando

Instalando

Instalando

Instalando

Para configurar o sdk para utilizar os endpoints de sandbox basta alterar a contante que guarda a url base.

Listando Pagamentos com a API

Para consultar os limites configurados em uma conta bancária do merchant, utilize o endpoint GET /api/v1/limits/.

Para consultar uma recuperação de fundos (MED) usando a API, você deverá fazer uma chamada GET para o endpoint /api/v1/funds-recovery/, usando como {id} o dictId retornado na criação ou o endToEndId da transação Pix que originou a recuperação.

Contribuindo com o woovi Java SDK

Contribuindo com o woovi Ruby SDK

Para criar clientes em lote acesse o menu de Clientes

Criando e aprovando um pagamento em uma única chamada

Para iniciar o processo de KYC (Know Your Customer) de um merchant, você utiliza o endpoint POST /api/v1/kyc/onboarding.

Como criar Pix Automático com valor variável

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

Você pode criar uma assinatura em que cada parcela é cobrada por Boleto. A cada

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 a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta

Endpoint

Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta

O endpoint de arquivos guarda um arquivo na Woovi e devolve os metadados dele junto com uma URL de download temporária. Use esse arquivo em outras APIs da Woovi que consomem documentos, como a evidência de uma disputa, sem precisar hospedar o arquivo por conta própria.

Como identificar no webhook de qual API veio a cobrança

Configurar os webhooks

Depois de gerar um linkOnboarding com o endpoint POST /api/v1/kyc/onboarding, você pode entregá-lo ao merchant de três formas:

Com a Woovi é possível criar webhooks para interceptar quando um Pix for realizado.

Ao incorporar o KYC Onboarding no seu produto (via iframe, redirecionamento ou popup), você pode querer uma experiência white-label, sem a logo da Woovi no topo da página.

Resumo

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

Depois que o seu cliente final preenche o link de KYC (criado via API), você pode recuperar todos os dados cadastrados — incluindo a selfie, documento de identidade e contrato social — através do endpoint GET /api/v1/account-register/:id.

Fazendo o registro das contas

Para atualizar os saldos antecipáveis de vários beneficiários de uma vez — o caso

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.

Para criar uma cobrança Pix com split para sub conta, você utiliza o endpoint /api/v1/charge da API.

Para criar uma cobrança Pix com split para sub conta, você utiliza o endpoint /api/v1/charge da API.

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 utilização dessa funcionalidade é necessário possuir a funcionalidade BETA

Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta

Este documento irá ajudá-lo a validar os dados bancários de um beneficiário (agência e conta) sem precisar de uma chave Pix.

Este documento irá ajudá-lo a validar os dados bancários de um beneficiário a partir de uma chave Pix (CPF, CNPJ, e-mail, telefone ou chave aleatória).

Como verificar qual o tipo da conta que recebi o webhook?

Plugin JavaScript

Resumo

Este documento irá ajudá-lo a configurar, via API, a emissão de nota fiscal eletrônica de serviço (NFS-e) de uma conta, do cadastro da integração até a emissão da nota de teste que valida tudo.

Criando um novo cabeçalho HTTP pro meu webhook

Este documento irá ajudá-lo a entender como criar APIs para as contas abertas no modo BaaS e como um AppId MASTER lê o extrato e as transações de outra conta da mesma empresa.

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

Este documento mostra como criar uma cobrança Pix para uma conta específica do modo BaaS.

1. Para criar uma nova API MASTER

Pela Woovi é 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 Woovi é 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.

A emissão exige que a integração de nota fiscal da conta já esteja configurada e ativa. Veja Configurando a emissão de nota fiscal via API ou Como ativar a emissão pela plataforma.

Este documento irá ajudá-lo a decodificar uma string de QR Code Pix ou Copia e Cola (formato EMV / BR Code do BCB).

Rotas da API de Stablecoin

Erros relacionados a Cobrança

Veja alguns exemplos de integrações com o SDK de PHP:

Selecione um endpoint da API Woovi e copie o payload em JSON, TypeScript, JSON Schema, Yup ou Zod.

Como Utilizar o Plugin JavaScript dentro de um iframe?

Este documento irá ajudá-lo a entender o fluxo básico de BaaS.

O fluxo de stablecoin segue a ideia de criar um depósito e aprová-lo: a aprovação debita o saldo em BRL da conta da sua empresa e entrega a stablecoin (USDT) na carteira de destino.

Fluxo básico de Pagamento

O fluxo de payout segue o mesmo padrão do depósito: criar e depois aprovar. Você informa o valor alvo em BRL; na aprovação o float INTERNAL (USDT/USDC/BRLA) é debitado conforme a cotação e o Pix é enviado.

Criação de uma assinatura

To create a new subscription with interests and fines using the API, you need to make a POST call to the /api/v1/subscriptions endpoint.

In order to use this functionality, it is necessary to have the Woovi Installment functionality. Request access via chat through the platform link.

Idempotência

Idempotência em Pagamentos

O que é a woovi Bridge?

This is Woovi's public remediation documentation for exposed credentials. Use

Limites do Stablecoin

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)

A Recuperação de fundos (Funds Recovery) é a implementação do MED (Mecanismo Especial de Devolução) do Banco Central. Ela permite que você solicite a devolução de uma transação Pix enviada pela sua conta em casos de golpe ou fraude.

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.

O Stablecoin da Woovi permite que sua empresa converta reais (BRL) em stablecoins — como USDT e USDC. A partir do saldo em BRL da conta da sua empresa, o valor é entregue, já convertido, em stablecoin na carteira de destino, na rede escolhida.

Payload de Cobrança Criada

Payload de Cobrança Expirada

Pix Cobrança Paga

Pix Cobrança Paga com um payer diferente do customer.

Payloads de Reembolso

Payloads de Reembolso

Disputa (DISPUTE_ACCEPTED)

Disputa (DISPUTE_CANCELED)

Disputa (DISPUTE_CREATE)

Disputa (DISPUTE_REJECTED)

Pagamento confirmado

Pix QR Code

Payloads de Reembolso

Registro de conta aprovado

Registro de conta pendente

Payloads de Reembolso

Payloads de Reembolso

Payload de transação recebida

Buscar Disputa (GET)

Uma subconta precisa ter uma chave pix válida e existente para que o saque seja realizado. Quando uma tentativa de saque é feita e a chave pix da subconta não é encontrada no DICT (Diretório de Identificadores de Contas Transacionais) do Banco Central, o campo withdrawBlocked da subconta é marcado como true e todas as tentativas futuras de saque serão bloqueadas imediatamente.

Este documento irá ajudá-lo a começar a utilizar a API pública de Account Limits.

Este documento irá ajudá-lo a começar a utilizar a API de KYC Onboarding.

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

Este documento mostra como movimentar o saldo das contas do modo BaaS: saque, transferência entre contas e extrato.

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

Taxas do Stablecoin

Toda consulta de chave Pix passa pelo DICT, o diretório de chaves do Banco Central. O Bacen limita quantas consultas cada participante pode fazer e penaliza consultas a chaves inexistentes — é assim que ele impede varredura de dados de titulares.

Transação

Este documento irá ajudá-lo a validar chave pix.

A Woovi se compromete a não quebrar silenciosamente integrações em produção.

Como vincular o webhook à API?

Como autenticar e integrar a API REST de Antecipação da Woovi para cadastrar beneficiários e sincronizar saldos a partir do seu ERP ou folha de pagamento.

Webhooks do Stablecoin

Webhooks pertencem à credencial que os registrou. No modo BaaS isso significa: