Skip to main content
Version: v2alpha1

Client credentials

Client credentials are used to authenticate and authorize your application when requesting access to the getpaid API. They are a combination of a client ID and a client secret.

Here's a breakdown of each component:

  1. Client ID: This is a unique identifier assigned to your application or client.
  2. Client secret: This is a confidential piece of information known only to your application and the API provider. It's used to authenticate your application when requesting a token. The client secret helps ensure that only authorized applications can obtain access tokens.
info

It's important to keep client credentials, especially the client secret, secure and not expose them publicly, as they grant access to your application's authorized capabilities within the getpaid API.

Creating client credentials

You can create as many client credentials as you need from the getpaid dashboard. To create new client credentials you need to:

  1. Go to the Developers page.
  2. Click on the Create new button.
  3. Type a friendly name and select the permissions you want to grant to the client credentials.
  4. Click on Create.
  5. Copy the client ID and client secret values. Please note that the client secret is only shown once, so make sure to store it securely.
info

Please note that the client secret is only shown once, so make sure to store it securely.

Revoke client credentials

If you suspect that your client credentials have been compromised, you can revoke them from the Developers page. To revoke the client credentials, click on the Revoke button next to the client credentials you want to revoke and confirm the action.

Using client credentials

In order to start using your client credentials, you need to request the token from the authentication server using the created client ID and client secret. You can find more details on how to do this in the authentication section.