OnrampOperations
Cancellation
POST /v1/conversions/:id/cancel. Valid only in awaiting_deposit. Releases reserve and lock.
POST /v1/conversions/:id/cancel ends a conversion before the Pix payment arrives. It is the clean exit from awaiting_deposit.
When it is valid
Only in status='awaiting_deposit'. In any other state, the call fails with a validation error.
What the call does
- Transitions the conversion to
canceled(terminal). - Releases the limit reservation for the end customer.
- Releases the
(user_id, transaction_type)lock. The end customer is free to start a new onramp conversion.
The response is the updated conversion.
What the call does not do
- Does not recover paid Pix. If the end customer paid (even during the cancel call), the conversion has already transitioned to
funded, andcancelis no longer valid. - Does not invalidate the Pix QR immediately if the window is still open at the provider. Recommend the end customer not pay while the UX confirms the cancellation.
When to use
Cancel when the end customer gave up before paying, or when you need to force a reset (e.g., the end customer closed the app and wants to start over).
Reference coming soon
Detailed documentation will appear here alongside API availability. For the conceptual design, see Conversion.
