Skip to content

3. Get a Payhawk API key ​

The connector authenticates to Payhawk with an API key sent in the X-Payhawk-ApiKey header. You generate this key in Payhawk.

Start in Sandbox

Always validate the integration with a Sandbox key first. Switch to a Production key only after a clean test sync. The Odoo side keeps Sandbox and Production keys separately, so you can hold both at once.

Generate the key in Payhawk ​

  1. Sign in to your Payhawk account.
  2. Open Settings → Developer API (you need developer/admin access). See Payhawk's API overview.
  3. Create an API key and copy it — you will paste it into Odoo.

Group (multi-entity) accounts ​

If your organization uses a Payhawk group account (multiple legal entities under one group), you will also have a Group ID and Group API key. The connector supports group accounts — you enter these in the configuration step.

Odoo 18 specifics

In Odoo 18 the Group ID and Group Key are global — a single value applies across all Odoo companies. (Company-dependent group settings were added in v19.) See version differences.

What you do not need to fill ​

The Account ID is discovered automatically on the first sync — leave it blank. Payhawk returns it from the /accounts endpoint and the connector stores it.

Next: Configuration →

© PLANA Digital Ltd.