Skip to main content

arcus-python

Build Status Coverage Status PyPI

Arcus python3.6 + 3.7 client library for API version 3.1 of Arcus.

Install

$ pip install arcus

Testing

$ make test

Authentication and account info

Current version support direct endpoint calls.

from arcus.client import Client

# Create an Arcus client instance
client = Client('your-api-key', 'your-secret-key')

# Get account info 
account_info = client.get('/account')

# create bill 
account_info = dict(biller_id=40, account_number='501000000007')
bill = client.post('/bills', account_info)

Pay bills

from arcus import Client

client = Client('your-api-key', 'your-secret-key')


# create bill
bill = client.bills.create(40, '501000000007')

# pay bill
transaction = bill.pay()

# refresh transaction
transaction.refresh()

# cancel transaction
cancellation = transaction.cancel()
assert cancellation['code'] == 'R0'
assert cancellation['message'] == 'Transaction successful'
assert transaction.status == 'refunded'

Top-up

from arcus import Client

client = Client('your-api-key', 'your-secret-key')

biller_id = 808080
phone_number = '5599992222'
amount = 100.0

# by default, currency is MXN
topup = client.topups.create(biller_id, phone_number, amount)

assert topup.bill_amount == 100.0

Billers list

You can list all active billers or filter in a specific field

from arcus.client import Client

# Create an Arcus client instance
client = Client('your-api-key', 'your-secret-key')

# Get all billers in Mexico which use MXN as currency
mx_biller_list = client.biller.list(country='MX', currency='MXN')

# Get all billers with an specific biller_type
electricity_biller_list = client.biller.list(biller_type='Electricity')

Download files

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

Source Distribution

arcus-1.2.0.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

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

arcus-1.2.0-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

Details for the file arcus-1.2.0.tar.gz.

File metadata

  • Download URL: arcus-1.2.0.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.1

File hashes

Hashes for arcus-1.2.0.tar.gz
Algorithm Hash digest
SHA256 1eed3a91b2b403b2179d66558d1b990aa93c222f567795899c462e9861e29d0d
MD5 13a5e28d61a0cbde2aa27df78851ee9d
BLAKE2b-256 c2c19a8eece050efc0531fba1c166552333b661f32d6293505c1ac6bbcab6d5e

See more details on using hashes here.

File details

Details for the file arcus-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: arcus-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 17.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.1

File hashes

Hashes for arcus-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 11d90691f7a4d5cd15b42ff7533a9251599d9bdb501a7a8c3b5f5eec55360d67
MD5 6f3c7237d96b3419bd4aa450cfe583f4
BLAKE2b-256 a2bce0d2f1f5782a9cddeec7a355ef03b9e072c461ae17714e75fb8b39bea041

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