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

ActiveLibrary[API Development](/categories/api)

eaglesistemas/pagarme-php
=========================

v4.0.4(6y ago)012.6k↓100%1MITPHPPHP &gt;=5.6.0

Since May 14Pushed 5y agoCompare

[ Source](https://github.com/EagleSistemas/pagarme-php)[ Packagist](https://packagist.org/packages/eaglesistemas/pagarme-php)[ Docs](http://pagar.me)[ RSS](/packages/eaglesistemas-pagarme-php/feed)WikiDiscussions V3 Synced today

READMEChangelogDependencies (3)Versions (56)Used By (0)

Pagar.me PHP SDK
================

[](#pagarme-php-sdk)

[![](https://avatars1.githubusercontent.com/u/3846050?s=200&v=4)](https://avatars1.githubusercontent.com/u/3846050?s=200&v=4)

Integração em PHP para a [Pagar.me API](https://docs.pagar.me/)

[![SensioLabsInsight](https://camo.githubusercontent.com/c21ed309602c21bd666de1f63aa110e98fc3ae8700599810161787051598f896/68747470733a2f2f696e73696768742e73656e73696f6c6162732e636f6d2f70726f6a656374732f34633334636331332d653532662d343932652d613266322d6462636433393831333561322f6d696e692e706e67)](https://insight.sensiolabs.com/projects/4c34cc13-e52f-492e-a2f2-dbcd398135a2)[![Coverage Status](https://camo.githubusercontent.com/e4d37b47f94de984d24e8c552bcad7f1d7c62a33095705d798c8db93d4b21fa9/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f70616761726d652f70616761726d652d7068702f62616467652e7376673f6272616e63683d5633)](https://coveralls.io/github/pagarme/pagarme-php?branch=V3)

Índice
======

[](#índice)

- [Instalação e configuração](#Instala%C3%A7%C3%A3o-e-configura%C3%A7%C3%A3o)
- [Utilizando a SDK](#Utilizando-a-SDK)
    - [Parâmetros page e count](#Par%C3%A2metros-page-e-count)
    - [Transações](#Transa%C3%A7%C3%B5es)
        - [Criando uma transação](#Criando-uma-transa%C3%A7%C3%A3o)
        - [Capturando uma transação](#Capturando-uma-transa%C3%A7%C3%A3o)
        - [Estornando uma transação](#Estornando-uma-transa%C3%A7%C3%A3o)
            - [Estornando uma transação parcialmente](#Estornando-uma-transa%C3%A7%C3%A3o-parcialmente)
            - [Estornando uma transação com split](#Estornando-uma-transa%C3%A7%C3%A3o-com-split)
        - [Retornando transações](#Retornando-transa%C3%A7%C3%B5es)
        - [Retornando uma transação](#Retornando-uma-transa%C3%A7%C3%A3o)
        - [Retornando recebíveis de uma transação](#Retornando-receb%C3%ADveis-de-uma-transa%C3%A7%C3%A3o)
        - [Retornando um recebível de uma transação](#Retornando-um-receb%C3%ADvel-de-uma-transa%C3%A7%C3%A3o)
        - [Retornando o histórico de operações de uma transação](#Retornando-o-hist%C3%B3rico-de-opera%C3%A7%C3%B5es-de-uma-transa%C3%A7%C3%A3o)
        - [Notificando cliente sobre boleto a ser pago](#Notificando-cliente-sobre-boleto-a-ser-pago)
        - [Retornando eventos de uma transação](#Retornando-eventos-de-uma-transa%C3%A7%C3%A3o)
        - [Calculando Pagamentos Parcelados](#Calculando-pagamentos-parcelados)
        - [Testando pagamento de boletos](#Testando-pagamento-de-boletos)
    - [Estornos](#Estornos)
    - [Cartões](#Cart%C3%B5es)
        - [Criando cartões](#Criando-cart%C3%B5es)
        - [Retornando cartões](#Retornando-cart%C3%B5es)
        - [Retornando um cartão](#Retornando-um-cart%C3%A3o)
    - [Planos](#Planos)
        - [Criando planos](#Criando-planos)
        - [Retornando planos](#Retornando-planos)
        - [Retornando um plano](#Retornando-um-plano)
        - [Atualizando um plano](#Atualizando-um-plano)
    - [Assinaturas](#Assinaturas)
        - [Criando assinaturas](#Criando-assinaturas)
        - [Split com assinatura](#Split-com-assinatura)
        - [Retornando uma assinatura](#Retornando-uma-assinatura)
        - [Retornando assinaturas](#Retornando-assinaturas)
        - [Atualizando uma assinatura](#Atualizando-uma-assinatura)
        - [Cancelando uma assinatura](#Cancelando-uma-assinatura)
        - [Transações de assinatura](#Transa%C3%A7%C3%B5es-de-assinatura)
        - [Pulando cobranças](#Pulando-cobran%C3%A7as)
    - [Postbacks](#Postbacks)
        - [Retornando postbacks](#Retornando-postbacks)
        - [Retornando um postback](#Retornando-um-postback)
        - [Reenviando um Postback](#Reenviando-um-postback)
    - [Saldo do recebedor principal](#Saldo-do-recebedor-principal)
    - [Operações de saldo](#Opera%C3%A7%C3%B5es-de-saldo)
        - [Histórico das operações](#Hist%C3%B3rico-das-opera%C3%A7%C3%B5es)
        - [Histórico de uma operação específica](#Hist%C3%B3rico-de-uma-opera%C3%A7%C3%A3o-espec%C3%ADfica)
    - [Recebível](#Receb%C3%ADvel)
        - [Retornando recebíveis](#Retornando-receb%C3%ADveis)
        - [Retornando um recebível](#Retornando-um-receb%C3%ADvel)
    - [Transferências](#Transfer%C3%AAncias)
        - [Criando uma transferência](#Criando-uma-transfer%C3%AAncia)
        - [Retornando transferências](#Retornando-transfer%C3%AAncias)
        - [Retornando uma transferência](#Retornando-uma-transfer%C3%AAncia)
        - [Cancelando uma transferência](#Cancelando-uma-transfer%C3%AAncia)
    - [Antecipações](#Antecipa%C3%A7%C3%B5es)
        - [Criando uma antecipação](#Criando-uma-antecipa%C3%A7%C3%A3o)
        - [Obtendo os limites de antecipação](#Obtendo-os-limites-de-antecipa%C3%A7%C3%A3o)
        - [Confirmando uma antecipação building](#Confirmando-uma-antecipa%C3%A7%C3%A3o-building)
        - [Cancelando uma antecipação pending](#Cancelando-uma-antecipa%C3%A7%C3%A3o-pending)
        - [Deletando uma antecipação building](#Deletando-uma-antecipa%C3%A7%C3%A3o-building)
        - [Retornando antecipações](#Retornando-antecipa%C3%A7%C3%B5es)
    - [Contas bancárias](#Contas-banc%C3%A1rias)
        - [Criando uma conta bancária](#Criando-uma-conta-banc%C3%A1ria)
        - [Retornando uma conta bancária](#Retornando-uma-conta-banc%C3%A1ria)
        - [Retornando contas bancárias](#Retornando-contas-banc%C3%A1rias)
    - [Recebedores](#Recebedores)
        - [Criando um recebedor](#Criando-um-recebedor)
        - [Retornando recebedores](#Retornando-recebedores)
        - [Retornando um recebedor](#Retornando-um-recebedor)
        - [Atualizando um recebedor](#Atualizando-um-recebedor)
        - [Saldo de um recebedor](#Saldo-de-um-recebedor)
        - [Operações de saldo de um recebedor](#Opera%C3%A7%C3%B5es-de-saldo-de-um-recebedor)
        - [Operação de saldo específica de um recebedor](#Opera%C3%A7%C3%A3o-de-saldo-espec%C3%ADfica-de-um-recebedor)
    - [Clientes](#Clientes)
        - [Criando um cliente](#Criando-um-cliente)
        - [Retornando clientes](#Retornando-clientes)
        - [Retornando um cliente](#Retornando-um-cliente)
- [Suporte](#Suporte)
- [Licença](#Licen%C3%A7a)
- [Contribuindo](#Contribuindo)

Instalação e configuração
=========================

[](#instalação-e-configuração)

Para utilizar a biblioteca, você pode instalá-la via composer, com o comando:

```
composer require 'pagarme/pagarme-php-v3.7.10'
```

Então, basta importá-la para dentro de seu arquivo e instanciar o objeto `PagarMe`:

```
require __DIR__.'/vendor/autoload.php';

$apiKey = 'ak_test_grXijQ4GicOa2BLGZrDRTR5qNQxJW0';
$pagarMe =  new \PagarMe\Sdk\PagarMe($apiKey);
```

Nota: todos os exemplos listados aqui utilizam o objeto `$pagarMe` instanciado acima.

Utilizando a SDK
================

[](#utilizando-a-sdk)

Parâmetros page e count
-----------------------

[](#parâmetros-page-e-count)

`$page` representa o número da página e `$count` representa a quantidade de registros. Então, se você utilizar, `$page = 2` e `$count = 20` para buscar um objeto, serão retornados os 20~40 objetos mais recentes

Transações
----------

[](#transações)

Nesta seção será explicado como utilizar transações no Pagar.me com essa biblioteca.

### Criando uma transação

[](#criando-uma-transação)

```
