Skip to main content
POST
Durably accept an ordered FinanceKit publisher batch

Authorizations

Authorization
string
header
required

Revocable credential restricted to one FinanceKit publisher upload URL.

Headers

Authorization
string
required
Idempotency-Key
string<uuid>
X-Sure-Payload-SHA256
string
Pattern: ^[0-9a-f]{64}$

Path Parameters

publisher_id
string<uuid>
required

Body

application/json

Immutable ordered publisher batch. sequence 1 omits predecessor_digest; later batches carry the SHA-256 digest of the preceding payload. Omission never deletes data.

protocol_version
enum<integer>
required
Available options:
2
connection_id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
publisher_id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
generation
integer
required
Required range: x >= 1
stream_id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
batch_id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
sequence
integer
required
Required range: x >= 1
capture_id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
chunk_index
integer
required
Required range: x >= 0
chunk_count
integer
required
Required range: 1 <= x <= 100
capture_mode
enum<string>
required
Available options:
snapshot,
delta
snapshot_complete
boolean
required
captured_at
string<date-time>
required
selected_source_account_ids
string<uuid>[]
required
Required array length: 1 - 20 elements
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
events
object[]
required
Maximum array length: 500
predecessor_digest
string
Pattern: ^[0-9a-f]{64}$

Response

Immutable bytes accepted into the inbox

connection_id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
publisher_id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
generation
integer
required
stream_id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
batch_id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
sequence
integer
required
payload_digest
string
required
Pattern: ^[0-9a-f]{64}$
status
enum<string>
required
Available options:
accepted,
processing,
applied,
failed,
revoked
accepted_at
string<date-time>
required
applied_at
string<date-time> | null
required
error_code
string | null
required