PHPackages                             paggi/sdk-ecommerce - 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. paggi/sdk-ecommerce

ActiveLibrary[API Development](/categories/api)

paggi/sdk-ecommerce
===================

Paggi PHP SDK - Ecommerce

V2.1.4(7y ago)12024MITPHPCI failing

Since Oct 25Pushed 5y ago4 watchersCompare

[ Source](https://github.com/paggi-com/sdk-php-ecommerce)[ Packagist](https://packagist.org/packages/paggi/sdk-ecommerce)[ Docs](https://docs.paggi.com)[ RSS](/packages/paggi-sdk-ecommerce/feed)WikiDiscussions master Synced today

READMEChangelog (8)Dependencies (6)Versions (10)Used By (0)

Paggi PHP SDK - Ecommerce
=========================

[](#paggi-php-sdk---ecommerce)

Utilize este SDK para realizar a integração com nossa API de ecommerce.

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

[](#instalação)

```
composer require paggi/sdk-ecommerce
```

Configuração de Ambiente
------------------------

[](#configuração-de-ambiente)

```
require "vendor/autoload.php"
use Paggi\SDK;
$envConfiguration = new \Paggi\SDK\EnvironmentConfiguration();
$envConfiguration->setEnv("Staging"); // Staging or Production
$envConfiguration->setToken(getenv("TOKEN"));
$envConfiguration->setPartnerIdByToken(getenv("TOKEN"));
```

Utilização
----------

[](#utilização)

### Cartões:

[](#cartões)

```
$target = new \Paggi\SDK\Card();

> Criar cartão:

$params = [
    "cvc" => "123",
    "year" => "2022",
    "number" => "4123200700046446",
    "month" => "09",
    "holder" => "BRUCE WAYNER",
    "document" => "12312312312"
];

$response = $target->create($params);

> Consultar cartão por cliente:

$params = [
    "document" => "12312312312"
];

$response = $target->find($params);

> Desativar cartão:

$response = $target->delete($card_id);
```

### Pedidos

[](#pedidos)

```
$target = new \Paggi\SDK\Order();

> Criar Pagamento

$params =
[
    "external_identifier" => "ABC123",
    "ip" => "8.8.8.8",
    "charges" => [
        "amount" => 5000,
        "installments" => 10,
            "card" => [
                "number" => "5573710095684403",
                "cvc" => "123",
                "holder" => "BRUCE WAYNE",
                "year" => "2020",
                "month" => "04",
                "document" => "16123541090"
            ]
        ];,
    "customer" => [
        "name" => "Bruce Wayne",
        "document" => "86219425006",
        "email" => "bruce@waynecorp.com"
    ]
];

$response = $target->create($params);

> Cancelar Pagamento

$response = $target->cancel($order_id);
```

### Recebedores

[](#recebedores)

O campo `account_type` pode ser:

- CONTA\_CORRENTE
- CONTA\_POUPANCA
- CONTA\_FACIL
- ENTIDADE\_PUBLICA

```
$target = new \Paggi\SDK\Recipient();

> Criar Recebedor:

$params = [
    "name" => "BRUCE WAYNER",
    "document" => "78945612389",
    "bank_account" => [
        "bank_code" => "077",
        "branch_number" => "0001",
        "branch_digit" => "5",
        "account_number" => "120003",
        "account_digit" => "4",
        "account_holder_name" => "BRUCE WAYNE"
        "account_type" => "CONTA_CORRENTE"
  ],
];

$response = $target->create($params);

> Buscar recebedor:

$reponse = $target->find();

> Atualizar Recebedor:

$params = [
    "name" => "BRUCE WAYNER",
    "document" => "78945612389",
    "bank_account" => [
        "bank_code" => "077",
        "branch_number" => "0123",
        "branch_digit" => "4",
        "account_number" => "330233",
        "account_digit" => "7",
        "account_holder_name" => "BRUCE WAYNE"
        "account_type" => "CONTA_CORRENTE"
  ],
];

$response = $target->update($params, $recipient_id);
```

### Bancos

[](#bancos)

```
$target = new \Paggi\SDK\Bank();

$response = $target->find(["start"=>0, "count"=>20]);
```

### Planos / Assinaturas

[](#planos--assinaturas)

Para criar uma assinatura é necessário um plano existente. O Plano controla o valor, intervalo entre pagamentos, duração, período de teste da assinatura. A Assinatura é responsável pelo pagamento, assim como desconto e preços adicionais se necessário.

```
$plan = new \Paggi\SDK\Plan();
$subscription = new \Paggi\SDK\Subscription();

> Criar Plano:

$params = [
    "name" => "Meu primeiro plano",
    "price" => 1990,
    "interval" => "1m",
    "trial_period" => "2d",
    "external_identifier" => "12345",
    "description"=> "Teste"
];

$response = $plan->create($params);

> Criar Assinatura:

$params = [
    "external_identifier" => "Seu ID de assinatura",
    "plan_id" => plan["id"],
    "ip" => "8.8.8.8",
    "customer" => [
        "name" => "Bruce Wayne",
        "document" => "86219425006",
        "email" => "bruce@waynecorp.com"
   ],
    "card" => [
        "cvc" => "123",
         "year" => "2020",
        "month" => "01",
          "number" => "4485200700046446",
        "holder" => "BRUCE WAYNER",
        "document" => "16223541090"
   ],
    "discount" => [
            "period" => 2,
            "description" => "Teste de discount",
         "  amount" => 2000
   ],
    "additional" => [
            "period" => 3,
            "description" => "Teste de additional",
            "amount" => 1999
        ]
]

$response = $subscription->find($params);

> Consultar plano:

$params = [
    "plan_id" => "7f42a0a0-6ae8-4a57-a340-a8c4867771eb"
]

$response = $plan->find($params);

> Atualizar plano:

$params = [
    "price" => 2990,
    "interval" => "3m"
]

$response = $plan->update($params, $plan_id);

> Cancelar plano:

$plan_id = "7f42a0a0-6ae8-4a57-a340-a8c4867771eb"

$response = $plan->delete($plan_id);
```

### Mais informações

[](#mais-informações)

Para mais informação, você pode conferir nossa documentação [aqui](https://developers.paggi.com/).

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 62.5% 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.

###  Release Activity

Cadence

Every ~13 days

Total

8

Last Release

2659d ago

Major Versions

V1.0.5 → V2.0.02018-12-10

### Community

Maintainers

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

![](https://www.gravatar.com/avatar/0f4d7ca7f2d5e8b48c04c740ac86092fd1259544edce692953b76847a59aacee?d=identicon)[thiagohdeplima](/maintainers/thiagohdeplima)

![](https://www.gravatar.com/avatar/81eb2da9270a46707f80e1be2e4912790e570793f3b5fc56071665c403803e07?d=identicon)[joaoanastacio](/maintainers/joaoanastacio)

---

Top Contributors

[![PauloDanielCarneiro](https://avatars.githubusercontent.com/u/15021651?v=4)](https://github.com/PauloDanielCarneiro "PauloDanielCarneiro (15 commits)")[![peguera-eu](https://avatars.githubusercontent.com/u/9318501?v=4)](https://github.com/peguera-eu "peguera-eu (4 commits)")[![joaoanastacio](https://avatars.githubusercontent.com/u/30802337?v=4)](https://github.com/joaoanastacio "joaoanastacio (2 commits)")[![aleDsz](https://avatars.githubusercontent.com/u/6402997?v=4)](https://github.com/aleDsz "aleDsz (1 commits)")[![d-fouto](https://avatars.githubusercontent.com/u/59567647?v=4)](https://github.com/d-fouto "d-fouto (1 commits)")[![rollergui](https://avatars.githubusercontent.com/u/24300308?v=4)](https://github.com/rollergui "rollergui (1 commits)")

---

Tags

ecommercephpsdkpaymentspagamentospayments brazilpagamento brasilpaggi.compaggi

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/paggi-sdk-ecommerce/health.svg)

```
[![Health](https://phpackages.com/badges/paggi-sdk-ecommerce/health.svg)](https://phpackages.com/packages/paggi-sdk-ecommerce)
```

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M650](/packages/sylius-sylius)[pagarme/pagarme-php

271.5M10](/packages/pagarme-pagarme-php)[transbank/transbank-sdk

Transbank SDK

62626.4k12](/packages/transbank-transbank-sdk)[fschmtt/keycloak-rest-api-client-php

PHP client to interact with Keycloak's Admin REST API.

4684.7k2](/packages/fschmtt-keycloak-rest-api-client-php)[invoiced/invoiced

Invoiced PHP Library

14117.1k](/packages/invoiced-invoiced)

PHPackages © 2026

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