Sign in

v1

latestOpenAPI 3.1.02026-07-13143194365.4 KB
onramp

Check whether there is an open onramp event awaiting transfer

Check if the authenticated user has an open (unconsumed) onramp event.

The frontend polls this endpoint after the user returns from the Coinbase onramp UI to determine whether a SA→tipping transfer is needed.

Parameters:

  • event_id (optional): When provided, returns only the specified event (event-scoped). When omitted, falls back to the latest open event for the account.

Response:

  • pending=true with event details when there is an actionable event
  • pending=false when no open events exist

Polling pattern: Frontend polls every ~5 seconds after onramp redirect return.

get/v1/onramp/pending-transfer

Query parameters

event_idstring nullable

Specific onramp event ID to check. When omitted, returns the latest open event.

Specific onramp event ID to check. When omitted, returns the latest open event.

Headers

authorizationstring nullable

Bearer JWT issued by Grove.

Bearer JWT issued by Grove.

Response

Successful Response

pendingboolean required

Whether there is an open onramp event

event_idstring nullable

Onramp event ID

statusstring nullable

Event status

settled_amountstring nullable

Settled amount to transfer from Smart Account

requested_amountstring nullable

Originally requested onramp amount

networkstring nullable

Network (e.g., base, base-sepolia)

tokenstring nullable

Token symbol (e.g., USDC)

created_atstring nullable

When event was created (ISO 8601)

consumedboolean

Whether this event was already consumed

lifecycle_statestring nullable

Structured lifecycle state: awaiting_coinbase_completion, settlement_detected, transfer_submitted, needs_attention