68 docs tagged with "api"

View All Tags

APIs de Cashback

Como dar cashback para um cliente via API?

APIs de Cashback Fidelidade

Como dar cashback para um cliente via API?

Campos Comum

Este documento irá ajudá-lo a entender como alguns campos retornados pela API funcionam.

Casos de uso para Subcontas

Gorjeta

Client

Cliente

Cobrança

Cobrar Pix usando conta corrente do Banco do Brasil

Integrando sua corrente do Banco Brasil na OpenPix

Começando sua integração OpenPix com Laravel

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

Começando sua integração OpenPix com Laravel

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

Como acessar saldo e detalhes de uma Subconta via API?

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

Como acessar a API com uma empresa afiliada?

Criando o acesso via API

Como buscar todos os reembolsos de uma cobrança usando a 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.

Como buscar uma Assinatura usando a API?

Para buscar uma assinatura usando a API, você deverá fazer uma chamada GET para o endpoint /api/v1/subscriptions/ usando o globalID da assinatura.

Como começar

Instalando

Como começar

Instalando

Como começar?

Instalando

Como contribuir com o SDK

Contribuindo com o OpenPix Java SDK

Como contribuir com o SDK

Contribuindo com o OpenPix Ruby SDK

Como criar clientes em lote?

Para criar clientes em lote acesse o menu de Clientes

Como criar um webhook para uma empresa afiliada?

Criando o webhook via API

Como criar uma Assinatura usando a API?

Para criar uma nova assinatura usando a API, você deverá fazer uma chamada POST para o endpoint /api/v1/subscriptions.

Como criar uma cobrança com dados no email de cobrança paga?

1. Crie a cobrança seguindo o tutorial Como criar uma cobrança com informações adicionais?

Como criar uma reembolso de uma cobrança usando a API?

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.

Como interceptar um Pix utilizando um webhook

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

Como pegar o Relatório de Saque pela a API?

Relatório de Saque pela a API

Como realizar o saque de uma Subconta via API?

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

Como receber webhooks em sua aplicação Laravel

Webhooks

Como usar a API de Aprovar Pagamentos?

Aprovando pagamentos com api

Como usar a API de Criar Pagamentos?

Criando Pagamentos com a API

Como usar a API listar as Subcontas de uma empresa via API?

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

Como usar a API para criar um cliente?

Para criar um cliente, você utiliza o endpoint /api/v1/customer da API.

Como usar a API para criar um QRCode Estático (cob)?

Para criar uma QRCode estático Pix, você utiliza o endpoint /api/v1/pixQrCode da API.

Como usar a API para criar uma cobrança (cob)?

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

Como usar a API para criar uma cobrança com split para Subconta?

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

Como usar a API para criar uma cobrança com split?

Para a ultilização dessa funcionalidade é necessário possuir a funcionalidade Split

Como usar a API para criar uma cobrança com vencimento (cobv)?

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

Como usar a API para Transferir Valores entre Contas?

Para a ultilização dessa funcionalidade é necessário possuir a funcionalidade BETA

Conceito

Plugin JavaScript

Configurando os cabeçalhos HTTP do meu webhook

Criando um novo cabeçalho HTTP pro meu webhook

Correlation ID

Criando um webhook para interceptar um Pix e chamar uma 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.

Criando um webhook para interceptar um Pix via 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.

Exemplos de integração

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

FAQ

Como Utilizar o Plugin JavaScript dentro de um iframe?

How to Create a Subscription with interests and fines Using the API?

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.

How to use the API to create a charge with OpenPix Parcelado?

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

Manipulação de erros

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.