Skip to main content

​
Prerequisites

Before you begin, you need to have a Coinbaseprime account. Make sure you have a Coinbaseprime API key and secret, with the least amount of permissions required to access the functionality of the Coinbaseprime Connector you plan to use.
Make sure to create an API key dedicated to Formance. Doing so will improve your auditability and security and will allow you to revoke access to Formance at any time if needed.
To create an API key in the Coinbase Prime console:
1

Navigate to API settings

Go to Settings, then API.
2

Create a new API key

Click Create API Key and select the portfolio you want to connect.
3

Set expiration

Choose an expiration date as needed.
If you set an expiration date, you will need to update the connector configuration with new credentials when the key expires.
4

Set permissions

Set Read permissions for the key. As of Payments v3.2, the Coinbase Prime connector is read-only. Configure IP restrictions as needed for your environment.
Save the API key, API secret, and passphrase — you will need all three for the connector configuration.

​
Installation

fctl payments connectors install coinbaseprime config.json
With config.json containing: 
{
  "apiKey": "string",
  "apiSecret": "string",
  "name": "string",
  "passphrase": "string",
  "pollingPeriod": "30m",
  "portfolioId": "string"
}

​
Configuration fields

​
apiKey
string
required
The API key from Coinbase Prime.
​
apiSecret
string
required
The secret key provided when creating the API key.
​
name
string
required
A unique name for this connector instance.
​
passphrase
string
required
The passphrase provided when creating the API key.
​
pollingPeriod
string
default:"30m"
How often the connector polls Coinbase Prime for new data.
​
portfolioId
string
required
The identifier of the portfolio to connect. The connector is scoped to a single portfolio — if you need to track multiple portfolios, create a separate connector instance for each one.

​
Capabilities

The Coinbase Prime connector supports:
  • FetchAccounts — sync wallets from the portfolio
  • FetchBalances — retrieve wallet balances
  • FetchPayments — import transactions from the Coinbase Prime transactions endpoint, including withdrawals, deposits, and conversions