diff --git a/widget.mdx b/widget.mdx index 442d40b..9e35b9e 100644 --- a/widget.mdx +++ b/widget.mdx @@ -5,7 +5,7 @@ description: "Embed a hosted cashout experience so your users can withdraw earne ## Overview -The ZBD Widget is an embeddable iframe that handles the full cashout flow for your users — identity verification (KYC), bank account linking (Plaid), and ACH payouts. Your backend handles user creation, session minting, and balance funding; the widget handles everything else. +The ZBD Widget is an embeddable iframe that runs the cashout experience for your users — OTP verification, identity verification, bank account linking, and bank payouts. Your backend creates widget users, funds their point balances, creates sessions, and handles its own end-user terms and disclosures before the widget opens. ## Prerequisites @@ -28,19 +28,52 @@ To get sandbox running quickly, start with the [sandbox guide](/widget/sandbox): 4. Embed the returned `widget_url` in your frontend. 5. Listen for widget events and webhook deliveries. +## Terms and disclosures + +Your application must present and record acceptance of its applicable Terms of +Service, Privacy Policy, and required disclosures before it creates a widget +session. The widget does not render those documents or collect that acceptance +on the publisher's behalf, but it validates that the required terms have been +accepted before the user can access its services. + +## Country availability + +The widget uses the country resolved from the user's IP before identity +verification. After identity verification, it uses the user's verified +residential country to select the available bank rail. + +### USD bank cashout + +USD bank cashout (ACH) is available only in the United States. + +### EUR bank cashout + +EUR bank cashout (SCT) is available in Austria, Belgium, Denmark, Estonia, +Finland, France, Germany, Italy, Latvia, Lithuania, the Netherlands, Poland, +Portugal, Spain, and Sweden. + +SCT is not available in other countries, including Bulgaria, Croatia, Cyprus, +Czechia, Greece, Hungary, Ireland, Luxembourg, Malta, Romania, Slovakia, +Slovenia, and Switzerland. + +### Restricted locations + +The widget is not supported for users in Cuba, Iran, North Korea, or Syria. + ## Integration Flow ``` 1. Create User POST /api/v1/widget/users (your server → ZBD API) 2. Fund User POST /api/v1/widget/users/fund (your server → ZBD API) -3. Deplete User POST /api/v1/widget/users/deplete (your server → ZBD API) +3. Reverse a Fund POST /api/v1/widget/users/deplete (your server → ZBD API) 4. Get Balance GET /api/v1/widget/users/{userId}/balance (your server → ZBD API) 5. Create Session POST /api/v1/widget/users/session (your server → ZBD API) 6. Embed Widget