Sign inGet started
Docs
Get started

Paymo API Authentication

How to authenticate Paymo API requests: one Bearer API key plus a connectionId. MindCloud stores your Paymo credentials — no auth headers to build.

Every Paymo API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Paymo account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

  1. Create a MindCloud account at app.mindcloud.co if you do not already have one.
  2. Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
  3. Create a Paymo connection in Connections. Paymo uses a username and password. You enter them when you create the connection — MindCloud stores them securely so your requests never carry raw credentials.
  4. Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Paymo account that should run the action. MindCloud stores and refreshes the Paymo credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling List Clients with an Paymo connection looks like this:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/paymo/latest/actions/list-clients" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which Paymo account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect your Paymo account

Sign in to the Paymo workspace you want to connect before starting these steps.

  1. Open Paymo API Keys

    In Paymo, click your profile picture in the bottom-left corner, open My Settings, then select API Keys.

  2. Create or copy an API key

    Create a new API key if needed, then copy the key value from Paymo.

  3. Enter the MindCloud credentials

    In MindCloud, paste the Paymo API key into the Username field and enter `x` in the Password field.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.