onzodocs
DocumentationAPI Reference
onzo.laRequest access
Getting started

Core concepts

The objects you work with on Onzo — payments, accounts, screening decisions, and corridors.

Every object on the Onzo platform carries the oz_ prefix. IDs are stable, unique, and safe to store.

Object Prefix Description
Payment oz_pay_ A single cross-border transaction, ISO 20022 native, traceable end to end
Account oz_acct_ A settlement or treasury account in a given market and currency
Screening decision oz_scr_ The Sirius Core decision attached to every payment — cleared, held, or declined
Quote oz_quote_ An FX quote — indicative for display, persisted for execution
Expected payment oz_exp_ A declared incoming payment, auto-matched on arrival for reconciliation
Return oz_ret_ A payment returned by the receiving side, with its own lifecycle

Payments

A payment moves value from one counterparty to another across a corridor. Every payment requires complete counterparty and remittance data at creation — there is no partial submission. This is what makes each payment screenable before settlement and auditable after it.

Screening decisions

Every payment gets exactly one screening decision from Sirius Core before funds move. The decision — and the reasons behind it — are first-class API objects you can retrieve, display, and audit. See Screening decisions.

Corridors and capabilities

Corridors are enabled per account. Retrieve your capabilities to see which corridors, currencies, and products your account can use — your integration can discover its own scope at runtime instead of hardcoding it.

Quotes

FX quotes come in two forms: indicative (for display, not guaranteed) and persisted (locked for execution within a validity window). Settlement always executes against a persisted quote — fx locked at execution is a property of the system, not a promise.