Download the PHP package vitorccs/braspag-pagador-php-sdk without Composer
On this page you can find all versions of the php package vitorccs/braspag-pagador-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vitorccs/braspag-pagador-php-sdk
More information about vitorccs/braspag-pagador-php-sdk
Files in vitorccs/braspag-pagador-php-sdk
Package braspag-pagador-php-sdk
Short Description SDK em PHP para API Braspag Pagador
License GPL-3.0
Homepage https://github.com/vitorccs/braspag-pagador-php-sdk
Informations about the package braspag-pagador-php-sdk
Braspag Pagador - SDK PHP
SDK em PHP para API Braspag Pagador e API Cartão Protegido
Requisitos
- PHP >= 8.0
Descrição
SDK em PHP para a API Braspag Pagador.
Instalação
Via Composer
Parâmetros
Parâmetro | Obrigatório | Padrão | Comentário |
---|---|---|---|
BRASPAG_MERCHANT_ID | Sim | null | Merchant ID para autenticação |
BRASPAG_MERCHANT_KEY | Sim | null | Merchant Key para autenticação |
BRASPAG_CLIENT_ID | *Sim | null | Client ID para API Cartão Protegido |
BRASPAG_CLIENT_SECRET | *Sim | null | Client Secret para API Cartão Protegido |
BRASPAG_SANDBOX | Não | false | Habilita o modo Sandbox |
BRASPAG_TIMEOUT | Não | 30 | Timeout em segundos para estabelecer conexão com a API |
* Obrigatório apenas se for utilizar a API Cartão Protegido
Podem ser definidos por variáveis de ambiente:
Ou passados como argumentos do serviço:
Serviços implementados
API Pagador - Transação
Criar Transação (para qualquer Meio de Pagamento)
Estornar Transação (para qualquer Meio de Pagamento)
API Pagador - Consultas
Obter Transação por Payment ID (ID de Pagamento)
Obter Transação por Merchant Order Id (Identificador da Loja)
Obter Transação por Recurrent Payment ID (ID de Pagamento Recorrente)
API Cartão Protegido
Gerar um Token para um Cartão de Crédito
Obter o Token que está associado ao Alias
Obter os dados do Cartão pelo seu Token
Suspender o Token
Reativar o Token
Remover o Token
Construtores (Builders)
Para auxiliar a criar uma Transação, foram disponibilizados alguns construtores:
API Pagador - Criando Endereço
API Pagador - Criando Cliente
API Pagador - Criando Pagamento PIX
API Pagador - Criando Pagamento Boleto Bancário
API Pagador - Criando Pagamento Cartão de Crédito
API Pagador - Criando Pagamento Cartão de Débito
API Cartão Protegido - Criando Cartão de Crédito
Tratamento de erros
Esta biblioteca lança as exceções abaixo:
Principais:
BraspagValidationException
para requisições que falharam (HTTP 4xx ou 5xx) e possuem mensagem de erro retornado pela API Braspag.BraspagRequestException
para requisições que falharam (HTTP 4xx ou 5xx) sem tratamento de erro ou problemas de conexão diversos (sem resposta HTTP).
No serviço de Criar Transação:
BraspagProviderException
para requisições que embora tenham retornado como sucesso (HTTP 2xx), o corpo da resposta indica um erro retornado pelo Provider Status = 0.
No serviço de Consultar Transação:
BraspagNotFoundException
ao tentar localizar uma Transação que não existe (ex: localizar por PaymentId ou MerchantOrderId).
Exemplo de corpo da resposta onde será lançado uma exceção BraspagProviderException
Exemplo de corpo da resposta onde será lançado uma exceção BraspagValidationException
Exemplo de implementação
Testes
Caso queira contribuir, por favor, implementar testes de unidade em PHPUnit.
Para executar: