Create flow

POST

/flow/v1/flows

Creates a new collection flow that groups one or more operations and immediately returns the payment URLs. The main entry point for starting Open Banking collections synchronously.

Must be sent as multipart/form-data. The payload part carries the JSON body and must use Content-Type: application/json — otherwise the server returns 400. Additional parts upload binary documents (typically PDFs) whose part names must match documents[].id in the payload. The response returns the new flowUuid and, for each operation that generates a link, the URL to deliver to the end user.

Authorizations

OAuth2

OAuth2 security scheme

clientCredentials Flow

Token URL"/api/v2/auth/token"

Scopes:

• "zertiban-api"Access to the API

Parameters

Header Parameters

x-tenant-id*

UUID of the business that owns the flow

Type

string

Required

Format

"uuid"

Request Body

multipart/form-data

object

object

Payload to create a new flow. Sent as the payload part of the multipart/form-data body; any
binary documents attached to operations travel as additional parts whose names match
documents[].id.

Binary content of a document referenced from the payload. The multipart part name
(here first-file) must exactly match the id of an entry in documents[] so that
the binary is linked to that document and to the operations that reference it.

Format"binary"