End-to-end integration flow

This guide walks through a full partner integration, from creating a user to receiving webhook confirmations for a verified payout.

Work in progress

This guide is being written as part of ZAY-395. For now, the API Reference covers every endpoint in detail, including a quick start.

The flow at a glance

1. Create a user — POST /merchants/v1/users with the recipient's details.
2. Launch onboarding — open the hosted widget so the user completes KYC.
3. Wait for readiness — poll the user or subscribe to lifecycle webhooks.
4. Report a payout — broadcast USDC on-chain yourself, then POST /merchants/v1/payouts/report with the transaction hash.
5. Verification — ZAY verifies the transaction on-chain and settles the payout.
6. Webhooks — receive signed deliveries as the payout moves through its lifecycle.