Create an API Integration

Dashboard Setup

Create your API integration.

Create an integration on the CoinPayments dashboard to receive a clientId and clientSecret. Every authenticated API request is bound to a specific integration and signed with its secret.

Open Dashboard Next: Generate Signature

Prerequisites

3 items

1
Create a CoinPayments Account
Sign up if you don't already have one.
2
Log In
Authenticate to your CoinPayments account.
3
Verify Your Account (KYC)
Optional — unverified accounts can still use the API, but only against the LTCT testing currency.

The API is unlocked for any account, but unverified merchants are limited to the LTCT testing currency. Complete KYC verification to transact in real cryptocurrencies.

Create the Integration

5 steps

Step 1Navigate to the Integrations page

Open the Integrations tab on the CoinPayments dashboard.

Dashboard with Integrations tab highlighted

Step 2Select "Add Integration"

From the Integrations page, click the Add Integration button.

Integrations page with Add Integration button highlighted

Step 3Select "API Integrations"

Choose API Integrations as the integration type.

Integration type selection screen with API Integrations highlighted

Step 4Provide integration information

Define an integration name and provide your store URL. These help you identify the integration and link to your website.

Step 5Review and save credentials

Your clientId and clientSecret have been generated. Save them for future use.

Newly created integration client credentials

The client secret is only displayed once. Copy it now — there is no way to retrieve it later.

Lost it? Regenerate the client secret — this invalidates all existing sessions.

Optional Configuration

3 add-ons

OptionalConfigure Permissions

Limit the scope of authorized resources and operations this integration has access to. Use the dropdown to allow only the specific functions you need.

Integration permissions dropdown selection

OptionalDefine Allowed IPs

Restrict which IP addresses can use this integration. By default any IP is allowed — adding an allow-list locks down where requests can originate from.

OptionalConfigure Webhooks

Specify a webhook endpoint and pick which events you'd like CoinPayments to deliver to it. (invoices)

Read the webhooks guide Integration manage webhooks section

Now authenticate your requests

With your clientId and clientSecret in hand, you're ready to authenticate.

Generate API Signature

Build the HMAC-SHA256 signature for each request.

Request Headers

The three CoinPayments headers every request needs.