Interface PayFlowConfig

Configuration for pay flow

interface PayFlowConfig {
    authCode?: string;
    billIds: string[];
    billIdType?: "accounting" | "melio";
    containerId: string;
    entryPoint?: "contacts";
}

Hierarchy (view full)

Properties

authCode? billIds billIdType? containerId entryPoint?

Properties

OptionalauthCode

authCode?: string

Optional authorization code for the flow

billIds

billIds: string[]

OptionalbillIdType

billIdType?: "accounting" | "melio"

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.

containerId

containerId: string

The ID of the DOM element to inject the flow iframe into

OptionalentryPoint

entryPoint

Optional entry point context — affects the externalOrigin passed to the platform

Settings

Member Visibility

On This Page

Properties