mrprompt/cielo

Integration with Cielo gateway.

4.0.0 2025-04-29 02:13 UTC

Requires

• php: ^8.2
• guzzlehttp/guzzle: ^7.0
• respect/validation: ^2.4

Requires (Dev)

• phpunit/php-code-coverage: ^11.0
• phpunit/phpunit: ~11.0
• vlucas/phpdotenv: ^5.6

GPL-3.0-or-later

• Thiago Paes

• payment
• gateway
• card
• token
• credit
• debit
• boleto
• Pagamento
• cielo
• credito
• debito
• pix
• cartão

README

Esta é uma biblioteca cliente para a API da Cielo.

AVISO

Esta versão foi inteiramente reescrita e é totalmente incompatível com as versões anteriores da biblioteca.

Requisitos

• PHP 8.2+

Instalação

composer require mrprompt/cielo "^4.0"

Exemplos

Para todos os recursos suportados pela biblioteca, existe um exemplo de código no diretório de exemplos. Para executa-los, copie o arquivo .env.example do diretório .env e edite os campos:

• CIELO_MERCHANT_ID
• CIELO_MERCHANT_KEY

Você pode obter as credencias diretamente na documentação da Cielo.

Recursos disponíveis

• Consulta BIN
  • Consultar BIN do cartão
• Zero Auth
  • Validar cartão com o Zero Auth
  • Validar cartão tokenizado
  • Validar cartão de e-wallet
• Cartão de crédito
  • Criar pagamento com cartão de crédito
  • Capturar transação de crédito após a autorização
  • Cancelar transação de crédito via PaymentId
  • Cancelar transação de crédito via MerchantOrderId
• Cartão de débito
  • Criar pagamento com cartão de débito
  • Cancelar transação de débito via PaymentId
  • Cancelar transação de débito via MerchantOrderId
• PIX
  • Criar pagamento com QRCode Pix
  • Solicitar uma devolução Pix
• Boleto
  • Criar pagamento com boleto
• Tokenização
  • Criar cartão tokenizado antes da autorização

Adicionais

Para Laravel/Lumen foi desenvolvido um Service Provider para facilitar o uso da biblioteca. Você pode obter mais detalhes sobre uso ou instalação diretamente no repositório.

Debug

Para todas as requisições/recursos, você pode obter no retorno as propriedades jsonEnvio e jsonRecebimento, com o corpo da requisição e da resposta da API.