Transacciones

Grupo de servicios para ver una transacción, consultar saldos, crear una nueva transacción y más.

Servicio que devuelve los saldos disponibles en la cuenta

POST /api/v1/commerces/getBusiness

Request Body

Name	Type	Description
data*	Object	Campo data

200: OK Respuesta exitosa

{
  "statusCode":200,
  "message": "Exitoso",
  "data": { 
    "Business": {
      "balance":12000,
      "profits":2300
    }
  },
  "_channel": "web"
}

Servicio que devuelve toda la información de una transacción

POST /api/v1/transactions/find

Este servicio devuelve información de una transacción si esta fue efectuada en los últimos dos días.

Request Body

Name	Type	Description
data*	Object
_id	String	Id del cliente (el mismo que se envió en la venta)

200: OK Repuesta satisfactoria

{
  "statusCode":200,
  "message": "Exitoso",
  "data": {
    "Transaction": {
      "id": 1,
      "amount": 5000,
      "currency": "COP",
      "costs": 0,
      "prevBalance": 30000,
      "newBalance": 25000,
      "createdAt": "DD/MM/YY HH:mm",
      "Product": {
        "id": 1,
        "name": "Exitoso",
      },
      "TransactionStatus": {
        "id": 1,
        "name": "Exitoso",
        "color": "red"
      },
      "Person": {
        "document": "",
        "cellphone": ""
      },
      "PaymentMethod": {
          "id": 1,
          "image": "",
          "name": "Saldo"
        }
      }
    },
  "_channel": "web"
}

404: Not Found Transacción no encontrada

{
  "errorMessage": "Transacción no encontrada"
  "path": "/api/v1/transactions/get",
  "date": 123123123,
  "errorCode": "transaction.notFound"
}

Estados de una transacción

Estado	Codigo
Pendiente	1
Aprobada	2
Rechazada	3
Procesando	4
Pago parcial	5

Vender un producto

Servicio que sirve para originar una venta

POST /api/v1/transactions/sell

Request Body

Name	Type	Description
data.productId	String	ID del producto
data.*	String	Campos adicionales que requiera el producto \ \ pueden ser consultados aquí Servicio que permite obtener toda la información a detalle de un producto
_channel	string	Siempre enviar WS
_version	String	Enviar versión del API
_id	String	Id del cliente (para conciliar)

200: OK Venta exitosa

{
  "message": "Exitoso",
  "_channel": "WS",
  "statusCode": 200,
  "data": {
    "transactionId": "5d2fa66e-4c73-4f86-b698-6bd5fd5284b1"
  }
}

400: Bad Request Error en la venta

{
  "path":"/sell",
  "date":1671479625960,
  "errorCode":"provider.error",
  "message":"Número no es del operador"
}

Consultar / Cotizar

Servicio que permite cotizar y obtener el valor de la venta

POST /api/v1/transactions/query

Se recomienda siempre consumir este servicio, así el producto no requiera una consulta previa

Request Body

Name	Type	Description
data.productId*	String	ID del producto
data.*	String	Campos adicionales que requiera el producto \ \ pueden ser consultados aquí Servicio que permite obtener toda la información a detalle de un producto
_channel	String	Siempre enviar WS
_version	String	Enviar versión del API