Developer Docs

Español

English

Español

English

Apariencia

Lista de operaciones​

GET
/flow/v1/operations

Lista las operaciones individuales dentro de los flujos. Se usa para conciliación operativa, trabajo de backoffice y seguimiento de cobros.

Paginado. Admite filtrado por UUID de operación, externalId, UUID del flujo padre, estado, tipo, ID externo de factura, rango de importe y rangos de fechas. Los resultados pueden ordenarse por createdAt, statusUpdatedAt, status, flowUuid, operationUuid, externalId, paymentAmount o invoiceExternalId.

Autorizaciones​

OAuth2

Esquema de seguridad OAuth2

clientCredentials Flow
Token URL"/api/v2/auth/token"
Scopes:
  • "zertiban-api"Access to the API

Parámetros​

Header Parameters

x-tenant-id*

Identificador del tenant que contiene el UUID del negocio

Tipo
string
Requerido

Query Parameters

limit

Tamaño de página

Tipo
integer
Mínimo
0
Máximo
100
Por defecto
10
offset

Desplazamiento (offset) desde cero

Tipo
integer
Mínimo
0
Por defecto
0
sort_by

Indica la propiedad por la que ordenar la lista de resultados (no distingue mayúsculas/minúsculas)

Tipo
string
Valores válidos
"operationUuid""externalId""status""flowUuid""createdAt""statusUpdatedAt""paymentAmount""invoiceExternalId"
Por defecto
"createdAt"
sort_dir

Indica el sentido de la ordenación (no distingue mayúsculas/minúsculas)

Tipo
string
Valores válidos
"ASC""DESC"
Por defecto
"DESC"
q_operationUuid

Filtra operaciones por UUID (coincidencia exacta)

Tipo
string
Ejemplo"f47ac10b-58cc-4372-a567-0e02b2c3d479"
Formato
"uuid"
q_externalId

Filtra operaciones por ID externo (coincidencia exacta)

Tipo
string
Ejemplo"EXT-2025-0001"
q_flowUuid

Filtra operaciones por UUID del flujo (coincidencia exacta)

Tipo
string
Ejemplo"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Formato
"uuid"
q_status

Filtra operaciones por estado (no distingue mayúsculas/minúsculas). Admite 0, 1 o N valores separados por comas.

Tipo
array
Ejemplo"OPENED""CREATED"
q_type

Filtra operaciones por tipo (no distingue mayúsculas/minúsculas). Admite 0, 1 o N valores separados por comas.

Tipo
array
Ejemplo"PAYMENT""SIGNATURE"
q_fromCreatedAt

Busca operaciones cuyo 'createdAt' sea posterior o igual a la fecha-hora indicada

Tipo
string
Ejemplo"2025-03-10T14:23:45Z"
Formato
"ISO 8601"
q_toCreatedAt

Busca operaciones cuyo 'createdAt' sea anterior o igual a la fecha-hora indicada

Tipo
string
Ejemplo"2025-03-10T14:23:45Z"
Formato
"ISO 8601"
q_fromStatusUpdatedAt

Busca operaciones cuyo 'statusUpdatedAt' sea posterior o igual a la fecha-hora indicada

Tipo
string
Ejemplo"2025-03-10T14:23:45Z"
Formato
"ISO 8601"
q_toStatusUpdatedAt

Busca operaciones cuyo 'statusUpdatedAt' sea anterior o igual a la fecha-hora indicada

Tipo
string
Ejemplo"2025-03-10T14:23:45Z"
Formato
"ISO 8601"
q_amountFrom

Filtra operaciones PAYMENT cuyo importe sea mayor o igual que este valor

Tipo
number
Ejemplo1000
q_amountTo

Filtra operaciones PAYMENT cuyo importe sea menor o igual que este valor

Tipo
number
Ejemplo5000
q_invoiceExternalId

Filtra operaciones PAYMENT por ID externo de la factura (coincidencia exacta)

Tipo
string
Ejemplo"INV-2025-0012"

Respuestas​

Lista de operaciones

application/json
JSON
{
  
"total": 2,
  
"results": [
  
  
{
  
  
  
"uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  
  
  
"externalId": "EXT-2025-0001",
  
  
  
"flowUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  
  
  
"type": "PAYMENT",
  
  
  
"status": "OPENED",
  
  
  
"createdAt": "2025-09-15T09:00:00Z",
  
  
  
"statusUpdatedAt": "2025-09-15T09:55:00Z",
  
  
  
"payment": {
  
  
  
  
"amount": 2500,
  
  
  
  
"currency": "EUR"
  
  
  
},
  
  
  
"invoice": {
  
  
  
  
"externalId": "INV-2025-0001",
  
  
  
  
"dueDate": "2025-10-15T00:00:00Z"
  
  
  
}
  
  
},
  
  
{
  
  
  
"uuid": "a2b3c4d5-e6f7-8901-2345-67890abcdef0",
  
  
  
"externalId": null,
  
  
  
"flowUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  
  
  
"type": "SIGNATURE",
  
  
  
"status": "CREATED",
  
  
  
"createdAt": "2025-09-16T08:22:00Z",
  
  
  
"statusUpdatedAt": null,
  
  
  
"payment": null,
  
  
  
"invoice": null
  
  
}
  
]
}

Playground​

Autorización
Headers
Variables
Key
Value

Ejemplos​