Skip to main content

Python API client for the Alma Installments API

Project description

alma-python-client

Travis Build Status PyPI

Python API Client for the Alma API

Install

pip install alma-client

Demo

We support both a sync and async client.

Synchronous client

from alma import Client

alma_client = Client.with_api_key("sk_test..")
payments = alma_client.payments.fetch_all()

for p in payments:
    print(f"{p.id}: Paiement en {len(p.payment_plan)} fois")


payment_data = {
    "payment": {
        "purchase_amount": 10000,
        "return_url": "http://merchant.com/payment-success",
        "shipping_address": {
            "first_name": "Martin",
            "last_name": "Dupond",
            "line1": "1 rue de Rivoli",
            "postal_code": "75004",
            "city": "Paris"
        }
    }
}

eligibility = alma_client.payments.eligibility(payment_data)
if eligibility.eligible:
    payment = alma_client.payments.create(payment_data)

print(payment.raw_data)

Asynchronous client

from alma import AsyncClient

alma_client = AsyncClient.with_api_key("sk_test..")
payments = await alma_client.payments.fetch_all()

for p in payments:
    print(f"{p.id}: Paiement en {len(p.payment_plan)} fois")


payment_data = {
    "payment": {
        "purchase_amount": 10000,
        "return_url": "http://merchant.com/payment-success",
        "shipping_address": {
            "first_name": "Martin",
            "last_name": "Dupond",
            "line1": "1 rue de Rivoli",
            "postal_code": "75004",
            "city": "Paris"
        }
    }
}

eligibility = await alma_client.payments.eligibility(payment_data)
if eligibility.eligible:
    payment = await alma_client.payments.create(payment_data)

print(payment.raw_data)

Changelog

2.0.2 (2022-06-22)

  • Fix potential-fraud method URLs (#27)

2.0.1 (2022-06-17)

  • Adds include_child_accounts and custom_fields params to the DataExport creation endpoint

2.0.0 (2021-08-12)

Breaking changes

  • Move from requests to HTTPX
  • Handle both sync and async python clients
  • Remove support for Python 3.5
  • Add support for Python 3.9

1.2.0 (2020-09-01)

  • Add support for different authentication methods
  • Add Black & isort checks on pull requests

1.1.0 (2020-03-25)

  • Add support for Python 3.5+

1.0.1 (2020-03-24)

  • Automatically detects the API mode from the api_key.

1.0.0 (2020-03-24)

  • Create a Python client for Alma
  • Handle Order entity for Payment
  • Handle the refund endpoint
  • Handle pagination for orders
  • Handle the send-sms API for payments.

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

alma-client-2.0.2.tar.gz (15.6 kB view hashes)

Uploaded source

Built Distribution

alma_client-2.0.2-py3-none-any.whl (21.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page