Saltar al contenido
Developer Docs

Crear flujo

POST
/flow/v1/flows

Crea un nuevo flujo de cobro que agrupa una o varias operaciones y devuelve de inmediato las URL de pago. El punto de entrada principal para iniciar cobros de Open Banking de forma síncrona.

Debe enviarse como multipart/form-data. La parte payload contiene el cuerpo JSON y debe usar Content-Type: application/json — de lo contrario el servidor devuelve 400. Las partes adicionales suben documentos binarios (normalmente PDF) cuyos nombres de parte deben coincidir con documents[].id en el payload. La respuesta devuelve el nuevo flowUuid y, por cada operación que genera un enlace, la URL para entregar al usuario final.

Autorizaciones

OAuth2

Esquema de seguridad OAuth2

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

Parámetros

Header Parameters

x-tenant-id*

UUID de la organización propietaria del flujo

Tipo
string
Requerido
Formato
"uuid"

Cuerpo de la petición

multipart/form-data

Payload para crear un nuevo flujo. Se envía como la parte payload del cuerpo multipart/form-data; cualquier
documento binario adjunto a operaciones viaja como partes adicionales cuyos nombres coinciden con
documents[].id.

Contenido binario de un documento referenciado desde el payload. El nombre de la parte multipart
(aquí first-file) debe coincidir exactamente con el id de una entrada de documents[] para que
el binario quede vinculado a ese documento y a las operaciones que lo referencian.

Formato"binary"

Respuestas

Creado

application/json
JSON
{
  
"uuid": "28ffd216-5ee8-4e99-b1a9-511961e9c655",
  
"externalId": "my-flow-external-id",
  
"operations": [
  
  
{
  
  
  
"uuid": "d1faff9e-bb8b-47bd-8b47-4f20f1a7912b",
  
  
  
"externalId": "my-operation-external-id",
  
  
  
"id": "first-operation",
  
  
  
"url": "https://zertiban.com/5f775b41-fbb5-45f3-a8eb-389e963374cf/b3945835-2a2b-40ad-9c5f-35faf141eb54",
  
  
  
"payment": {
  
  
  
  
"types": [
  
  
  
  
  
[
  
  
  
  
  
  
"PSD2_PAYMENT"
  
  
  
  
  
]
  
  
  
  
],
  
  
  
  
"psd2Payment": {
  
  
  
  
  
"creditorAccount": {
  
  
  
  
  
  
"uuid": "94ba8750-b772-4ca1-91b0-1c8a658a6175"
  
  
  
  
  
}
  
  
  
  
}
  
  
  
}
  
  
}
  
]
}

Playground

Servidor
Autorización
Headers
Cuerpo

Ejemplos