Skip to main content
The MobileDeposit class is the main entry point for the mobile SDK. It manages the signer call, in-app browser lifecycle, deep link handling, and completion detection. 
import { MobileDeposit } from '@swype-org/deposit-mobile';

​
Constructor

new MobileDeposit(config: MobileDepositConfig)
Creates a new MobileDeposit instance. Throws a DepositError with code INVALID_REQUEST if any required config field is missing or invalid.

​
MobileDepositConfig

PropertyTypeDefaultDescription
signerstring | SignerFunctionrequiredURL string for the signer endpoint, or a custom async function. When a string, the SDK sends a POST with a JSON SignerRequest body. When a function, the SDK calls it with a SignerRequest and expects a Promise<SignerResponse>.
callbackSchemestringrequiredCustom URL scheme registered by the mobile app (e.g. 'myapp'). The hosted flow redirects to {callbackScheme}://swype/callback?... on completion.
openUrl(url: string) => Promise<void>requiredFunction that opens a URL in an in-app browser. Use expo-web-browser, SFSafariViewController (iOS), or CustomTabsIntent (Android). The returned promise should resolve when the browser is dismissed.
environment'production' | 'sandbox''production'Blink environment to target. 'sandbox' points the hosted flow at the testnet sandbox (https://pay-sandbox.blink.cash). An explicit webviewBaseUrl takes precedence.
webviewBaseUrlstring'https://pay.blink.cash'Base URL of the hosted payment webview app. Overrides environment when set.
callbackPathstring'/swype/callback'Path component of the callback deep link.
signerTimeoutMsnumber15000Maximum milliseconds to wait for the signer to respond.
flowTimeoutMsnumberundefined (no limit)Maximum milliseconds for the entire flow (signer + user completion).
debugbooleanfalseLog lifecycle events to console.debug with the [SwypeMobileDeposit] prefix.

​
Methods

​
requestDeposit

deposit.requestDeposit(request: DepositRequest): Promise<DepositResult>
Opens the hosted deposit flow in an in-app browser. The returned Promise resolves when the user completes the payment (via deep link callback) and rejects with a DepositError on failure. The merchant must listen for incoming deep links and pass them to handleDeepLink() for the promise to resolve. If a flow is already active, calling requestDeposit again cancels the previous flow and starts a new one. See Types for DepositRequest and DepositResult definitions. 
deposit.handleDeepLink(url: string): boolean
Feed an incoming deep link URL to the SDK. Returns true if the URL was a valid Blink callback and the SDK handled it, false if the URL did not match the expected callback pattern. Call this from your deep link listener (e.g. Linking.addEventListener('url', ...)).

​
on

deposit.on(event: EventName, handler: EventHandler): this
Register an event listener. Returns this for chaining.
EventHandler signatureWhen
complete(result: DepositResult) => voidPayment completed successfully.
error(error: DepositError) => voidPayment failed.
close() => voidIn-app browser closed or the flow was cancelled.
dismiss() => voidDeprecated alias for close.
status-change(status: MobileDepositStatus) => voidStatus changed.

​
off

deposit.off(event: EventName, handler: EventHandler): this
Remove a previously registered event listener. Returns this for chaining.

​
close

deposit.close(): void
Cancel the current flow. Rejects the pending promise with DEPOSIT_DISMISSED.

​
focus

deposit.focus(): void
No-op retained for API compatibility with @swype-org/deposit.

​
destroy

deposit.destroy(): void
Tear down the instance and release all resources. Clears all timers, removes all event listeners, and marks the instance as destroyed. Subsequent calls to requestDeposit will reject with INVALID_REQUEST. Call this on component unmount.

​
Properties

​
status

deposit.status: MobileDepositStatus
Current phase of the deposit flow. One of 'idle', 'signer-loading', 'browser-active', 'completed', or 'error'.

​
result

deposit.result: DepositResult | null
Last successful DepositResult, available when status === 'completed'.

​
error

deposit.error: DepositError | null
Last DepositError, available when status === 'error'.

​
isActive

deposit.isActive: boolean
true when a deposit flow is in progress (status is 'signer-loading' or 'browser-active').