Quickstart ⚡

Get started with Crossmint Consumer Offramp - enable your end users to convert stablecoins to fiat

This guide will help you understand how to integrate Crossmint’s Offramp solution into your application.

Overview

Crossmint’s Consumer Offramp enables your end users to convert stablecoins to fiat and receive funds via their personal bank accounts, cards, or local payment methods. The integration involves:

1. Creating an offramp order with conversion details
2. Handling user compliance verification (KYC/AML)
3. Processing the stablecoin transfer
4. Monitoring payout status via webhooks
5. Reconciling completed transactions

Prerequisites

Before you begin, you’ll need:

• A Crossmint account with Offramp enabled
• API keys (available once your account is provisioned)
• Understanding of your use case and target geographies
• Basic knowledge of REST APIs and webhooks

Integration Flow

Step 1: Request Access

Our team will work with you to:

• Understand your use case and volume requirements
• Configure supported payout methods and geographies
• Set up compliance requirements
• Provision your API credentials
• Assist with integration and testing

Step 2: Design Your UX

Plan how users will interact with the offramp experience:

• Payout Method Selection: How will users choose their preferred payout method?
• Amount Input: Will users specify amount in stablecoins or fiat?
• Compliance Flow: How will you handle KYC prompts if needed?
• Status Updates: How will you communicate payout status to users?

Step 3: Implement the API

Once provisioned, you’ll integrate with Crossmint’s Offramp API:

// 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"
    }
  }
});

Step 4: Handle Compliance

Crossmint automatically verifies user compliance status:

// 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
}

Step 5: Process the Transfer

Once compliance is cleared, initiate the stablecoin transfer:

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

Step 6: Monitor Status

Use webhooks to track the offramp lifecycle:

// 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);
});

Step 7: Handle Reconciliation

Access transaction data for accounting and reconciliation:

// 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)

Testing

Your Crossmint account will include a staging environment where you can:

• Test the full offramp flow with test credentials
• Simulate various compliance scenarios
• Verify webhook delivery
• Test error handling

Go to Production

Once testing is complete:

1. Complete production readiness review with Crossmint team
2. Update API keys to production credentials
3. Configure production webhooks
4. Launch with monitoring enabled

Support

The Crossmint team provides hands-on support throughout your integration:

• Technical integration assistance
• Compliance guidance
• Production deployment support
• Ongoing optimization

Contact Sales

Get started with Crossmint Offramp

Next Steps

API Reference

Detailed API documentation (available after provisioning)

Compliance Guide

Understanding KYC and AML requirements