Transacciones

Obtener métricas

GET /v1/dashboard

Este endpoint devuelve las métricas de las operaciones realizadas en un período: cantidades, montos por moneda, marcas de tarjeta y métodos de pago. Disponible con credenciales CUSTOMER y MERCHANT.

Datos de consulta

ParámetrosDescripción
start
  • date
  • La fecha de inicio del período. Requiere offset: Z o, por ejemplo, -03:00
  • [yyyy-MM-ddTHH:mm:ssXXX]
end
  • date
  • La fecha de fin del período. Requiere offset, igual que start
  • [yyyy-MM-ddTHH:mm:ssXXX]
merchantId
  • (opcional)
  • array
  • Identificadores (UUID) de comercio para acotar la búsqueda
ℹ️
  • NET_TOTAL es el total bruto (GROSS_TOTAL) menos las operaciones canceladas (CANCELLED).
  • AVERAGE es el monto neto dividido por la cantidad neta de operaciones.

Datos de respuesta

ParámetrosDescripción
active_users
  • (opcional)
  • object
  • Comercios activos en el período. Se omite con credenciales MERCHANT
  • active_users.
merchants
  • integer
  • Cantidad de comercios activos
  • active_users.
reference_amount
  • object
  • Montos de referencia
transaction_stats
  • object
  • Métricas de las operaciones del período
  • transaction_stats.
transactions_count
  • list
  • Cantidad de operaciones. Cada elemento tiene name y value (número)
  • [GROSS_TOTAL, NET_TOTAL, CANCELLED]
  • transaction_stats.
revenue
  • list
  • Montos de las operaciones. Cada elemento tiene name y value, un objeto con un monto por moneda
  • [GROSS_TOTAL, NET_TOTAL, CANCELLED, AVERAGE]
  • transaction_stats.
card_brand
  • list
  • Cantidad de operaciones por marca de tarjeta. Cada elemento tiene name y value (número)
  • [VISA, MASTERCARD, AMEX, OTHER]
  • transaction_stats.
payment_method
  • list
  • Cantidad de operaciones por método de pago. Cada elemento tiene name y value (número)
  • [DEBIT, CREDIT, QR, PREPAID, OTHER]
  • transaction_stats.
acceptance_rate
  • list
  • Cantidad de operaciones por resultado. Cada elemento tiene name y value (número). Con credenciales CUSTOMER y MERCHANT los valores son 0
  • [APPROVED, FAILED, REJECTED]
  curl --request GET \
    --url 'https://api.menta.global/api/v1/dashboard' \
    --header 'Authorization: Bearer {access_token}' \
    --url-query 'start=string' \
    --url-query 'end=string'
  {
    "active_users": {
      "merchants": 0,
      "reference_amount": {}
    },
    "transaction_stats": {
      "transactions_count": [
        { "name": "GROSS_TOTAL", "value": 0 },
        { "name": "NET_TOTAL", "value": 0 },
        { "name": "CANCELLED", "value": 0 }
      ],
      "revenue": [
        { "name": "GROSS_TOTAL", "value": { "ARS": 0 } },
        { "name": "NET_TOTAL", "value": { "ARS": 0 } },
        { "name": "CANCELLED", "value": { "ARS": 0 } },
        { "name": "AVERAGE", "value": { "ARS": 0 } }
      ],
      "card_brand": [
        { "name": "VISA", "value": 0 }
      ],
      "payment_type": [],
      "payment_method": [
        { "name": "CREDIT", "value": 0 }
      ],
      "acceptance_rate": [
        { "name": "APPROVED", "value": 0 },
        { "name": "FAILED", "value": 0 },
        { "name": "REJECTED", "value": 0 }
      ]
    }
  }