Skip to main content

Authorization

Follow this guide to create a new Paymo credential that will allow Nexla to authenticate to and exchange data with your Paymo account.
paymo_api_auth.png

Paymo

Prerequisites​

Before creating a Paymo credential, you need to obtain your API key from your Paymo account. Paymo uses API key authentication for all API requests, with the API key sent in the Authorization header.

To obtain your Paymo API key, follow these steps:

  1. Sign in to your Paymo account using your administrator credentials.

  2. Navigate to your account settings or profile settings in the Paymo interface.

  3. Look for the API or API Keys section in your account settings.

  4. If you don't have an API key yet, look for the option to generate or view your API key.

  5. Click Generate API Key or Create API Key to create a new API key.

  6. Configure your API key settings:

    • Enter a name for the API key (e.g., "Nexla Integration")
    • Review and select the permissions or scopes for the key (if applicable)

  7. Click Generate or Create to create the API key.

  8. Copy the API key immediately after it's generated, as it may not be accessible again after you navigate away from the page.

  9. Store the API key securely, as you will need it to configure your Nexla credential. The API key is sensitive information and should be kept confidential.

The API key is sent in the Authorization header for all API requests to the Paymo API. The API key authenticates your requests and grants access to Paymo resources based on your account permissions and the key's scopes. If your API key is compromised, you should immediately revoke it in your Paymo account settings and generate a new one. For detailed information about obtaining API keys, API authentication, and available endpoints, refer to the Paymo API documentation.

Create a Paymo Credential​

  • To create a new Paymo credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Paymo

PaymoCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

Paymo uses API key authentication for all API requests. The API key is sent in the Authorization header to authenticate API requests to the Paymo API.

  1. Enter your Paymo API key in the API Key Value field. This is the API key you obtained from your Paymo account settings (API or API Keys section). The API key is sent in the Authorization: {api_key} header for all API requests to the Paymo API. The API key is sensitive information and must be kept confidential.

    Your Paymo API key can be found in your Paymo account settings under the API or API Keys section. The API key is sent in the Authorization: {api_key} header for all API requests to the Paymo API.

    If your API key is compromised, you should immediately revoke it in your Paymo account settings and generate a new one. The API key provides access to your Paymo account data and should be treated as sensitive information. Keep your API key secure and do not share it publicly.

    For detailed information about obtaining API keys, API authentication, and available endpoints, see the Paymo API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.