Transacción #

Section renders pages in section as definition list, using title and description.

Example #

{{< section >}}

Crear transacción: Crear transacción # Este método permite crear una transacción entre dos usuarios o comercios existentes en el ecosistema. Se deben proporcionar los detalles del pagador y el receptor de la transacción, así como cualquier información adicional relevante que pueda respaldar la trazabilidad del pago. URL del endpoint # POST /create-transaction Parámetros de entrada # Los parámetros deben enviarse en el cuerpo de la solicitud HTTP en formato JSON.
Crear transacción de billetera: Crear transacción de billetera # Este método permite crear una transacción entre dos usuarios o comercios existentes en el ecosistema. Se deben definir los campos del pagador y el receptor de la transacción, además de los detalles de información útil que puedan argumentar la trazabilidad del pago. URL del endpoint # POST /create-ledger-transaction Parámetros de entrada # Los parámetros deben enviarse en el cuerpo de la solicitud HTTP en formato JSON.
Crear transacción de pago: Crear transacción de pago # El método create_payment_transaction permite crear una transacción de pago. URL del endpoint # POST /create-payment-transaction Parámetros de entrada # Los parámetros deben enviarse en el cuerpo de la solicitud HTTP en formato JSON. A continuación, se detallan los parámetros requeridos: Parámetro Tipo Descripción from_user_id string Identificador único (UUID) del pagador to_user_id string Identificador único (UUID) del receptor payments list Lista de objetos de pago Encabezados # Encabezado Valor Authorization Bearer {token} Content-Type application/json Respuesta esperada # El método devuelve una respuesta en formato JSON con los siguientes campos:
Crear transacción de recarga: Crear transacción de recarga # Este método permite crear una transacción de recarga, a través de este método un usuario del ecosistema podrá recargar su cupo. URL del endpoint # POST /create-recharge-transaction Parámetros de entrada # Los parámetros deben enviarse en el cuerpo de la solicitud HTTP en formato JSON. A continuación, se detallan los parámetros requeridos: Parámetro Tipo Descripción from_user_id string Identificador único (UUID) del pagador to_user_id string Identificador único (UUID) del receptor amount float Monto de la transacción date string Fecha de la transacción en formato ISO8601 status string Estado de la transacción details object Información adicional (opcional) Encabezados # Encabezado Valor Authorization Bearer {token} Content-Type application/json Respuesta esperada # El método devuelve una respuesta en formato JSON con los siguientes campos:
Crear QR de transacción: Crear QR de transacción # Este método permite crear un código QR de transacción de pago asociado entre usuarios o comercios existentes en el ecosistema. Retorna una imagen (código QR) que contiene la información del pagador, el receptor y los detalles de la transacción para dar trazabilidad en la lógica de negocio al ejecutar el pago. URL del endpoint # POST /create-transaction-qr Parámetros de entrada # Los parámetros deben enviarse en el cuerpo de la solicitud HTTP en formato JSON.
Obtener transacción por ID: Obtener transacción por ID # Este método permite obtener una transacción por su ID. URL del endpoint # GET /transaction Parámetros de entrada # Parámetro Tipo Descripción id string ID de la transacción a obtener Encabezados # Encabezado Valor Authorization Bearer {token} Content-Type application/json Respuesta esperada # El método devuelve una respuesta en formato JSON con los siguientes campos:
Obtener transacción por referencia: Obtener transacción por referencia # Este método permite obtener una transacción por su referencia. URL del endpoint # GET /find-transaction-by-reference Parámetros de entrada # Parámetro Tipo Descripción reference string Referencia de la transacción a obtener Encabezados # Encabezado Valor Authorization Bearer {token} Content-Type application/json Respuesta esperada # El método devuelve una respuesta en formato JSON con los siguientes campos:
Obtener historial de transacciones para un usuario: Obtener historial de transacciones para un usuario # Este método retorna un objeto con el histórico de transacciones de pago registradas por un usuario o comercio determinado usando su identificador único (UUID) como parámetro de consulta. URL del endpoint # GET /find-transaction-by-reference Parámetros de entrada # Parámetro Tipo Descripción user-id string El identificador único del usuario o comercio. Encabezados # Encabezado Valor Authorization Bearer {token} Content-Type application/json Respuesta esperada # El método devuelve una respuesta en formato JSON con los siguientes campos:
Obtener el historial de pagos recibidos por un usuario: Obtener el historial de pagos recibidos por un usuario # Usa este método para retornar un objeto con la información de pagos recibidos por un usuario o comercio, detalles de la transacción e información adicional que se haya referenciado en este usando su identificador único (UUID) como parámetro de consulta. URL del endpoint # GET /received-payments Parámetros de entrada # Parámetro Tipo Descripción user-id string El identificador único del usuario o comercio.
Obtener historial de transacciones de tipo billetera para un usuario: Obtener historial de transacciones de tipo billetera para un usuario # Este método retorna un objeto con el histórico de transacciones de tipo billetera registradas por un usuario o comercio determinado usando su identificador único (UUID) como parámetro de consulta. URL del endpoint # GET /ledger-transaction-history Parámetros de entrada # Parámetro Tipo Descripción user-id string El identificador único del usuario o comercio.
Obtener resumen de transacciones para un usuario: Obtener resumen de transacciones para un usuario # Este método retorna un objeto con el resumen de transacciones registradas por un usuario usando su identificador único (UUID) como parámetro de consulta. URL del endpoint # GET /transaction-summary Parámetros de entrada # Parámetro Tipo Descripción user-id string El identificador único del usuario o comercio. Encabezados # Encabezado Valor Authorization Bearer {token} Content-Type application/json Respuesta esperada # El método devuelve una respuesta en formato JSON con los siguientes campos:
Actualizar el estado de una transacción: Actualizar el estado de una transacción # Este método permite cambiar el estado de entrada por defecto de un pago registrado enviando el ID asignado a la transacción y el nuevo estado a definir. URL del endpoint # POST /update-transaction-status Parámetros de entrada # Parámetro Tipo Descripción transaction_id string El ID de la transacción a actualizar el estado. status string El nuevo estado a definir para la transacción.