Download the PHP package andreoneres/pagarme-php without Composer
On this page you can find all versions of the php package andreoneres/pagarme-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download andreoneres/pagarme-php
More information about andreoneres/pagarme-php
Files in andreoneres/pagarme-php
Package pagarme-php
Short Description Pagar.Me PHP Library
License MIT
Homepage http://pagar.me
Informations about the package pagarme-php
Introdução
Essa SDK foi construída com o intuito de torná-la flexível, de forma que todos possam utilizar todas as features, de todas as versões de API.
Você pode acessar a documentação oficial da PagarMe - v5 acessando esse link.
Requisitos
- PHP versão 8.0 ou maior;
- Guzzle Http versão 7.4 ou maior.
Índice
- Introdução
- Requisitos
- Índice
- Instalação
- Configuração
- Definindo headers customizados
- Pedidos
- Criando um pedido
- Incluindo cobrança em pedido aberto
- Fechando um pedido
- Retornando pedidos
- Retornando um pedido
- Itens em pedidos abertos
- Incluindo item
- Atualizando item
- Retornando item
- Deletando item
- Removendo todos os itens
- Cobranças
- Capturando cobrança
- Editando cartão de cobrança
- Editando data de vencimento da cobrança
- Editando método de pagamento da cobrança
- Retornando todas as cobranças
- Retornando uma cobrança
- Confirmando uma cobrança (cash)
- Retentando uma cobrança manualmente
- Cancelando uma cobrança
- Cartões
- Criando um cartão
- Atualizando um cartão
- Retornando cartões
- Retornando um cartão
- Deletando um cartão
- Clientes
- Criando um cliente
- Atualizando um cliente
- Retornando clientes
- Retornando um cliente
- Endereços do cliente
- Criando um endereço
- Atualizando um endereço
- Retornando endereços
- Retornando um endereço
- Deletando um endereço
- Tratando exceções
- Testes
Instalação
Instale a biblioteca utilizando o comando
composer require andreoneres/pagarme-php
Configuração
Para incluir a biblioteca em seu projeto, basta fazer o seguinte:
Definindo headers customizados
- Se necessário for é possível definir headers http customizados para os requests. Para isso basta informá-los durante
a instanciação do objeto
Client
:
E então, você poderá utilizar o cliente para fazer requisições ao Pagar.me, como nos exemplos abaixo.
Pedidos
Nesta seção será explicado como realizar e manipular pedidos no Pagar.me com essa biblioteca.
Criando um pedido
Incluindo cobrança em pedido aberto
Fechando um pedido
Retornando pedidos
Se preferir, é possível utilizar parâmetros para filtrar essa busca, por exemplo, se quiser filtrar apenas pedidos pagas, você pode utilizar o código abaixo:
Retornando um pedido
Itens em pedidos abertos
Com a criação de um pedido aberto, é possível que os itens sejam gerenciados.
Incluindo item
Atualizando item
Retornando item
Deletando item
Removendo todos os itens
Cobranças
A cobrança é sempre a base de um pagamento. Desta forma, ela pode ser gerada por pedidos e assinaturas.
Capturando cobrança
Editando cartão de cobrança
Editando data de vencimento da cobrança
Editando método de pagamento da cobrança
Retornando todas as cobranças
Se preferir, é possível utilizar parâmetros para filtrar essa busca, por exemplo, se quiser filtrar apenas cobranças pagas, você pode utilizar o código abaixo:
Retornando uma cobrança
Confirmando uma cobrança (cash)
Retentando uma cobrança manualmente
Cancelando uma cobrança
Cartões
Sempre que você faz uma requisição através da nossa API, nós guardamos as informações do portador do cartão, para que, futuramente, você possa utilizá-las em novas cobranças, ou até mesmo implementar features como one-click-buy.
Criando um cartão
Atualizando um cartão
Retornando cartões
Retornando um cartão
Deletando um cartão
Clientes
Clientes representam os usuários de sua loja, ou negócio. Este objeto contém informações sobre eles, como nome, e-mail e telefone, além de outros campos.
Criando um cliente
Atualizando um cliente
Retornando clientes
Retornando um cliente
Endereços do cliente
Seu cliente pode ter um ou vários endereços cadastrados, sendo assim, você poderá manipulá-los através desta seção.
Criando um endereço
Atualizando um endereço
Retornando endereços
Retornando um endereço
Deletando um endereço
Tratando exceções
Caso a API retorne um erro, a biblioteca irá lançar uma exceção do tipo PagarMe\Exceptions\PagarMeException
.
Para capturar esta exceção, você deve utilizar o bloco try/catch
e tratar o erro da forma que desejar.
Exemplo:
Testes
Neste projeto é utilizado o PHPUnit para a implementação de testes automatizados. Para rodá-los, execute o seguinte comando: