PHPackages                             canislupus/api-client-pagseguro - 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. canislupus/api-client-pagseguro

ActiveLibrary[API Development](/categories/api)

canislupus/api-client-pagseguro
===============================

Client for PagSeguro API

0.4.0(2y ago)014MITPHPPHP ^8.1

Since Oct 16Pushed 2y ago1 watchersCompare

[ Source](https://github.com/canis-lupus-solutions/t06-api-client-pagseguro)[ Packagist](https://packagist.org/packages/canislupus/api-client-pagseguro)[ Docs](https://canislupus.com.br)[ RSS](/packages/canislupus-api-client-pagseguro/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (1)Versions (6)Used By (0)

API CLIENT - PAG-SEGURO
=======================

[](#api-client---pag-seguro)

Cliente para integração com a API do sistema PagSeguro. [Conheça o PagSeguro](https://pagseguro.uol.com.br)

Este cliente se refere à mais recente API do PagSeguro, que está documentada em

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

[](#instalação)

### Composer

[](#composer)

```
composer require canislupus/api-client-pagseguro

```

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

[](#utilização)

```
use CanisLupus\ApiClients\PagSeguro\v1\PagSeguroApiClient;
use CanisLupus\ApiClients\PagSeguro\v1\Enums\EnvironmentEnum;
use CanisLupus\ApiClients\PagSeguro\v1\PagSeguroApiConfig;
use CanisLupus\ApiClients\PagSeguro\v1\Exceptions\PagSeguroApiException;

// Inicialize o cliente passando um objeto de configuração
$clientPagSeguro = new PagSeguroApiClient(
    new PagSeguroApiConfig(EnvironmentEnum::Sandbox, '#SEU-TOKEN-PAGSEGURO#')
);

// Use o cliente
try {
    // Por exemplo, para criar uma chave-pública
    $newPublicKey = $clientPagSeguro->publicKeys->create();

    // Para criar um pedido (veja nos exemplos abaixo como passar os $dadosPedido)
    $newOrder = $clientPagSeguro->orders->create($dadosPedido);

} catch (PagSeguroApiException $e) {
    die($e->getMessage());
}
```

### Pode-se criar um pedido passando um objeto OrderResource construído

[](#pode-se-criar-um-pedido-passando-um-objeto-orderresource-construído)

```
$orderResource = new OrderResource();
$orderResource->setReferenceId('ex-00001');
$orderResource->setCustomer(new CustomerResource(
    'Jose da Silva',
    'c96827089160215759351@sandbox.pagseguro.com.br',
    '12345678909'
));
$orderResource->setItems([
    new ItemResource('item-id-001', 'Item 01', 2, 4500), // 4500 é o valor referente à R$ 45,00
    new ItemResource('item-id-002', 'Item 02', 1, 6599) // 6599 é o valor referente à R$ 65,99
]);
$orderResource->setNotificationUrls(['https://meusite.com/notificacoes1']);
$orderResource->setCharges([
    (new ChargeResource())
        ->setReferenceId('charge-id-001')
        ->setDescription('descricao da cobranca')
        ->setAmount(new AmountResource(15599, 'BRL')) // 15599 é o valor referente à R$ 155,99
        ->setPaymentMethod(
            (new PaymentMethodResource(PaymentMethodEnum::CREDIT_CARD))
                ->setInstallments(1)
                ->setCard(
                    (new CardResource())
                        ->setHolder(new HolderResource("Jose da Silva"))
                        // Pode passar diretamente os dados do cartão
                        ->setNumber('4242424242424242')->setExpMonth('12')->setExpYear('2032')
                        // Ou pode passar o cartão criptografado pelo javascript do PagSeguro
                        // ->setEncrypted($encryptedCard)
                )
        )
]);

$newOrder = $clientPagSeguro->orders->create($orderResource);
```

### Ou pode-se criar um pedido passando diretamente o array da estrutura requerida

[](#ou-pode-se-criar-um-pedido-passando-diretamente-o-array-da-estrutura-requerida)

```
$newOrder = $clientPagSeguro->orders->create([
    'reference_id' => 'ex-00001',
    'customer' => [
        'name' => 'Jose da Silva',
        'email' => 'c96827089160215759351@sandbox.pagseguro.com.br',
        'tax_id' => '12345678909',
    ],
    'items' => [
        [
            'reference_id' => 'item-id-001',
            'name' => 'Item 01',
            'quantity' => '1',
            'unit_amount' => '15599', // Significa R$ 155,99
        ]
    ],
    'notification_urls' => ['https://meusite.com/notificacoes'],
    'charges' => [
        [
            'reference_id' => 'charge-id-001',
            'description' => 'descricao da cobranca',
            'amount' => [
                'value' => '15599', // Significa R$ 155,99
                'currency' => 'BRL',
            ],
            'payment_method' => [
                'type' => 'CREDIT_CARD',
                'installments' => '1',
                'capture' => true,
                'card' => [
                    'holder' => [
                        'name' => "Jose da Silva",
                    ],
                    'store' => false,

                    // Pode passar diretamente os dados do cartão
                    'number' => '4242424242424242',
                    'exp_month' => '12',
                    'exp_year' => '2032',

                     // Ou pode passar o cartão criptografado pelo javascript do PagSeguro
                     //'encrypted' => $encryptedCard,
                ],
            ]
        ]
    ],
]);
```

Mais exemplos
-------------

[](#mais-exemplos)

Mais exemplos podem ser encontrados na pasta docs/examples

Abrangência
-----------

[](#abrangência)

 Total de Endpoints 35 Total de Endpoints abrangidos 6 Percentual abrangido 17,14%### Lista de API's

[](#lista-de-apis)

**Grupo****Recurso****Situação**Chaves Públicas\[POST\] Criar chave pública100%Chaves Públicas\[GET\] Consultar chave pública100%Chaves Públicas\[PUT\] Alterar chave pública0%Connect\[POST\] Criar aplicação0%Connect\[GET\] Consultar aplicação0%Connect\[POST\] Solicitar autorização via SMS0%Connect\[POST\] Obter access token0%Connect\[POST\] Obter access token para transferência0%Connect\[POST\] Renovar access token0%Connect\[POST\] Revogar access token0%Certificado Digital\[POST\] Criar certificado digital0%Cadastro\[POST\] Criar conta0%Cadastro\[GET\] Consultar conta0%Pedidos &amp; Pagamentos (Order)\[POST\] Criar pedido100%Pedidos &amp; Pagamentos (Order)\[GET\] Consultar pedido100%Pedidos &amp; Pagamentos (Order)\[GET\] Consultar pedido através de parâmetros0%Pedidos &amp; Pagamentos (Order)\[POST\] Pagar pedido0%Pedidos &amp; Pagamentos (Order)\[GET\] Consultar pagamento100%Pedidos &amp; Pagamentos (Order)\[POST\] Capturar pagamento0%Pedidos &amp; Pagamentos (Order)\[POST\] Cancelar pagamento0%Pedidos &amp; Pagamentos (Order)\[POST\] Criar sessão de autenticação 3DS0%Pedidos &amp; Pagamentos (Order)\[GET\] Consultar juros de uma transação100%Pedidos &amp; Pagamentos (Order)\[POST\] Validar e armazenar um cartão no PagBank0%Pedidos com Divisão do Pagamento\[POST\] Criar um pedido com divisão do pagamento0%Pedidos com Divisão do Pagamento\[GET\] Consultar um pedido com divisão do pagamento0%Pedidos com Divisão do Pagamento\[GET\] Consultar dados da divisão do pagamento0%Pedidos com Divisão do Pagamento\[POST\] Cancelar um pedido com divisão do pagamento0%Transferência\[POST\] Criar transferência0%Transferência\[GET\] Consultar transferência pelo código da transação0%Transferência\[GET\] Consultar transferência pelo ID do cliente ou período0%Transferência\[GET\] Consultar transferência pelo ID0%Checkout PagBank\[POST\] Criar um Checkout0%Checkout PagBank\[GET\] Consultar um Checkout0%Checkout PagBank\[POST\] Ativar um Checkout0%Checkout PagBank\[POST\] Inativar um Checkout0%Licença
-------

[](#licença)

- MIT License

###  Health Score

21

—

LowBetter than 19% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 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.

###  Release Activity

Cadence

Every ~0 days

Total

5

Last Release

933d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c7e3014c18984d7f01f222a345c0df77a0725278f639c80909aa6e4febb525f0?d=identicon)[leoaguiarpereira@gmail.com](/maintainers/leoaguiarpereira@gmail.com)

---

Top Contributors

[![leoap](https://avatars.githubusercontent.com/u/2475774?v=4)](https://github.com/leoap "leoap (7 commits)")

---

Tags

apiclientpaymentsecommercePagsegurocanis lupus

### Embed Badge

![Health badge](/badges/canislupus-api-client-pagseguro/health.svg)

```
[![Health](https://phpackages.com/badges/canislupus-api-client-pagseguro/health.svg)](https://phpackages.com/packages/canislupus-api-client-pagseguro)
```

###  Alternatives

[openai-php/laravel

OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API

3.7k7.6M74](/packages/openai-php-laravel)[resend/resend-php

Resend PHP library.

564.7M21](/packages/resend-resend-php)[crowdin/crowdin-api-client

PHP client library for Crowdin API v2

611.5M5](/packages/crowdin-crowdin-api-client)[mozex/anthropic-laravel

Anthropic PHP for Laravel is a supercharged PHP API client that allows you to interact with the Anthropic API

71226.4k1](/packages/mozex-anthropic-laravel)[culqi/culqi-php

Cliente Culqi API para PHP

41356.8k1](/packages/culqi-culqi-php)[markrogoyski/numverify-api-client-php

Numverify API Client for PHP

1220.9k](/packages/markrogoyski-numverify-api-client-php)

PHPackages © 2026

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