Métricas de los cobros recibidos

GET/bancos/bdv/metricasProbar

ServidorURL base

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

Parámetros de consultaperiodohoy | 7d | 30d

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

/bancos/bdv/metricas

const url = 'http://localhost:3000/v1/bancos/bdv/metricas?periodo=hoy';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:3000/v1/bancos/bdv/metricas?periodo=hoy' \
  --header 'x-api-key: <x-api-key>'

Scope bdv:read. Agregados de los pagos recibidos en tu cuenta BDV: cantidad, monto, ticket medio, por banco de origen y verificados frente a sin verificar. Sin datos del pagador.

Cada llamada consulta los movimientos de tu cuenta en el banco. Con una key sk_test_, salen del banco simulado.

Montos en bolívares con punto decimal ("125.50"), como el resto de los cobros BDV. El ticket medio se redondea hacia abajo.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

periodo

string

default: hoy

Allowed values: hoy 7d 30d

Responses

200

Agregados del periodo

application/json

object

periodo

string

Allowed values: hoy 7d 30d

cantidad

integer

monto

string

ticketMedio

string

nullable

porBanco

Array<object>

object

banco

string

bancoNombre

string

nullable

cantidad

integer

monto

string

verificados

object

cantidad

integer

monto

Bolívares con punto decimal

string

sinVerificar

object

cantidad

integer

monto

Bolívares con punto decimal

string

Example

{
  "periodo": "hoy",
  "cantidad": 3,
  "monto": "2125.50",
  "ticketMedio": "708.50",
  "porBanco": [
    {
      "banco": "0102",
      "bancoNombre": "Venezuela",
      "cantidad": 2,
      "monto": "2000.00"
    },
    {
      "banco": "0105",
      "bancoNombre": "Mercantil",
      "cantidad": 1,
      "monto": "125.50"
    }
  ],
  "verificados": {
    "cantidad": 1,
    "monto": "500.00"
  },
  "sinVerificar": {
    "cantidad": 2,
    "monto": "1625.50"
  }
}

400

Error con código estable

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

404

bank_credential_missing: no has registrado la llave de tu cuenta BDV

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

422

bank_credential_invalid: el banco rechazó tu llave

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

502

bank_unavailable: el banco no respondió

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