190 docs tagged with "api"

Como restringir um AppID da Woovi aos endpoints necessários atribuindo escopos, ao criar uma API/Plugin ou editando uma existente.

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

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 instalar e configurar o SDK de PHP da Woovi em um projeto Laravel para começar a receber pagamentos via Pix.

Como abrir uma recuperação de fundos (MED) via API da Woovi para uma transação Pix enviada pela sua conta em caso de golpe ou fraude.

Criando o acesso via API

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

Entre "criei o link de onboarding" e "a conta foi aprovada" existe um processo de vários passos que pode durar dias: o seu cliente final preenche os dados da empresa, sobe o contrato social, cadastra os sócios, faz a selfie, autoriza o BC Protege+ e assina os termos — e, no meio disso, pode ser que a análise peça um documento novo e devolva o cadastro para ele.

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.

Como buscar todos os reembolsos de uma cobrança Pix via API da Woovi usando o correlationID da cobrança, com exemplo de resposta.

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

Como cancelar via API uma recuperação de fundos (MED) aberta pela sua conta e que ainda não chegou a um status final.

Instalando

Instalando

Instalando

Instalando

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

Padrões para integrar com a Woovi 100% via API: AppID com escopos mínimos, upload de arquivos com fileId, webhooks e idempotência.

Como consultar via API as disputas (MED recebido) abertas na sua conta relacionadas a uma recuperação de fundos.

Como consultar via API as notificações de infração enviadas ao Banco Central ligadas a uma recuperação de fundos (MED).

Como consultar via API as solicitações de devolução de uma recuperação de fundos (MED) e quanto foi efetivamente devolvido.

Listando Pagamentos com a API

Os dois endpoints retornam TEDs enviadas e recebidas pela sua empresa, no mesmo

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

Como consultar via API uma recuperação de fundos (MED) pelo dictId ou pelo endToEndId e acompanhar o seu status.

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?

Além de contas para empresas (CNPJ), uma empresa BaaS pode abrir contas de pessoa física (PF) para os seus clientes, identificadas pelo CPF do titular.

Criando uma empresa afiliada

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

Como criar o reembolso total ou parcial de uma cobrança Pix via API da Woovi, com o correlationID de idempotência do reembolso.

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

Para devolver ao remetente uma TED que a sua empresa recebeu, use o endpoint

Endpoint

Para enviar uma TED a partir de uma conta da sua empresa, use o endpoint

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

Como enviar um arquivo para a Woovi via API e usá-lo em evidências de disputa, pedidos de aumento de limite e documentos de KYC.

O carnê reúne em um único PDF as cobranças da sua assinatura — uma via por parcela,

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.

Como ocultar a logo da Woovi no link de KYC Onboarding com o parâmetro ?embed=true e o que continua visível no modo embedded.

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

Como recuperar os dados e documentos de um cadastro KYC pelo endpoint GET /api/v1/account-register/:id, usando o CNPJ ou o correlationID.

Fazendo o registro das contas

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

Aumentar o limite de uma conta deixou de ser um pedido manual pelo console: dá para abrir a

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

Cobrança

Resumo

Resumo

Como configurar via API a emissão de nota fiscal de serviço (NFS-e) de uma conta, do cadastro da integração até a nota de teste.

Criando um novo cabeçalho HTTP pro meu webhook

Como usar uma API MASTER no modo BaaS da Woovi para criar AppIDs por conta e ler extrato e transações de outras contas da empresa.

O que é o correlationID na Woovi, o formato recomendado e por que ele funciona como chave de idempotência de cobranças e pagamentos.

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.

Como emitir uma nota fiscal de serviço (NFS-e) pelo endpoint POST /api/v1/invoice da Woovi, com os formatos de payload aceitos.

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

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

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.

Fluxo de depósito (on-ramp) do Stablecoin da Woovi: crie e aprove um depósito para converter saldo em BRL em USDT na carteira de destino.

Fluxo básico de Pagamento

Fluxo de payout (off-ramp) do Stablecoin da Woovi: converta USDT, USDC ou BRLA em BRL e envie o valor via Pix.

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.

Instead of polling GET /api/v1/pix-auth/:id until the Pix Auth ends, you can be notified by webhook as soon as it ends.

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

How to confirm that a CPF or CNPJ belongs to who claims it with Woovi Pix Auth, using a R$ 0.01 Pix that is refunded.

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

Como tratar erros no SDK de Node.js da Woovi: exceptions lançadas pela API, novas tentativas automáticas e exemplo de try/catch.

Como tratar erros no SDK de PHP da Woovi: ApiErrorException, exceções de transporte PSR-18 e exemplo de captura de erros.

Como funciona a Máquina de Estados do Pagamento

Assinatura (Subscription)

O que é a Recuperação de fundos da Woovi, implementação do MED do Banco Central para pedir a devolução de um Pix em casos de golpe ou fraude.

O que é o Pix Automático, como funcionam a criação e a autorização da assinatura e quais são as jornadas definidas pelo Banco Central.

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 que é o Stablecoin da Woovi: converta reais (BRL) em USDT ou USDC e receba na carteira de destino, na rede escolhida.

Como fazer o onboarding KYC inteiro pela API da Woovi, coletando documentos, selfie e dados dos sócios dentro do seu próprio produto.

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)

Por que o saque de uma subconta é bloqueado quando a chave Pix não existe no DICT ou está restrita, e como verificar o bloqueio.

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.

A API de TED permite enviar uma TED a partir de uma conta da sua empresa,

Qual jornada do Pix Automático escolher na Woovi para cada cenário: autorização com pagamento, só recorrência, push ou migração.

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

Como funciona o token bucket da Woovi que limita as consultas de chave Pix no DICT, quanto custa cada consulta e como ler o saldo.

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

Como escolher a credencial certa, quais eventos existem no BaaS e o que fazer quando um webhook não chega.