Developer Docs

Español

English

Español

English

Apariencia

Lista de flujos​

GET
/flow/v1/flows

Devuelve todos los flujos de cobro del negocio. Se usa principalmente para conciliación, generación de informes y supervisión general de los cobros.

Paginado. Admite filtros por UUID de flujo, externalId, estado, etiqueta de producto y rangos de fechas de creación/cambio de estado. Los resultados pueden ordenarse por createdAt, statusUpdatedAt, flowUuid, externalId o status.

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
"flowUuid""externalId""status""createdAt""statusUpdatedAt"
Formato
"string"
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"
Formato
"string"
Por defecto
"DESC"
q_fromStatusUpdatedAt

Busca flujos 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 flujos cuyo 'statusUpdatedAt' sea anterior o igual a la fecha-hora indicada

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

Busca flujos 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 flujos cuyo 'createdAt' sea anterior o igual a la fecha-hora indicada

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

Filtra flujos por UUID

Tipo
string
Ejemplo"12087dd4-336d-4c21-90e1-3dbd58f14f87"
Formato
"UUID v4"
q_externalId

Filtra flujos por ID externo

Tipo
string
Ejemplo"my-external-id"
q_productLabelValue

Recupera flujos que tengan una etiqueta con nombre "product" y el valor indicado. Admite varios separados por comas

Tipo
string
Ejemplo"whatever product label value"
q_status

Filtra flujos por estado. Admite varios separados por comas

Tipo
array
Ejemplo"CREATED""COMPLETED"

Respuestas​

Lista de flujos

application/json
JSON
{
  
"results": [
  
  
{
  
  
  
"uuid": "string",
  
  
  
"externalId": "FLW-99881",
  
  
  
"status": "CREATED",
  
  
  
"createdAt": "2025-03-10T14:23:45Z",
  
  
  
"statusUpdatedAt": "2025-03-10T14:23:45Z",
  
  
  
"labels": [
  
  
  
  
{
  
  
  
  
  
"name": "my-label",
  
  
  
  
  
"value": "my-label-value"
  
  
  
  
}
  
  
  
],
  
  
  
"operationsCount": 1
  
  
}
  
],
  
"total": 0
}

Playground​

Autorización
Headers
Variables
Key
Value

Ejemplos​