Skip to main content

Cuenca API Client

Project description

Cuenca – Python client library

Transfers

Create transfer

import cuenca

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

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

# To get updated status (estado)
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
transfer = cuenca.Transfer.one(idempotency_key='unique string')

# 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

Roll the ApiKey

import cuenca

# create new key and deactive old key in 60 mins
old_key, new_key = cuenca.ApiKey.roll(60)

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.0.1.dev0.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

cuenca-0.0.1.dev0-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file cuenca-0.0.1.dev0.tar.gz.

File metadata

  • Download URL: cuenca-0.0.1.dev0.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.7

File hashes

Hashes for cuenca-0.0.1.dev0.tar.gz
Algorithm Hash digest
SHA256 85e4f39944729cdaf500639b2c9b3aff10adb90621b2ad2246208400c1cae709
MD5 bdd2c3d593e06e81504faa0560b6152e
BLAKE2b-256 0d59b5a116a25f538a87e0247767acdb17952cd39bb6eb76156e2ffeaff76d85

See more details on using hashes here.

File details

Details for the file cuenca-0.0.1.dev0-py3-none-any.whl.

File metadata

  • Download URL: cuenca-0.0.1.dev0-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.7

File hashes

Hashes for cuenca-0.0.1.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 871b9e0b6f22544834b58e00173359bf4f45be8fd1741478cdf0ce0b5987b11f
MD5 69cbb117bf40a700d99a3da666fb245e
BLAKE2b-256 0ef28c90fb18b898b07c62e6aa584a553e2b54527291cf40bbca28446ad2844f

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