onzodocs
DocumentationAPI Reference
onzo.laRequest access
API Reference

Platform

Capabilities, quotes, and webhook endpoint management.

GET/v1/capabilitiesRetrieve capabilities

Returns the corridors, currencies, and products enabled for the authenticated account. Integrations should discover scope at runtime rather than hardcode it.

json Response { "corridors": [ { "id": "CL-US", "currencies": ["CLP", "USD"], "status": "active" }, { "id": "CL-MX", "currencies": ["CLP", "MXN"], "status": "active" }, { "id": "US-BR", "currencies": ["USD", "BRL"], "status": "pending_activation" } ], "products": ["rail", "ledger", "sirius"] }

POST/v1/quotesCreate a quote
Parameter Type Required Description
corridor string yes e.g. CL-US
amount object yes value, currency (either leg)
mode string yes indicative (display) or persisted (locked for execution)

Persisted quotes return expires_at. Settlement always executes against a persisted quote.

GET/v1/quotes/{id}Retrieve a quote
POST/v1/webhook_endpointsCreate a webhook endpoint
Parameter Type Required Description
url string yes HTTPS delivery URL
events array yes Event names, e.g. ["payment.held", "payment.settled"]

Returns the endpoint with its signing secret — shown once. Verify every delivery with the Onzo-Signature header.

POST/v1/webhook_endpoints/{id}/pingSend a test event
POST/v1/events/{id}/redeliverRedeliver an event

Events are retained for 30 days. See Webhooks for signatures and delivery guarantees.