Skip to main content

Client library for stpmex.com

Project description

STP python3.6+ client library

test codecov PyPI Downloads

Cliente para el servicio REST de STP

Requerimientos

Python v3.6 o superior.

Documentación de API

General y WADL

Instalación

pip install stpmex

Correr pruebas

make venv
source venv/bin/activate
make test

Uso básico

import datetime as dt

from stpmex import Client
from stpmex.types import Pais

client = Client(
    empresa='TU_EMPRESA',
    priv_key='PKEY_CONTENIDO',
    priv_key_passphrase='supersecret',
)

cuenta_persona_fisica = client.cuentas.alta(
    nombre='Eduardo',
    apellidoPaterno='Salvador',
    apellidoMaterno='Hernández',
    rfcCurp='SAHE800416HDFABC01',
    cuenta='646180110400000007',
    paisNacimiento=Pais.MX,
    fechaNacimiento=dt.date(1980, 4, 14),
)


cuenta_persona_moral = client.cuentas_morales.alta(
    nombre='LA TIENDITA DE LA ESQUINA SA DE CV',
    cuenta='646180157036325892',
    pais=Pais.MX,
    fechaConstitucion=dt.date(2021, 1, 1),
    rfcCurp='ABC200101AB0',
)

# Si deseas dar de alta una nueva clabe para la misma 
# razón social, haces el mismo request sustituyendo `cuenta`
# con la nueva clabe
cuenta_persona_moral = client.cuentas_morales.alta(
    nombre='LA TIENDITA DE LA ESQUINA SA DE CV',
    cuenta='646180157036325832',
    pais=Pais.MX,
    fechaConstitucion=dt.date(2021, 1, 1),
    rfcCurp='ABC200101AB0',
)

orden = client.ordenes.registra(
    monto=1.2,
    cuentaOrdenante=cuenta.cuenta,
    nombreBeneficiario='Ricardo Sanchez',
    cuentaBeneficiario='072691004495711499',
    institucionContraparte='40072',
    conceptoPago='Prueba',
)

# Saldo
saldo = client.saldos.consulta(cuenta='646456789123456789')

# Ordenes - enviadas
enviadas = client.ordenes.consulta_enviadas() # fecha_operacion es el día de hoy

# Ordenes - recibidas
recibidas = client.ordenes.consulta_recibidas(
    fecha_operacion=dt.date(2020, 4, 20)
)

# Orden - consulta por clave rastreo
orden = client.ordenes.consulta_clave_rastreo(
    claveRastreo='CR1234567890',
    institucionOperante=90646,
    fechaOperacion=dt.date(2020, 4, 20)
)

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

stpmex-3.15.1.tar.gz (25.2 kB view hashes)

Uploaded Source

Built Distribution

stpmex-3.15.1-py3-none-any.whl (29.2 kB view hashes)

Uploaded Python 3

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