Payout metrics by day

GET/payments/metricsProbar

URL base

API key x-api-keyRecordar la clave en este navegador (localStorage, no sale de aquí)

Parámetros de consulta

fromstringDesde este día, INCLUSIVE (hora de Venezuela).tostringHasta este día, INCLUSIVE. Por defecto, hoy.groupBydaySólo `day` por ahora.

Enviar peticiónCopiar como curl

La llamada la hace tu navegador, contra el servidor que elijas arriba. Si la documentación no está servida desde el mismo origen que la API, el navegador puede bloquear la respuesta por CORS: en ese caso abre estas páginas desde la propia API (/docs) o usa el curl de arriba.

GET

/payments/metrics

curl --request GET \
  --url 'http://localhost:3000/v1/payments/metrics?from=2026-10-01&to=2026-10-19&groupBy=day' \
  --header 'x-api-key: <x-api-key>'

• Pruebas (sandbox)
• Producción

Scope payments:read. Aggregates of your payouts by day and by asset: count and amount by status, success rate, fee charged and median time to settled. Figures only: no beneficiary, account or reference.

Unlike the statement, days are counted by created_at in Venezuelan time (America/Caracas): a failed payout also counts on the day you requested it. Maximum range: 92 days. Without from or to, the last 30 days up to today.

Amounts in minor units, as strings. successRate is settled / (settled + failed) with 4 decimals; null if there were neither.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

from

string format: date

Example

2026-10-01

Desde este día, INCLUSIVE (hora de Venezuela).

to

string format: date

Example

2026-10-19

Hasta este día, INCLUSIVE. Por defecto, hoy.

groupBy

string

default: day

Allowed values: day

Sólo day por ahora.

Responses

200

Agregados por día y activo

Media typeapplication/json

object

from

string format: date

to

string format: date

groupBy

string

Allowed values: day

timeZone

string

data

Array<object>

object

date

string format: date

asset

Decimales: BS y USD 2; USDT y USDC 6 (1000000 = 1 USDT).

string

Allowed values: BS USD USDT USDC VESC

total

object

count

integer

amount

string

byStatus

Siempre trae settled, failed, unknown y submitted; otros estados, si los hubo.

object

key

additional properties

object

count

integer

amount

string

successRate

string

nullable

fee

Comisión cobrada, minor units. 0 en los compensados

string

medianSecondsToSettled

integer

nullable

Example

{
  "from": "2026-10-18",
  "to": "2026-10-19",
  "groupBy": "day",
  "timeZone": "America/Caracas",
  "data": [
    {
      "date": "2026-10-18",
      "asset": "BS",
      "total": {
        "count": 41,
        "amount": "205000000"
      },
      "byStatus": {
        "settled": {
          "count": 39,
          "amount": "195000000"
        },
        "failed": {
          "count": 1,
          "amount": "5000000"
        },
        "unknown": {
          "count": 0,
          "amount": "0"
        },
        "submitted": {
          "count": 1,
          "amount": "5000000"
        }
      },
      "successRate": "0.9750",
      "fee": "1950000",
      "medianSecondsToSettled": 142
    }
  ]
}

400

Error con código estable

Media typeapplication/json

object

error

object

meta

Contexto estructurado del error cuando lo hay: qué límite se superó y de cuánto, qué campo es inválido, cuánto saldo había. No aparece en errores internos.

object

key

additional properties

any

type

string

Allowed values: invalid_request_error authentication_error rate_limit_error upstream_error api_error

code

Código ESTABLE. Programa contra esto.

string

message

string

request_id

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "insufficient_balance",
    "request_id": "req_8a0312ba896772bc441134cd"
  }
}