Saltar al contenido principal
Version: v2.0 (RESTful)

Historial de Movimientos

Este endpoint devuelve un listado estructurado y paginado de todas las transacciones financieras asociadas al saldo de tu comercio (ingresos por QR y egresos por transferencias).

Petición

  • Endpoint: /api/v2/balance/movements
  • Método: GET

Headers Requeridos

HeaderValorDescripción
X-API-KEY<TU_API_KEY>Tu llave de integración API Key.
Acceptapplication/json

Query Parameters

ParámetroTipoDescripción
pageintegerNúmero de página para la paginación. Por defecto es 1.
typestringFiltra los movimientos por tipo. Opciones: payment (Cobros), transfer (Transferencias), all (Todos). Por defecto es all.

Ejemplo de Petición

GET /api/v2/balance/movements?page=1&type=all
X-API-KEY: <TU_API_KEY>
Accept: application/json

Respuesta

El endpoint devuelve los datos anidados bajo la llave data y la información de paginación bajo la llave meta.

Ejemplo de Respuesta (HTTP 200 OK)

{
"data": [
{
"id": 894,
"type": "payment",
"amount": 50.00,
"currency": "BOB",
"status": "COMPLETED",
"reference": "Cobro de Pedido #1234",
"date": "2026-05-15T14:30:00Z",
"details": {
"source_bank": "BCP",
"account_number": "******-4",
"account_titular": "María López"
}
},
{
"id": 123,
"type": "transfer",
"amount": -1500.00,
"currency": "BOB",
"status": "IN_TRANSIT",
"reference": "Pago a Proveedor Factura 001",
"date": "2026-05-15T14:15:00Z",
"destination": {
"type": "bank_account",
"bank_code": 1,
"account_number": "******-7",
"account_titular": "Juan Pérez"
}
}
],
"meta": {
"current_page": 1,
"last_page": 5,
"per_page": 15,
"total": 75
}
}

Explicación de los Atributos (data)

  • type: Identifica el tipo de transacción. Puede ser payment (un cobro positivo que suma a tu saldo) o transfer (un retiro negativo que descuenta de tu saldo).
  • amount: El monto numérico absoluto. Los egresos (transfer) siempre tendrán el símbolo negativo -.
  • status: Estado de la transacción (ej. COMPLETED, IN_TRANSIT, PENDING).
  • details / destination: Objetos polimórficos con metadatos útiles. En ingresos (payments) aparecerá details (ej. banco origen), y en egresos (transfers) aparecerá el objeto completo de destination.