GRgrove
onramp

Cancel a pending onramp event

Cancel the user's current open onramp event (pending or confirmed). Marks it as failed so the frontend stops polling. Used when the user abandons the Coinbase flow before completing the purchase.

Returns the cancelled event ID, or 404 if no open onramp exists.

post/v1/onramp/cancel

Request

  • Base URL
    https://api.grove.city (the document declares no server; this is the origin it was published from)
  • URL
    https://api.grove.city/v1/onramp/cancel
  • Auth
    none declared

Headers

authorizationstring nullable

Bearer JWT issued by Grove.

Response

Successful Response

cancelledboolean required

Whether the onramp was cancelled

event_idstring required

Cancelled onramp event ID

Changes

No recorded changes to this operation across all 1 revision of this API.