Cuenca API Client
Project description
Cuenca – Python client library
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. RaisesNoResultFoundif there are no results andMultipleResultsFoundif there are more than onefirst()- returns the first result orNoneif there aren't anyall()- returns a generator of all matching results. Pagination is handled automatically as you iterate over the responsecount()- 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)
Balance
Current balance
import cuenca
# balance is the amount in cents
balance = cuenca.get_balance()
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
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cuenca-2.1.16.tar.gz.
File metadata
- Download URL: cuenca-2.1.16.tar.gz
- Upload date:
- Size: 38.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0e1e9ed23021b1e35cec8e6114707efbd2a32b5a5b6b66b913b7307081766858
|
|
| MD5 |
3b3f2cbc68b8135a72f80b4a0d33d4ee
|
|
| BLAKE2b-256 |
c872dec58b134f4b6bf6da174c798d38bb95f22db2313e91f90a54160eeaee10
|
File details
Details for the file cuenca-2.1.16-py3-none-any.whl.
File metadata
- Download URL: cuenca-2.1.16-py3-none-any.whl
- Upload date:
- Size: 69.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9b509886e1acbf890aed9e9fde922dbaf825ecfda57a6ad29ff3c24ee24ecb16
|
|
| MD5 |
7373d681808ae2ff93c7b2e0f9a188a5
|
|
| BLAKE2b-256 |
df443c12410e83283b1ee0bf4149f30004d5132ae71bd6367da57245afe4b8a1
|
