Widget events in the SDK communication layer
This interface represents the events that the Widget SDK can trigger from within the MoonPay Widget to partners' parent applications.
This allows partner apps to be informed and adapt to certain widget lifecycle events.
RampsSwapsKycChildToParentInterface
↳ RampsChildToParentInterface
â–¸ onAuthToken(props): Promise<void>
Fired when the partner needs to receive an updated customer auth token so they can perform authorized actions on behalf of the customer.
Promise<void>
RampsSwapsKycChildToParentInterface.onAuthToken
â–¸ onInitiateDeposit(props): Promise<>
Called in the integrated sell flow, in the transaction tracker, when the widget is waiting for the sell amount to be deposited by the customer.
This allows the partner to trigger a deposit right from their wallet app.
Promise<>
â–¸ onLogin(props): Promise<void>
Fired when the customer logs in or their authentication is refreshed.
Promise<void>
â–¸ onSwapsCustomerSetupComplete(): Promise<void>
Fired when the Swaps Customer Setup flow has completed signaling to the parent app that the widget may now be closed.
Promise<void>
RampsSwapsKycChildToParentInterface.onSwapsCustomerSetupComplete
â–¸ onTransactionCompleted(props): Promise<void>
Fired when a transaction is detected as completed or if a previously completed transaction is loaded again in the transaction tracker.
Promise<void>
â–¸ onUnsupportedRegion(): Promise<void>
Fired when the Unsupported Region screen is triggered, independently of whether the widget redirects away from it.
Promise<void>
Updated 4 months ago
Table of Contents
Interface: RampsChildToParentInterface
Hierarchy
Methods
