openIframe()

Opens the payment page in an iframe for a given session ID.

openIframe(sessionId: string, iframeConfig?: IframeConfig): void

Pass iframeConfig directly to open a session created by your backend — the recommended integration. If you omit it, the SDK reuses the iframeConfig from a previous createSession() call on the same instance.

Iframe mode requires your domain to be whitelisted in your Payviox dashboard settings.

An iframe doesn’t guarantee the customer stays on your page. Redirect-based providers (PayPal, Zen, Nicepay, Payssion, Pallapay, Crypto.com) can’t render inside an iframe, so picking one triggers a full-page navigation to the provider. To keep the customer on your page in all cases, restrict the session to a non-redirect method — for example paymentMethodId: 'stripe_credit'. See Iframe integration.

Parameters

string

required

The session ID to display in the iframe. Returned by POST /session or by createSession().

IframeConfig

Iframe configuration. Required unless a previous createSession() call on this instance already provided one.

Show IframeConfig properties

HTMLElement

required

DOM element the iframe is inserted into. Its existing children are replaced.

string

default:"100%"

Any valid CSS width.

string

default:"400px"

Any valid CSS height.

boolean

default:"false"

Removes the iframe border.

boolean

default:"false"

Renders the payment page with a transparent background.

string

Additional CSS applied to the iframe.

Examples

Recommended: session created by your backend

const payviox = new Payviox('pk_live_your_key');

const { session_id } = await fetch('/api/checkout', { method: 'POST' }).then((r) => r.json());

payviox.openIframe(session_id, {
  iframeTarget: document.getElementById('payment-container'),
  height: '600px',
  withoutBorder: true,
});

Session created by the SDK

const payviox = new Payviox('pk_live_your_key');

// Passing iframeConfig here lets openIframe() be called later without arguments.
const sessionId = await payviox.createSession({
  amount: 5000,
  currency: 'USD',
  customer: 'user@example.com',
  description: 'Order payment',
  order_id: 'order_123',
  items: [{ name: 'Product', quantity: 1, price: 5000 }]
}, {
  iframeConfig: {
    iframeTarget: document.getElementById('payment-container')
  }
});

// Open the iframe later
payviox.openIframe(sessionId);

If you don’t need to do anything between session creation and display, iframeMode: true in createSession() opens the iframe for you.

Errors

Throws Iframe target is required when no iframeTarget is available — neither in the iframeConfig argument nor from a previous createSession() call.

SDK - Getting Started

SDK - Integration

SDK - API Reference

Parameters

Examples

Recommended: session created by your backend

Session created by the SDK

Errors

​Parameters

​Examples

​Recommended: session created by your backend

​Session created by the SDK

​Errors

Parameters

Examples

Recommended: session created by your backend

Session created by the SDK

Errors