Asset Transfers

import { Pay100 } from "@100pay-hq/100pay.js";
 
const client = new Pay100({
  publicKey: "your_public_key",
  secretKey: "your_secret_key", // Required for server-side operations
});

const transfer = await client.transfer.executeTransfer({
  amount: 50,
  symbol: "USDT",
  to: "user@payid",        // Recipient's PayID or internal wallet identifier
  transferType: "internal",
  note: "Payment for invoice #42",
});
 
console.log(transfer.data.transactionId);
// => "txn_abc123..."

const transfer = await client.transfer.executeTransfer({
  amount: 0.01,
  symbol: "ETH",
  to: "0x1234567890abcdef1234567890abcdef12345678", // On-chain wallet address
  transferType: "external",
  note: "Payout to partner",
});
 
console.log(transfer.data.receipt);
// => Transaction receipt hash

const transfer = await client.transfer.executeTransfer({
  amount: 25,
  symbol: "USDT",
  to: "partner@payid",
  transferType: "internal",
  oauthAccessToken: "user_oauth_access_token",
});

{
  statusCode: 200,
  message: "Transfer successful",
  data: {
    receipt: "0xabc...",          // Transaction receipt / confirmation
    transactionId: "txn_xyz...",  // 100Pay internal transaction ID
    timestamp: 1709500000000,     // Unix timestamp
  }
}

const history = await client.transfer.getHistory({
  page: 1,
  limit: 20,
  symbols: ["USDT", "BTC"],  // Optional: filter by currency
  type: "debit",              // Optional: "credit" or "debit"
  accountIds: ["acc_123"],    // Optional: filter by account IDs
  addresses: ["0x..."],       // Optional: filter by wallet addresses
});
 
history.data.forEach((tx) => {
  console.log(`${tx.type} ${tx.amount} ${tx.symbol} — ${tx.status}`);
});

{
  statusCode: 200,
  message: "Transfer history retrieved",
  data: [
    {
      _id: "txn_abc123",
      symbol: "USDT",
      from: "0xSenderAddress",
      to: "0xRecipientAddress",
      type: "debit",
      amount: "50.00",
      status: "completed",
      note: "Payout to partner",
      transactionHash: "0xhash...",
      createdAt: "2024-03-01T12:00:00Z",
    },
    // ...
  ],
  meta: {
    total: 150,
    page: 1,
    limit: 20,
    pages: 8,
    hasNextPage: true,
    hasPreviousPage: false,
  }
}

// Fee for an external (onchain) USDT transfer
const fee = await client.transfer.calculateFee({
  symbol: "USDT",
  transferType: "external",
});
 
console.log(`Total fee: ${fee.data.totalFee} ${fee.data.feeSymbol}`);
console.log(`Network congestion: ${fee.data.networkCongestion}`);
// => Total fee: 1.5 USDT
// => Network congestion: low

// Fee for an internal transfer (typically free or very low)
const internalFee = await client.transfer.calculateFee({
  symbol: "USDT",
  transferType: "internal",
});

{
  statusCode: 200,
  message: "Fee calculated",
  data: {
    baseFee: "0.5",
    networkFee: "1.0",
    totalFee: "1.5",
    feeSymbol: "USDT",
    networkCongestion: "low",
  }
}

interface ITransferAssetData {
  amount: number | string;
  symbol: string;
  to: string;
  transferType?: "internal" | "external";
  note?: string;
  oauthAccessToken?: string;
}
 
interface ITransferAssetResponse {
  statusCode: number;
  message: string;
  data: {
    receipt: string;
    transactionId: string;
    timestamp: string | number;
  };
}
 
interface ITransferHistoryParams {
  accountIds?: string[];
  addresses?: string[];
  symbols?: string[];
  page?: number;
  limit?: number;
  type?: string; // "credit" | "debit"
}
 
interface ITransferHistoryResponse {
  statusCode: number;
  message: string;
  data: ITransferHistoryItem[];
  meta: {
    total: number;
    page: number;
    limit: number;
    pages: number;
    hasNextPage: boolean;
    hasPreviousPage: boolean;
  };
}
 
interface ITransferHistoryItem {
  _id: string;
  accountId: string;
  symbol: string;
  from: string;
  to: string;
  type: "credit" | "debit";
  amount: string;
  status?: string;
  transactionHash?: string | null;
  note?: string;
  createdAt?: Date;
  updatedAt?: Date;
}
 
interface ITransferFeeParams {
  symbol: string;
  transferType?: "internal" | "external";
}
 
interface ITransferFeeResponse {
  statusCode: number;
  message: string;
  data: {
    baseFee: string | number;
    networkFee?: string | number;
    totalFee: string | number;
    feeSymbol: string;
    networkCongestion?: "low" | "medium" | "high";
  };
}