82 docs tagged with "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á 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 OpenPix

Criando uma nova chave de API/Plugin

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 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

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 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 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

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

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

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

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 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, 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

Plugin JavaScript

Criando um novo cabeçalho HTTP pro meu webhook

Correlation ID

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.

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

Como Utilizar o Plugin JavaScript dentro de um iframe?

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 OpenPix Installment functionality. Request access via chat through the platform link.

Idempotência

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

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 Node é um kit de ferramentas criado com o objetivo de integrar facilmente os serviços da OpenPix 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 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

Pagamentos

Pix Avulso

Pix Cobrança

Pix QR Code

Payloads de Reembolso

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.

Veja sobre os possíveis problemas que podem ocorrer ao utilizar nossa integração com o Laravel:

Transação