PHPackages                             andreoneres/pagarme-php - 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. andreoneres/pagarme-php

ActiveLibrary[API Development](/categories/api)

andreoneres/pagarme-php
=======================

v5.0.0(3y ago)4888↓50%3MITPHP >=8.0

Since May 14Pushed 3y agoCompare

[ Source](https://github.com/andreoneres/pagarme-php)[ Packagist](https://packagist.org/packages/andreoneres/pagarme-php)[ Docs](http://pagar.me)[ RSS](/packages/andreoneres-pagarme-php/feed)WikiDiscussions V5 Synced 1mo ago

READMEChangelog (1)Dependencies (3)Versions (67)Used By (0)

Introdução
----------

[](#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](https://docs.pagar.me/v5/docs).

Requisitos
----------

[](#requisitos)

- PHP versão 8.0 ou maior;
- Guzzle Http versão 7.4 ou maior.

Índice
------

[](#índice)

- [Introdução](#introdu%C3%A7%C3%A3o)
- [Requisitos](#requisitos)
- [Índice](#%C3%ADndice)
- [Instalação](#instala%C3%A7%C3%A3o)
- [Configuração](#configura%C3%A7%C3%A3o)
    - [Definindo headers customizados](#definindo-headers-customizados)
- [Pedidos](#pedidos)
    - [Criando um pedido](#criando-um-pedido)
    - [Incluindo cobrança em pedido aberto](#incluindo-cobran%C3%A7a-em-pedido-aberto)
    - [Fechando um pedido](#fechando-um-pedido)
    - [Retornando pedidos](#retornando-pedidos)
    - [Retornando um pedido](#retornando-um-pedido)
- [Itens em pedidos abertos](#itens-em-pedidos-abertos)
    - [Incluindo item](#incluindo-item)
    - [Atualizando item](#atualizando-item)
    - [Retornando item](#retornando-item)
    - [Deletando item](#deletando-item)
    - [Removendo todos os itens](#removendo-todos-os-itens)
- [Cobranças](#cobran%C3%A7as)
    - [Capturando cobrança](#capturando-cobran%C3%A7a)
    - [Editando cartão de cobrança](#editando-cart%C3%A3o-de-cobran%C3%A7a)
    - [Editando data de vencimento da cobrança](#editando-data-de-vencimento-da-cobran%C3%A7a)
    - [Editando método de pagamento da cobrança](#editando-m%C3%A9todo-de-pagamento-da-cobran%C3%A7a)
    - [Retornando todas as cobranças](#retornando-todas-as-cobran%C3%A7as)
    - [Retornando uma cobrança](#retornando-uma-cobran%C3%A7a)
    - [Confirmando uma cobrança (cash)](#confirmando-uma-cobran%C3%A7a-cash)
    - [Retentando uma cobrança manualmente](#retentando-uma-cobran%C3%A7a-manualmente)
    - [Cancelando uma cobrança](#cancelando-uma-cobran%C3%A7a)
- [Cartões](#cart%C3%B5es)
    - [Criando um cartão](#criando-um-cart%C3%A3o)
    - [Atualizando um cartão](#atualizando-um-cart%C3%A3o)
    - [Retornando cartões](#retornando-cart%C3%B5es)
    - [Retornando um cartão](#retornando-um-cart%C3%A3o)
    - [Deletando um cartão](#deletando-um-cart%C3%A3o)
- [Clientes](#clientes)
    - [Criando um cliente](#criando-um-cliente)
    - [Atualizando um cliente](#atualizando-um-cliente)
    - [Retornando clientes](#retornando-clientes)
    - [Retornando um cliente](#retornando-um-cliente)
- [Endereços do cliente](#endere%C3%A7os-do-cliente)
    - [Criando um endereço](#criando-um-endere%C3%A7o)
    - [Atualizando um endereço](#atualizando-um-endere%C3%A7o)
    - [Retornando endereços](#retornando-endere%C3%A7os)
    - [Retornando um endereço](#retornando-um-endere%C3%A7o)
    - [Deletando um endereço](#deletando-um-endere%C3%A7o)
- [Tratando exceções](#tratando-exce%C3%A7%C3%B5es)
- [Testes](#testes)

Instalação
----------

[](#instalação)

Instale a biblioteca utilizando o comando

`composer require andreoneres/pagarme-php`

Configuração
------------

[](#configuração)

Para incluir a biblioteca em seu projeto, basta fazer o seguinte:

```