Skip to main content
View as MarkdownOpen in ChatGPTOpen in Claude

PayFit setup

PayFit connects through the unified HRIS connector. This page covers the PayFit-side configuration you complete first. Once it's done, add the connector in Mesh by following Connect your HR system.

You finish with one value: an API key.

Before you start​

You must be an admin in PayFit to generate an API key.

Third-party product

These steps reflect Axiad's current understanding of PayFit's configuration. Because PayFit is a third-party product, there may be variations between your experience and what this guide describes, depending on the version in use and recent updates.

If you find a significant difference, or anything that doesn't make sense, let us know through Axiad support.

Step 1 — Open API access​

Select Integrations in the left panel, then API Access.

The PayFit integrations panel with API Access

Step 2 — Create an API key​

  1. Name the key — something identifying the Axiad Mesh connection.

  2. Select both read scopes:

    ScopeGives Mesh
    Access to contractsEmployment records
    Access to collaboratorsPeople records

    Both are needed. With only one, the connector authenticates and returns an incomplete picture rather than failing outright.

  3. Select Create, then copy the key.

    Creating the API key with the read scopes selected

Step 3 — Connect in Mesh​

Follow Connect your HR system, choose PayFit in the connection window, and paste the API key.

After connecting​

The connector appears in your connectors list with Health: Initializing while the first collection runs, then moves to Good. Access is read-only: Mesh does not write back to PayFit.

If it doesn't come online, see Troubleshoot HR connectors.

Troubleshooting​

What you seeLikely causeFix
People arrive without employment detailOnly the collaborators scope was grantedCreate a key with both read scopes
You cannot create a keyThe account is not a PayFit adminAsk a PayFit administrator to generate it