@ton-pay/api 0.1.2 → 0.2.0

package/README.md

@@ -22,28 +22,28 @@ import {
   verifySignature,
   TON,
   USDT,
-} from "@ton-pay/api";
+} from '@ton-pay/api';
 
 // Create a TON Pay transfer
 const transfer = await createTonPayTransfer(
   {
     amount: 10.5,
     asset: TON,
-    recipientAddr: "EQC...", // Optional if API key is provided
-    senderAddr: "EQC...",
-    commentToSender: "Payment for order #123",
-    commentToRecipient: "Thank you!",
+    recipientAddr: 'EQC...', // Optional if API key is provided
+    senderAddr: 'EQC...',
+    commentToSender: 'Payment for order #123',
+    commentToRecipient: 'Thank you!',
   },
   {
-    chain: "mainnet",
-    apiKey: "your-api-key",
-  }
+    chain: 'mainnet',
+    apiKey: 'your-api-key',
+  },
 );
 
 // Get transfer status by reference
 const transferInfo = await getTonPayTransferByReference(transfer.reference, {
-  chain: "mainnet",
-  apiKey: "your-api-key",
+  chain: 'mainnet',
+  apiKey: 'your-api-key',
 });
 
 // Verify webhook signature

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-type Chain = "mainnet" | "testnet";
+type Chain = 'mainnet' | 'testnet';
 
 type APIOptions = {
     chain?: Chain;
@@ -46,6 +46,124 @@ type CreateTonPayTransferResponse = {
  */
 declare const createTonPayTransfer: (params: CreateTonPayTransferParams, options?: APIOptions) => Promise<CreateTonPayTransferResponse>;
 
+/**
+ * MoonPay geo location result
+ */
+type MoonpayGeoResult = {
+    alpha2: string;
+    alpha3: string;
+    country: string;
+    state: string;
+    ipAddress: string;
+    isAllowed: boolean;
+    isBuyAllowed: boolean;
+    isNftAllowed: boolean;
+    isSellAllowed: boolean;
+    isBalanceLedgerWithdrawAllowed: boolean;
+    isFiatBalanceAllowed: boolean;
+    isMoonPayBalanceAllowed: boolean;
+    isLowLimitEnabled: boolean;
+};
+/**
+ * MoonPay amount limits
+ */
+type MoonpayAmountLimits = {
+    paymentMethod: string;
+    quoteCurrency: {
+        code: string;
+        minBuyAmount: number;
+        maxBuyAmount: number;
+    };
+    baseCurrency: {
+        code: string;
+        minBuyAmount: number;
+        maxBuyAmount: number;
+    };
+    areFeesIncluded: boolean;
+};
+/**
+ * @param amount - in human readable format, 10.5 for example
+ * @param asset - jetton master address or TON coin address for TON transfer
+ * @param recipientAddr - recipient wallet address. Optional if API key is provided - defaults to the merchant's wallet address from the admin panel
+ * @param userIp - user's IP address (required for geo verification)
+ * @param redirectURL - redirect URL after Moonpay purchase
+ */
+type CreateMoonpayTransferParams = {
+    amount: number;
+    asset: string;
+    recipientAddr?: string;
+    userIp: string;
+    redirectURL: string;
+};
+/**
+ * @param link - MoonPay payment link
+ * @param geo - MoonPay geo location result
+ * @param limits - MoonPay amount limits
+ */
+type CreateMoonpayTransferResponse = {
+    link: string;
+    geo?: MoonpayGeoResult;
+    limits: MoonpayAmountLimits;
+};
+
+/**
+ * Creates a MoonPay payment link for buying crypto
+ * @param params - the parameters for the MoonPay transfer
+ * @param options - the options for the transfer (requires API key)
+ * @returns the payment link, geo restrictions, and amount limits
+ */
+declare const createMoonpayTransfer: (params: CreateMoonpayTransferParams, options: APIOptions) => Promise<CreateMoonpayTransferResponse>;
+
+/**
+ * @param ipAddress - IP address to check for geo restrictions
+ */
+type CheckMoonpayGeoParams = {
+    ipAddress: string;
+};
+/**
+ * MoonPay geo check response
+ */
+type CheckMoonpayGeoResponse = MoonpayGeoResult;
+
+/**
+ * Checks MoonPay geo restrictions for an IP address
+ * @param params - the IP address to check
+ * @param options - optional API options
+ * @returns the geo location and restrictions
+ */
+declare const checkMoonpayGeo: (params: CheckMoonpayGeoParams, options?: APIOptions) => Promise<CheckMoonpayGeoResponse>;
+
+/**
+ * @param asset - jetton master address or TON coin address for TON
+ */
+type CheckMoonpayLimitsParams = {
+    asset: string;
+};
+/**
+ * MoonPay limits check response
+ */
+type CheckMoonpayLimitsResponse = MoonpayAmountLimits;
+
+/**
+ * Gets MoonPay amount limits for an asset
+ * @param params - the asset to check limits for
+ * @param options - optional API options
+ * @returns the amount limits for the asset
+ */
+declare const checkMoonpayLimits: (params: CheckMoonpayLimitsParams, options?: APIOptions) => Promise<CheckMoonpayLimitsResponse>;
+
+type CheckMoonpayAvailabilityParams = {
+    asset: string;
+    ipAddress?: string;
+};
+type CheckMoonpayAvailabilityResponse = {
+    geo: MoonpayGeoResult;
+    limits: MoonpayAmountLimits;
+    currencyCode: string;
+};
+
+declare const checkMoonpayAvailability: (params: CheckMoonpayAvailabilityParams, options?: APIOptions) => Promise<CheckMoonpayAvailabilityResponse>;
+
 /**
  * @param amount - the amount of the transfer in human readable format
  * @param rawAmount - the amount of the transfer in base units
@@ -120,7 +238,7 @@ type GetTonPayTransferByReferenceParams = {
  * - `transfer.completed` - Transfer completed (check `data.status` for success/failed)
  * - `transfer.refunded` - Transfer was refunded (Coming Soon)
  */
-type WebhookEventType = "transfer.completed" | "transfer.refunded";
+type WebhookEventType = 'transfer.completed' | 'transfer.refunded';
 
 /**
  * Base webhook payload structure
@@ -137,7 +255,7 @@ interface BaseWebhookPayload {
  * Check `data.status` field to determine if transfer was "success" or "failed".
  */
 interface TransferCompletedWebhookPayload extends BaseWebhookPayload {
-    event: "transfer.completed";
+    event: 'transfer.completed';
     data: CompletedTonPayTransferInfo;
 }
 /**
@@ -147,7 +265,7 @@ interface TransferCompletedWebhookPayload extends BaseWebhookPayload {
  * Coming Soon - Sent when a transfer is refunded
  */
 interface TransferRefundedWebhookPayload extends BaseWebhookPayload {
-    event: "transfer.refunded";
+    event: 'transfer.refunded';
     data: unknown;
 }
 /**
@@ -199,4 +317,4 @@ declare const TON = "TON";
  */
 declare function verifySignature(payload: string | object, signature: string, apiSecret: string): boolean;
 
-export { type APIOptions, type Chain, type CompletedTonPayTransferInfo, type CreateTonPayTransferParams, type CreateTonPayTransferResponse, type GetTonPayTransferByBodyHashParams, type GetTonPayTransferByReferenceParams, TON, type TransferCompletedWebhookPayload, type TransferRefundedWebhookPayload, USDT, type WebhookEventType, type WebhookPayload, createTonPayTransfer, getTonPayTransferByBodyHash, getTonPayTransferByReference, verifySignature };
+export { type APIOptions, type Chain, type CheckMoonpayAvailabilityParams, type CheckMoonpayAvailabilityResponse, type CheckMoonpayGeoParams, type CheckMoonpayGeoResponse, type CheckMoonpayLimitsParams, type CheckMoonpayLimitsResponse, type CompletedTonPayTransferInfo, type CreateMoonpayTransferParams, type CreateMoonpayTransferResponse, type CreateTonPayTransferParams, type CreateTonPayTransferResponse, type GetTonPayTransferByBodyHashParams, type GetTonPayTransferByReferenceParams, type MoonpayAmountLimits, type MoonpayGeoResult, TON, type TransferCompletedWebhookPayload, type TransferRefundedWebhookPayload, USDT, type WebhookEventType, type WebhookPayload, checkMoonpayAvailability, checkMoonpayGeo, checkMoonpayLimits, createMoonpayTransfer, createTonPayTransfer, getTonPayTransferByBodyHash, getTonPayTransferByReference, verifySignature };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-type Chain = "mainnet" | "testnet";
+type Chain = 'mainnet' | 'testnet';
 
 type APIOptions = {
     chain?: Chain;
@@ -46,6 +46,124 @@ type CreateTonPayTransferResponse = {
  */
 declare const createTonPayTransfer: (params: CreateTonPayTransferParams, options?: APIOptions) => Promise<CreateTonPayTransferResponse>;
 
+/**
+ * MoonPay geo location result
+ */
+type MoonpayGeoResult = {
+    alpha2: string;
+    alpha3: string;
+    country: string;
+    state: string;
+    ipAddress: string;
+    isAllowed: boolean;
+    isBuyAllowed: boolean;
+    isNftAllowed: boolean;
+    isSellAllowed: boolean;
+    isBalanceLedgerWithdrawAllowed: boolean;
+    isFiatBalanceAllowed: boolean;
+    isMoonPayBalanceAllowed: boolean;
+    isLowLimitEnabled: boolean;
+};
+/**
+ * MoonPay amount limits
+ */
+type MoonpayAmountLimits = {
+    paymentMethod: string;
+    quoteCurrency: {
+        code: string;
+        minBuyAmount: number;
+        maxBuyAmount: number;
+    };
+    baseCurrency: {
+        code: string;
+        minBuyAmount: number;
+        maxBuyAmount: number;
+    };
+    areFeesIncluded: boolean;
+};
+/**
+ * @param amount - in human readable format, 10.5 for example
+ * @param asset - jetton master address or TON coin address for TON transfer
+ * @param recipientAddr - recipient wallet address. Optional if API key is provided - defaults to the merchant's wallet address from the admin panel
+ * @param userIp - user's IP address (required for geo verification)
+ * @param redirectURL - redirect URL after Moonpay purchase
+ */
+type CreateMoonpayTransferParams = {
+    amount: number;
+    asset: string;
+    recipientAddr?: string;
+    userIp: string;
+    redirectURL: string;
+};
+/**
+ * @param link - MoonPay payment link
+ * @param geo - MoonPay geo location result
+ * @param limits - MoonPay amount limits
+ */
+type CreateMoonpayTransferResponse = {
+    link: string;
+    geo?: MoonpayGeoResult;
+    limits: MoonpayAmountLimits;
+};
+
+/**
+ * Creates a MoonPay payment link for buying crypto
+ * @param params - the parameters for the MoonPay transfer
+ * @param options - the options for the transfer (requires API key)
+ * @returns the payment link, geo restrictions, and amount limits
+ */
+declare const createMoonpayTransfer: (params: CreateMoonpayTransferParams, options: APIOptions) => Promise<CreateMoonpayTransferResponse>;
+
+/**
+ * @param ipAddress - IP address to check for geo restrictions
+ */
+type CheckMoonpayGeoParams = {
+    ipAddress: string;
+};
+/**
+ * MoonPay geo check response
+ */
+type CheckMoonpayGeoResponse = MoonpayGeoResult;
+
+/**
+ * Checks MoonPay geo restrictions for an IP address
+ * @param params - the IP address to check
+ * @param options - optional API options
+ * @returns the geo location and restrictions
+ */
+declare const checkMoonpayGeo: (params: CheckMoonpayGeoParams, options?: APIOptions) => Promise<CheckMoonpayGeoResponse>;
+
+/**
+ * @param asset - jetton master address or TON coin address for TON
+ */
+type CheckMoonpayLimitsParams = {
+    asset: string;
+};
+/**
+ * MoonPay limits check response
+ */
+type CheckMoonpayLimitsResponse = MoonpayAmountLimits;
+
+/**
+ * Gets MoonPay amount limits for an asset
+ * @param params - the asset to check limits for
+ * @param options - optional API options
+ * @returns the amount limits for the asset
+ */
+declare const checkMoonpayLimits: (params: CheckMoonpayLimitsParams, options?: APIOptions) => Promise<CheckMoonpayLimitsResponse>;
+
+type CheckMoonpayAvailabilityParams = {
+    asset: string;
+    ipAddress?: string;
+};
+type CheckMoonpayAvailabilityResponse = {
+    geo: MoonpayGeoResult;
+    limits: MoonpayAmountLimits;
+    currencyCode: string;
+};
+
+declare const checkMoonpayAvailability: (params: CheckMoonpayAvailabilityParams, options?: APIOptions) => Promise<CheckMoonpayAvailabilityResponse>;
+
 /**
  * @param amount - the amount of the transfer in human readable format
  * @param rawAmount - the amount of the transfer in base units
@@ -120,7 +238,7 @@ type GetTonPayTransferByReferenceParams = {
  * - `transfer.completed` - Transfer completed (check `data.status` for success/failed)
  * - `transfer.refunded` - Transfer was refunded (Coming Soon)
  */
-type WebhookEventType = "transfer.completed" | "transfer.refunded";
+type WebhookEventType = 'transfer.completed' | 'transfer.refunded';
 
 /**
  * Base webhook payload structure
@@ -137,7 +255,7 @@ interface BaseWebhookPayload {
  * Check `data.status` field to determine if transfer was "success" or "failed".
  */
 interface TransferCompletedWebhookPayload extends BaseWebhookPayload {
-    event: "transfer.completed";
+    event: 'transfer.completed';
     data: CompletedTonPayTransferInfo;
 }
 /**
@@ -147,7 +265,7 @@ interface TransferCompletedWebhookPayload extends BaseWebhookPayload {
  * Coming Soon - Sent when a transfer is refunded
  */
 interface TransferRefundedWebhookPayload extends BaseWebhookPayload {
-    event: "transfer.refunded";
+    event: 'transfer.refunded';
     data: unknown;
 }
 /**
@@ -199,4 +317,4 @@ declare const TON = "TON";
  */
 declare function verifySignature(payload: string | object, signature: string, apiSecret: string): boolean;
 
-export { type APIOptions, type Chain, type CompletedTonPayTransferInfo, type CreateTonPayTransferParams, type CreateTonPayTransferResponse, type GetTonPayTransferByBodyHashParams, type GetTonPayTransferByReferenceParams, TON, type TransferCompletedWebhookPayload, type TransferRefundedWebhookPayload, USDT, type WebhookEventType, type WebhookPayload, createTonPayTransfer, getTonPayTransferByBodyHash, getTonPayTransferByReference, verifySignature };
+export { type APIOptions, type Chain, type CheckMoonpayAvailabilityParams, type CheckMoonpayAvailabilityResponse, type CheckMoonpayGeoParams, type CheckMoonpayGeoResponse, type CheckMoonpayLimitsParams, type CheckMoonpayLimitsResponse, type CompletedTonPayTransferInfo, type CreateMoonpayTransferParams, type CreateMoonpayTransferResponse, type CreateTonPayTransferParams, type CreateTonPayTransferResponse, type GetTonPayTransferByBodyHashParams, type GetTonPayTransferByReferenceParams, type MoonpayAmountLimits, type MoonpayGeoResult, TON, type TransferCompletedWebhookPayload, type TransferRefundedWebhookPayload, USDT, type WebhookEventType, type WebhookPayload, checkMoonpayAvailability, checkMoonpayGeo, checkMoonpayLimits, createMoonpayTransfer, createTonPayTransfer, getTonPayTransferByBodyHash, getTonPayTransferByReference, verifySignature };