spei-python 0.37.0

No project description provided

spei-python

A library for accessing the SPEI API and SICE API for python.

Installation

Use the package manager poetry to install.

poetry install spei-python

Usage

Use our client to send orders to SPEI.

from spei.client import BaseClient

client = BaseClient(
    host='http://karpay-beta.intfondeadora.app',
    username='karpay',
    password='password',
    priv_key='private_key',
    priv_key_passphrase='passphrase',
)

Use our client to send orders to SICE.

from spei.sice import BaseClient

client = BaseClient(
    host='https://172.30.3.204:8443',
)

Methods

• registra_orden
• registra_cda

Resources

There are four main resources.

• Orden our abstraction of order, this goes through SPEI as XML.
• Respuesta our abstraction of received SPEI messages and response to SPEI orders.
• CDA our abstraction of cda, this goes through SICE as XML.
• Acuse our abstraction of received SICE messages and confirmation message to SICE.

Types

• TipoPagoOrdenPago Order payment type.
• TipoOrdenPago Order type.
• TipoCuentaOrdenPago Account type.
• PrioridadOrdenPago Order priority.
• CategoriaOrdenPago Order Category.
• EstadoOrdenPago Order status.
• ClaveOrdenanteOrdenPago Root Institution Code.
• FolioOrdenPago Order invoice identifier.
• MedioEntregaOrdenPago Order transmission method.
• TopologiaOrdenPago Order notification method.

Requests

These are used to perform requests to karpay using our resources.

• OrdenRequest Maps an existing orden to XML.
• RespuestaRequest Maps an existing respuesta to XML.
• CDARequest Maps an existing CDA to XML.

Responses

These are used to map karpay results to our resources.

• AcuseResponse Maps a acuse XML to our CDA resource.
• RespuestaResponse Maps a respuesta XML to our Response resource.

Errors

Available errors messages from Karpay.

These errors are included inside respuesta.

Test

Tested with mamba, install poetry dev packages and then run tests.

poetry run make test

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Checksum Generator

This repo includes a utility to generate firma digital aplicada

python bin/generate_checksum.py bin/message.json