PHPackages                             andersonav/laravel-psp-pix - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. andersonav/laravel-psp-pix

ActiveLibrary[API Development](/categories/api)

andersonav/laravel-psp-pix
==========================

Integration PIX with Laravel

v15.0.0(2mo ago)027MITPHPPHP ^8.0|^8.2|^8.3|^8.4

Since Aug 20Pushed 2mo ago1 watchersCompare

[ Source](https://github.com/andersonav/laravel-psp-pix)[ Packagist](https://packagist.org/packages/andersonav/laravel-psp-pix)[ RSS](/packages/andersonav-laravel-psp-pix/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (5)Versions (16)Used By (0)

Uma solução simples para integrar a sua aplicação Laravel com a API PIX do Banco Central do Brasil
==================================================================================================

[](#uma-solução-simples-para-integrar-a-sua-aplicação-laravel-com-a-api-pix-do-banco-central-do-brasil)

- [Instalação](#instalacao)
    - [Publicando os assets](#publicando-os-assets)
    - [Publicando o arquivo de configuração](#publicando-o-arquivo-de-configuracao)
- [Endpoints](#endpoints)
- [Configurações iniciais](#configuracoes-iniciais)
    - [Obtendo o token de acesso](#obtendo-o-token-de-acesso)
    - [Configurando PSPs](#configurando-psps)
- [Cob](#cob)
    - [Criando uma cobrança imediata](#criando-um-cob)
    - [Revisando uma cobrança imediata](#revisar-uma-cobranca-imediata)
    - [Consultando uma cobrança imediata](#consultando-uma-cobranca-imediata)
    - [Criar cobranças imediatas sem `transactionId`](#criando-cobrancas-imediatas-sem-transactionid)
    - [Consultando lista de cobranças imediatas](#consultando-lista-de-cobrancas-imediatas)
- [CobV](#cobv)
    - [Criando uma cobrança com vencimento](#criando-cobrancas-com-vencimento)
    - [Revisando cobranças com vencimento](#revisando-cobrancas-com-vencimento)
    - [Consultando uma cobrança com vencimento](#consultar-uma-cobranca-com-vencimento)
    - [Consultar lista de cobranças com vencimento](#consultar-lista-de-cobrancas-com-vencimento)
- [LoteCobV](#lotecobv)
    - [Criando cobranças com vencimento em lote](#criando-cobranca-com-vencimento-em-lote)
    - [Revisando lotes de cobranças com vencimento](#revisar-lotes-de-cobrancas-com-vencimento)
    - [Consultar lote de cobrança com vecimento](#consultar-um-lote-de-cobrancas-com-vencimento)
    - [Consultar lista de lotes de cobrança com vencimento](#consultar-lista-de-cobrancas-com-vencimento-em-lote)
- [Payload Location](#payload-location)
    - [Criar location do payload](#criar-location-do-payload)
    - [Consultar locations cadastradas](#consultar-locations-cadastradas)
    - [Recuperar location do payload](#recuperar-location-do-payload)
    - [Desvincular uma cobrança de um location](#desvincular-uma-cobranca-de-uma-location)
- [Pix recebidos](#pix-recebidos)
    - [Consultar um pix recebido](#consultar-pix)
    - [Consultar lista de pix recebidos](#consultar-pix-recebidos)
    - [Solicitar devolução de um pix](#solicitar-devoluo)
    - [Consultar uma devolução de pix](#consultar-devoluo)
- [Webhooks](#webhooks)
    - [Configurar o webhook pix](#configurar-o-webhook-pix)
    - [Exibir informações sobre o webhook pix](#exibir-informaes-sobre-o-webhook-pix)
    - [Cancelar o webhook pix](#cancelar-o-webhook-pix)
    - [Consutlar webhooks cadastrados](#consultar-webhooks-cadastrados)
- [Configurando endpoints](#configurando-endpoints)

Este pacote oferece integração completa com a API PIX do Banco Central do Brasil.

Instalação
==========

[](#instalação)

Você pode instalar este pacote utilizando o composer:

```
composer require andersonav/laravel-psp-pix
```

Agora, é necessário publicar os assets utilizados e o arquivo de configuração do pacote.

Publicando os assets
--------------------

[](#publicando-os-assets)

Para publicar os assets deste pacote para a pasta public do seu projeto, utilize o comando

```
php artisan vendor:publish --tag=laravel-psp-pix-assets
```

Publicando o arquivo de configuração
------------------------------------

[](#publicando-o-arquivo-de-configuração)

Para publicar o arquivo de configuração, execute o comando abaixo:

```
php artisan vendor:publish --tag=laravel-psp-pix-config
```

Este comando vai copiar o arquivo `laravel-psp-pix.php` para sua pasta config, com o seguinte conteúdo:

```