Create a borrow position for an end user smart account

curl --request POST \
  --url https://api.cdp.coinbase.com/platform/v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Wallet-Auth: <x-wallet-auth>' \
  --data '
{
  "borrowProductId": "bp_07fb56c0-9afe-5440-8ff2-5b0e115458df",
  "collateralAmount": "1",
  "loanAmount": "100",
  "walletSecretId": "e051beeb-7163-4527-a5b6-35e301529ff2",
  "useCdpPaymaster": false,
  "paymasterUrl": "https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456"
}
'

import requests

url = "https://api.cdp.coinbase.com/platform/v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions"

payload = {
    "borrowProductId": "bp_07fb56c0-9afe-5440-8ff2-5b0e115458df",
    "collateralAmount": "1",
    "loanAmount": "100",
    "walletSecretId": "e051beeb-7163-4527-a5b6-35e301529ff2",
    "useCdpPaymaster": False,
    "paymasterUrl": "https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456"
}
headers = {
    "X-Wallet-Auth": "<x-wallet-auth>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Wallet-Auth': '<x-wallet-auth>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    borrowProductId: 'bp_07fb56c0-9afe-5440-8ff2-5b0e115458df',
    collateralAmount: '1',
    loanAmount: '100',
    walletSecretId: 'e051beeb-7163-4527-a5b6-35e301529ff2',
    useCdpPaymaster: false,
    paymasterUrl: 'https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456'
  })
};

fetch('https://api.cdp.coinbase.com/platform/v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cdp.coinbase.com/platform/v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'borrowProductId' => 'bp_07fb56c0-9afe-5440-8ff2-5b0e115458df',
    'collateralAmount' => '1',
    'loanAmount' => '100',
    'walletSecretId' => 'e051beeb-7163-4527-a5b6-35e301529ff2',
    'useCdpPaymaster' => false,
    'paymasterUrl' => 'https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Wallet-Auth: <x-wallet-auth>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cdp.coinbase.com/platform/v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions"

	payload := strings.NewReader("{\n  \"borrowProductId\": \"bp_07fb56c0-9afe-5440-8ff2-5b0e115458df\",\n  \"collateralAmount\": \"1\",\n  \"loanAmount\": \"100\",\n  \"walletSecretId\": \"e051beeb-7163-4527-a5b6-35e301529ff2\",\n  \"useCdpPaymaster\": false,\n  \"paymasterUrl\": \"https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Wallet-Auth", "<x-wallet-auth>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cdp.coinbase.com/platform/v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions")
  .header("X-Wallet-Auth", "<x-wallet-auth>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"borrowProductId\": \"bp_07fb56c0-9afe-5440-8ff2-5b0e115458df\",\n  \"collateralAmount\": \"1\",\n  \"loanAmount\": \"100\",\n  \"walletSecretId\": \"e051beeb-7163-4527-a5b6-35e301529ff2\",\n  \"useCdpPaymaster\": false,\n  \"paymasterUrl\": \"https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cdp.coinbase.com/platform/v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Wallet-Auth"] = '<x-wallet-auth>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"borrowProductId\": \"bp_07fb56c0-9afe-5440-8ff2-5b0e115458df\",\n  \"collateralAmount\": \"1\",\n  \"loanAmount\": \"100\",\n  \"walletSecretId\": \"e051beeb-7163-4527-a5b6-35e301529ff2\",\n  \"useCdpPaymaster\": false,\n  \"paymasterUrl\": \"https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456\"\n}"

response = http.request(request)
puts response.read_body

{
  "network": "base",
  "userOpHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "calls": [
    {
      "to": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "value": "0",
      "data": "0xa9059cbb000000000000000000000000fc807d1be4997e5c7b33e4d8d57e60c5b0f02b1a0000000000000000000000000000000000000000000000000000000000000064"
    },
    {
      "to": "0xdac17f958d2ee523a2206206994597c13d831ec7",
      "value": "1000000000000000",
      "data": "0x"
    }
  ],
  "status": "pending",
  "transactionHash": "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "receipts": [
    {
      "revert": {
        "data": "0x123",
        "message": "reason for failure"
      },
      "blockHash": "0x386544b58930c0ec9e8f3ed09fb4cdb76b9ae0a1a37ddcacebe3925b57978e65",
      "blockNumber": 29338819,
      "gasUsed": "100000"
    }
  ],
  "expiresAt": "2025-03-25T12:00:00Z"
}

End User Accounts

Create a borrow position for an end user smart account

Creates a borrow position for a specific borrow product, by posting collateral from an end user smart account and borrowing a loan against it. One position can be opened per borrow product for a given smart account. A borrow product is a protocol-native representation of a borrowable market, such as a Morpho Blue market that lends USDC against cbBTC. The borrowProductId identifies the product to borrow against, and the collateralAmount and loanAmount specify the collateral to post and the loan to take, both expressed as decimal strings in standard unit denomination of their respective tokens. A user operation is broadcast to open the position onchain. Poll getUserOperationWithEndUserAccount with the returned userOpHash until it reaches a terminal state. Once the user operation succeeds onchain, use the borrow positions list endpoint to view the user’s active positions.

POST

embedded-wallet-api

end-users

{userId}

evm

smart-accounts

{address}

borrow-positions

Create a borrow position for an end user smart account

curl --request POST \
  --url https://api.cdp.coinbase.com/platform/v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Wallet-Auth: <x-wallet-auth>' \
  --data '
{
  "borrowProductId": "bp_07fb56c0-9afe-5440-8ff2-5b0e115458df",
  "collateralAmount": "1",
  "loanAmount": "100",
  "walletSecretId": "e051beeb-7163-4527-a5b6-35e301529ff2",
  "useCdpPaymaster": false,
  "paymasterUrl": "https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456"
}
'

import requests

url = "https://api.cdp.coinbase.com/platform/v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions"

payload = {
    "borrowProductId": "bp_07fb56c0-9afe-5440-8ff2-5b0e115458df",
    "collateralAmount": "1",
    "loanAmount": "100",
    "walletSecretId": "e051beeb-7163-4527-a5b6-35e301529ff2",
    "useCdpPaymaster": False,
    "paymasterUrl": "https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456"
}
headers = {
    "X-Wallet-Auth": "<x-wallet-auth>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Wallet-Auth': '<x-wallet-auth>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    borrowProductId: 'bp_07fb56c0-9afe-5440-8ff2-5b0e115458df',
    collateralAmount: '1',
    loanAmount: '100',
    walletSecretId: 'e051beeb-7163-4527-a5b6-35e301529ff2',
    useCdpPaymaster: false,
    paymasterUrl: 'https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456'
  })
};

fetch('https://api.cdp.coinbase.com/platform/v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cdp.coinbase.com/platform/v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'borrowProductId' => 'bp_07fb56c0-9afe-5440-8ff2-5b0e115458df',
    'collateralAmount' => '1',
    'loanAmount' => '100',
    'walletSecretId' => 'e051beeb-7163-4527-a5b6-35e301529ff2',
    'useCdpPaymaster' => false,
    'paymasterUrl' => 'https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Wallet-Auth: <x-wallet-auth>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cdp.coinbase.com/platform/v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions"

	payload := strings.NewReader("{\n  \"borrowProductId\": \"bp_07fb56c0-9afe-5440-8ff2-5b0e115458df\",\n  \"collateralAmount\": \"1\",\n  \"loanAmount\": \"100\",\n  \"walletSecretId\": \"e051beeb-7163-4527-a5b6-35e301529ff2\",\n  \"useCdpPaymaster\": false,\n  \"paymasterUrl\": \"https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Wallet-Auth", "<x-wallet-auth>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cdp.coinbase.com/platform/v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions")
  .header("X-Wallet-Auth", "<x-wallet-auth>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"borrowProductId\": \"bp_07fb56c0-9afe-5440-8ff2-5b0e115458df\",\n  \"collateralAmount\": \"1\",\n  \"loanAmount\": \"100\",\n  \"walletSecretId\": \"e051beeb-7163-4527-a5b6-35e301529ff2\",\n  \"useCdpPaymaster\": false,\n  \"paymasterUrl\": \"https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cdp.coinbase.com/platform/v2/embedded-wallet-api/end-users/{userId}/evm/smart-accounts/{address}/borrow-positions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Wallet-Auth"] = '<x-wallet-auth>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"borrowProductId\": \"bp_07fb56c0-9afe-5440-8ff2-5b0e115458df\",\n  \"collateralAmount\": \"1\",\n  \"loanAmount\": \"100\",\n  \"walletSecretId\": \"e051beeb-7163-4527-a5b6-35e301529ff2\",\n  \"useCdpPaymaster\": false,\n  \"paymasterUrl\": \"https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456\"\n}"

response = http.request(request)
puts response.read_body

{
  "network": "base",
  "userOpHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "calls": [
    {
      "to": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "value": "0",
      "data": "0xa9059cbb000000000000000000000000fc807d1be4997e5c7b33e4d8d57e60c5b0f02b1a0000000000000000000000000000000000000000000000000000000000000064"
    },
    {
      "to": "0xdac17f958d2ee523a2206206994597c13d831ec7",
      "value": "1000000000000000",
      "data": "0x"
    }
  ],
  "status": "pending",
  "transactionHash": "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "receipts": [
    {
      "revert": {
        "data": "0x123",
        "message": "reason for failure"
      },
      "blockHash": "0x386544b58930c0ec9e8f3ed09fb4cdb76b9ae0a1a37ddcacebe3925b57978e65",
      "blockNumber": 29338819,
      "gasUsed": "100000"
    }
  ],
  "expiresAt": "2025-03-25T12:00:00Z"
}

Authorizations

Authorization

string

header

required

A JWT signed using the developer's own JWT private key (in the case of JWT authentication), or an end user JWT signed by CDP, encoded in base64. This is used for End User Account APIs.

Headers

X-Wallet-Auth

string

required

A JWT signed using your Wallet Secret, encoded in base64. Refer to the Generate Wallet Token section of our Authentication docs for more details on how to generate your Wallet Token.

Path Parameters

userId

string

required

The ID of the end user.

Pattern: ^[a-zA-Z0-9-]{1,100}$

Example:

"e051beeb-7163-4527-a5b6-35e301529ff2"

address

string

required

The address of the EVM Smart Account to open the borrow position from.

Pattern: ^0x[0-9a-fA-F]{40}$

Query Parameters

projectID

string

The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

A request to create a borrow position for an end user's smart account for the specified borrow product. The smart account posts collateral and borrows against it, broadcasting a user operation to open the position onchain.

borrowProductId

string

required

The globally unique ID of the borrow product, which is a UUID prefixed with the string bp_.

Pattern: ^bp_[a-f0-9-]{36}$

Example:

"bp_07fb56c0-9afe-5440-8ff2-5b0e115458df"

collateralAmount

string

required

The amount of collateral to post, as a decimal string in standard unit denomination of the collateral token (i.e. "1" for 1 cbBTC).

Pattern: ^\+?(?:(?:0*[1-9]\d*)(?:\.\d*)?|0*\.\d*[1-9]\d*)$

Example:

"1"

loanAmount

string

required

The amount of the loan token to borrow, as a decimal string in standard unit denomination of the loan token (i.e. "100" for 100 USDC).

Pattern: ^\+?(?:(?:0*[1-9]\d*)(?:\.\d*)?|0*\.\d*[1-9]\d*)$

Example:

"100"

walletSecretId

string

required

The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth header.

Pattern: ^[a-zA-Z0-9-]{1,100}$

Example:

"e051beeb-7163-4527-a5b6-35e301529ff2"

useCdpPaymaster

boolean

required

Whether to use the CDP Paymaster for the user operation. When true, paymasterUrl must not be set.

Example:

false

paymasterUrl

string<uri>

Paymaster URL to use for the user operation. Must not be set when useCdpPaymaster is true. If useCdpPaymaster is false and no paymasterUrl is set, the smart account must have sufficient funds to cover network fees.

Required string length: 11 - 2048

Pattern: ^https?://.*$

Example:

"https://api.developer.coinbase.com/rpc/v1/base/AbCdEf123456"

paymasterContext

object

Optional paymaster metadata forwarded to the configured paymaster service. Valid only when a paymaster is configured via useCdpPaymaster: true or a paymasterUrl.

Example:

{
  "policyId": "962b252c-a726-4a37-8d86-333ce0a07299"
}

Response

Successfully created the borrow position and broadcast the user operation.

A smart account operation response.

network

enum<string>

required

The network the user operation is for.

Available options:

base-sepolia,

base,

arbitrum,

optimism,

zora,

polygon,

bnb,

avalanche,

ethereum,

ethereum-sepolia

Example:

"base"

userOpHash

string

required

The hash of the user operation. This is not the transaction hash, as a transaction consists of multiple user operations. The user operation hash is the hash of this particular user operation which gets signed by the owner of the Smart Account.

Pattern: ^0x[0-9a-fA-F]{64}$

Example:

"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"

calls

object[]

required

The list of calls in the user operation.

Show child attributes

Example:

[
  {
    "to": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
    "value": "0",
    "data": "0xa9059cbb000000000000000000000000fc807d1be4997e5c7b33e4d8d57e60c5b0f02b1a0000000000000000000000000000000000000000000000000000000000000064"
  },
  {
    "to": "0xdac17f958d2ee523a2206206994597c13d831ec7",
    "value": "1000000000000000",
    "data": "0x"
  }
]

status

enum<string>

required

The status of the user operation.

Available options:

pending,

signed,

broadcast,

complete,

dropped,

failed

Example:

"pending"

transactionHash

string

The hash of the transaction that included this particular user operation. This gets set after the user operation is broadcasted and the transaction is included in a block.

Pattern: ^0x[0-9a-fA-F]{64}$|^$

Example:

"0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"

receipts

object[]

The list of receipts associated with the user operation.

Show child attributes

Example:

[
  {
    "revert": {
      "data": "0x123",
      "message": "reason for failure"
    },
    "blockHash": "0x386544b58930c0ec9e8f3ed09fb4cdb76b9ae0a1a37ddcacebe3925b57978e65",
    "blockNumber": 29338819,
    "gasUsed": "100000"
  }
]

expiresAt

string<date-time>

The timestamp at which the prepared user operation expires.

Example:

"2025-03-25T12:00:00Z"

CDP API

REST API

Create a borrow position for an end user smart account

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response