Plans
Plan Repay
Create a plan to repay a borrow and reclaim collateral
POST
/
accounts
/
{account_id}
/
plan
/
repay
Plan Repay
curl --request POST \
--url https://api.example.com/accounts/{account_id}/plan/repayimport requests
url = "https://api.example.com/accounts/{account_id}/plan/repay"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/accounts/{account_id}/plan/repay', 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.example.com/accounts/{account_id}/plan/repay",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/accounts/{account_id}/plan/repay"
req, _ := http.NewRequest("POST", url, nil)
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.example.com/accounts/{account_id}/plan/repay")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/accounts/{account_id}/plan/repay")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyPlan Repay
Creates a plan to repay borrowed assets and withdraw collateral. Returns a plan ID and an EIP-712 digest that must be signed to authorize execution.Request
POST /accounts/:account_id/plan/repay
Path parameters
| Parameter | Type | Description |
|---|---|---|
account_id | string | The sub-account ID |
Body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
amount | string | Yes | Amount to repay in the asset’s smallest unit |
asset | string | Yes | Asset being repaid (e.g., "USDC") |
collateral_amount | string | Yes | Collateral to withdraw in its smallest unit |
collateral_asset | string | Yes | Collateral asset (e.g., "WETH") |
network | string | Yes | Target network (e.g., "base", "mainnet"). Funds on other chains are bridged automatically. |
protocol | string | Yes | Lending protocol: "compound" or "morpho" |
market | string | Morpho only | Morpho market ID (0x-prefixed 32-byte hex) |
Examples
curl -X POST https://prime-api.legend.xyz/accounts/acc_2o0yiljtp378/plan/repay \
-H "Authorization: Bearer $LEGEND_QUERY_KEY" \
-H "Content-Type: application/json" \
-d '{
"amount": "1000000",
"asset": "USDC",
"collateral_amount": "500000000000000000",
"collateral_asset": "WETH",
"network": "base",
"protocol": "compound"
}'
const plan = await client.plan.repay("acc_2o0yiljtp378", {
amount: "1000000",
asset: "USDC",
collateralAmount: "500000000000000000",
collateralAsset: "WETH",
network: "base",
protocol: "compound",
});
plan = await client.plan.repay(
"acc_2o0yiljtp378",
amount="1000000",
asset="USDC",
collateral_amount="500000000000000000",
collateral_asset="WETH",
network="base",
protocol="compound",
)
use legend_client::RepayParams;
let plan = client.plan.repay("acc_2o0yiljtp378", &RepayParams {
amount: "1000000".into(),
asset: "USDC".into(),
collateral_amount: "500000000000000000".into(),
collateral_asset: "WETH".into(),
network: "base".into(),
protocol: "compound".into(),
}).await?;
Response (201 Created)
{
"plan_id": "pln_71mcui082png",
"details": {
"quark_operation_actions": [...],
"eip712_data": {
"digest": "0x8a3f...b7c2",
"domain_separator": "0x...",
"hash_struct": "0x..."
}
},
"expires_at": "2025-06-15T10:32:00Z"
}
Response fields
| Field | Type | Description |
|---|---|---|
plan_id | string | Unique identifier for this plan (pln_ prefix) |
details | object | Transaction details including EIP-712 signing data |
details.eip712_data.digest | string | The hash to sign with the account’s signer key |
expires_at | string | ISO 8601 timestamp — plan must be executed before this time |
Errors
| Status | Code | Description |
|---|---|---|
| 400 | invalid_params | Missing required parameters, unsupported protocol, or invalid market ID |
| 400 | plan_failed | Could not generate a valid plan (e.g., no outstanding borrow) |
| 400 | no_wallet | Account has no wallets |
| 408 | timeout | Folio computation timed out |
Notes
- Plans expire after 2 minutes. Sign and execute via Execute Plan before expiry.
- The
marketparameter is required for Morpho and must be a valid 32-byte market ID. - The resulting activity will have
action_type: "COMET_REPAY"(Compound) or"MORPHO_REPAY"(Morpho) in its metadata.
⌘I
Plan Repay
curl --request POST \
--url https://api.example.com/accounts/{account_id}/plan/repayimport requests
url = "https://api.example.com/accounts/{account_id}/plan/repay"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/accounts/{account_id}/plan/repay', 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.example.com/accounts/{account_id}/plan/repay",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/accounts/{account_id}/plan/repay"
req, _ := http.NewRequest("POST", url, nil)
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.example.com/accounts/{account_id}/plan/repay")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/accounts/{account_id}/plan/repay")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body