Skip to main content

Method Signature

align.transfers.listOfframpTransfers(
  customerId: string
): Promise<TransferListResponse>

Parameters

customerId
string
required
The unique customer identifier (UUID format)

Returns

items
Transfer[]
Array of offramp transfer objects

Examples

import Align from "@tolbel/align";

const align = new Align({
  apiKey: process.env.ALIGN_API_KEY!,
  environment: "sandbox",
});

const response = await align.transfers.listOfframpTransfers(
  "123e4567-e89b-12d3-a456-426614174000"
);

console.log(`Total offramp transfers: ${response.items.length}`);

for (const transfer of response.items) {
  console.log(`${transfer.id}: ${transfer.status}`);
  console.log(`  ${transfer.source_amount} USDC → $${transfer.destination_amount} USD`);
}

Filter by Status

const response = await align.transfers.listOfframpTransfers(customerId);

// Get only completed offramps
const completed = response.items.filter((t) => t.status === "completed");

// Calculate total volume sold
const totalSold = completed.reduce(
  (sum, t) => sum + parseFloat(t.source_amount),
  0
);

console.log(`Total crypto sold: ${totalSold} USDC`);