Skip to main content

Cuenca API Client

Project description

Cuenca – Python client library

test codecov PyPI

Installation

pip install cuenca

Authentication

The preferred way to configure the credentials for the client is to set the CUENCA_API_KEY and CUENCA_API_SECRET environment variables. The client library will automatically configure based on the values of those variables.

To configure manually:

import cuenca

cuenca.configure(api_key='PKxxxx', api_secret='yyyyyy')

Jwt

JWT tokens can also be used if your credentials have enough permissions. To do so, you may include the parameter use_jwt as part of your configure

import cuenca

cuenca.configure(use_jwt=True)

A new token will be created at this moment and automatically renewed before sending any request if there is less than 5 minutes to be expired according to its payload data.

Transfers

Create transfer

import cuenca

cuenca.configure(sandbox=True)  # if using sandbox

local_transfer_id = '078efdc20bab456285437309c4b75673'

transfer = cuenca.Transfer.create(
    recipient_name='Benito Juárez',
    account_number='646180157042875763',  # CLABE or card number
    amount=12345,  # Mx$123.45
    descriptor='sending money',  # As it'll appear for the customer
    idempotency_key=local_transfer_id
)

# To get updated status
transfer.refresh()

Retrieve by id

import cuenca

transfer = cuenca.Transfer.retrieve('tr_123')

Query by idempotency_key, account_number and status

Results are always returned in descending order of created_at

The methods that can be used:

  • one() - returns a single result. Raises NoResultFound if there are no results and MultipleResultsFound if there are more than one
  • first() - returns the first result or None if there aren't any
  • all() - returns a generator of all matching results. Pagination is handled automatically as you iterate over the response
  • count() - returns an integer with the count of the matching results
import cuenca
from cuenca.types import Status

# find the unique transfer using the idempotency key
local_transfer_id = '078efdc20bab456285437309c4b75673'
transfer = cuenca.Transfer.one(idempotency_key=local_transfer_id)

# returns a generator of all succeeded transfers to the specific account
transfers = cuenca.Transfer.all(
    account_number='646180157000000004',
    status=Status.succeeded
)

# the total number of succeeded transfers
count = cuenca.Transfer.count(status=Status.succeeded)

Api Keys

Create new ApiKey and deactivate old

import cuenca

# Create new ApiKey
new = cuenca.ApiKey.create()

# Have to use the new key to deactivate the old key
old_id = cuenca.session.auth[0]
cuenca.session.configure(new.id, new.secret)
cuenca.ApiKey.deactivate(old_id, 60)  # revoke prior API key in an hour

Login

Create a new password

cuenca.UserCredential.create(password='1234567890')

To update your password

cuenca.UserCredential.update(password='1234567890')

To reset password

cuenca.UserCredential.update(password=None)

Login in and out

cuenca.UserLogin.create(password='1234567890')
...  # authenticated operation
cuenca.UserLogin.logout()

Create login token for biometrics

# Must be logged in
cuenca.UserLogin.create(password='1234567890')
token = cuenca.LoginToken.create()
cuenca.UserLogin.logout()

# Then you can use the token which lasts for 7 days
cuenca.configure(login_token=token)
...  # authenticated operation

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cuenca-0.7.5.dev2.tar.gz (21.6 kB view details)

Uploaded Source

Built Distribution

cuenca-0.7.5.dev2-py3-none-any.whl (34.6 kB view details)

Uploaded Python 3

File details

Details for the file cuenca-0.7.5.dev2.tar.gz.

File metadata

  • Download URL: cuenca-0.7.5.dev2.tar.gz
  • Upload date:
  • Size: 21.6 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 cuenca-0.7.5.dev2.tar.gz
Algorithm Hash digest
SHA256 9af9661a3034763f0846f077f60888a1fb5ec470022b26e27668c79c8c7107b4
MD5 f78a008450f10d7ce7f9dc694e90305c
BLAKE2b-256 ecb26e1bd9301f02b0e458d69e289a29fda29f41468356bf30da1bfc42824fd7

See more details on using hashes here.

File details

Details for the file cuenca-0.7.5.dev2-py3-none-any.whl.

File metadata

  • Download URL: cuenca-0.7.5.dev2-py3-none-any.whl
  • Upload date:
  • Size: 34.6 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 cuenca-0.7.5.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 693404492d4cd103a64235762e556166c841d3bf0eee0f8d73836c591f79d178
MD5 ca687ca22b99d45a983f56df43fe4d0a
BLAKE2b-256 2d8a41ed14d6cb7cf5fe537d01a860e26756b1b92359c2cdec3e486b946601b0

See more details on using hashes here.

Supported by

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