pygamentos

pygamentos é uma biblioteca idealizada para facilitar a utilização dos principais meios de pagamentos online em Python 3, neste primeiro momento apenas o Ebanx está disponível, mas vamos adicionar novos serviços em breve.

Versão do Python

Python >= 3.5

Dependências

*Biblioteca requests
pip install requests

Para instalar

pip install pygamentos

Para fazer o upgrade

pip install pygamentos --upgrade

Chamando a biblioteca

from pygamentos import *

Passando os parâmetro de conexão

• payment = Config(key=key,mode=mode,gateway=gateway) - Recebe valor da chave(key) e o modo sandobox(mode=1), se estiver em produção, não precisa informar o mode! O gateway por enquanto utilizamos apenas o serviço da Ebanx.

Funções disponíveis

• send() - Recebe os dados para solicitar o pagamento.

• refund() - Recebe os dados para solicitar o reembolso de um pagamento.

• refund_or_cancel() - Recebe os dados para solicitar o reembolso ou um cancelamento de um pagamento.

• cancel_refund() - Recebe os dados para solicitar o cancelamento de um reembolso.

• cancel() - Recebe os dados para solicitar o cancelamento de um pagamento.

Exemplos

• from pygamentos import *

• key = "xyz"

• payment = Config(key=key,mode=1,gateway='Ebanx')

Gerando um Boleto

novo = payment.send(type_payment='boleto',
name='João da Couves',
document='886.959.180-84',
email='jonhofcouves@gmail.com',
address='Rua João um',
number='900',
phone='999998888',
city='Rio de Janeiro',
state='RJ',
country='br',
zipcode='20000-111',
payment_code='691671504',
currency='BRL',
total=1200)

print (novo)

O retorno será um dicionário:

• { 'payment': { 'hash': '5d78739aa5d43d1fe5590503088bd022153b133170e8ad61', 'pin': '351416861', 'country': 'br', 'merchant_payment_code': '69123900504', 'order_number': None, 'status': 'PE', 'status_date': None, 'open_date': '2019-09-11 04:10:02', 'confirm_date': None, 'transfer_date': None, 'amount_br': '1200.00', 'amount_ext': '1200.00', 'amount_iof': '0.00', 'currency_rate': '1.0000', 'currency_ext': 'BRL', 'due_date': '2019-09-14', 'instalments': '1', 'payment_type_code': 'boleto', 'boleto_url': 'https://staging-print.ebanx.com.br/print/?hash=5d78739aa5d43d1fe5590503088bd022153b133170e8ad61', 'boleto_barcode': '34191760070014759372714245740007880120000120000', 'boleto_barcode_raw': '34198801200001200001760000147593721424574000', 'pre_approved': False, 'capture_available': None }, 'status': 'SUCCESS' }*

Se você precisar acessar o link do boleto gerado, basta capturar: novo['payment']['boleto_url']

O resultado será: https://staging-print.ebanx.com.br/print/?hash=5d78739aa5d43d1fe5590503088bd022153b133170e8ad61

Gerando um pagamento para cartão de crédito

novo = payment.send(type_payment='boleto',
name='João da Couves',
document='886.959.180-84',
email='jonhofcouves@gmail.com',
address='Rua João um',
number='900',
phone='999998888',
city='Rio de Janeiro',
state='RJ',
country='br',
zipcode='20000-111',
payment_code='691671504',
currency='BRL',
total=1201.55,
card_number="4111111111111111",
card_name='João das Couves',
card_due_date='12/2029',
cvv='123')

print (novo)

O retorno será um dicionário:

• { 'payment': { 'hash': '5e5865bfad7ba928f4a08dab22fd644189cf553b62e9a6e4', 'pin': '750405144', 'country': 'br', 'merchant_payment_code': '691671504', 'order_number': None, 'status': 'CO', 'status_date': '2020-02-28 00:58:39', 'open_date': '2020-02-28 00:58:39', 'confirm_date': '2020-02-28 00:58:39', 'transfer_date': None, 'amount_br': '1201.55', 'amount_ext': '1201.55', 'amount_iof': '0.00', 'currency_rate': '1.0000', 'currency_ext': 'BRL', 'due_date': '2020-03-02', 'instalments': '1', 'payment_type_code': 'visa', 'details': { 'billing_descriptor': 'EBANX*YOUR NAME Company' }, 'transaction_status': { 'acquirer': 'EBANX', 'code': 'OK', 'description': 'Accepted', 'authcode': '42526' }, 'pre_approved': True, 'capture_available': False }, 'status': 'SUCCESS' }, 'status': 'SUCCESS' }

Solicitando Refund parcial ou total

novo = payment.refund(operation='request', hash='5e5865bfad7ba928f4a08dab22fd644189cf553b62e9a6e4', amount=1000.00,# Parcial description='Solicitado pelo usuario', refund_code='691671504')

O retorno será um dicionário:

{ 'payment': { 'hash': '5e5865bfad7ba928f4a08dab22fd644189cf553b62e9a6e4', 'pin': '376784161', 'country': 'br', 'merchant_payment_code': '691671504', 'order_number': None, 'status': 'CO', 'status_date': '2020-02-28 00:17:12', 'open_date': '2020-02-28 00:17:12', 'confirm_date': '2020-02-28 00:17:12', 'transfer_date': None, 'amount_br': '1000.00', 'amount_ext': '1000.00', 'amount_iof': '0.00', 'currency_rate': '1.0000', 'currency_ext': 'BRL', 'due_date': '2020-03-02', 'instalments': '1', 'payment_type_code': 'visa', 'details': { 'billing_descriptor': 'EBANX*YOUR BRAND COMPANY' }, 'transaction_status': { 'acquirer': 'EBANX', 'code': 'OK', 'description': 'Accepted', 'authcode': '18742' }, 'pre_approved': True, 'capture_available': False, 'refunds': [ { 'id': '50000465', 'merchant_refund_code': '691pp1504', 'status': 'RE', 'request_date': '2020-02-28 00:33:07', 'pending_date': None, 'confirm_date': None, 'cancel_date': None, 'amount_ext': '1000.00', 'description': 'Solicitado pelo usuario' } ] }, 'refund': { 'id': '50000465', 'merchant_refund_code': '691pp1504', 'status': 'RE', 'request_date': '2020-02-28 00:33:07', 'pending_date': None, 'confirm_date': None, 'cancel_date': None, 'amount_ext': '1000.00', 'description': 'Solicitado pelo usuario' }, 'operation': 'refund', 'status': 'SUCCESS' }

Solicitando Refund ou Cancelamento

novo = payment.refund_or_cancel(operation='request', hash='5e585b89e151a8e9d22e3c9def1f27d359d890da3f0e5b22', description='Solicitado pelo usuario')

O retorno será um dicionário:

{ 'payment': { 'hash': '5e5858de0e09569482eb1bea94f4d44cf93f32e699118857', 'pin': '942215124', 'country': 'br', 'merchant_payment_code': '69112397qw01504', 'order_number': None, 'status': 'CO', 'status_date': '2020-02-28 00:03:41', 'open_date': '2020-02-28 00:03:41', 'confirm_date': '2020-02-28 00:03:41', 'transfer_date': None, 'amount_br': '1200.55', 'amount_ext': '1200.55', 'amount_iof': '0.00', 'currency_rate': '1.0000', 'currency_ext': 'BRL', 'due_date': '2020-03-02', 'instalments': '1', 'payment_type_code': 'visa', 'details': { 'billing_descriptor': 'EBANX*YOUR BRAND COMPANY' }, 'transaction_status': { 'acquirer': 'EBANX', 'code': 'OK', 'description': 'Accepted', 'authcode': '83227' }, 'pre_approved': True, 'capture_available': False, 'refunds': [ { 'id': '50000462', 'merchant_refund_code': None, 'status': 'RE', 'request_date': '2020-02-28 00:05:16', 'pending_date': None, 'confirm_date': None, 'cancel_date': None, 'amount_ext': '1200.55', 'description': 'Solicitado pelo usuario' } ] }, 'refund': { 'id': '50000462', 'merchant_refund_code': None, 'status': 'RE', 'request_date': '2020-02-28 00:05:16', 'pending_date': None, 'confirm_date': None, 'cancel_date': None, 'amount_ext': '1200.55', 'description': 'Solicitado pelo usuario' }, 'operation': 'refund', 'status': 'SUCCESS' }

Agradecimentos

• Carlos Costa - Mr.Web2py Brasil por todo o suporte e mentoria!
• Grupo Web2py Brasil - Somos poucos, porém apaixonados pelo que fazemos e um grupo acolhedor!