Skip to main content
POST
/
v1
/
entities
/
{entity_id}
/
funding_settings
Update Funding Settings
curl --request POST \
  --url https://api.prime.coinbase.com/v1/entities/{entity_id}/funding_settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "designated_funding_portfolio_id": "a0724c0c-0f9e-4525-baf4-1aa8fce77eb2",
  "automatic_conversion_enabled": true,
  "automatic_loan_enabled": true,
  "automatic_excess_return_enabled": true,
  "excess_funds_target_amount": "1000.00"
}
'
{
  "activity_id": "<string>",
  "activity_type": "<string>",
  "num_approvals_remaining": 123
}

Path Parameters

​
entity_id
string
required

Prime Entity ID

Body

application/json
​
designated_funding_portfolio_id
string
required

Set the Derivatives Funding Portfolio that will be used to fund FCM margin calls and receive excess margin sweeps. Only one portfolio per entity.

Example:

"a0724c0c-0f9e-4525-baf4-1aa8fce77eb2"

​
automatic_conversion_enabled
boolean
required

When true, USDC in your Derivatives Funding Portfolio will be converted to USD to meet FCM margin calls (Auto-Convert USDC).

​
automatic_loan_enabled
boolean
required

When true, Coinbase affiliates may initiate loans on your behalf to meet FCM margin calls, per your Lending agreement. Available to Portfolio Margin or Cross Margin clients only. (Auto-Initiate Loans)

​
automatic_excess_return_enabled
boolean
required

When true, any FCM account balance above your margin requirements will be automatically swept back to your Derivatives funding portfolio. (Auto-Return Excess Margin)

​
excess_funds_target_amount
string
required

Weekend Buying Power: Setting a target amount to maintain in your Futures account above margin requirements. You can only withdraw funds in excess of this amount.

Example:

"1000.00"

Response

200 - application/json

A successful response.

​
activity_id
string

Identifier for the created activity / proposal

​
activity_type
string

Type of the activity (e.g. PCS proposal type)

​
num_approvals_remaining
integer<int32>

Number of approvals still required before the change applies