Skip to main content

Arcus API Client

Project description

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')

Project details


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.11.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

arcus-1.2.11-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: arcus-1.2.11.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for arcus-1.2.11.tar.gz
Algorithm Hash digest
SHA256 85fcf13c88d0a912f6ef5d0a436d1b9b2f8c213b8015c26c22a860be17315483
MD5 f7e10a9754a0de492a567ed8c2202d05
BLAKE2b-256 8f6340e20b8ea06809b8a5f6ebadff0081cd6c7490205d3deecb52c34c34c8d7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: arcus-1.2.11-py3-none-any.whl
  • Upload date:
  • Size: 18.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for arcus-1.2.11-py3-none-any.whl
Algorithm Hash digest
SHA256 e50c7d37752b7dbf42ec291bd87836c60e47a833023ca20de7d2c3da5d1ee6a9
MD5 d562ff8940d63f7d97528e599ca709e4
BLAKE2b-256 e1c232c53c051160ea48703e9db3e7a3b25c93c8aac6e1a35530e76c3f503c53

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page