Basic Integration

Create Swipelux OnRamp orders programmatically with the minimum required parameters. This guide covers the essential steps to get started with server-side order creation.

Quick Start

This guide features implementations in JavaScript, Python, PHP, Go, and Java, but these snippets can be translated to almost any other language by following the Reference section.

Get Your Secret API Key

If you don't have one, create it in the Merchant Panel. Read here for more information.

Install Dependencies if Needed

If you don't have a preferred language, we recommend using JavaScript. Most modern browsers and runtimes have Fetch API built-in, which is a modern way to make HTTP requests.

If you need to use a different language, you can use a package manager like pip to install the requests library for Python or curl for PHP. Refer to your language's documentation for more information.

Define a Basic Function

async function createBasicOrder(
  secretKey,
  {
    amount,
    fromCurrency = "USD", 
    toCurrency = "USDC",
    targetAddress,
    userEmail,
    userPhone,
  },
) {
  const response = await fetch(
    "https://api.swipelux.com/api/orders/createPrepared",
    {
      method: "POST",
      headers: {
        Authorization: secretKey,
        "Content-Type": "application/json",
      },
      body: JSON.stringify({
        amounts: {
          from: {
            amount,
            currency: fromCurrency
          },
          to: {
            currency: toCurrency
          },
        },
        user: {
          email: userEmail,
          phone: userPhone
        },
        targetAddress,
      }),
    },
  );
 
  if (!response.ok) {
    const error = await response.json();
    throw new Error(`API Error: ${error.message}`);
  }
 
  return await response.json();
}

Make Your First Request

try {
  const response = await createBasicOrder("YOUR_SECRET_KEY_HERE", {
    amount: 100,
    fromCurrency: "USD",
    toCurrency: "USDC", 
    targetAddress: "0x1234...",
    userEmail: "user@example.com",
    userPhone: "+1234567890",
  });
  console.log("Order created:", response.orderId);
  console.log("Order token:", response.orderToken);
} catch (error) {
  console.error("Error:", error.message);
}

Handle the Response

The JSON response contains important information about the created order:

{
  "orderId": "ord_abc123def456",
  "orderToken": "ord_token_abc123def456",
  "acsUrl": "https://track.swipelux.com?specificSettings={...}",
  "externalId": null
}

Using the response:

acsUrl: Direct users to this URL to complete payment via Payment Link
orderToken: Use with the widget for embedded integration
orderId: Track this order in your system and match with webhook events

Header	Value	Required
`Authorization`	Your secret API key	Yes
`Content-Type`	application/json	Yes

Required Parameters

Prop	Type	Default
`targetAddress`	`string`	-
`user`	`object`	-
`amounts`	`object`	-

`amounts` Object

Prop	Type	Default
`to.currency`	`string`	-
`from.amount`	`number`	-
`from.currency`	`string`	-

`user` Object

Prop	Type	Default
`email?`	`string`	-
`phone`	`string`	-

Next Steps

After creating your first order:

Add payment customization: Restrict payment methods with Payment Method Customization
Enable advanced features: Pre-fill user data and KYC with Advanced Features
Widget integration: Use the orderToken with your client-side widget
Order tracking: Monitor order status with GET order API
Event handling: Set up webhooks for real-time order updates