---
updatedAt: 2026-09-03T05:18:14.000Z
agentTools:
  projectIndex: https://docs.zeptopayments.com/llms.txt
---

# Zepto Flow Overview

Accept payments with Zepto's embeddable Flow widget. Your server creates a Payment Intent. The browser mounts the widget, and the widget does the rest.

<div class="zepto-docs-hero">
  <div class="zepto-docs-hero__content">
    <span class="zepto-docs-hero__badge">DEVELOPER GUIDE</span>
    <h1>Zepto Flow Overview</h1>
    <p>Accept PayTo payments with Zepto's embeddable Flow widget.</p>
  </div>
  <div class="zepto-docs-hero__visual" aria-hidden="true">
    <div class="zepto-docs-hero__glow"></div>
   
  </div>
</div>

Zepto Flow is an embeddable PayTo experience for your own checkout. You create a **Payment Intent** with a single API call from your server, then you hand the result to the widget in the payer's browser. From there the widget does the work: it collects the payer's account details, it waits while the payer approves the PayTo agreement in the banking app, then it tells your page the outcome.

You get a PayTo integration, without having to build the UI or manage multiple calls to Zepto's APIs. The payer's payment details never touch your servers.

## What is a Payment Intent?

A **Payment Intent** is a server-side object that represents one checkout session. It holds the agreement and the payment you want to take, and it drives the widget from start to finish.

You create a Payment Intent on your server with your secret API key. In return you get a browser-safe `token` and the first `action`. Pass both to your page.

A Payment Intent has four traits worth knowing:

* **One per checkout.** It covers a single session: one PayTo agreement and one payment. Create a new Payment Intent for each checkout attempt.
* **Temporary.** It is short-lived. The `token` is scoped to this one Payment Intent, and it cannot be reused across sessions.
* **Client-side safe.** The `token` is the only credential that reaches the browser. Your secret API key is only used between your server and our API.
* **Self-driving.** After the widget is mounted with the `token` and `action`, the Payment Intent advances through the workflow until it settles or fails.

You create it in the first step. See [Create a Payment Intent](https://docs.zeptopayments.com/docs/zepto-flow-create-payment-intent) for the full request.

<div class="zepto-flow-steps">
  <div class="zepto-flow-steps__header">
    <span class="zepto-flow-steps__eyebrow">ZEPTO FLOW</span>
    <h3 class="zepto-flow-steps__title">

Accept a PayTo payment with <strong>Zepto Flow</strong> in 3 simple steps

    </h3>
    <p class="zepto-flow-steps__subtitle">

Create a Payment Intent, embed the widget, and redirect the payer once the payment settles.

    </p>
  </div>

  <div class="zepto-flow-steps__grid">
    <div class="zepto-flip-card">
      <div class="zepto-flip-card__inner">
        <div class="zepto-flip-card__face zepto-flip-card__face--front">
          <div class="zepto-step-badge">01</div>
          <div class="zepto-step-icon" aria-hidden="true">
            <svg viewBox="0 0 24 24" fill="none">
              <path d="M7 4.75h7.5L19 9.25V19a2 2 0 0 1-2 2H7a2 2 0 0 1-2-2V6.75a2 2 0 0 1 2-2Z" stroke="currentColor" stroke-width="1.7" stroke-linejoin="round"></path>
              <path d="M14 4.75v4a.5.5 0 0 0 .5.5h4" stroke="currentColor" stroke-width="1.7" stroke-linecap="round" stroke-linejoin="round"></path>
            </svg>
          </div>
          <h4>Create Payment Intent</h4>
          <p>Your server creates a Payment Intent and passes the returned values to your checkout page.</p>
        </div>

        <div class="zepto-flip-card__face zepto-flip-card__face--back">
          <h4>Create Payment Intent</h4>
          <ul>
            <li>Server-to-server call with your API key</li>
            <li>Describes the agreement and payment</li>
            <li>Returns a browser-safe <code>{token, action}</code></li>
          </ul>
        </div>
      </div>
    </div>

    <div class="zepto-flip-card">
      <div class="zepto-flip-card__inner">
        <div class="zepto-flip-card__face zepto-flip-card__face--front">
          <div class="zepto-step-badge">02</div>
          <div class="zepto-step-icon" aria-hidden="true">
            <svg viewBox="0 0 24 24" fill="none">
              <rect x="3" y="4.5" width="18" height="15" rx="2.5" stroke="currentColor" stroke-width="1.7"></rect>
              <path d="M3 9h18" stroke="currentColor" stroke-width="1.7" stroke-linecap="round"></path>
              <circle cx="6" cy="6.75" r="0.7" fill="currentColor"></circle>
              <circle cx="8.4" cy="6.75" r="0.7" fill="currentColor"></circle>
            </svg>
          </div>
          <h4>Flow UI</h4>
          <p>Mount the Flow widget on your page - it autonomously collects the payer's details and guides them through authorising the agreement.</p>
        </div>

        <div class="zepto-flip-card__face zepto-flip-card__face--back">
          <h4>Flow UI</h4>
          <ul>
            <li>Load the SDK and mount with <code>{token, action}</code></li>
            <li>Payer enters their PayID or bank account</li>
            <li>Payer approves in their banking app</li>
          </ul>
        </div>
      </div>
    </div>

    <div class="zepto-flip-card">
      <div class="zepto-flip-card__inner">
        <div class="zepto-flip-card__face zepto-flip-card__face--front">
          <div class="zepto-step-badge">03</div>
          <div class="zepto-step-icon" aria-hidden="true">
            <svg viewBox="0 0 24 24" fill="none">
              <circle cx="12" cy="12" r="8.25" stroke="currentColor" stroke-width="1.7"></circle>
              <path d="M8.5 12.2l2.3 2.3 4.7-5" stroke="currentColor" stroke-width="1.8" stroke-linecap="round" stroke-linejoin="round"></path>
            </svg>
          </div>
          <h4>Redirect on Success</h4>
          <p>When the payment settles, Flow tells your page. Send the payer to your success page.</p>
        </div>

        <div class="zepto-flip-card__face zepto-flip-card__face--back">
          <h4>Redirect on Success</h4>
          <ul>
            <li>Subscribe to the widget's events</li>
            <li>On success, redirect to your confirmation page</li>
            <li>Handle failures with a retry</li>
          </ul>
        </div>
      </div>
    </div>
  </div>

</div>

<style>
.zepto-flow-steps {
    --zepto-green: #00b389;
    --zepto-green-dark: #009e79;

    /* default = light-safe */
    --zp-bg: linear-gradient(180deg, rgba(255,255,255,0.96), rgba(248,250,250,0.98));
    --zp-border: rgba(16, 24, 40, 0.10);
    --zp-title: #142021;
    --zp-text: #5f6b6d;
    --zp-surface: #ffffff;
    --zp-surface-border: rgba(0, 179, 137, 0.18);
    --zp-surface-shadow: 0 10px 30px rgba(16, 24, 40, 0.08), inset 0 1px 0 rgba(255,255,255,0.45);
    --zp-front-overlay: linear-gradient(180deg, rgba(0, 179, 137, 0.08), rgba(0, 179, 137, 0.03));
    --zp-back-bg: #212323;
    --zp-back-border: rgba(255,255,255,0.08);
    --zp-back-text: rgba(255,255,255,0.92);
    --zp-eyebrow-bg: rgba(0, 179, 137, 0.10);
    --zp-icon-bg: rgba(0, 179, 137, 0.10);

    position: relative;
    padding: 32px;
    border-radius: 24px;
    border: 1px solid var(--zp-border);
    background:
      radial-gradient(circle at top right, rgba(0, 179, 137, 0.10), transparent 28%),
      var(--zp-bg);
    overflow: hidden;
  }

  .zepto-flow-steps__header {
    max-width: 760px;
    margin: 0 auto 28px;
    text-align: center;
  }

  .zepto-flow-steps__eyebrow {
    display: inline-flex;
    align-items: center;
    justify-content: center;
    margin-bottom: 12px;
    padding: 7px 12px;
    border-radius: 999px;
    background: var(--zp-eyebrow-bg);
    color: var(--zepto-green);
    font-size: 12px;
    font-weight: 700;
    letter-spacing: 0.12em;
  }

  .zepto-flow-steps__title {
    margin: 0;
    font-size: clamp(28px, 3vw, 38px);
    line-height: 1.15;
    letter-spacing: -0.03em;
    font-weight: 700;
    color: var(--zp-title);
  }

  .zepto-flow-steps__title strong {
    color: var(--zepto-green);
    font-weight: 800;
  }

  .zepto-flow-steps__subtitle {
    margin: 14px auto 0;
    max-width: 620px;
    font-size: 15px;
    line-height: 1.65;
    color: var(--zp-text);
  }

  .zepto-flow-steps__grid {
    display: grid;
    grid-template-columns: repeat(3, minmax(0, 1fr));
    gap: 22px;
  }

  .zepto-flip-card {
    perspective: 1400px;
    min-height: 280px;
  }

  .zepto-flip-card__inner {
    position: relative;
    width: 100%;
    height: 100%;
    min-height: 280px;
    transition: transform 0.75s cubic-bezier(0.22, 1, 0.36, 1);
    transform-style: preserve-3d;
  }

  .zepto-flip-card:hover .zepto-flip-card__inner,
  .zepto-flip-card:focus-within .zepto-flip-card__inner {
    transform: rotateY(180deg);
  }

  .zepto-flip-card__face {
    position: absolute;
    inset: 0;
    border-radius: 22px;
    -webkit-backface-visibility: hidden;
    backface-visibility: hidden;
    overflow: hidden;
    display: flex;
    flex-direction: column;
    justify-content: flex-start;
    min-height: 280px;
  }

  .zepto-flip-card__face--front {
    padding: 22px;
    border: 1px solid var(--zp-surface-border);
    background: var(--zp-front-overlay), var(--zp-surface);
    box-shadow: var(--zp-surface-shadow);
  }

  .zepto-flip-card__face--back {
    padding: 24px 24px 24px 26px;
    background:
      radial-gradient(circle at top right, rgba(0, 179, 137, 0.18), transparent 32%),
      var(--zp-back-bg);
    border: 1px solid var(--zp-back-border);
    color: #ffffff;
    transform: rotateY(180deg);
    box-shadow: 0 14px 34px rgba(0, 0, 0, 0.22);
  }

  .zepto-step-badge {
    display: inline-flex;
    align-items: center;
    justify-content: center;
    width: 42px;
    height: 42px;
    border-radius: 12px;
    background: var(--zepto-green);
    color: #ffffff;
    font-size: 13px;
    font-weight: 800;
    letter-spacing: 0.06em;
    box-shadow: 0 10px 22px rgba(0, 179, 137, 0.24);
  }

  .zepto-step-icon {
    display: inline-flex;
    align-items: center;
    justify-content: center;
    width: 58px;
    height: 58px;
    margin-top: 18px;
    border-radius: 16px;
    background: var(--zp-icon-bg);
    color: var(--zepto-green);
  }

  .zepto-step-icon svg {
    width: 28px;
    height: 28px;
  }

  .zepto-flip-card__face--front h4,
  .zepto-flip-card__face--back h4 {
    margin: 20px 0 10px;
    font-size: 22px;
    line-height: 1.15;
    letter-spacing: -0.02em;
    font-weight: 700;
  }

  .zepto-flip-card__face--front h4 {
    color: var(--zp-title);
  }

  .zepto-flip-card__face--front p {
    margin: 0;
    font-size: 14px;
    line-height: 1.65;
    color: var(--zp-text);
  }

  .zepto-flip-card__face--back ul {
    margin: 6px 0 0;
    padding-left: 18px;
  }

  .zepto-flip-card__face--back li {
    margin: 0 0 10px;
    font-size: 14px;
    line-height: 1.6;
    color: var(--zp-back-text);
  }

  /* Explicit ReadMe / app light mode */
  :root.light .zepto-flow-steps,
  [data-theme="light"] .zepto-flow-steps,
  [data-color-mode="light"] .zepto-flow-steps,
  [data-mode="light"] .zepto-flow-steps,
  .rm-Light .zepto-flow-steps,
  .light .zepto-flow-steps {
    --zp-bg: linear-gradient(180deg, rgba(255,255,255,0.96), rgba(248,250,250,0.98));
    --zp-border: rgba(16, 24, 40, 0.10);
    --zp-title: #142021;
    --zp-text: #5f6b6d;
    --zp-surface: #ffffff;
    --zp-surface-border: rgba(0, 179, 137, 0.18);
    --zp-surface-shadow: 0 10px 30px rgba(16, 24, 40, 0.08), inset 0 1px 0 rgba(255,255,255,0.45);
    --zp-front-overlay: linear-gradient(180deg, rgba(0, 179, 137, 0.08), rgba(0, 179, 137, 0.03));
    --zp-back-bg: #212323;
    --zp-back-border: rgba(255,255,255,0.08);
    --zp-back-text: rgba(255,255,255,0.92);
    --zp-eyebrow-bg: rgba(0, 179, 137, 0.10);
    --zp-icon-bg: rgba(0, 179, 137, 0.10);
  }

  /* Explicit ReadMe / app dark mode */
  :root.dark .zepto-flow-steps,
  [data-theme="dark"] .zepto-flow-steps,
  [data-color-mode="dark"] .zepto-flow-steps,
  [data-mode="dark"] .zepto-flow-steps,
  .rm-Dark .zepto-flow-steps,
  .dark .zepto-flow-steps {
    --zp-bg: linear-gradient(180deg, rgba(18,22,22,0.98), rgba(13,17,17,0.98));
    --zp-border: rgba(255, 255, 255, 0.10);
    --zp-title: #ffffff;
    --zp-text: rgba(255,255,255,0.74);
    --zp-surface: #161a1a;
    --zp-surface-border: rgba(255,255,255,0.08);
    --zp-surface-shadow: 0 10px 30px rgba(0, 0, 0, 0.22), inset 0 1px 0 rgba(255,255,255,0.03);
    --zp-front-overlay: linear-gradient(180deg, rgba(0, 179, 137, 0.12), rgba(0, 179, 137, 0.04));
    --zp-back-bg: #0f1313;
    --zp-back-border: rgba(255,255,255,0.08);
    --zp-back-text: rgba(255,255,255,0.9);
    --zp-eyebrow-bg: rgba(0, 179, 137, 0.14);
    --zp-icon-bg: rgba(0, 179, 137, 0.12);
  }

  /* System mode fallback */
  @media (prefers-color-scheme: dark) {
    .zepto-flow-steps {
      --zp-bg: linear-gradient(180deg, rgba(18,22,22,0.98), rgba(13,17,17,0.98));
      --zp-border: rgba(255, 255, 255, 0.10);
      --zp-title: #ffffff;
      --zp-text: rgba(255,255,255,0.74);
      --zp-surface: #161a1a;
      --zp-surface-border: rgba(255,255,255,0.08);
      --zp-surface-shadow: 0 10px 30px rgba(0, 0, 0, 0.22), inset 0 1px 0 rgba(255,255,255,0.03);
      --zp-front-overlay: linear-gradient(180deg, rgba(0, 179, 137, 0.12), rgba(0, 179, 137, 0.04));
      --zp-back-bg: #0f1313;
      --zp-back-border: rgba(255,255,255,0.08);
      --zp-back-text: rgba(255,255,255,0.9);
      --zp-eyebrow-bg: rgba(0, 179, 137, 0.14);
      --zp-icon-bg: rgba(0, 179, 137, 0.12);
    }
  }

  @media (prefers-color-scheme: light) {
    .zepto-flow-steps {
      --zp-bg: linear-gradient(180deg, rgba(255,255,255,0.96), rgba(248,250,250,0.98));
      --zp-border: rgba(16, 24, 40, 0.10);
      --zp-title: #142021;
      --zp-text: #5f6b6d;
      --zp-surface: #ffffff;
      --zp-surface-border: rgba(0, 179, 137, 0.18);
      --zp-surface-shadow: 0 10px 30px rgba(16, 24, 40, 0.08), inset 0 1px 0 rgba(255,255,255,0.45);
      --zp-front-overlay: linear-gradient(180deg, rgba(0, 179, 137, 0.08), rgba(0, 179, 137, 0.03));
      --zp-back-bg: #212323;
      --zp-back-border: rgba(255,255,255,0.08);
      --zp-back-text: rgba(255,255,255,0.92);
      --zp-eyebrow-bg: rgba(0, 179, 137, 0.10);
      --zp-icon-bg: rgba(0, 179, 137, 0.10);
    }
  }

  @media (max-width: 980px) {
    .zepto-flow-steps__grid {
      grid-template-columns: 1fr;
    }

    .zepto-flip-card,
    .zepto-flip-card__inner,
    .zepto-flip-card__face {
      min-height: 250px;
    }
  }

  @media (max-width: 640px) {
    .zepto-flow-steps {
      padding: 24px 18px;
      border-radius: 20px;
    }

    .zepto-flow-steps__header {
      margin-bottom: 22px;
    }

    .zepto-flow-steps__title {
      font-size: 28px;
    }

    .zepto-flip-card,
    .zepto-flip-card__inner,
    .zepto-flip-card__face {
      min-height: 230px;
    }

    .zepto-flip-card__face--front,
    .zepto-flip-card__face--back {
      padding: 20px;
    }

    .zepto-flip-card__face--front h4,
    .zepto-flip-card__face--back h4 {
      font-size: 20px;
    }
  }
</style>

## How it works

Flow splits cleanly into two responsibilities.

**Your backend** makes one server-to-server call to create a Payment Intent. It uses your secret API key for authentication. It gets back a `token` and the first `action`.

**Your checkout page** loads the Flow SDK. It mounts the widget with that `{ token, action }`. Then it listens for lifecycle events. The widget makes every later API call with the browser-safe `token` for authentication - your secret key isn't needed.

The end-to-end sequence:

1. Your backend calls `create-payment-intent` and receives `{ token, action }`.
2. Your page mounts the widget: `ZeptoFlow.mount('#el', { token, action })`.
3. The widget collects the payer's PayID or BSB and account number. Then it creates the PayTo agreement.
4. The payer approves the agreement in the banking app. The widget waits.
5. The widget creates the payment and waits for settlement.
6. The widget emits a terminal event: `zepto:payto:payment-settled` or `zepto:payto:payment-failed`.

<Zepto_Callout type="info" title="One call is yours, the rest are the widget's" id="one-call-is-yours">
Your server calls `create-payment-intent` directly. The widget makes the agreement, payment, and settlement calls for the payer. You react to the events it emits.
</Zepto_Callout>

## What Flow supports today

Flow now supports the **one-time payment** flow (`PayTo.Debtor.OneTimePayment`). It creates an agreement and takes one payment against it in one guided session. We will add more flows to this guide when they become available.

Flow is built to grow beyond PayTo. Events are namespaced by rail (`zepto:payto:*`), which leaves room for future rails such as PayID (`zepto:payid:*`).

## Build it in five pages

This guide shows you a complete integration:

1. [Before you begin](https://docs.zeptopayments.com/docs/zepto-flow-before-you-begin): API keys, environments, and how to load the SDK.
2. [Create a Payment Intent](https://docs.zeptopayments.com/docs/zepto-flow-create-payment-intent): the one server-side call.
3. [Mount the widget](https://docs.zeptopayments.com/docs/zepto-flow-mount-widget): add Flow to your checkout page.
4. [Handle the payment lifecycle](https://docs.zeptopayments.com/docs/zepto-flow-payment-lifecycle): react to the events.
5. [Test in the sandbox](https://docs.zeptopayments.com/docs/zepto-flow-sandbox-testing): check the success and failure paths.

For theming, see [Theming the widget](https://docs.zeptopayments.com/docs/zepto-flow-theming). For the complete client API, see the [SDK reference](https://docs.zeptopayments.com/docs/zepto-flow-sdk-reference).