PHPackages                             paymee/paymee-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. [Payment Processing](/categories/payments)
4. /
5. paymee/paymee-php

ActiveLibrary[Payment Processing](/categories/payments)

paymee/paymee-php
=================

SDK Paymee for PHP

1416↓50%PHP

Since Jul 22Pushed 4y ago3 watchersCompare

[ Source](https://github.com/paymeebrasil/sdk-php)[ Packagist](https://packagist.org/packages/paymee/paymee-php)[ RSS](/packages/paymee-paymee-php/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

PayMee PHP SDK
==============

[](#paymee-php-sdk)

Description
-----------

[](#description)

The Paymee library in PHP is a set of domain classes that facilitate, for the PHP developer, the use of the functionalities that Paymee offers in the form of APIs. With the library installed and configured, you can easily integrate functionality of our API

\##Requirements

- [PHP 5.6+](https://www.php.net)
- [Composer](https://getcomposer.org/)
- [cURL](https://www.php.net/manual/en/book.curl.php)

Installation
------------

[](#installation)

> Note: We recommend installing by \*\* Composer \*\*. You can also download the repository or clone via Git. To download and install Composer visit:

#### Install by Composer

[](#install-by-composer)

Its possible install via Composer by two ways:

- Executing by composer require (recommended) ```
    php composer.phar require paymee/paymee-php

    ```

**Or**

- Creating dependence on file `composer.json````
    {
        "require": {
           "paymee/paymee-php" : "^1.0"
        }
    }
    ```

### Manual Installation

[](#manual-installation)

- Download or clone this repository;
- Decompress files on your project;
- Execute `php composer.phar install` on paymee SDK project folder.

### Environment Configuration

[](#environment-configuration)

Choose your credentials like `API_KEY` and `API_TOKEN` on file `Environment.php`:

```
    const X_API_KEY     = "305148c0-fa9f-3898-8866-8604e7f2ab55";
    const X_API_TOKEN   = "2db5812c-ea29-3c11-bc2a-23a3b60544ea";
```

Change `IS_SANDBOX` true or false to enable sandbox mode:

```
    const IS_SANDBOX = true;
```

### Usage

[](#usage)

#### Create Shopper

[](#create-shopper)

```
$shopper = new Shopper();
$shopper->setId(1);
$shopper->setName("Fulano de tal");
$shopper->setEmail("fulano@gmail.com");
$shopper->setDocType("CPF"); //CPF or CPNJ
$shopper->setDocNumber("793.557.390-52");
$shopper->setPhoneType("MOBILE");
$shopper->setPhoneNumber("41987042218");
```

#### Create Payment Data

[](#create-payment-data)

```
$paymentData = new PaymentData();
$paymentData->setCurrency("BRL");
$paymentData->setAmount("99.00");
$paymentData->setReferenceCode("10000098");
$paymentData->setMaxAge(2880);
$paymentData->setPaymentMethod("PIX");
$paymentData->setCallbackURL("https://yourstore.com/foo/bar");
$paymentData->setShopper($shopper);
```

#### Create Pix Checkout

[](#create-pix-checkout)

```
$payment = new Payment();
$responsePix = $payment->createPix($paymentData);
```

### Examples

[](#examples)

> All examples are available on examples folder

To test creation pix:

```
php examples/checkout-pix.php
```

To test creation transfer:

```
php examples/checkout-transfer.php
```

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity29

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/e0ae6443cf5b16ae2599f2511eb223ca4c0601ba743e999bbadcb5776d52f5f6?d=identicon)[jrmaia](/maintainers/jrmaia)

---

Top Contributors

[![jrmaia](https://avatars.githubusercontent.com/u/19672685?v=4)](https://github.com/jrmaia "jrmaia (10 commits)")

### Embed Badge

![Health badge](/badges/paymee-paymee-php/health.svg)

```
[![Health](https://phpackages.com/badges/paymee-paymee-php/health.svg)](https://phpackages.com/packages/paymee-paymee-php)
```

###  Alternatives

[omnipay/paypal

PayPal gateway for Omnipay payment processing library

3156.8M53](/packages/omnipay-paypal)[eduardokum/laravel-boleto

Biblioteca com boletos para o laravel

626351.9k2](/packages/eduardokum-laravel-boleto)[tbbc/money-bundle

This is a Symfony bundle that integrates moneyphp/money library (Fowler pattern): https://github.com/moneyphp/money.

1961.9M](/packages/tbbc-money-bundle)[2checkout/2checkout-php

2Checkout PHP Library

83740.3k2](/packages/2checkout-2checkout-php)[smhg/sepa-qr-data

Generate QR code data for SEPA payments

61717.2k5](/packages/smhg-sepa-qr-data)[omnipay/dummy

Dummy driver for the Omnipay payment processing library

271.2M33](/packages/omnipay-dummy)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)