@moonpay/platform-sdk-core 1.11.0 → 1.13.0

package/dist/index.d.cts

@@ -1,8 +1,8 @@
 import { Customer } from '@moonpay/platform-protocol/api/customer';
-import { GetCustomerError, GetCustomerUploadUrlError, SubmitCustomerFilesError, SubmitCustomerKycError, DevPlatformApiError, GetAssetsError, GetQuoteError, GetTransactionsError, CreateIdentityError, GetIdentityError, GetIdentityUploadUrlError, SubmitIdentityFilesError, UpdateIdentityError, VerifyIdentityError, GetPaymentMethodsError } from '@moonpay/platform-protocol/api/errors';
+import { GetCustomerError, GetCustomerUploadUrlError, SubmitCustomerFilesError, SubmitCustomerKycError, DevPlatformApiError, GetAssetsError, GetQuoteError, GetTransactionsError, CreateIdentityError, GetIdentityError, GetIdentityUploadUrlError, SubmitIdentityFilesError, UpdateIdentityError, VerifyIdentityError, GetPaymentMethodsError, SimulateBankTransferError } from '@moonpay/platform-protocol/api/errors';
 import { IdentityFileUploadUrlRequestBody, IdentityFileUploadUrl, SubmitIdentityFilesRequestBody, UpdateIdentityRequestBody, CreateIdentityRequestBody, Identity, IdentityVerificationResponse } from '@moonpay/platform-protocol/api/identity';
 import { Result } from '@moonpay/platform-protocol/result';
-import { ListAssetsResponse, GetQuoteParams, Quote, TransactionWithStages, Transaction, PaginationInfo, ListPaymentMethodsResponse } from '@moonpay/platform-protocol/api';
+import { ListAssetsResponse, GetQuoteParams, Quote, TransactionWithStages, Transaction, PaginationInfo, ListPaymentMethodsResponse, SimulateBankTransferParams } from '@moonpay/platform-protocol/api';
 import { ProtocolMessage } from '@moonpay/platform-protocol/protocol';
 import { DecryptedCredentials } from '@moonpay/platform-protocol/models/connection';
 
@@ -103,6 +103,19 @@ declare function getPaymentMethods(ctx: ClientContext): Promise<Result<{
 }, GetPaymentMethodsError>>;
 declare function deletePaymentMethod(ctx: ClientContext, paymentMethodId: string): Promise<Result<void, DevPlatformApiError>>;
 
+/** The API wraps the transaction in a `{ data: ... }` envelope. */
+interface SimulateBankTransferApiResponse {
+    data: TransactionWithStages;
+}
+/**
+ * Simulate bank-transfer settlement for a test-mode transaction (sandbox only).
+ *
+ * Drives a waiting-payment bank-transfer transaction to a terminal outcome
+ * without real funds. Settlement is asynchronous, so the response reflects the
+ * transaction's current state — poll `getTransaction(id)` for the terminal state.
+ */
+declare function simulateBankTransfer(ctx: ClientContext, id: string, params: SimulateBankTransferParams): Promise<Result<SimulateBankTransferApiResponse, SimulateBankTransferError>>;
+
 /** Options for creating a frame (iframe or WebView). */
 interface FrameOptions {
     /** Container to render the frame into. Platform-specific. */
@@ -217,6 +230,10 @@ interface CoreClient {
     getTransaction(id: string): Promise<Result<{
         data: TransactionWithStages;
     }, GetTransactionsError>>;
+    /** Simulate bank-transfer settlement for a test-mode transaction (sandbox only). */
+    simulateBankTransfer(id: string, params: SimulateBankTransferParams): Promise<Result<{
+        data: TransactionWithStages;
+    }, SimulateBankTransferError>>;
     deletePaymentMethod(id: string): Promise<Result<void, DevPlatformApiError>>;
     getCustomer(id: string): Promise<Result<{
         data: Customer;
@@ -332,4 +349,4 @@ declare function isTrustedFrameOrigin(origin: string): boolean;
  */
 declare function isTrustedFrameUrl(value: string): boolean;
 
-export { type ClientContext, type ClientContextOptions, type CoreClient, type CoreClientOptions, FRAME_PATHS, type FrameHandle, type FrameOptions, type FrameOrchestratorOptions, type FrameTransport, type KeyPair, type ListAssetsParams, type ListTransactionsParams, type PresentationMode, TRUSTED_FRAME_ORIGIN_PATTERNS, type ThemeOptions, type UrlBuilderOptions, apiFetch, applyPresentationParam, applyThemeParam, buildFrameUrl, createClientContext, createClientCore, createFrameOrchestrator, createIdentity, decryptCredentials, deletePaymentMethod, generateKeyPair, getAssets, getCustomer, getCustomerUploadUrl, getIdentity, getIdentityUploadUrl, getPaymentMethods, getQuote, getTransaction, isTrustedFrameOrigin, isTrustedFrameUrl, listTransactions, presentationParams, submitCustomerFiles, submitCustomerKyc, submitIdentityFiles, themeParams, updateIdentity, verifyIdentity };
+export { type ClientContext, type ClientContextOptions, type CoreClient, type CoreClientOptions, FRAME_PATHS, type FrameHandle, type FrameOptions, type FrameOrchestratorOptions, type FrameTransport, type KeyPair, type ListAssetsParams, type ListTransactionsParams, type PresentationMode, TRUSTED_FRAME_ORIGIN_PATTERNS, type ThemeOptions, type UrlBuilderOptions, apiFetch, applyPresentationParam, applyThemeParam, buildFrameUrl, createClientContext, createClientCore, createFrameOrchestrator, createIdentity, decryptCredentials, deletePaymentMethod, generateKeyPair, getAssets, getCustomer, getCustomerUploadUrl, getIdentity, getIdentityUploadUrl, getPaymentMethods, getQuote, getTransaction, isTrustedFrameOrigin, isTrustedFrameUrl, listTransactions, presentationParams, simulateBankTransfer, submitCustomerFiles, submitCustomerKyc, submitIdentityFiles, themeParams, updateIdentity, verifyIdentity };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import { Customer } from '@moonpay/platform-protocol/api/customer';
-import { GetCustomerError, GetCustomerUploadUrlError, SubmitCustomerFilesError, SubmitCustomerKycError, DevPlatformApiError, GetAssetsError, GetQuoteError, GetTransactionsError, CreateIdentityError, GetIdentityError, GetIdentityUploadUrlError, SubmitIdentityFilesError, UpdateIdentityError, VerifyIdentityError, GetPaymentMethodsError } from '@moonpay/platform-protocol/api/errors';
+import { GetCustomerError, GetCustomerUploadUrlError, SubmitCustomerFilesError, SubmitCustomerKycError, DevPlatformApiError, GetAssetsError, GetQuoteError, GetTransactionsError, CreateIdentityError, GetIdentityError, GetIdentityUploadUrlError, SubmitIdentityFilesError, UpdateIdentityError, VerifyIdentityError, GetPaymentMethodsError, SimulateBankTransferError } from '@moonpay/platform-protocol/api/errors';
 import { IdentityFileUploadUrlRequestBody, IdentityFileUploadUrl, SubmitIdentityFilesRequestBody, UpdateIdentityRequestBody, CreateIdentityRequestBody, Identity, IdentityVerificationResponse } from '@moonpay/platform-protocol/api/identity';
 import { Result } from '@moonpay/platform-protocol/result';
-import { ListAssetsResponse, GetQuoteParams, Quote, TransactionWithStages, Transaction, PaginationInfo, ListPaymentMethodsResponse } from '@moonpay/platform-protocol/api';
+import { ListAssetsResponse, GetQuoteParams, Quote, TransactionWithStages, Transaction, PaginationInfo, ListPaymentMethodsResponse, SimulateBankTransferParams } from '@moonpay/platform-protocol/api';
 import { ProtocolMessage } from '@moonpay/platform-protocol/protocol';
 import { DecryptedCredentials } from '@moonpay/platform-protocol/models/connection';
 
@@ -103,6 +103,19 @@ declare function getPaymentMethods(ctx: ClientContext): Promise<Result<{
 }, GetPaymentMethodsError>>;
 declare function deletePaymentMethod(ctx: ClientContext, paymentMethodId: string): Promise<Result<void, DevPlatformApiError>>;
 
+/** The API wraps the transaction in a `{ data: ... }` envelope. */
+interface SimulateBankTransferApiResponse {
+    data: TransactionWithStages;
+}
+/**
+ * Simulate bank-transfer settlement for a test-mode transaction (sandbox only).
+ *
+ * Drives a waiting-payment bank-transfer transaction to a terminal outcome
+ * without real funds. Settlement is asynchronous, so the response reflects the
+ * transaction's current state — poll `getTransaction(id)` for the terminal state.
+ */
+declare function simulateBankTransfer(ctx: ClientContext, id: string, params: SimulateBankTransferParams): Promise<Result<SimulateBankTransferApiResponse, SimulateBankTransferError>>;
+
 /** Options for creating a frame (iframe or WebView). */
 interface FrameOptions {
     /** Container to render the frame into. Platform-specific. */
@@ -217,6 +230,10 @@ interface CoreClient {
     getTransaction(id: string): Promise<Result<{
         data: TransactionWithStages;
     }, GetTransactionsError>>;
+    /** Simulate bank-transfer settlement for a test-mode transaction (sandbox only). */
+    simulateBankTransfer(id: string, params: SimulateBankTransferParams): Promise<Result<{
+        data: TransactionWithStages;
+    }, SimulateBankTransferError>>;
     deletePaymentMethod(id: string): Promise<Result<void, DevPlatformApiError>>;
     getCustomer(id: string): Promise<Result<{
         data: Customer;
@@ -332,4 +349,4 @@ declare function isTrustedFrameOrigin(origin: string): boolean;
  */
 declare function isTrustedFrameUrl(value: string): boolean;
 
-export { type ClientContext, type ClientContextOptions, type CoreClient, type CoreClientOptions, FRAME_PATHS, type FrameHandle, type FrameOptions, type FrameOrchestratorOptions, type FrameTransport, type KeyPair, type ListAssetsParams, type ListTransactionsParams, type PresentationMode, TRUSTED_FRAME_ORIGIN_PATTERNS, type ThemeOptions, type UrlBuilderOptions, apiFetch, applyPresentationParam, applyThemeParam, buildFrameUrl, createClientContext, createClientCore, createFrameOrchestrator, createIdentity, decryptCredentials, deletePaymentMethod, generateKeyPair, getAssets, getCustomer, getCustomerUploadUrl, getIdentity, getIdentityUploadUrl, getPaymentMethods, getQuote, getTransaction, isTrustedFrameOrigin, isTrustedFrameUrl, listTransactions, presentationParams, submitCustomerFiles, submitCustomerKyc, submitIdentityFiles, themeParams, updateIdentity, verifyIdentity };
+export { type ClientContext, type ClientContextOptions, type CoreClient, type CoreClientOptions, FRAME_PATHS, type FrameHandle, type FrameOptions, type FrameOrchestratorOptions, type FrameTransport, type KeyPair, type ListAssetsParams, type ListTransactionsParams, type PresentationMode, TRUSTED_FRAME_ORIGIN_PATTERNS, type ThemeOptions, type UrlBuilderOptions, apiFetch, applyPresentationParam, applyThemeParam, buildFrameUrl, createClientContext, createClientCore, createFrameOrchestrator, createIdentity, decryptCredentials, deletePaymentMethod, generateKeyPair, getAssets, getCustomer, getCustomerUploadUrl, getIdentity, getIdentityUploadUrl, getPaymentMethods, getQuote, getTransaction, isTrustedFrameOrigin, isTrustedFrameUrl, listTransactions, presentationParams, simulateBankTransfer, submitCustomerFiles, submitCustomerKyc, submitIdentityFiles, themeParams, updateIdentity, verifyIdentity };

package/dist/index.js

@@ -193,6 +193,18 @@ async function deletePaymentMethod(ctx, paymentMethodId) {
   return ok3(void 0);
 }
 
+// src/api/simulate-bank-transfer.ts
+async function simulateBankTransfer(ctx, id, params) {
+  return apiFetch(
+    ctx,
+    `/platform/v1/transactions/${encodeURIComponent(id)}/simulate-bank-transfer`,
+    {
+      method: "POST",
+      body: JSON.stringify(params)
+    }
+  );
+}
+
 // src/client.ts
 function createClientCore(options) {
   const ctx = createClientContext({
@@ -211,6 +223,7 @@ function createClientCore(options) {
     getPaymentMethods: () => getPaymentMethods(ctx),
     listTransactions: (params) => listTransactions(ctx, params),
     getTransaction: (id) => getTransaction(ctx, id),
+    simulateBankTransfer: (id, params) => simulateBankTransfer(ctx, id, params),
     deletePaymentMethod: (id) => deletePaymentMethod(ctx, id),
     getCustomer: (id) => getCustomer(ctx, id),
     submitCustomerKyc: (id, body) => submitCustomerKyc(ctx, id, body),
@@ -1701,6 +1714,7 @@ export {
   isTrustedFrameUrl,
   listTransactions,
   presentationParams,
+  simulateBankTransfer,
   submitCustomerFiles,
   submitCustomerKyc,
   submitIdentityFiles,