Download the PHP package clubedev/pagbank-php without Composer

On this page you can find all versions of the php package clubedev/pagbank-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of clubedev/pagbank-php

Informations about the package pagbank-php

PagBank PHP SDK – API Pix, Boleto e Cartão

SDK PHP para integração com a API do PagBank (PagSeguro). Pagamentos via Pix, Boleto e Cartão de Crédito de forma simples e segura.

Este SDK facilita pagamentos com PagBank utilizando a ponte oficial do ClubeDev, permitindo criar cobranças, consultar transações e realizar cancelamentos totais ou parciais de maneira simples e padronizada.

A biblioteca foi desenvolvida para ser utilizada por programadores iniciantes e intermediários, com foco em simplicidade, clareza e segurança.

Sumário

Instalação

Requisitos

Autenticação e Tokens

Para utilizar a biblioteca, você precisa fornecer:

Ambos são obrigatórios para validação, segurança e auditoria das operações.

Adquirindo e configurando seu Token ClubeDev

Ambiente Sandbox (testes)

  1. Utilize o seguinte token: 78e670d6-bbbc-4cec-a4e8-79556aa61dfc

Ambiente Produção

  1. Acesse: https://clubedev.com.br
  2. Compre seu token
  3. Acesse sua conta em: https://painel.clubedev.com.br
  4. Vá ao menu Tokens
  5. Clique em Configurar Token
  6. Preencha os dados e clique em Salvar

Gerando seu Token PagBank

Ambiente Sandbox (testes)

  1. Acesse: https://portaldev.pagbank.com.br/
  2. Crie sua conta de desenvolvedor
  3. Vá até o menu Tokens
  4. Gere o token de sandbox

Ambiente Produção

  1. Faça login em: https://acesso.pagbank.com.br/
  2. Acesse diretamente o painel de integrações:
    https://minhaconta.pagbank.com.br/venda-online/integracoes/configuracoes
  3. Clique em Gerar Token

Inicialização

Pagamentos

Criar pagamento Pix

Retorno esperado

Método Tipo Retorno Descrição
$response->raw() Array Este método retorna os dados brutos
$response->orderId() String ID do pedido PagBank
$response->reference() Mixed Referência enviada por você ao PagBank
$response->createdAt() String Data de criação do pagamento, formato: Y-m-d H:i:s
$response->status() String Status do pagamento
$response->shipping() Shipping* ou null Caso tenha enviado dados de entrega, será retornado aqui
$response->items() Array de Item* Caso tenha enviado items, será retornado aqui
$response->client() Client* Dados do cliente que irá realizar o pagamento
$response->payment() Payment* Dados do pagamento

* Shipping, Item, Client e Payment são domain para tratamento de dados, no fim da documentação terá os detalhes de cada um

Exemplo de uso do retorno

Criar pagamento Cartão

Para criar pagamento com cartão é obrigatório a utilização da biblioteca frontend @clubedev/pagbank-encrypt-card para gerar o card_token

Retorno esperado

Método Tipo Retorno Descrição
$response->raw() Array Este método retorna os dados brutos
$response->orderId() String ID do pedido PagBank
$response->reference() Mixed Referência enviada por você ao PagBank
$response->createdAt() String Data de criação do pagamento, formato: Y-m-d H:i:s
$response->status() String Status do pagamento
$response->shipping() Shipping* ou null Caso tenha enviado dados de entrega, será retornado aqui
$response->items() Array de Item* Caso tenha enviado items, será retornado aqui
$response->client() Client* Dados do cliente que irá realizar o pagamento
$response->payment() Payment* Dados do pagamento

* Shipping, Item, Client e Payment são domain para tratamento de dados, no fim da documentação terá os detalhes de cada um

Exemplo de uso do retorno

Criar pagamento Boleto

Retorno esperado

Método Tipo Retorno Descrição
$response->raw() Array Este método retorna os dados brutos
$response->orderId() String ID do pedido PagBank
$response->reference() Mixed Referência enviada por você ao PagBank
$response->createdAt() String Data de criação do pagamento, formato: Y-m-d H:i:s
$response->status() String Status do pagamento
$response->shipping() Shipping* ou null Caso tenha enviado dados de entrega, será retornado aqui
$response->items() Array de Item* Caso tenha enviado items, será retornado aqui
$response->client() Client* Dados do cliente que irá realizar o pagamento
$response->payment() Payment* Dados do pagamento

* Shipping, Item, Client e Payment são domain para tratamento de dados, no fim da documentação terá os detalhes de cada um

Exemplo de uso do retorno

Consultar pagamento

Para consultar o pagamento será necessário informar o ORDER_ID que é encontrado na criação do pagamento $response->orderId()

Retorno esperado

Método Tipo Retorno Descrição
$response->raw() Array Este método retorna os dados brutos
$response->orderId() String ID do pedido PagBank
$response->reference() Mixed Referência enviada por você ao PagBank
$response->createdAt() String Data de criação do pagamento, formato: Y-m-d H:i:s
$response->status() String Status do pagamento
$response->shipping() Shipping* ou null Caso tenha enviado dados de entrega, será retornado aqui
$response->items() Array de Item* Caso tenha enviado items, será retornado aqui
$response->client() Client* Dados do cliente que irá realizar o pagamento
$response->payment() Payment* Dados do pagamento

* Shipping, Item, Client e Payment são domain para tratamento de dados, no fim da documentação terá os detalhes de cada um

Exemplo de uso do retorno pix

Exemplo de uso do retorno cartão de crédito

Exemplo de uso do retorno boleto

Cancelamentos

O mesmo método é utilizado tanto para cancelamento parcial quanto completo. Este método espera o CHARGE_ID que é encontrado na criação ou busca do pagamento:

Cancelamento parcial

Se o valor enviado for menor que o total pago, o PagBank realizará um cancelamento parcial.

Cancelamento total

Se o valor for igual ao valor total pago, será realizado um cancelamento completo.

Retorno esperado

Método Tipo Retorno Descrição
$response->raw() Array Este método retorna os dados brutos
$response->canceled() Boolean Informa se sua requisição foi bem executada
$response->id() String ID do pedido PagBank
$response->fullRefunded() Boolean Informa se o pagamento foi completamente estornado
$response->paid() Float Valor pago pelo cliente
$response->refunded() Float Valor estornado ao cliente

Processamento Webhook

Para facilitar, desenvolvemos um método que irá processar o webhook para você.

Retorno esperado

Método Tipo Retorno Descrição
$response->raw() Array Este método retorna os dados brutos
$response->orderId() String ID do pedido PagBank
$response->reference() Mixed Referência informada por você na criação do pagamento
$response->createdAt() String Data de criação do pagamento, formato Y-m-d H:i:s
$response->status() String Status do pagamento
$response->paid() Boolean Informa se o pagamento foi concluído
$response->canceled() Boolean Informa se o pagamento foi cancelado
$response->waiting() Boolean Informa se o pagamento está pendente
$response->inAnalysis() Boolean Informa se o pagamento está em análise
$response->declined() Boolean Informa se o pagamento foi recusado
$response->authorized() Boolean Informa se o pagamento foi autorizado
$response->shipping() Shipping* ou null Caso tenha enviado dados de entrega, será retornado aqui
$response->items() Array de Item* Caso tenha enviado items, será retornado aqui
$response->client() Client* Dados do cliente que irá realizar o pagamento
$response->payment() Payment* Dados do pagamento

* Shipping, Item, Client e Payment são domain para tratamento de dados, no fim da documentação terá os detalhes de cada um

Domínios (Domains)

A biblioteca usa objetos para garantir que os dados enviados ao backend estejam no formato correto e também uma forma de utilização/formatação dos dados recebidos do backend.

Abaixo, um resumo simples:

Phone

Client

Item

Address

Shipping

Holder

CreditCard

Title

Pix

Payment

Tratamento de Exceções

Todas as operações podem lançar exceções:

Exemplo de uso seguro:

Suporte

⌛ Desenvolvido para ser simples, direto e produtivo.

All versions of pagbank-php with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
guzzlehttp/guzzle Version ^7.0
ext-json Version *
nesbot/carbon Version ^3.10
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package clubedev/pagbank-php contains the following files

Loading the files please wait ...