Skip to main content
GET
Legacy: Get offramp

Overview

Retrieve an offramp through the legacy compatibility route. New integrations should use GET /v1/funding-accounts/{id}.

Authentication

X-Api-Key
string
required
Your merchant API key

Path Parameters

id
string
required
Offramp ID (UUID format)Example: a50e8400-e29b-41d4-a716-446655440000

Request Examples

Response

id
string
required
Unique offramp identifier (UUID)
type
string
required
Offramp type: TEMPORARY or PERMANENT
customer_id
string
required
Associated customer ID (UUID)
address
string
required
Crypto deposit address
chain
string
required
Blockchain network: APTOS, BASE, CELO, ETHEREUM, POLYGON, SOLANA, or TRON
asset
string
required
Stablecoin asset: USDC or USDT
status
string
required
Offramp status: ACTIVE, INACTIVE, or EXPIRED
developer_fee
object
required
Developer fee percentage used for deposits received through this offramp.
settlement
object
required
Settlement configuration
created_at
string
required
When the offramp was created (ISO 8601 timestamp)
updated_at
string
required
When the offramp was last updated (ISO 8601 timestamp)

Success Responses

Next Steps

List Offramps

List all offramps with filters

Create Offramp

Create a new offramp