Sign in

v1

latestOpenAPI 3.1.02026-07-13143194365.4 KB
onramp

Record settled onramp amount for exact SA transfer

Record the exact settled amount from a completed Coinbase onramp purchase.

Called by the frontend after the user completes the Coinbase onramp UI and the settled crypto amount is known. This transitions the onramp event from pending to confirmed, making it available for the SA→tipping transfer step.

Idempotent: If the event is already consumed, returns current state without error.

Error codes:

  • 400: Invalid settled_amount format or not positive
  • 404: Event not found or doesn't belong to authenticated account
  • 409: Event is stale, or has a conflicting coinbase_transaction_id
post/v1/onramp/settled

Headers

authorizationstring nullable

Bearer JWT issued by Grove.

Bearer JWT issued by Grove.

Request body

event_idstring required

Onramp event ID returned by /v1/onramp/url

settled_amountstring required

Settled USDC amount from Coinbase onramp flow

coinbase_transaction_idstring nullable

Optional Coinbase transaction ID for idempotency/correlation

Response

Successful Response

event_idstring required

Onramp event ID

statusstring required

Event status

settled_amountstring nullable

Settled amount in token units

consumedboolean required

Whether this event has already been consumed by transfer-complete

lifecycle_statestring nullable

Structured lifecycle state: awaiting_coinbase_completion, settlement_detected, transfer_submitted, needs_attention