@melio-eng/web-sdk 1.0.39 → 1.0.40-pr.86.97072e0

package/README.md

@@ -35,6 +35,7 @@ init.on("authenticationSucceeded", () => {
   const payFlow = melioSDK.openPayFlow({
     containerId: "melio-payflow-container",
     billIds: ["bill_abc123"],
+    billIdType: "melio",
   });
 
   payFlow.on("completed", (data) => {
@@ -101,11 +102,15 @@ Each environment uses a different base URL:
 ### Flow Methods
 
 #### Pay Flow
-Pay one or more bills. Pass the **Melio bill IDs** returned by `POST /pay-flow/prepare`.
+Pay one or more bills. Pass the **Melio bill IDs** returned by `POST /pay-flow/prepare` together with `billIdType: "melio"`.
 ```typescript
 melioSDK.openPayFlow(config: PayFlowConfig): FlowInstance
 ```
 
+`billIdType` controls how the platform resolves `billIds` (defaults to `"accounting"`):
+- `"melio"` — `billIds` are Melio bill IDs from `/pay-flow/prepare`; the payment screen opens directly. **Use this for the prepare-based pay-flow integration.**
+- `"accounting"` — `billIds` are external accounting-software IDs, imported on demand (for accounting-software partners such as Xero / QuickBooks).
+
 #### Just Pay Flow
 Vendor-based payment (start from a vendor rather than a specific bill).
 ```typescript
@@ -138,6 +143,7 @@ Each flow method returns a `FlowInstance` that allows you to register event list
 const flow = melioSDK.openPayFlow({
   containerId: "melio-payflow-container",
   billIds: ["bill_abc123"],
+  billIdType: "melio",
 });
 
 flow.on("loaded",    ()     => console.log("Flow rendered"));
@@ -163,6 +169,7 @@ flow.on("navigated", (p)    => console.log("Navigated to:", p.target));
 const payFlow = melioSDK.openPayFlow({
   containerId: "melio-payflow-container",
   billIds: ["bill_abc123", "bill_def456"],   // Melio bill IDs from /pay-flow/prepare
+  billIdType: "melio",
 });
 
 payFlow.on("completed", (data) => {
@@ -187,6 +194,7 @@ init.on("authenticationSucceeded", () => {
   melioSDK.openPayFlow({
     containerId: "payment-container",
     billIds: ["bill_abc123"],
+    billIdType: "melio",
   });
 });
 ```

package/dist/flows/PayFlow.d.ts

@@ -7,9 +7,20 @@ export declare class PayFlow extends Flow {
     private billIds;
     private authCode;
     private entryPoint?;
+    private billIdType;
     constructor(containerId: string, config: PayFlowConfig, partnerName: string, environment: Environment, authCode: string, branchOverride?: string);
     /**
      * Construct the specific flow URL for bill payment - now goes through /auth
      */
     protected constructFlowUrl(baseUrl: string): string;
+    /**
+     * Native Melio bill ids (from POST /pay-flow/prepare) already exist in Melio,
+     * so open the payment screen directly instead of importing via external-entries.
+     */
+    private buildMelioTarget;
+    /**
+     * External accounting-software bill ids are imported on demand through the
+     * external-entries flow before payment.
+     */
+    private buildAccountingTarget;
 }

package/dist/flows/PayFlow.js

@@ -9,6 +9,7 @@ export class PayFlow extends Flow {
         this.billIds = config.billIds;
         this.authCode = authCode;
         this.entryPoint = config.entryPoint;
+        this.billIdType = config.billIdType ?? 'accounting';
         if (isEmptyString(this.authCode)) {
             throw new Error('Authorization code is required for pay flow. Please call init() before opening pay flow.');
         }
@@ -17,10 +18,26 @@ export class PayFlow extends Flow {
      * Construct the specific flow URL for bill payment - now goes through /auth
      */
     constructFlowUrl(baseUrl) {
-        const billIdsParam = this.billIds.join(',');
-        const externalOrigin = this.entryPoint ? `${this.partnerName}-${this.entryPoint}` : this.partnerName;
-        const target = `/external-entries/payment-flow?billIds=${billIdsParam}&externalOrigin=${externalOrigin}`;
+        const target = this.billIdType === 'melio' ? this.buildMelioTarget() : this.buildAccountingTarget();
         const encodedTarget = encodeURIComponent(target);
         return `${baseUrl}/${this.partnerName}/auth?token=${this.authCode}&redirectUrl=${encodedTarget}`;
     }
+    /**
+     * Native Melio bill ids (from POST /pay-flow/prepare) already exist in Melio,
+     * so open the payment screen directly instead of importing via external-entries.
+     */
+    buildMelioTarget() {
+        return this.billIds.length === 1
+            ? `/payment/new?billId=${this.billIds[0]}`
+            : `/batch-payments/${this.billIds.join(',')}`;
+    }
+    /**
+     * External accounting-software bill ids are imported on demand through the
+     * external-entries flow before payment.
+     */
+    buildAccountingTarget() {
+        const billIdsParam = this.billIds.join(',');
+        const externalOrigin = this.entryPoint ? `${this.partnerName}-${this.entryPoint}` : this.partnerName;
+        return `/external-entries/payment-flow?billIds=${billIdsParam}&externalOrigin=${externalOrigin}`;
+    }
 }

package/dist/types.d.ts

@@ -63,6 +63,16 @@ export interface PayFlowConfig extends BaseFlowConfig {
     billIds: Array<string>;
     /** Optional entry point context — affects the externalOrigin passed to the platform */
     entryPoint?: ExternalEntryPoint;
+    /**
+     * How the platform should resolve the provided `billIds`. Defaults to `'accounting'`.
+     * - `'accounting'`: `billIds` are external accounting-software ids. The platform imports
+     *   them on demand through the external-entries flow. Use this for accounting-software
+     *   partners (e.g. Xero, QuickBooks) whose bills originate in the external system.
+     * - `'melio'`: `billIds` are native Melio bill ids returned by `POST /pay-flow/prepare`.
+     *   The bills already exist in Melio, so the payment screen opens directly — no
+     *   accounting-platform sync. Use this for the prepare-based pay-flow integration.
+     */
+    billIdType?: 'accounting' | 'melio';
 }
 /**
  * Configuration for just pay flow (vendor-based payment)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@melio-eng/web-sdk",
-  "version": "1.0.39",
+  "version": "1.0.40-pr.86.97072e0",
   "description": "Melio Web SDK - Embed core Melio workflows directly into partner UI with minimal effort",
   "main": "dist/index.js",
   "module": "dist/index.js",