APIs de Cashback
Como dar cashback para um cliente via API?
Como dar cashback para um cliente via API?
Como dar cashback para um cliente via API?
Este documento irá ajudá-lo a entender como alguns campos retornados pela API funcionam.
Gorjeta
Cliente
Cobrança
Integrando sua corrente do Banco Brasil na OpenPix
Este documento irá ajudá-lo a começar a utilizar as APIs e Plugins da OpenPix.
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
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 a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta
Criando o acesso via API
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.
Instalando
Instalando
Instalando
Contribuindo com o OpenPix Java SDK
Contribuindo com o OpenPix Ruby SDK
Para criar clientes em lote acesse o menu de Clientes
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?
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.
Com a Openpix é possível criar webhooks para interceptar quando um Pix for realizado.
Relatório de Saque pela a API
Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta
Webhooks
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 a ultilização dessa funcionalidade é necessário possuir a funcionalidade OpenPix Parcelado. Solicite o acesso via chat pela plataforma pelo link
Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta
Para a ultilização dessa funcionalidade é necessário possuir a funcionalidade Split
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 BETA
Plugin JavaScript
Criando um novo cabeçalho HTTP pro meu webhook
Correlation ID
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 OpenPix em seu backend ou frontend
Aqui, temos 2 exemplos de como integrar a API OpenPix 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?
Idempotência
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
O SDK de Java é um kit de ferramentas criado com o objetivo de integrar facilmente os serviços da OpenPix em suas aplicações Java.
O SDK de PHP é um kit de ferramentas criado com o objetivo de integrar facilmente os serviços da OpenPix em suas aplicações PHP.
O SDK de Ruby é um kit de ferramentas criado com o objetivo de integrar facilmente os serviços da OpenPix em suas aplicações Ruby.
Payload de Cobrança Expirada
Pagamento confirmado
Pix Avulso
Pix Cobrança
Pix QR Code
Payloads de Reembolso
Você também pode testar a API usando OpenPix Postman
Quando usar o sistema de Parceiro
Lista de recursos disponíveis
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.
Veja sobre os possíveis problemas que podem ocorrer ao utilizar nossa integração com o Laravel:
Sub Conta
Transação