onzodocs
DocumentationAPI Reference
onzo.laRequest access
Treasury & Ledger

Returns

Payments come back. Returns are first-class objects with their own lifecycle.

A return (oz_ret_) is created when the receiving side sends funds back after settlement — wrong account details, closed account, or beneficiary rejection.

Lifecycle

Event Meaning
return.created The receiving institution initiated a return
return.settled Returned funds have landed back in your account
return.returned The return itself failed and bounced — rare, but real; handle it

json Return object { "id": "oz_ret_4e7a90", "payment": "oz_pay_8f2c41", "reason": "returned_by_beneficiary_bank", "amount": { "value": "48500.00", "currency": "USD" }, "status": "settled" }

Every return references its original payment — your reconciliation closes the loop automatically in Ledger. Before retrying a returned payment, verify the counterparty account data; consider pre-payment verification to prevent returns entirely.