Ir al contenido

What you sold in a period and its fee

GET/treasury/volumeProbar
Parámetros de consulta

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
/treasury/volume
curl --request GET \
--url http://localhost:3000/v1/treasury/volume \
--header 'x-api-key: <x-api-key>'

Scope treasury:read. For those who sell at their own rate. It is what you are billed, so every figure comes from adding up lines:

  • It counts the payments settled in the period; one that fails doesn’t count.
  • Each payment is worth what you sold: the exact USDT of its quote (base: sale). A payment without conversion (Bs → Bs) is worth what those Bs cost you (base: cost).
  • Each payment pays the fee % in force when it settled. If the % changed in the period there is one tier per % (tiers) and feeUsd is their sum. A fee change never moves a period already reported. Your % depends on your commercial agreement and your volume: see GET /treasury/volume-fee.
  • A bank return subtracts in the period it happens, at the % it paid.
  • USD are added up exactly (6 decimals) and each tier’s fee is rounded once, to the cent: round(volumeUsd × feeBps / 10000).

Without from/to: the last full week, Monday to Sunday in Venezuelan time.

from
string format: date

AAAA-MM-DD, hora de Venezuela

to
string format: date

AAAA-MM-DD, incluido

Ventas y fee del período

Media typeapplication/json
object
tenantId
string format: uuid
from
string format: date
to
string format: date
timeZone
string
paymentCount

Pagos liquidados en el período

integer
returnCount

Devoluciones del banco en el período

integer
volumeBs

Bs entregados en minor units, devoluciones restadas

string
volumeUsd

USD exactos (6 decimales): suma de lines[].amountUsd

string
paymentsWithoutUsdValue

Pagos sin valoración en USD (anteriores a la cuenta propia)

integer
volumeFeeBps

El % vigente HOY. El del período está en tiers

integer
nullable
feeUsd

Suma de tiers[].feeUsd. null si nada tiene fee acordado

string
nullable
tiers
Array<object>
object
feeBps
integer
nullable
paymentCount
integer
volumeUsd
string
feeUsd
string
nullable
networkFeeBs

Lo que la red de pago descontó de tu cuenta en el período, en céntimos de Bs. No es un cobro nuestro. En el sandbox la comisión simulada de la red es 0,3 %; en real la fija la red de pago y te llega en este reporte

string
networkFeeUsd

La misma comisión en USD (2 decimales), a la tasa de cada pago

string
lines
Array<object>
object
paymentId
string format: uuid
type
string
Allowed values: payment return
date
string format: date-time
amountBs

Negativo en una devolución

string
base
string
Allowed values: sale cost
asset
string
amountUsd

Exacto; negativo en una devolución

string
nullable
rate

Bs por 1 unidad: tu tasa de venta, o tu costo si no hubo venta

string
nullable
feeBps
integer
nullable
Examples
ExamplesemanaConCambioDeFee

Ejemplo: el fee cambió a mitad de semana (los % son de ejemplo; el tuyo depende de tu acuerdo)

{
"from": "2026-10-12",
"to": "2026-10-18",
"timeZone": "America/Caracas",
"paymentCount": 6,
"returnCount": 1,
"volumeBs": "26228434",
"volumeUsd": "259.599815",
"volumeFeeBps": 100,
"feeUsd": "2.97",
"tiers": [
{
"feeBps": 125,
"paymentCount": 3,
"volumeUsd": "149.662881",
"feeUsd": "1.87"
},
{
"feeBps": 100,
"paymentCount": 4,
"volumeUsd": "109.936934",
"feeUsd": "1.10"
}
],
"networkFeeBs": "87018",
"networkFeeUsd": "0.86",
"lines": [
{
"paymentId": "1b6e0f5a-3c2d-4e8f-9a1b-7c6d5e4f3a21",
"type": "payment",
"date": "2026-10-14T14:20:11.000Z",
"amountBs": "123435",
"base": "sale",
"asset": "USDT",
"amountUsd": "1.221524",
"rate": "1010.5",
"feeBps": 125
}
]
}

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"
}
}