Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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.8.dev0.tar.gz (13.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.8.dev0-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

Details for the file arcus-1.2.8.dev0.tar.gz.

File metadata

  • Download URL: arcus-1.2.8.dev0.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for arcus-1.2.8.dev0.tar.gz
Algorithm Hash digest
SHA256 4eb6b14209d62f2218faefe0bd9962a0aa8cf25185737a83219768a7d49bca77
MD5 a2b6dc1a175ddc7e13e271ba2b8d924a
BLAKE2b-256 c79a168315acd6358364a1d13e98f512cf0c1a0a28b4427ce6094a4174d97df6

See more details on using hashes here.

File details

Details for the file arcus-1.2.8.dev0-py3-none-any.whl.

File metadata

  • Download URL: arcus-1.2.8.dev0-py3-none-any.whl
  • Upload date:
  • Size: 18.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for arcus-1.2.8.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 786c41c4d9ae99d9c9f21213d8fdf23df4860af4b2e6128e723c00a8af5f4942
MD5 f6381c698835c8064b87c75a3e640b5f
BLAKE2b-256 78c140284c6716b3e9f70b18486ed0aacda40a47c9f6d26ee3345a0939b91f53

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