PHPackages                             mateusjunges/laravel-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. mateusjunges/laravel-pix

AbandonedArchivedLibrary[API Development](/categories/api)

mateusjunges/laravel-pix
========================

PIX integration with Laravel

v1.1.0(4y ago)966.7k28[3 issues](https://github.com/mateusjunges/laravel-pix/issues)MITPHPPHP ^7.4|^8.0

Since Jun 2Pushed 4y ago3 watchersCompare

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

READMEChangelog (2)Dependencies (5)Versions (3)Used By (0)

[![Readme banner](docs/banner.png)](docs/banner.png)

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)

[![Continuous Integration](https://github.com/mateusjunges/laravel-pix/actions/workflows/run-tests.yml/badge.svg?branch=master)](https://github.com/mateusjunges/laravel-pix/actions/workflows/run-tests.yml)[![StyleCI](https://camo.githubusercontent.com/8e172e418a6520788bdc7b9f9df62a2f995bd45927bcce28b18e757e480e7b4a/68747470733a2f2f7374796c6563692e696f2f7265706f732f3336343830393230362f736869656c643f7374796c653d666c6174)](https://styleci.io/repos/364809206)

- [Instalação](#instalao)
    - [Publicando os assets](#publicando-os-assets)
    - [Publicando o arquivo de configuração](#publicando-o-arquivo-de-configurao)
- [Endpoints](#endpoints)
- [Configurações iniciais](#configuraes-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-cobrana-imediata)
    - [Consultando uma cobrança imediata](#consultando-uma-cobrana-imediata)
    - [Criar cobranças imediatas sem `transactionId`](#criando-cobranas-imediatas-sem-transactionid)
    - [Consultando lista de cobranças imediatas](#consultando-lista-de-cobranas-imediatas)
- [CobV](#cobv)
    - [Criando uma cobrança com vencimento](#criando-cobranas-com-vencimento)
    - [Revisando cobranças com vencimento](#revisando-cobranas-com-vencimento)
    - [Consultando uma cobrança com vencimento](#consultar-uma-cobrana-com-vencimento)
    - [Consultar lista de cobranças com vencimento](#consultar-lista-de-cobranas-com-vencimento)
- [LoteCobV](#lotecobv)
    - [Criando cobranças com vencimento em lote](#criando-cobrana-com-vencimento-em-lote)
    - [Revisando lotes de cobranças com vencimento](#revisar-lotes-de-cobranas-com-vencimento)
    - [Consultar lote de cobrança com vecimento](#consultar-um-lote-de-cobranas-com-vencimento)
    - [Consultar lista de lotes de cobrança com vencimento](#consultar-lista-de-cobranas-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-cobrana-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 mateusjunges/laravel-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-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-pix-config
```

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

```