Getting started

Use this checklist to establish the integration before implementing individual product flows.

1. Obtain credentials

ZTL supplies a client ID and client secret for each environment. Keep secrets in a server-side secret store, never in browser code, mobile applications, source control, logs, or support screenshots.

2. Authenticate

Send a client-credentials request to the current /v2/connect/token endpoint. Cache and reuse the returned token until shortly before expiry. See Authentication.

3. Prepare user-return handling

Onboarding, consent, payment approval, and payroll approval can send the user through browser-based authentication. Supply an HTTPS callback URL owned by your application and preserve your own correlation state.

Treat the return as a signal to resume polling, not as proof that the operation succeeded.

4. Preserve resource identifiers

Store the identifiers returned for onboarding, consent, accounts, payments, approvals, payrolls, and bulk requests. Also log the ztl-request-id response header in both success and error situations for support and reconciliation.

5. Implement the journey in order

Onboard the company before creating bank consent. Fetch the authorized accounts after consent completes. Creation/initiation and approval are separate for payments and payroll; always poll the resource after the user returns.

Note: Build bank, country, currency, and company choices from the endpoints listed in capabilities & constraints rather than a hard-coded matrix.

Continue with Environments and first request and then choose an integration guide.

See the glossary for open-banking terms.