Quickstart ⚡

// Example: Create an offramp order (API design subject to change)
const offrampOrder = await crossmint.offramp.create({
  userId: "user_123",
  amount: "100.00",
  currency: "USD",
  sourceToken: "USDC",
  chain: "solana",
  payoutMethod: {
    type: "bank_transfer",
    details: {
      accountNumber: "****1234",
      routingNumber: "021000021",
      accountType: "checking"
    }
  }
});

// Check if additional verification is needed
if (offrampOrder.status === "pending_verification") {
  // Direct user to complete KYC
  const verificationUrl = offrampOrder.verificationUrl;
  // Redirect user or display verification requirements
}

// User approves the stablecoin transfer
const transfer = await crossmint.offramp.transfer({
  orderId: offrampOrder.id,
  walletAddress: userWalletAddress
});

// Webhook event types
// - offramp.order.created
// - offramp.order.pending_verification
// - offramp.order.verified
// - offramp.order.processing
// - offramp.order.completed
// - offramp.order.failed

app.post('/webhooks/crossmint', (req, res) => {
  const event = req.body;
  
  if (event.type === 'offramp.order.completed') {
    // Update user balance, send notification
    notifyUser(event.data.userId, 'Your withdrawal is complete!');
  }
  
  res.sendStatus(200);
});

// Get offramp order details
const order = await crossmint.offramp.get(orderId);

// Fields include:
// - sourceAmount (stablecoin amount)
// - destinationAmount (fiat amount)
// - fxRate (conversion rate)
// - fees (breakdown of all fees)
// - timestamps (created, completed)
// - transactionHashes (on-chain references)