Transaction

Transaction #

Crear transacción #

Crea una transacción entre dos usuarios existentes en el ecosistema, definiendo detalles del usuario pagador y receptor de la operación, además de los detalles que darán trazabilidad en la transacción a ser registrada.

Ejemplo

POST /create-transaction

{
  "amount": 0,
  "date": "string",
  "details": {
    "detail1": "string"
  },
  "from_user": "string",
  "from_user_id": "string",
  "status": "string",
  "to_user": "string",
  "to_user_id": "string"
}

Resultado

{
  "amount": 0,
  "date": "string",
  "details": {
    "detail1": "string"
  },
  "from_user": "string",
  "from_user_id": "string",
  "id": "string",
  "reference": "string",
  "status": "string",
  "to_user": "string",
  "to_user_id": "string"
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Crear transacción de pago #

Crea una transacción entre dos usuarios existentes en el ecosistema, definiendo detalles del usuario pagador y receptor de la operación, además de los detalles que darán trazabilidad en la transacción a ser registrada.

Ejemplo

POST /create-payment-transaction

{
  "from_user": "string",
  "from_user_id": "string",
  "payments": [
    {
      "amount": 0,
      "details": {
        "detail1": "string"
      },
      "to_user": "string",
      "to_user_id": "string"
    }
  ]
}

Resultado

[
  {
    "amount": 0,
    "date": "string",
    "details": {
      "detail1": "string"
    },
    "from_user": "string",
    "from_user_id": "string",
    "id": "string",
    "reference": "string",
    "status": "string",
    "to_user": "string",
    "to_user_id": "string"
  }
]

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Crear transacción de recarga #

Crea una transacción de pago en recarga entre dos usuarios dentro del ecosistema, definiendo los detalles del usuario pagador y receptor en la operación, además de los detalles que darán trazabilidad en la transacción a ser registrada.

Ejemplo

POST /create-recharge-transaction

{
  "amount": 0,
  "date": "string",
  "details": {
    "detail1": "string"
  },
  "from_user": "string",
  "from_user_id": "string",
  "status": "string",
  "to_user": "string",
  "to_user_id": "string"
}

Resultado

{
  "amount": 0,
  "date": "string",
  "details": {
    "detail1": "string"
  },
  "from_user": "string",
  "from_user_id": "string",
  "id": "string",
  "reference": "string",
  "status": "string",
  "to_user": "string",
  "to_user_id": "string"
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Consultar transacción #

Devuelve un objeto con la información relacionada a una transacción de pago generada entre dos usuarios del ecosistema enviando el id asignado a la transacción para obtener detalles de la operación.

Ejemplo

GET /transaction

https://www.api.sandbox-middleware.leancore.co/transaction?id=9c3ed9b2-26db-45c9-922a-42118cbbc82b

Resultado

{
  "amount": 0,
  "date": "string",
  "details": {
    "detail1": "string"
  },
  "from_user": "string",
  "from_user_id": "string",
  "id": "string",
  "reference": "string",
  "status": "string",
  "to_user": "string",
  "to_user_id": "string"
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Historial de transacciones de usuario #

Devuelve una lista con el historial de transacciones de pago recibidas por un usuario específico dentro del ecosistema enviando el id del usuario a consultar como campo requerido para obtener los detalles de las operaciones registradas.

Ejemplo

GET /transaction-history

https://www.api.sandbox-middleware.leancore.co/transaction-history?user-id=708cb291-b3b2-4af9-aadc-e9ee1faeb2c9

Resultado

[
  {
    "amount": 0,
    "date": "string",
    "details": {},
    "from_user": "string",
    "from_user_id": "string",
    "id": "string",
    "reference": "string",
    "status": "string",
    "to_user": "string",
    "to_user_id": "string"
  }
]

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Consultar pagos recibidos por usuario #

Devuelve una lista de transacciones y detalles de pagos recibidos por un usuario específico dentro del ecosistema enviando el id del usuario a consultar como campo requerido para obtener los detalles de las operaciones registradas.

Ejemplo

GET /received-payments

https://www.api.sandbox-middleware.leancore.co/received-payments?user-id=6c9fbb96-9bae-4617-8cf1-0430b5196d89

Resultado

[
  {
    "amount": 0,
    "date": "string",
    "details": {
      "detail1": "string"
    },
    "from_user": "string",
    "from_user_id": "string",
    "id": "string",
    "reference": "string",
    "status": "string",
    "to_user": "string",
    "to_user_id": "string"
  }
]

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Consultar resumen de transacciones #

Devuelve una lista con el resúmen de transacciones generadas por un usuario específico dentro del ecosistema enviando el id del usuario a consultar como campo requerido para obtener los registros relacionados.

Ejemplo

GET /transaction-summary

https://www.api.sandbox-middleware.leancore.co/transaction-summary?user-id=708cb291-b3b2-4af9-aadc-e9ee1faeb2c9

Resultado

[
  {
    "_id": "string",
    "to_user": "string",
    "total_amount": "string",
    "transactions": {}
  }
]

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Consultar transacción por referencia #

Devuelve un objeto con la información relacionada a una transacción de pago generada por dos usuarios dentro del ecosistema enviando la referencia de pago como campo requerido para obtener los detalles de la operación.

Ejemplo

GET /find-transaction-by-reference

https://www.api.sandbox-middleware.leancore.co/find-transaction-by-reference?reference=tx_3b0b75b1-60bf-4325-b0cf-d2788266ae59

Resultado

{
  "amount": 0,
  "date": "string",
  "details": {
    "detail1": "string"
  },
  "from_user": "string",
  "from_user_id": "string",
  "id": "string",
  "reference": "string",
  "status": "string",
  "to_user": "string",
  "to_user_id": "string"
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Crear QR de transacción #

Permite crear una transacción de pago a través de código qr entre dos usuarios existentes del ecosistema, definiendo los detalles del usuario pagador y receptor de la operación, además de los detalles a registrar en la transacción a ser generada. Devuelve un objeto con los recursos necesarios para registrarla operación de pago.

Ejemplo

POST /create-transaction-qr

{
  "amount": 0,
  "date": "string",
  "details": {
    "detail1": "string"
  },
  "from_user": "string",
  "from_user_id": "string",
  "status": "string",
  "to_user": "string",
  "to_user_id": "string"
}

Resultado (Ejemplo)

image

Crear transacción de ledger #

Crea una nueva transferencia de saldo entre usuarios, esta operación es aprobada o rechazada de forma automática de acuerdo a la disponibilidad de saldo del usuario emisor de la transacción. Retorna un objeto con los detalles y estado de la ejecución.

Ejemplo

POST /create-ledger-transaction

{
  "from_user_id": "string",
  "to_user_id": "string",
  "amount": "int",
  "date": "string",
  "details": {
    "your_detail": "string"
  }
}

Resultado

[
  {
    "from_user_id": "string",
    "to_user_id": "string",
    "amount": "int",
    "date": "string",
    "details": {
      "your_detail": "string"
    }
  }
]

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Consultar historial de transacciones ledger #

Devuelve una lista con el total de transacciones recibidas y generadas por un cliente a través de su identificador como parámetro de consulta.

Ejemplo

GET /ledger-transaction-history

https://www.api.sandbox-middleware.leancore.co/ledger-transaction-history?user-id=<USER_ID>

Resultado

[
  {
    "from_user_id": "string",
    "to_user_id": "string",
    "amount": "int",
    "date": "string",
    "details": {
      "your_detail": "string"
    }
  }
]

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>