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.7.tar.gz (13.1 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.7-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: arcus-1.2.7.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for arcus-1.2.7.tar.gz
Algorithm Hash digest
SHA256 d06cfd4e5e621e8bbb6098925e489083eb2d63ea4e462ec8345e1d40915bbbd0
MD5 9a33f0e07e655c8507829f01eb03fe38
BLAKE2b-256 69b7973bf1834516fadaac65c6ea7c24424960bcef85d4c3bf11af7ac71068da

See more details on using hashes here.

File details

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

File metadata

  • Download URL: arcus-1.2.7-py3-none-any.whl
  • Upload date:
  • Size: 18.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for arcus-1.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 eb1d004123795c992431ba1e90d5eaa88655caebc2f5835993a5965d6a69b83c
MD5 63fcac06102954f39a1904feffc70252
BLAKE2b-256 d4ae18faf0010131c0463d10bd4d62f0621c0096803027c4ad805a447befada3

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