Documentación API

Transacciones

POST/open-bank/request/transaction

Descripción:

Este endpoint permite realizar transacciones financieras, incluyendo la posibilidad de hacer dispersión de pagos a múltiples cuentas, desde múltiples cuentas o realizar pagos directos de una cuenta a otra. Los detalles de la transacción, como el monto, la descripción y los movimientos de débito y crédito, deben ser enviados en el cuerpo de la solicitud.

Request

Json

Response

Json

Propiedades de la transacción

PropiedadTipoDescripción
amountnumberCantidad total de la transacción
descriptionstringDescripción de la transacción (ej. "Pago a tercero")
movementsarrayLista de movimientos financieros asociados a la transacción
movements.debitsarrayLista de débitos que restan fondos de las cuentas involucradas
movements.debits.accountIdstringIdentificador único de la cuenta de la cual se debitan fondos
movements.debits.amountnumberCantidad debitada de la cuenta
movements.creditsarrayLista de créditos que suman fondos a las cuentas involucradas
movements.credits.accountIdstringIdentificador único de la cuenta a la cual se acreditan fondos
movements.credits.amountnumberCantidad acreditada a la cuenta

Propiedades de la respuesta

PropiedadTipoDescripción
lastActionstringÚltima acción realizada (ej. "/open-bank/request/transaction")
successbooleanIndica si la petición fue exitosa
titleResponsestringTítulo de la respuesta (ej. "Petición realizada con éxito")
textResponsestringTexto adicional explicativo (puede estar vacío)
dataobjectObjeto que contiene los datos específicos de la respuesta
data.confirmConsentUrlstringURL para confirmar el consentimiento en la petición de transacciones
paginationobjectObjeto relacionado con la paginación (vacío en este caso)
totalCountsobjectObjeto relacionado con el conteo total (vacío en este caso)
extraobjectObjeto adicional para información extra (vacío en este caso)