Skip to main content

arcus-python

test codecov PyPI Downloads

Arcus python3.6+ 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.5.tar.gz (12.5 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.5-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: arcus-1.2.5.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5

File hashes

Hashes for arcus-1.2.5.tar.gz
Algorithm Hash digest
SHA256 ecd4cafff84f61e787048e58a4aae8538bf2f8aeafe2a36aeb9141417e141123
MD5 66cd71f06fa67cb94549e6665e4c2d43
BLAKE2b-256 1387d298ee288a6b63315c2391ea920ed8c63cfc867ba9ef4047353fbf5a36a3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: arcus-1.2.5-py3-none-any.whl
  • Upload date:
  • Size: 18.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5

File hashes

Hashes for arcus-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1aa18a3c2765e73e3632ba29ffc0a31abd21358cd0093c03bac57692be4934ed
MD5 97254b43dc0b45a3287c7a1db86c90d2
BLAKE2b-256 efa871326eeaa89a25e76500ee7b56e3c800a9fe92d87ee4a347c0c13e2d5b20

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 Sentry Error logging StatusPage Status page