Overview
Widget ACH cashout requires the user to accept the latest Electronic Funds Transfer disclosure (type6). ZBD tracks acceptance by disclosure type and
version, so the user must accept a new type 6 version even if they accepted an
older version before.
Disclosure status does not block widget session creation. The disclosure APIs
can also return types 1 through 5; those types do not block widget cashout
and can be ignored for widget eligibility. Your contract or other ZBD services
may impose separate legal requirements.
Your application is responsible for presenting the Electronic Funds Transfer
document and collecting the user’s acceptance. The widget does not render the
document or record acceptance on the publisher’s behalf.
End-to-end Flow
No disclosure type is checked when a widget session is created. Type
6 is checked only when an ACH cashout is submitted. Complete the publisher-side type 6 flow before opening the widget to avoid sending the user into a blocked ACH flow. Disclosure APIs require your server-side API key and must not be called from a browser, game client, or WebView.Outstanding Disclosures on User Creation
You do not need a separate call to discover whether Electronic Funds Transfer type6 is outstanding. The Create User response (POST /api/v1/widget/users) already includes an outstanding_disclosures array on
that first user request.
The array can contain types 1 through 5; ignore those entries for widget
eligibility. For ACH, filter for type_id: 6. If no type 6 entry is present,
the user is current for the widget ACH disclosure gate.
outstanding_disclosures only lists what is still outstanding. When you need the complete picture — including which disclosures a user has already accepted and when — use the dedicated endpoints:
- Get Disclosure Status — list every current disclosure type with the user’s acceptance state (
tos_current,accepted_at); inspect type6for ACH. - Submit Disclosure Acceptance — record acceptance of the latest type
6version from your server.
The same
outstanding_disclosures shape also appears in the widget session status during a session (see Session Status). Create User is the initial snapshot at provisioning time; Get Disclosure Status is the source of truth for the full, up-to-date acceptance state.Disclosure Types
The disclosure endpoints can report other types, but the widget has one required publisher-managed disclosure:ACH cashout submission requires the current Electronic Funds Transfer disclosure to be accepted. If the user has not accepted the latest type
6 version, the request is rejected before payout processing. Type 6 is not required for SCT cashout. Types 1 through 5 do not block widget cashout, and no disclosure type blocks widget session creation.Session Status
During a widget session, ZBD can return all outstanding disclosure information as a read-only status. The field is namedoutstanding_disclosures. This does
not cause the widget to display documents or collect acceptance.
Only an outstanding type 6 entry affects widget ACH eligibility. Types 1
through 5 can remain outstanding without blocking the session or cashout.
Example session status shape:
outstanding_disclosures contains type 6, return the user to the
publisher-side EFT acceptance flow before ACH cashout. Do not block widget access
because the array contains only types 1 through 5.
Recording acceptance before the widget
Use the widget disclosure APIs from your server to check and record type6
acceptance before ACH cashout. The API key determines the project context, so
these endpoints only require the widget user ID in the path.
Use Get Disclosure Status to check type 6 and
Submit Disclosure Acceptance to record
acceptance of its latest version.
Existing Users
Disclosure acceptance is versioned. If an existing user needs to accept the current Electronic Funds Transfer disclosure, submit type6 with the endpoint
above.
Do not rely on an idempotent user-create call to update disclosure acceptance for an existing user. User creation can return an existing user without recording new disclosure acceptance.
Sandbox
Sandbox uses the same type6 status and acceptance model as production. When testing disclosure handling, use your sandbox API key and sandbox API base URL:
6 acceptance,
make sure your sandbox setup is not bypassing the disclosure gate.