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

ActiveLib[API Development](/categories/api)

fhferreira/pagarme-php
======================

Pagar.Me PHP Library

4.1.2(1y ago)02.4kMITPHPPHP &gt;=5.6.0

Since Sep 17Pushed 1y ago1 watchersCompare

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

READMEChangelog (1)Dependencies (3)Versions (5)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 do Pagar.me acessando esse [link](https://docs.pagar.me).

Índice
------

[](#índice)

- [Instalação](#instala%C3%A7%C3%A3o)
- [Configuração](#configura%C3%A7%C3%A3o)
- [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)
- [Chargebacks](#chargebacks)
- [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)
- [Links de pagamento](#links-de-pagamento)
    - [Criando um link de pagamento](#criando-um-link-de-pagamento)
    - [Retornando links de pagamento](#retornando-links-de-pagamento)
    - [Retornando um link de pagamento](#retornando-um-link-de-pagamento)
    - [Cancelando um link de pagamento](#cancelando-um-link-de-pagamento)
- [Buscas avançadas (Elasticsearch)](#buscas-avan%C3%A7adas-elasticsearch)
    - [Realizando uma busca](#realizando-uma-busca)

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

[](#instalação)

Instale a biblioteca utilizando o comando

`composer require fhferreira/pagarme-php`

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

[](#configuração)

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

```
