nodejs-cryptomus/src/types/payout.ts

A comprehensive Node.js client for the Cryptomus API

/**
 * Payout creation request
 */
export interface CreatePayoutRequest {
  /** Amount to send */
  amount: string | number;
  /** Currency to send */
  currency: string;
  /** Network for the currency */
  network?: string;
  /** Address to send funds to */
  address: string;
  /** Order ID in your system */
  order_id: string;
  /** IPN URL to receive payout notifications */
  url_callback?: string;
  /** Whether to sign webhook messages */
  is_sign?: boolean;
}

/**
 * Payout information
 */
export interface PayoutInfo {
  /** UUID of the payout */
  uuid: string;
  /** Order ID in your system */
  order_id: string;
  /** Amount to send */
  amount: string;
  /** Currency to send */
  currency: string;
  /** Network for the currency */
  network: string;
  /** Address to send funds to */
  address: string;
  /** Transaction hash */
  txid?: string;
  /** Fee amount */
  fee?: string;
  /** Payout status */
  status: string;
  /** Processing timestamp */
  processing_date?: string;
  /** Created timestamp */
  created_at: string;
  /** Updated timestamp */
  updated_at: string;
}

/**
 * Payout status request
 */
export interface PayoutStatusRequest {
  /** UUID of the payout */
  uuid?: string;
  /** Order ID in your system */
  order_id?: string;
}

/**
 * Payout history request
 */
export interface PayoutHistoryRequest {
  /** Page number */
  page?: number;
  /** Items per page */
  per_page?: number;
  /** Filter by currency */
  currency?: string;
  /** Filter by status */
  status?: string;
  /** Filter by date range (start) */
  date_from?: string;
  /** Filter by date range (end) */
  date_to?: string;
}