Skip to main content

Wrapper para a API PushinPay

Project description

PushinPay

pushinpay é uma biblioteca Python para integração com a API do gateway de pagamento PushinPay, permitindo a criação e gerenciamento de pagamentos via Pix.

Documentação oficial: https://doc.pushinpay.com.br/#introducao

Instalação

Para instalar a biblioteca, utilize o pip:

pip install pushinpay

Configuração

Para começar a usar a biblioteca, você precisa de uma chave de API fornecida pelo PushinPay. Você pode configurar a biblioteca da seguinte forma:

from pushinpay import PushinPay

# Inicialize o cliente PushinPay
pushinpay = PushinPay(api_key="SUA_CHAVE_API", webhook_url="https://seu-webhook.com", sandbox=True)
  • api_key: Sua chave de API.
  • webhook_url: (Opcional) URL para receber notificações de eventos.
  • sandbox: (Opcional) Define se o ambiente de sandbox será utilizado. O padrão é False.

Funcionalidades

Criar QR Code Pix

Você pode criar um QR Code Pix para pagamentos:

# Criar um QR Code Pix
qrcode = pushinpay.pix.create_qrcode(value=1000)  # Valor em centavos (R$10,00)
print(qrcode)  # String do QR Code (__str__)
# Ou
print(qrcode.qrcode)

Consultar Status de um QR Code Pix

Para consultar o status de um QR Code Pix:

# Consultar o status do QR Code
qrcode_status = pushinpay.pix.get_status_qrcode(qrcode)
print(qrcode_status)  # Uma instância de QRCodeResponseStatus
print(qrcode_status.value) # 1000

# Observação: qrcode.status é diferente de qrcode_status

Tratamento de Erros

A biblioteca lança exceções específicas para erros da API:

  • PushinPayError: Exceção base para erros da biblioteca.
  • APIError: Exceção para erros retornados pela API.

Exemplo de tratamento de erros:

from pushinpay.errors import APIError

try:
    qrcode = pushinpay.pix.create_qrcode(value=1000)
except APIError as e:
    print(f"Erro na API: {e.status_code} - {e.message}")

Requisitos

  • Python 3.6 ou superior
  • Biblioteca requests

Contribuição

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues ou pull requests no repositório.

Licença

Este projeto está licenciado sob a licença MIT. Consulte o arquivo LICENSE para mais detalhes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pushinpay-0.1.0.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pushinpay-0.1.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file pushinpay-0.1.0.tar.gz.

File metadata

  • Download URL: pushinpay-0.1.0.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for pushinpay-0.1.0.tar.gz
Algorithm Hash digest
SHA256 41a1ae9d835551f55abb5dfd355344372ea1e2118bd904d771d9140ee06340e3
MD5 bd2646c4a7b6e84a05c2fb93934fc670
BLAKE2b-256 e650d3c1c7ce9ef77b20045577ddb8d671771b1c7ca33b5db31d35f87c458fce

See more details on using hashes here.

File details

Details for the file pushinpay-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pushinpay-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for pushinpay-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ca09cda52004ccfc91725c3acec82c2f7eb5f4f8f2cecdf7a2676572fa0d9520
MD5 1a58e97fc0a3049b0ba1a7d7ab474c92
BLAKE2b-256 f7cb46ac00a718272dbbe4c4da11cb61e17f9726d9b6516866733b0416827fd6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page