Sandbox Environment

Documentation Index

Fetch the complete documentation index at: https://docs.swiftpay.finance/llms.txt

Use this file to discover all available pages before exploring further.

​

Quick Reference

​

Getting Started with Sandbox

​

1. Access the Sandbox Portal

• Create a sandbox merchant account
• Generate API keys (sk_test_* and pk_test_*)
• View test transactions and webhooks
• Configure webhook endpoints

​

2. Get Test Funds

​

3. Make Your First Test API Call

curl -X GET "https://sandbox-api.swiftpay.finance/v1/utils/chains" \
  -H "Content-Type: application/json"

[
  {
    "id": "ethereum-sepolia",
    "name": "Ethereum Sepolia",
    "chainId": 11155111,
    "isTestnet": true
  },
  {
    "id": "polygon-mumbai",
    "name": "Polygon Mumbai",
    "chainId": 80001,
    "isTestnet": true
  }
]

​

4. Create a Test Invoice

import { SwiftPay } from '@swiftpayfi/api-client';

const client = new SwiftPay({
  secretKey: 'sk_test_your_sandbox_key',
  baseUrl: 'https://sandbox-api.swiftpay.finance',
});

const { invoice } = await client.invoices.create({
  amount: '10.00',
  token: 'USDC',
  network: 'ethereum-sepolia',
  recipients: { evm: '0xYourTestWallet...' },
  externalRef: 'test_order_001',
});

console.log(`Test invoice: ${invoice.id}`);

from swiftpay import SwiftPay

client = SwiftPay(
    secret_key="sk_test_your_sandbox_key",
    base_url="https://sandbox-api.swiftpay.finance",
)

result = client.invoices.create(
    amount="10.00",
    token="USDC",
    network="ethereum-sepolia",
    recipients={"evm": "0xYourTestWallet..."},
    external_ref="test_order_001",
)

print(f"Test invoice: {result.invoice.id}")

curl -X POST "https://sandbox-api.swiftpay.finance/v1/invoices" \
  -H "Content-Type: application/json" \
  -H "X-Swift-Key: sk_test_your_sandbox_key" \
  -d '{
    "amount": "10.00",
    "token": "USDC",
    "network": "ethereum-sepolia",
    "recipients": { "evm": "0xYourTestWallet..." },
    "externalRef": "test_order_001"
  }'

​

Key Differences from Production

​

Testnet Networks

• Ethereum Sepolia (chainId: 11155111)
• Polygon Mumbai (chainId: 80001)
• Solana Devnet
• Tron Shasta

​

Test Data Isolation

• Sandbox and production accounts are completely separate
• Sandbox invoices, webhooks, and keys don’t affect production
• Test transactions won’t appear in production dashboards

​

Webhook Testing

1. Go to Settings → Webhooks
2. Create a webhook endpoint (e.g., https://localhost:3000/webhooks)
3. Use the test_whsec_* secret to verify signatures
4. Click Send Test Event to simulate payment events

• webhook.site — Instantly get a unique webhook URL for testing (no setup required)
• ngrok — Tunnel your local server to a public URL for production-like testing

​

Best Practices

​

Switching to Production

1. Generate production keys in cockpit.swiftpay.finance
2. Update environment variables to use sk_live_* and pk_live_*
3. Change API URL to https://api.swiftpay.finance
4. Update network from testnet (e.g., ethereum-sepolia) to mainnet (e.g., ethereum)
5. Test in production with small amounts before full deployment

// Environment-based configuration
const client = new SwiftPay({
  secretKey: process.env.SWIFTPAY_SECRET_KEY,
  baseUrl: process.env.SWIFTPAY_API_URL || 'https://api.swiftpay.finance',
});

const network = process.env.NODE_ENV === 'production' 
  ? 'ethereum'  // mainnet
  : 'ethereum-sepolia';  // testnet

​

Sandbox Limitations

• No real money transfers — all transactions are on test networks
• Rate limits may be higher than production
• Data retention — sandbox data may be reset periodically
• Testnet faucets may have daily limits — plan test cycles accordingly

​

Support

• 📖 See API Reference for detailed endpoint documentation
• 🆘 Contact support at support@swiftpay.finance for sandbox-specific issues
• 🐛 Report bugs with test data to help us improve the sandbox experience