Merge pull request #103 from revolut-engineering/REVG-2150

REVG-2150 Expose embedded checkout

Author: immolateimp

src/types.ts

@@ -718,6 +718,32 @@ export interface PaymentsModulePaymentRequest {
   destroy: () => void
 }
 
+export interface EmbeddedCheckoutInstance {
+  /** Manually destroy the instance	 */
+  destroy: () => void
+}
+
+export interface EmbeddedCheckoutOptions {
+  /** Empty element inside payment page */
+  target: HTMLElement
+  /** A function to create a Revolut order at a later time within the flow  */
+  createOrder: () => Promise<{ publicId: string }>
+  /** Callback will be called when the payment is completed successfully */
+  onSuccess?: (payload: { orderId: string }) => void
+  /** Callback if transaction is failed to complete, the reason should be available in the message parameter */
+  onError?: (payload: { error: RevolutCheckoutError; orderId: string }) => void
+  /** Callback if an user did not complete the transaction and canceled the authorisation */
+  onCancel?: (payload: { orderId: string | undefined }) => void
+  /** Customer's email */
+  email?: string
+  /** Contains customer's billing address */
+  billingAddress?: Address
+}
+
+export interface EmbeddedCheckout {
+  (options: EmbeddedCheckoutOptions): EmbeddedCheckoutInstance
+}
+
 export interface RevolutCheckoutInstance {
   /**
    * Show full-screen payment form with card field and user email.
@@ -745,6 +771,8 @@ export interface RevolutCheckoutInstance {
   payments: (
     option: RevolutPaymentsModuleOptions
   ) => RevolutPaymentsModuleInstance
+  /** Accept payments via checkout widget */
+  embeddedCheckout: EmbeddedCheckout
 }
 
 export interface RevolutPaymentsModuleInstance {