For AI agents: the documentation index is at /llms.txt, and this page is available as Markdown at /api/gateway/get-ramp.md.
Get ramp by ID
Returns the current state of a ramp
bearerAuthAuthorizationBearer <JWT>An access token from POST /v1/auth/api-key/token. An organization token lasts one hour and has no refresh token; a personal token can be refreshed.
id*stringRamp ID (UUID)
uuidTM-On-Behalf-Of?stringAct as one of your organization's users. The value is the user_id returned when the user was created; the request then reads and writes that user's account. Requires an organization token and a user your organization created: 400 for a personal token, a repeated header or a non-UUID, 403 for a user outside your organization. Not accepted on organization-scoped routes.
uuidRamp retrieved successfully
application/json- response
Canonical representation of a ramp, served from the Gateway's own record. The settlement fields are filled in as the ramp progresses, so they are absent on a freshly created ramp and present once it settles.
id*stringuuidpayment_method*RampPaymentMethodRail the ramp is funded or paid out through. DeFi routes the provider from it, so it is the caller's only choice of venue. APPLE_PAY and GOOGLE_PAY are onramp-only and require a channel.
"COINBASE""PAYPAL""APPLE_PAY""GOOGLE_PAY"direction*string"onramp""offramp"status*RampStatusRamp lifecycle: created until funds move, pending while the provider settles, then completed, failed, or expired if it was abandoned before any funds moved.
"created""pending""completed""failed""expired"amount*stringAmount requested at creation, in the settlement asset
chain*stringChain the ramp settles on
"solana""base""robinhood""hypercore-spot""hypercore-perp"asset_symbol?stringasset_amount?stringAmount actually settled
fiat_currency?stringfiat_amount?stringfee_amount?stringfee_currency?stringexchange_rate?stringwallet_address?stringAddress the ramp settles against
provider_wallet_address?stringProvider deposit address the offramp transfer sends to
tx_hash?stringredirect_url?stringfailure_reason?stringcreated_at*stringdate-timeupdated_at*stringdate-timecompleted_at?stringdate-timecurl -X GET 'https://api.truemarkets.co/v1/gateway/ramps/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'TM-On-Behalf-Of: 3f6d2c0e-8a41-4c2b-9f1e-2b7d5c0a9e11'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "payment_method": "COINBASE", "direction": "onramp", "status": "created", "amount": "string", "chain": "solana", "asset_symbol": "string", "asset_amount": "string", "fiat_currency": "string", "fiat_amount": "string", "fee_amount": "string", "fee_currency": "string", "exchange_rate": "string", "wallet_address": "string", "provider_wallet_address": "string", "tx_hash": "string", "redirect_url": "string", "failure_reason": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z"}Create a ramp POST
Creates an onramp that buys crypto with fiat, or an offramp that converts the user's stablecoin balance to fiat, through the given provider. The response's redirect_url is the provider page the user completes the ramp on.
Execute a ramp's bridge plan POST
Executes the bridge_plan returned by ramp creation, moving the user's own funds from other chains or stablecoins onto the settlement chain. Sign every payload in the plan and submit the signatures in the same order. Offramps only.