Bitcoin has some challenges...
","bullish_insights":"Bitcoin has strong fundamentals...
","circulating_supply":"19940768","total_supply":null,"max_supply":"21000000","market_cap_value":"2304382465497","change_value_24h":"41170105372","change_percent_24h":"1.8191","volume_value_24h":"64775687006","ath_value":"126080","ath_date":"2025-10-06"}}}}}}}}}},"/v1/kraken_embed/assets/{asset_id}/rates":{"get":{"tags":["Kraken Embed"],"operationId":"listAssetRates","summary":"Get Asset Historical Rates","description":"Get historical price rates for a specific asset with optional time range and interval filtering.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","maxLength":16,"description":"The asset identifier (e.g., BTC, ETH)"},"required":true,"name":"asset_id","in":"path"},{"schema":{"type":"string","maxLength":16},"required":false,"name":"quote","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"start_time","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"end_time","in":"query"},{"schema":{"type":"string"},"required":false,"name":"interval","in":"query"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"Historical rates retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"errors":{"type":"array","items":{}},"error":{"type":"array","items":{}},"result":{"type":["object","null"],"properties":{"rates":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"price":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["timestamp","price"],"additionalProperties":false}},"meta":{"type":"object","properties":{"page_oldest_rate":{"type":["object","null"],"properties":{"timestamp":{"type":"string","format":"date-time"},"price":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["timestamp","price"],"additionalProperties":false},"page_newest_rate":{"type":["object","null"],"properties":{"timestamp":{"type":"string","format":"date-time"},"price":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["timestamp","price"],"additionalProperties":false},"page_price_change_value":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"page_price_change_percent":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"additionalProperties":false}},"required":["rates","meta"],"additionalProperties":false}},"required":["result"],"additionalProperties":false}},"required":["data"],"example":{"data":{"errors":[],"error":[],"result":{"rates":[{"timestamp":"2025-10-20T00:00:00.0+00:00","price":"110575.61"},{"timestamp":"2025-10-21T00:00:00.0+00:00","price":"108376.01"},{"timestamp":"2025-10-22T00:00:00.0+00:00","price":"107591.76"}],"meta":{"page_oldest_rate":{"timestamp":"2025-10-20T00:00:00.0+00:00","price":"110575.61"},"page_newest_rate":{"timestamp":"2025-10-22T00:00:00.0+00:00","price":"107591.76"},"page_price_change_value":"-2983.85","page_price_change_percent":"-2.70"}}}}}}}}}}},"/v1/kraken_embed/users/{user_id}/details":{"get":{"tags":["Kraken Embed"],"operationId":"getPortfolioDetails","summary":"Get Portfolio Details","description":"Get detailed portfolio information for a user including asset balances, values, and positions.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"The ID of the Privy user."},"required":true,"name":"user_id","in":"path"},{"schema":{"type":"string","maxLength":16},"required":false,"name":"quote","in":"query"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"Portfolio details retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"errors":{"type":"array","items":{}},"error":{"type":"array","items":{}},"result":{"type":["object","null"],"properties":{"timestamp":{"type":"string","format":"date-time"},"currency":{"type":"string","maxLength":16},"assets":{"type":"array","items":{"type":"object","properties":{"asset":{"type":"string","maxLength":16},"class":{"type":["string","null"],"enum":["currency","commodity","stock","bond","derivative"]},"cash_balance":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"index_price":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"cash_value":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"held_orders_spot":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"avail_trade":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"avail_trade_value":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"credit_line_used":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"credit_line_available":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"lots_upnl":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"avg_entry_price":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"cost_basis":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","class","cash_balance","index_price","cash_value","held_orders_spot","avail_trade","avail_trade_value","lots_upnl"],"additionalProperties":false}}},"required":["timestamp","currency","assets"],"additionalProperties":false}},"required":["result"],"additionalProperties":false}},"required":["data"],"example":{"data":{"result":{"timestamp":"2024-04-15T12:00:00Z","currency":"USD","assets":[{"asset":"BTC","class":"currency","cash_balance":"0.15000000","index_price":"66000.00","cash_value":"9900.00","held_orders_spot":"0.00000000","avail_trade":"0.15000000","avail_trade_value":"9900.00","lots_upnl":"0.00","avg_entry_price":"65000.00","cost_basis":"9750.00"}]}}}}}}}}}},"/v1/kraken_embed/users/{user_id}/summary":{"get":{"tags":["Kraken Embed"],"operationId":"getPortfolioSummary","summary":"Get Portfolio Summary","description":"Get a high-level summary of a user's portfolio including total value, available balance, and unrealized P&L.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"The ID of the Privy user."},"required":true,"name":"user_id","in":"path"},{"schema":{"type":"string","maxLength":16},"required":false,"name":"quote","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include[current_day_pnl]","in":"query"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"Portfolio summary retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KrakenEmbedGetPortfolioSummaryResponse"}}}}}}},"/v1/kraken_embed/master_account/summary":{"get":{"tags":["Kraken Embed"],"operationId":"getMasterAccountPortfolioSummary","summary":"Get Master Account Portfolio Summary","description":"Get a high-level summary of the master account's portfolio including total value, available balance, and unrealized P&L.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","maxLength":16},"required":false,"name":"quote","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include[current_day_pnl]","in":"query"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"Portfolio summary retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KrakenEmbedGetPortfolioSummaryResponse"}}}}}}},"/v1/kraken_embed/master_account/details":{"get":{"tags":["Kraken Embed"],"operationId":"getMasterAccountPortfolioDetails","summary":"Get Master Account Portfolio Details","description":"Get detailed portfolio information for the master account including asset balances, values, and positions.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","maxLength":16},"required":false,"name":"quote","in":"query"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"Portfolio details retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{}},"error":{"type":"array","items":{}},"result":{"type":["object","null"],"properties":{"timestamp":{"type":"string","format":"date-time"},"currency":{"type":"string","maxLength":16},"assets":{"type":"array","items":{"type":"object","properties":{"asset":{"type":"string","maxLength":16},"class":{"type":["string","null"],"enum":["currency","commodity","stock","bond","derivative"]},"cash_balance":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"index_price":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"cash_value":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"held_orders_spot":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"avail_trade":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"avail_trade_value":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"credit_line_used":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"credit_line_available":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"lots_upnl":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"avg_entry_price":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"cost_basis":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","class","cash_balance","index_price","cash_value","held_orders_spot","avail_trade","avail_trade_value","lots_upnl"],"additionalProperties":false}}},"required":["timestamp","currency","assets"],"additionalProperties":false}},"required":["result"],"additionalProperties":false}}}}}}},"/v1/kraken_embed/master_account/history":{"get":{"tags":["Kraken Embed"],"operationId":"getMasterAccountPortfolioHistory","summary":"Get Master Account Portfolio History","description":"Get historical balances and valuations over time for the master account's portfolio with optional filtering by assets and date range.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"anyOf":[{"type":"array","items":{"type":"string","maxLength":16}},{"type":"string","maxLength":16},{"type":"null"}]},"required":false,"name":"include[assets]","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include[total_balance]","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include[total_pnl]","in":"query"},{"schema":{"type":["string","null"],"format":"date"},"required":false,"name":"start_date","in":"query"},{"schema":{"type":["string","null"],"format":"date"},"required":false,"name":"end_date","in":"query"},{"schema":{"type":["integer","null"],"minimum":0},"required":false,"name":"resolution","in":"query"},{"schema":{"type":["string","null"],"maxLength":16},"required":false,"name":"quote","in":"query"},{"schema":{"type":["string","null"]},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"Portfolio history retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{}},"error":{"type":"array","items":{}},"result":{"type":["object","null"],"properties":{"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"next_cursor":{"type":["string","null"]},"currency":{"type":["string","null"],"maxLength":16},"total_pnl":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"total_pnl_pct":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"history":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"total_balance":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"total_pnl":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"total_pnl_pct":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"assets":{"type":["object","null"],"additionalProperties":{"type":"object","properties":{"balance":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"additionalProperties":false}}},"required":["date"],"additionalProperties":false}}},"required":["start_date","end_date","history"],"additionalProperties":false}},"required":["result"],"additionalProperties":false}}}}}}},"/v1/kraken_embed/master_account/transactions":{"get":{"tags":["Kraken Embed"],"operationId":"getMasterAccountPortfolioTransactions","summary":"Get Master Account Portfolio Transactions","description":"Get transaction history for the master account's portfolio with filtering and pagination options.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"array","items":{"type":"string","enum":["simple_order","simple_order_failed","earn_reward"]}},"required":false,"name":"types","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":25},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"array","items":{"type":"string","maxLength":16}},"required":false,"name":"assets","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from_time","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"until_time","in":"query"},{"schema":{"type":"array","items":{"type":"string","enum":["unspecified","in_progress","successful","failed"]}},"required":false,"name":"statuses","in":"query"},{"schema":{"type":"array","items":{"type":"string"}},"required":false,"name":"ids","in":"query"},{"schema":{"type":"string","enum":["descending","ascending"]},"required":false,"name":"sorting","in":"query"},{"schema":{"type":"string","maxLength":16},"required":false,"name":"quote","in":"query"},{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["simple_order_quote","simple_order_quote_failed"]},"ref_id":{"type":"string","maxLength":64}},"required":["type","ref_id"],"additionalProperties":false}},"required":false,"name":"ref_ids","in":"query"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"Transaction history retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{}},"error":{"type":"array","items":{}},"result":{"type":["object","null"],"properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"time":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["simple_order","simple_order_failed","earn_reward"]},"status":{"type":["string","null"],"enum":["unspecified","in_progress","successful","failed"]},"ref_id":{"type":"string"},"ref_id2":{"type":["string","null"]},"spend":{"type":["object","null"],"properties":{"ledger_id":{"type":["string","null"]},"time":{"type":["string","null"],"format":"date-time"},"amount":{"type":"object","properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"quoted_amount":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"fee":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"quoted_fee":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"total":{"type":"object","properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"quoted_total":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"balance":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false}},"required":["amount","total"],"additionalProperties":false},"receive":{"type":["object","null"],"properties":{"ledger_id":{"type":["string","null"]},"time":{"type":["string","null"],"format":"date-time"},"amount":{"type":"object","properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"quoted_amount":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"fee":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"quoted_fee":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"total":{"type":"object","properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"quoted_total":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"balance":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false}},"required":["amount","total"],"additionalProperties":false},"details":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["simple_order"]},"quote_id":{"type":"string"},"trade_type":{"type":"string","enum":["unspecified","buy","sell","convert"]},"parent_transaction":{"type":["string","null"]}},"required":["type","quote_id","trade_type","parent_transaction"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["simple_order_failed"]},"receive_asset":{"type":"object","properties":{"asset":{"type":"string"},"class":{"type":"string","enum":["currency"]}},"required":["asset","class"],"additionalProperties":false},"spend_asset":{"type":"object","properties":{"asset":{"type":"string"},"class":{"type":"string","enum":["currency"]}},"required":["asset","class"],"additionalProperties":false},"trade_type":{"type":"string","enum":["unspecified","buy","sell","convert"]},"failure_reason":{"type":"string","enum":["other","insufficient_funds","card_issue","user_account_issue"]}},"required":["type","receive_asset","spend_asset","trade_type","failure_reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["earn_reward"]}},"required":["type"],"additionalProperties":false},{"type":"null"}]}},"required":["id","time","type","ref_id","spend","receive","details"],"additionalProperties":false}},"stats":{"type":["object","null"],"properties":{"transactions_seen":{"type":["integer","null"],"minimum":0}},"required":["transactions_seen"],"additionalProperties":false},"next_cursor":{"type":["string","null"]}},"required":["transactions","stats","next_cursor"],"additionalProperties":false}},"required":["result"],"additionalProperties":false}}}}}}},"/v1/kraken_embed/master_account/funds/withdrawals":{"post":{"tags":["Kraken Embed"],"operationId":"initiateMasterAccountWithdrawal","summary":"Initiate Master Account Fiat Withdrawal","description":"Initiate a withdrawal of funds from the master account.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"asset":{"type":"string","maxLength":16},"key":{"type":"string","minLength":1},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"idempotency_token":{"type":"string","format":"uuid"}},"required":["asset","key","amount"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success result with a reference ID.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{}},"error":{"type":"array","items":{}},"result":{"type":["object","null"],"properties":{"reference_id":{"type":"string"}},"required":["reference_id"],"additionalProperties":false}},"required":["result"],"additionalProperties":false}}}}}}},"/v1/kraken_embed/users/{user_id}/history":{"get":{"tags":["Kraken Embed"],"operationId":"getProtfolioHistoryForUser","summary":"Get Portfolio History","description":"Get historical balances and valuations over time for a user's portfolio with optional filtering by assets and date range.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"The ID of the Privy user."},"required":true,"name":"user_id","in":"path"},{"schema":{"anyOf":[{"type":"array","items":{"type":"string","maxLength":16}},{"type":"string","maxLength":16},{"type":"null"}]},"required":false,"name":"include[assets]","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include[total_balance]","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include[total_pnl]","in":"query"},{"schema":{"type":["string","null"],"format":"date"},"required":false,"name":"start_date","in":"query"},{"schema":{"type":["string","null"],"format":"date"},"required":false,"name":"end_date","in":"query"},{"schema":{"type":["integer","null"],"minimum":0},"required":false,"name":"resolution","in":"query"},{"schema":{"type":["string","null"],"maxLength":16},"required":false,"name":"quote","in":"query"},{"schema":{"type":["string","null"]},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"Portfolio history retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"errors":{"type":"array","items":{}},"error":{"type":"array","items":{}},"result":{"type":["object","null"],"properties":{"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"next_cursor":{"type":["string","null"]},"currency":{"type":["string","null"],"maxLength":16},"total_pnl":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"total_pnl_pct":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"history":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"total_balance":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"total_pnl":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"total_pnl_pct":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"assets":{"type":["object","null"],"additionalProperties":{"type":"object","properties":{"balance":{"type":["string","null"],"minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"additionalProperties":false}}},"required":["date"],"additionalProperties":false}}},"required":["start_date","end_date","history"],"additionalProperties":false}},"required":["result"],"additionalProperties":false}},"required":["data"],"example":{"data":{"result":{"start_date":"2024-01-01","end_date":"2024-12-31","next_cursor":null,"currency":"USD","total_pnl":"1500.00","total_pnl_pct":"15.00","history":[{"date":"2024-01-01","total_balance":"10000.00","total_pnl":"0.00","total_pnl_pct":"0.00","assets":{"BTC":{"balance":"0.15000000"},"ETH":{"balance":"5.00000000"}}},{"date":"2024-12-31","total_balance":"11500.00","total_pnl":"1500.00","total_pnl_pct":"15.00","assets":{"BTC":{"balance":"0.16000000"},"ETH":{"balance":"5.20000000"}}}]}}}}}}}}}},"/v1/kraken_embed/users/{user_id}/transactions":{"get":{"tags":["Kraken Embed"],"operationId":"getPortfolioTransactions","summary":"Get Portfolio Transactions","description":"Get transaction history for a user's portfolio with filtering and pagination options.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"The ID of the Privy user."},"required":true,"name":"user_id","in":"path"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"array","items":{"type":"string","enum":["simple_order","simple_order_failed","earn_reward"]}},"required":false,"name":"types","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":25},"required":false,"name":"page_size","in":"query"},{"schema":{"type":"array","items":{"type":"string","maxLength":16}},"required":false,"name":"assets","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from_time","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"until_time","in":"query"},{"schema":{"type":"array","items":{"type":"string","enum":["unspecified","in_progress","successful","failed"]}},"required":false,"name":"statuses","in":"query"},{"schema":{"type":"array","items":{"type":"string"}},"required":false,"name":"ids","in":"query"},{"schema":{"type":"string","enum":["descending","ascending"]},"required":false,"name":"sorting","in":"query"},{"schema":{"type":"string","maxLength":16},"required":false,"name":"quote","in":"query"},{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["simple_order_quote","simple_order_quote_failed"]},"ref_id":{"type":"string","maxLength":64}},"required":["type","ref_id"],"additionalProperties":false}},"required":false,"name":"ref_ids","in":"query"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"Transaction history retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"errors":{"type":"array","items":{}},"error":{"type":"array","items":{}},"result":{"type":["object","null"],"properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"time":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["simple_order","simple_order_failed","earn_reward"]},"status":{"type":["string","null"],"enum":["unspecified","in_progress","successful","failed"]},"ref_id":{"type":"string"},"ref_id2":{"type":["string","null"]},"spend":{"type":["object","null"],"properties":{"ledger_id":{"type":["string","null"]},"time":{"type":["string","null"],"format":"date-time"},"amount":{"type":"object","properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"quoted_amount":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"fee":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"quoted_fee":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"total":{"type":"object","properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"quoted_total":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"balance":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false}},"required":["amount","total"],"additionalProperties":false},"receive":{"type":["object","null"],"properties":{"ledger_id":{"type":["string","null"]},"time":{"type":["string","null"],"format":"date-time"},"amount":{"type":"object","properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"quoted_amount":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"fee":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"quoted_fee":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"total":{"type":"object","properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"quoted_total":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false},"balance":{"type":["object","null"],"properties":{"asset":{"type":"string","maxLength":16},"asset_class":{"type":["string","null"],"enum":["currency"]},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"}},"required":["asset","asset_class","amount"],"additionalProperties":false}},"required":["amount","total"],"additionalProperties":false},"details":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["simple_order"]},"quote_id":{"type":"string"},"trade_type":{"type":"string","enum":["unspecified","buy","sell","convert"]},"parent_transaction":{"type":["string","null"]}},"required":["type","quote_id","trade_type","parent_transaction"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["simple_order_failed"]},"receive_asset":{"type":"object","properties":{"asset":{"type":"string"},"class":{"type":"string","enum":["currency"]}},"required":["asset","class"],"additionalProperties":false},"spend_asset":{"type":"object","properties":{"asset":{"type":"string"},"class":{"type":"string","enum":["currency"]}},"required":["asset","class"],"additionalProperties":false},"trade_type":{"type":"string","enum":["unspecified","buy","sell","convert"]},"failure_reason":{"type":"string","enum":["other","insufficient_funds","card_issue","user_account_issue"]}},"required":["type","receive_asset","spend_asset","trade_type","failure_reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["earn_reward"]}},"required":["type"],"additionalProperties":false},{"type":"null"}]}},"required":["id","time","type","ref_id","spend","receive","details"],"additionalProperties":false}},"stats":{"type":["object","null"],"properties":{"transactions_seen":{"type":["integer","null"],"minimum":0}},"required":["transactions_seen"],"additionalProperties":false},"next_cursor":{"type":["string","null"]}},"required":["transactions","stats","next_cursor"],"additionalProperties":false}},"required":["result"],"additionalProperties":false}},"required":["data"],"example":{"data":{"result":{"transactions":[{"id":"TXN-12345","time":"2024-04-15T11:00:00Z","type":"simple_order","status":"successful","ref_id":"REF-12345","ref_id2":"QTE-12345-ABCDE","spend":{"ledger_id":"LED-001","time":"2024-04-15T11:00:00Z","amount":{"asset":"USD","asset_class":"currency","amount":"100.00"},"quoted_amount":null,"fee":{"asset":"USD","asset_class":"currency","amount":"1.00"},"quoted_fee":null,"total":{"asset":"USD","asset_class":"currency","amount":"101.00"},"quoted_total":null,"balance":{"asset":"USD","asset_class":"currency","amount":"899.00"}},"receive":{"ledger_id":"LED-002","time":"2024-04-15T11:00:00Z","amount":{"asset":"BTC","asset_class":"currency","amount":"0.00150000"},"quoted_amount":null,"fee":{"asset":"BTC","asset_class":"currency","amount":"0.00000150"},"quoted_fee":null,"total":{"asset":"BTC","asset_class":"currency","amount":"0.00149850"},"quoted_total":null,"balance":{"asset":"BTC","asset_class":"currency","amount":"0.00149850"}},"details":{"type":"simple_order","quote_id":"QTE-12345-ABCDE","trade_type":"buy","parent_transaction":null}}],"stats":{"transactions_seen":1},"next_cursor":"next_page_token_xyz"}}}}}}}}}},"/v1/kraken_embed/funds/withdrawals":{"post":{"tags":["Kraken Embed"],"operationId":"withdrawFunds","summary":"Withdraw funds","description":"Currently, this is a master-only operation. Therefore, no User parameter exists.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"asset":{"type":"string","maxLength":16},"key":{"type":"string","minLength":1},"amount":{"type":"string","minLength":1,"maxLength":64,"pattern":"^-?[0-9]+(\\.[0-9]+)?$"},"idempotency_token":{"type":"string","format":"uuid"}},"required":["asset","key","amount"],"additionalProperties":false,"example":{"amount":"100.00","asset":"BTC","key":"key"}}}}},"responses":{"200":{"description":"Success result with a reference ID.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"errors":{"type":"array","items":{}},"error":{"type":"array","items":{}},"result":{"type":["object","null"],"properties":{"reference_id":{"type":"string"}},"required":["reference_id"],"additionalProperties":false}},"required":["result"],"additionalProperties":false}},"required":["data"],"example":{"data":{"errors":[],"error":[],"result":{"reference_id":"reference_123"}}}}}}}}}},"/v1/wallets/{wallet_id}/ethereum_yield_deposit":{"post":{"tags":["Yield"],"operationId":"ethereumYieldDeposit","summary":"Deposit into Vault","description":"Deposit assets from a wallet into an ERC-4626 vault. This endpoint generates and broadcasts the necessary approval and deposit transactions.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"ID of the wallet."},"required":true,"name":"wallet_id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"},{"schema":{"type":"string","description":"Request authorization signature. If multiple signatures are required, they should be comma separated."},"required":false,"name":"privy-authorization-signature","in":"header"},{"schema":{"type":"string","description":"Request expiry. Value is a Unix timestamp in milliseconds representing the deadline by which the request must be processed."},"required":false,"name":"privy-request-expiry","in":"header"},{"schema":{"type":"string","description":"Idempotency keys ensure API requests are executed only once within a 24-hour window."},"required":false,"name":"privy-idempotency-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EthereumYieldDepositInput"}}}},"responses":{"200":{"description":"Yield sweep created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EthereumYieldSweepResponse"}}}}}}},"/v1/wallets/{wallet_id}/ethereum_yield_withdraw":{"post":{"tags":["Yield"],"operationId":"ethereumYieldWithdraw","summary":"Withdraw from Vault","description":"Withdraw assets from an ERC-4626 vault back to a wallet. This endpoint generates and broadcasts the withdrawal transaction.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"ID of the wallet."},"required":true,"name":"wallet_id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"},{"schema":{"type":"string","description":"Request authorization signature. If multiple signatures are required, they should be comma separated."},"required":false,"name":"privy-authorization-signature","in":"header"},{"schema":{"type":"string","description":"Request expiry. Value is a Unix timestamp in milliseconds representing the deadline by which the request must be processed."},"required":false,"name":"privy-request-expiry","in":"header"},{"schema":{"type":"string","description":"Idempotency keys ensure API requests are executed only once within a 24-hour window."},"required":false,"name":"privy-idempotency-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EthereumYieldWithdrawInput"}}}},"responses":{"200":{"description":"Yield sweep created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EthereumYieldSweepResponse"}}}}}}},"/v1/wallets/{wallet_id}/ethereum_yield_vault":{"get":{"tags":["Yield"],"operationId":"getEthereumYieldPosition","summary":"Get Ethereum Yield Vault Position","description":"Retrieve a wallet's current position in a specific ethereum yield vault. Returns the vault shares and asset values.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"ID of the wallet."},"required":true,"name":"wallet_id","in":"path"},{"schema":{"type":"string","description":"The vault ID to get position for."},"required":true,"name":"vault_id","in":"query"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"Yield position retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EthereumYieldPositionResponse"}}}}}}},"/v1/ethereum_yield_vault/{vault_id}":{"get":{"tags":["Yield"],"operationId":"getEthereumYieldVault","summary":"Get Ethereum Vault Details","description":"Retrieve detailed information about an ethereum yield vault, including current APY and liquidity.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"The Privy vault ID."},"required":true,"name":"vault_id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"Vault details retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EthereumVaultDetailsResponse"}}}}}}},"/v1/ethereum_yield_sweep/{id}":{"get":{"tags":["Yield"],"operationId":"getEthereumYieldSweep","summary":"Get Yield Sweep","description":"Retrieve a yield sweep (deposit or withdrawal) by its ID.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"The yield sweep ID."},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"Yield sweep retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EthereumYieldSweepResponse"}}}}}}},"/v1/wallets/{wallet_id}/ethereum_yield_claim":{"post":{"tags":["Yield"],"operationId":"ethereumYieldClaim","summary":"Claim Yield Rewards","description":"Claim incentive rewards accrued from vault participation on the specified chain via Merkl.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"ID of the wallet."},"required":true,"name":"wallet_id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"},{"schema":{"type":"string","description":"Request authorization signature. If multiple signatures are required, they should be comma separated."},"required":false,"name":"privy-authorization-signature","in":"header"},{"schema":{"type":"string","description":"Request expiry. Value is a Unix timestamp in milliseconds representing the deadline by which the request must be processed."},"required":false,"name":"privy-request-expiry","in":"header"},{"schema":{"type":"string","description":"Idempotency keys ensure API requests are executed only once within a 24-hour window."},"required":false,"name":"privy-idempotency-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EthereumYieldClaimInput"}}}},"responses":{"200":{"description":"Claim transaction submitted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EthereumYieldClaimResponse"}}}}}}},"/v1/ethereum_yield_claim/{id}":{"get":{"tags":["Yield"],"operationId":"getEthereumYieldClaim","summary":"Get Yield Reward Claim","description":"Retrieve a yield reward claim transaction by its ID.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"The yield claim transaction ID."},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"Yield reward claim retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EthereumYieldClaimResponse"}}}}}}},"/v1/accounts":{"post":{"tags":["Accounts"],"operationId":"createAccount","summary":"Create account","description":"Creates a new account with associated wallets.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"},{"schema":{"type":"string","description":"Idempotency keys ensure API requests are executed only once within a 24-hour window."},"required":false,"name":"privy-idempotency-key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountInput"},"example":{"display_name":"My Account","wallets_configuration":[{"chain_type":"ethereum"}]}}}},"responses":{"200":{"description":"The created account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountResponse"}}}}}},"get":{"tags":["Accounts"],"operationId":"listAccounts","summary":"List accounts","description":"List all accounts in your app.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1},"required":false,"name":"cursor","in":"query"},{"schema":{"type":["number","null"],"maximum":100},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","description":"Optional search term to filter accounts by display name, account ID, or wallet address."},"required":false,"name":"search","in":"query"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"Paginated list of accounts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountsListResponse"}}}}}}},"/v1/accounts/{account_id}":{"get":{"tags":["Accounts"],"operationId":"getAccount","summary":"Get account","description":"Get an account by account ID.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"description":"ID of the account."},"required":true,"name":"account_id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"The requested account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountResponse"}}}}}},"patch":{"tags":["Accounts"],"operationId":"updateAccount","summary":"Update account","description":"Update an account by account ID. Supports updating the display name and adding new wallets.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"description":"ID of the account."},"required":true,"name":"account_id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountInput"},"example":{"display_name":"Updated Account Name","wallets_configuration":[{"chain_type":"ethereum"},{"chain_type":"solana"}]}}}},"responses":{"200":{"description":"The updated account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountResponse"}}}}}}},"/v1/accounts/{account_id}/balance":{"get":{"tags":["Accounts"],"operationId":"getAccountBalance","summary":"Get account balance","description":"Get the balance of an account, aggregated across all wallets and supported chains.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"description":"ID of the account."},"required":true,"name":"account_id","in":"path"},{"schema":{"type":"string","enum":["true","false"],"description":"When set to true, returns balances from testnet chains instead of mainnets."},"required":false,"name":"testnet_mode","in":"query"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"}],"responses":{"200":{"description":"The account balance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountBalanceResponse"}}}}}}},"/v1/wallets/{wallet_id}/swap/quote":{"post":{"tags":["Swaps"],"operationId":"swapQuote","summary":"Get Swap Quote","description":"Get a price quote for swapping tokens within a wallet.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"ID of the wallet."},"required":true,"name":"wallet_id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"},{"schema":{"type":"string","description":"Request authorization signature. If multiple signatures are required, they should be comma separated."},"required":false,"name":"privy-authorization-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwapQuoteRequestBody"},"example":{"caip2":"eip155:1","input_token":"native","output_token":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","amount":"1000000000000000000","amount_type":"exact_input"}}}},"responses":{"200":{"description":"Swap quote retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwapQuoteResponse"},"example":{"caip2":"eip155:1","input_token":"native","output_token":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","input_amount":"1000000000000000000","est_output_amount":"2000000000","minimum_output_amount":"1980000000","gas_estimate":"150000"}}}}}}},"/v1/wallets/{wallet_id}/swap":{"post":{"tags":["Swaps"],"operationId":"swapTokens","summary":"Swap Tokens","description":"Execute a token swap within a wallet.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"ID of the wallet."},"required":true,"name":"wallet_id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"},{"schema":{"type":"string","description":"Request authorization signature. If multiple signatures are required, they should be comma separated."},"required":false,"name":"privy-authorization-signature","in":"header"},{"schema":{"type":"string","description":"Idempotency keys ensure API requests are executed only once within a 24-hour window."},"required":false,"name":"privy-idempotency-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwapRequestBody"},"example":{"caip2":"eip155:1","input_token":"native","output_token":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","amount":"1000000000000000000","amount_type":"exact_input","slippage_bps":50}}}},"responses":{"200":{"description":"Swap initiated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwapActionResponse"},"example":{"id":"cm7oxq1el000e11o8iwp7d0d0","status":"pending","wallet_id":"fmfdj6yqly31huorjqzq38zc","caip2":"eip155:1","input_token":"native","output_token":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","input_amount":"1000000000000000000"}}}}}}},"/v1/wallets/{wallet_id}/actions/{action_id}":{"get":{"tags":["Wallet Actions"],"operationId":"getWalletAction","summary":"Get wallet action","description":"Get the current status of a wallet action by its ID. Use `?include=steps` to include step-level details.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"ID of the wallet."},"required":true,"name":"wallet_id","in":"path"},{"schema":{"type":"string","format":"uuid","description":"ID of the wallet action."},"required":true,"name":"action_id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"},{"schema":{"type":"string","description":"Request authorization signature. If multiple signatures are required, they should be comma separated."},"required":false,"name":"privy-authorization-signature","in":"header"}],"responses":{"200":{"description":"The wallet action with its current status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionResponse"},"example":{"id":"cm7oxq1el000e11o8iwp7d0d0","status":"pending","wallet_id":"fmfdj6yqly31huorjqzq38zc","type":"swap","caip2":"eip155:1","input_token":"native","output_token":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","input_amount":null,"output_amount":null}}}}}}},"/v1/wallets/{wallet_id}/transfer":{"post":{"tags":["Wallet Actions"],"operationId":"transfer","summary":"Transfer","description":"Transfer tokens from a wallet to a destination address.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"ID of the wallet."},"required":true,"name":"wallet_id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"},{"schema":{"type":"string","description":"Request authorization signature. If multiple signatures are required, they should be comma separated."},"required":false,"name":"privy-authorization-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferRequestBody"},"example":{"source":{"asset":"usdc","amount":"10.5","chain":"base"},"destination":{"address":"0xB00F0759DbeeF5E543Cc3E3B07A6442F5f3928a2"}}}}},"responses":{"200":{"description":"Transfer initiated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferActionResponse"},"example":{"id":"550e8400-e29b-41d4-a716-446655440000","status":"pending","wallet_id":"fmfdj6yqly31huorjqzq38zc","type":"transfer","source_asset":"usdc","source_amount":"10.5","source_chain":"base","destination_address":"0xB00F0759DbeeF5E543Cc3E3B07A6442F5f3928a2"}}}}}}},"/v1/wallets/{wallet_id}/earn/ethereum/deposit":{"post":{"tags":["Wallet Actions"],"operationId":"ethereumEarnDeposit","summary":"Earn deposit","description":"Deposit assets into an ERC-4626 vault.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"ID of the wallet."},"required":true,"name":"wallet_id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"},{"schema":{"type":"string","description":"Request authorization signature. If multiple signatures are required, they should be comma separated."},"required":false,"name":"privy-authorization-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarnDepositRequestBody"},"example":{"vault_id":"cm7oxq1el000e11o8iwp7d0d0","amount":"1.5"}}}},"responses":{"200":{"description":"Earn deposit initiated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarnDepositActionResponse"},"example":{"id":"550e8400-e29b-41d4-a716-446655440000","status":"pending","wallet_id":"fmfdj6yqly31huorjqzq38zc","type":"earn_deposit","caip2":"eip155:8453","vault_id":"cm7oxq1el000e11o8iwp7d0d0","vault_address":"0x1234567890abcdef1234567890abcdef12345678","asset":"usdc","asset_address":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","decimals":6,"amount":"1.5","raw_amount":"1500000","share_amount":null}}}}}}},"/v1/wallets/{wallet_id}/earn/ethereum/withdraw":{"post":{"tags":["Wallet Actions"],"operationId":"ethereumEarnWithdraw","summary":"Earn withdraw","description":"Withdraw assets from an ERC-4626 vault.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"ID of the wallet."},"required":true,"name":"wallet_id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"},{"schema":{"type":"string","description":"Request authorization signature. If multiple signatures are required, they should be comma separated."},"required":false,"name":"privy-authorization-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarnWithdrawRequestBody"},"example":{"vault_id":"cm7oxq1el000e11o8iwp7d0d0","amount":"1.5"}}}},"responses":{"200":{"description":"Earn withdraw initiated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarnWithdrawActionResponse"},"example":{"id":"550e8400-e29b-41d4-a716-446655440000","status":"pending","wallet_id":"fmfdj6yqly31huorjqzq38zc","type":"earn_withdraw","caip2":"eip155:8453","vault_id":"cm7oxq1el000e11o8iwp7d0d0","vault_address":"0x1234567890abcdef1234567890abcdef12345678","asset":"usdc","asset_address":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","decimals":6,"amount":"1.5","raw_amount":"1500000","share_amount":null}}}}}}},"/v1/wallets/{wallet_id}/earn/ethereum/incentive/claim":{"post":{"tags":["Wallet Actions"],"operationId":"ethereumEarnIncentiveClaim","summary":"Earn incentive claim","description":"Claim incentive rewards for a wallet.","security":[{"appSecretAuth":[]}],"parameters":[{"schema":{"type":"string","description":"ID of the wallet."},"required":true,"name":"wallet_id","in":"path"},{"schema":{"type":"string","description":"ID of your Privy app."},"required":true,"name":"privy-app-id","in":"header"},{"schema":{"type":"string","description":"Request authorization signature. If multiple signatures are required, they should be comma separated."},"required":false,"name":"privy-authorization-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarnIncentiveClaimRequestBody"},"example":{"chain":"base"}}}},"responses":{"200":{"description":"Earn incentive claim initiated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarnIncentiveClaimActionResponse"},"example":{"id":"550e8400-e29b-41d4-a716-446655440000","status":"pending","wallet_id":"fmfdj6yqly31huorjqzq38zc","type":"earn_incentive_claim","chain":"base","rewards":null}}}}}}}},"webhooks":{"user.created":{"post":{"summary":"User created","description":"Fired when a new user is created in your app.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreatedWebhookPayload"},"examples":{"user-created":{"value":{"type":"user.created","user":{"id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","created_at":1716153600,"linked_accounts":[],"mfa_methods":[],"has_accepted_terms":true,"is_guest":false}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"user.authenticated":{"post":{"summary":"User authenticated","description":"Fired when a user successfully authenticates (logs in) to your app.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAuthenticatedWebhookPayload"},"examples":{"email-authentication":{"value":{"type":"user.authenticated","user":{"id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","created_at":1716153600,"linked_accounts":[{"type":"email","address":"user@example.com","verified_at":1716153600,"first_verified_at":1716153600,"latest_verified_at":1716153600}],"mfa_methods":[{"type":"totp","verified_at":1716153600}],"has_accepted_terms":true,"is_guest":false},"account":{"type":"email","address":"user@example.com","verified_at":1716153600,"first_verified_at":1716153600,"latest_verified_at":1716153600}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"user.linked_account":{"post":{"summary":"User linked account","description":"Fired when a user links a new account (email, phone, wallet, social login, etc.) to their profile.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserLinkedAccountWebhookPayload"},"examples":{"email-account":{"value":{"type":"user.linked_account","user":{"id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","created_at":1716153600,"linked_accounts":[],"mfa_methods":[],"has_accepted_terms":true,"is_guest":false},"account":{"type":"email","address":"user@example.com","verified_at":1716153600,"first_verified_at":1716153600,"latest_verified_at":1716153600}}},"ethereum-wallet":{"value":{"type":"user.linked_account","user":{"id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","created_at":1716153600,"linked_accounts":[],"mfa_methods":[],"has_accepted_terms":true,"is_guest":false},"account":{"type":"wallet","address":"0x1234567890123456789012345678901234567890","chain_type":"ethereum","verified_at":1716153600,"first_verified_at":1716153600,"latest_verified_at":1716153600,"wallet_client":"unknown","wallet_client_type":"unknown","connector_type":"unknown"}}},"google-oauth":{"value":{"type":"user.linked_account","user":{"id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","created_at":1716153600,"linked_accounts":[],"mfa_methods":[],"has_accepted_terms":true,"is_guest":false},"account":{"type":"google_oauth","subject":"110248495921238986420","email":"test@gmail.com","name":"Test User","verified_at":1716153600,"first_verified_at":1716153600,"latest_verified_at":1716153600}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"user.unlinked_account":{"post":{"summary":"User unlinked account","description":"Fired when a user unlinks an account from their profile.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUnlinkedAccountWebhookPayload"},"examples":{"user-unlinked-account":{"value":{"type":"user.unlinked_account","user":{"id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","created_at":1716153600,"linked_accounts":[],"mfa_methods":[],"has_accepted_terms":true,"is_guest":false},"account":{"type":"email","address":"user@example.com","verified_at":1716153600,"first_verified_at":1716153600,"latest_verified_at":1716153600}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"user.updated_account":{"post":{"summary":"User updated account","description":"Fired when a user updates one of their linked accounts.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdatedAccountWebhookPayload"},"examples":{"user-updated-account":{"value":{"type":"user.updated_account","user":{"id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","created_at":1716153600,"linked_accounts":[],"mfa_methods":[],"has_accepted_terms":true,"is_guest":false},"account":{"type":"email","address":"user@example.com","verified_at":1716153600,"first_verified_at":1716153600,"latest_verified_at":1716153600}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"user.transferred_account":{"post":{"summary":"User transferred account","description":"Fired when an account is transferred from one user to another.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTransferredAccountWebhookPayload"},"examples":{"user-transferred-account":{"value":{"type":"user.transferred_account","fromUser":{"id":"did:privy:clu2wsin402h9h9kt6ae7dfuh"},"toUser":{"id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","created_at":1716153600,"linked_accounts":[],"mfa_methods":[],"has_accepted_terms":true,"is_guest":false},"account":{"type":"email","address":"user@example.com","verified_at":1716153600,"first_verified_at":1716153600,"latest_verified_at":1716153600},"deletedUser":true}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"user.wallet_created":{"post":{"summary":"User wallet created","description":"Fired when an embedded wallet is created for a user.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWalletCreatedWebhookPayload"},"examples":{"user-wallet-created":{"value":{"type":"user.wallet_created","user":{"id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","created_at":1716153600,"linked_accounts":[],"mfa_methods":[],"has_accepted_terms":true,"is_guest":false},"wallet":{"type":"wallet","address":"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045","chain_type":"ethereum"}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"transaction.broadcasted":{"post":{"summary":"Transaction broadcasted","description":"Fired when a transaction is successfully broadcast to the blockchain network.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionBroadcastedWebhookPayload"},"examples":{"transaction-broadcasted":{"value":{"type":"transaction.broadcasted","wallet_id":"fmfdj6yqly31huorjqzq38zc","transaction_id":"36d384ec-4e62-4332-ae6f-9ded2c27c680","caip2":"eip155:1","transaction_hash":"0x2446f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"transaction.confirmed":{"post":{"summary":"Transaction confirmed","description":"Fired when a transaction is confirmed on-chain.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionConfirmedWebhookPayload"},"examples":{"transaction-confirmed":{"value":{"type":"transaction.confirmed","wallet_id":"fmfdj6yqly31huorjqzq38zc","transaction_id":"36d384ec-4e62-4332-ae6f-9ded2c27c680","caip2":"eip155:1","transaction_hash":"0x2446f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"transaction.execution_reverted":{"post":{"summary":"Transaction execution reverted","description":"Fired when a transaction execution reverts on-chain.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionExecutionRevertedWebhookPayload"},"examples":{"transaction-execution-reverted":{"value":{"type":"transaction.execution_reverted","wallet_id":"r3mbxxfmzsuxxw3guxxha2xx","transaction_id":"537e327d-7382-4e61-93e5-0241c72d0793","caip2":"eip155:1","transaction_hash":"0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"transaction.still_pending":{"post":{"summary":"Transaction still pending","description":"Fired when a transaction has been pending for an extended period without confirmation.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionStillPendingWebhookPayload"},"examples":{"transaction-still-pending":{"value":{"type":"transaction.still_pending","wallet_id":"fmfdj6yqly31huorjqzq38zc","transaction_id":"9a8b7c6d-5e4f-3a2b-1c0d-ef9876543210","caip2":"eip155:1","transaction_hash":"0x1234abcd5678ef901234abcd5678ef901234abcd5678ef901234abcd5678ef90","transaction_request":{"from":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","to":"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045","value":"0x0","data":"0x","gas":"0x5208","gasPrice":"0x4a817c800"}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"transaction.failed":{"post":{"summary":"Transaction failed","description":"Fired when a transaction fails.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionFailedWebhookPayload"},"examples":{"transaction-failed":{"value":{"type":"transaction.failed","wallet_id":"fmfdj6yqly31huorjqzq38zc","transaction_id":"36d384ec-4e62-4332-ae6f-9ded2c27c680","caip2":"eip155:1","transaction_hash":"0x2446f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"transaction.replaced":{"post":{"summary":"Transaction replaced","description":"Fired when a transaction is replaced by another transaction (e.g., speed-up or cancellation).","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionReplacedWebhookPayload"},"examples":{"transaction-replaced":{"value":{"type":"transaction.replaced","wallet_id":"fmfdj6yqly31huorjqzq38zc","transaction_id":"36d384ec-4e62-4332-ae6f-9ded2c27c680","caip2":"eip155:1","transaction_hash":"0x2446f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"transaction.provider_error":{"post":{"summary":"Transaction provider error","description":"Fired when there is an error from the transaction provider.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionProviderErrorWebhookPayload"},"examples":{"transaction-provider-error":{"value":{"type":"transaction.provider_error","wallet_id":"fmfdj6yqly31huorjqzq38zc","transaction_id":"36d384ec-4e62-4332-ae6f-9ded2c27c680","caip2":"eip155:1","transaction_hash":"0x2446f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"user_operation.completed":{"post":{"summary":"User operation completed","description":"Fired when an ERC-4337 UserOperation lands on-chain.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserOperationCompletedWebhookPayload"},"examples":{"user-operation-completed":{"value":{"type":"user_operation.completed","user_op_hash":"0xabc123def456789abc123def456789abc123def456789abc123def456789abc1","sender":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","paymaster":"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045","nonce":"0x1","success":true,"actual_gas_cost":"0x2386f26fc10000","actual_gas_used":"0x5208","caip2":"eip155:8453","transaction_hash":"0x2446f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c","block_number":12345678,"log_index":0}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet.funds_deposited":{"post":{"summary":"Funds deposited","description":"Fired when funds are deposited into a wallet.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundsDepositedWebhookPayload"},"examples":{"native-token":{"value":{"type":"wallet.funds_deposited","wallet_id":"fmfdj6yqly31huorjqzq38zc","idempotency_key":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","caip2":"eip155:1","asset":{"type":"native-token","address":null},"amount":"1000000000000000000","transaction_hash":"0x2446f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c","sender":"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045","recipient":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","block":{"number":19832451}}},"erc20-token":{"value":{"type":"wallet.funds_deposited","wallet_id":"fmfdj6yqly31huorjqzq38zc","idempotency_key":"b2c3d4e5-f6a7-8901-bcde-f12345678901","caip2":"eip155:1","asset":{"type":"erc20","address":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"},"amount":"10000000","transaction_hash":"0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890","sender":"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045","recipient":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","block":{"number":19832450}}},"spl-token":{"value":{"type":"wallet.funds_deposited","wallet_id":"r3mbxxfmzsuxxw3guxxha2xx","idempotency_key":"c3d4e5f6-a7b8-9012-cdef-123456789012","caip2":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","asset":{"type":"spl","mint":"So11111111111111111111111111111111111111112"},"amount":"1000000000","transaction_hash":"5UfDuX7hXbMjRHzbMbLFnCejwdSJYhEFjGHxaGeFMpQPeMzPcpBLQNHXcPhPrNBRGdxkVPcBYAMW4os8qoEzQwVE","sender":"DYw8jCTfwHNRJhhmFcbXvVDTqWMEVFBX6ZKUmG5CNSKK","recipient":"7EcDhSYGxXyscszYEp35KHN8vvw3svAuLKTzXwCFLtV","block":{"number":259830245}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet.funds_withdrawn":{"post":{"summary":"Funds withdrawn","description":"Fired when funds are withdrawn from a wallet.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundsWithdrawnWebhookPayload"},"examples":{"native-token":{"value":{"type":"wallet.funds_withdrawn","wallet_id":"fmfdj6yqly31huorjqzq38zc","idempotency_key":"d4e5f6a7-b8c9-0123-defa-234567890123","caip2":"eip155:1","asset":{"type":"native-token","address":null},"amount":"1000000000000000000","transaction_hash":"0x3a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b","sender":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","recipient":"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045","block":{"number":19832455}}},"erc20-token":{"value":{"type":"wallet.funds_withdrawn","wallet_id":"fmfdj6yqly31huorjqzq38zc","idempotency_key":"e5f6a7b8-c9d0-1234-efab-345678901234","caip2":"eip155:1","asset":{"type":"erc20","address":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"},"amount":"10000000","transaction_hash":"0x1234abcd5678ef901234abcd5678ef901234abcd5678ef901234abcd5678ef90","sender":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","recipient":"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045","block":{"number":19832456}}},"spl-token":{"value":{"type":"wallet.funds_withdrawn","wallet_id":"r3mbxxfmzsuxxw3guxxha2xx","idempotency_key":"f6a7b8c9-d0e1-2345-fabc-456789012345","caip2":"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp","asset":{"type":"spl","mint":"So11111111111111111111111111111111111111112"},"amount":"1000000000","transaction_hash":"3Mq7Dw4yvbRPKBEQ9Nb2yER3pGCbsEQCiKBdFpHuNDFvhWfnQRpL2fG1RAVRyS5sij2eKBnNoCmL8y7h8YMWV5T","sender":"7EcDhSYGxXyscszYEp35KHN8vvw3svAuLKTzXwCFLtV","recipient":"DYw8jCTfwHNRJhhmFcbXvVDTqWMEVFBX6ZKUmG5CNSKK","block":{"number":259830300}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet.private_key_export":{"post":{"summary":"Private key export","description":"Fired when a user exports the private key of their embedded wallet.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateKeyExportWebhookPayload"},"examples":{"private-key-export":{"value":{"type":"wallet.private_key_export","user_id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","wallet_id":"fmfdj6yqly31huorjqzq38zc","wallet_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet.recovery_setup":{"post":{"summary":"Wallet recovery setup","description":"Fired when a user sets up recovery for their embedded wallet.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletRecoverySetupWebhookPayload"},"examples":{"wallet-recovery-setup":{"value":{"type":"wallet.recovery_setup","user_id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","wallet_id":"fmfdj6yqly31huorjqzq38zc","wallet_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","method":"recovery_encryption_key"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet.recovered":{"post":{"summary":"Wallet recovered","description":"Fired when a user recovers their embedded wallet.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletRecoveredWebhookPayload"},"examples":{"wallet-recovered":{"value":{"type":"wallet.recovered","user_id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","wallet_id":"fmfdj6yqly31huorjqzq38zc","wallet_address":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.swap.created":{"post":{"summary":"Wallet action swap created","description":"Fired when a wallet action is created and execution has begun. The action is now pending.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionSwapCreatedWebhookPayload"},"examples":{"wallet-action-swap-created":{"value":{"type":"wallet_action.swap.created","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"swap","status":"pending","caip2":"eip155:8453","input_token":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","output_token":"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2","input_amount":null}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.swap.succeeded":{"post":{"summary":"Wallet action swap succeeded","description":"Fired when all steps of a wallet action have been confirmed on-chain. The action is complete.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionSwapSucceededWebhookPayload"},"examples":{"wallet-action-swap-succeeded":{"value":{"type":"wallet_action.swap.succeeded","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"swap","status":"succeeded","caip2":"eip155:8453","input_token":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","output_token":"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2","input_amount":"1000000","output_amount":"550000000000000","steps":[{"type":"evm_transaction","status":"confirmed","caip2":"eip155:8453","transaction_hash":"0x2446f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c"}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.swap.rejected":{"post":{"summary":"Wallet action swap rejected","description":"Fired when a wallet action fails before any on-chain effects (e.g. policy rejection, simulation failure). Safe to retry.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionSwapRejectedWebhookPayload"},"examples":{"wallet-action-swap-rejected":{"value":{"type":"wallet_action.swap.rejected","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"swap","status":"rejected","caip2":"eip155:8453","input_token":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","output_token":"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2","input_amount":null,"failure_reason":{"message":"Transaction simulation reverted"},"steps":[{"type":"evm_transaction","status":"rejected","caip2":"eip155:8453","transaction_hash":null,"failure_reason":{"message":"Transaction simulation reverted"}}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.swap.failed":{"post":{"summary":"Wallet action swap failed","description":"Fired when a wallet action fails after at least one transaction was broadcast. There may be on-chain state changes; inspect the steps for details.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionSwapFailedWebhookPayload"},"examples":{"wallet-action-swap-failed":{"value":{"type":"wallet_action.swap.failed","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"swap","status":"failed","caip2":"eip155:8453","input_token":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","output_token":"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2","input_amount":"1000000","failure_reason":{"message":"Transaction execution reverted"},"steps":[{"type":"evm_transaction","status":"confirmed","caip2":"eip155:8453","transaction_hash":"0x1111111111111111111111111111111111111111111111111111111111111111"},{"type":"evm_transaction","status":"reverted","caip2":"eip155:8453","transaction_hash":"0x2222222222222222222222222222222222222222222222222222222222222222","failure_reason":{"message":"Transaction execution reverted"}}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.transfer.created":{"post":{"summary":"Wallet action transfer created","description":"Fired when a wallet action is created and execution has begun. The action is now pending.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionTransferCreatedWebhookPayload"},"examples":{"wallet-action-transfer-created":{"value":{"type":"wallet_action.transfer.created","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"transfer","status":"pending","source_asset":"usdc","source_amount":"1.5","source_chain":"base","destination_address":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.transfer.succeeded":{"post":{"summary":"Wallet action transfer succeeded","description":"Fired when all steps of a wallet action have been confirmed on-chain. The action is complete.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionTransferSucceededWebhookPayload"},"examples":{"wallet-action-transfer-succeeded":{"value":{"type":"wallet_action.transfer.succeeded","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"transfer","status":"succeeded","source_asset":"usdc","source_amount":"1.5","source_chain":"base","destination_address":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","steps":[{"type":"evm_transaction","status":"confirmed","caip2":"eip155:8453","transaction_hash":"0x2446f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c"}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.transfer.rejected":{"post":{"summary":"Wallet action transfer rejected","description":"Fired when a wallet action fails before any on-chain effects (e.g. policy rejection, simulation failure). Safe to retry.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionTransferRejectedWebhookPayload"},"examples":{"wallet-action-transfer-rejected":{"value":{"type":"wallet_action.transfer.rejected","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"transfer","status":"rejected","source_asset":"usdc","source_amount":"1.5","source_chain":"base","destination_address":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","failure_reason":{"message":"Transaction simulation reverted"},"steps":[{"type":"evm_transaction","status":"rejected","caip2":"eip155:8453","transaction_hash":null,"failure_reason":{"message":"Transaction simulation reverted"}}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.transfer.failed":{"post":{"summary":"Wallet action transfer failed","description":"Fired when a wallet action fails after at least one transaction was broadcast. There may be on-chain state changes; inspect the steps for details.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionTransferFailedWebhookPayload"},"examples":{"wallet-action-transfer-failed":{"value":{"type":"wallet_action.transfer.failed","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"transfer","status":"failed","source_asset":"usdc","source_amount":"1.5","source_chain":"base","destination_address":"0x742d35Cc6634C0532925a3b844Bc9e7595f2bD18","failure_reason":{"message":"Transaction execution reverted"},"steps":[{"type":"evm_transaction","status":"reverted","caip2":"eip155:8453","transaction_hash":"0x2222222222222222222222222222222222222222222222222222222222222222","failure_reason":{"message":"Transaction execution reverted"}}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.earn_deposit.created":{"post":{"summary":"Wallet action earn_deposit created","description":"Fired when a wallet action is created and execution has begun. The action is now pending.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionEarnDepositCreatedWebhookPayload"},"examples":{"wallet-action-earn_deposit-created":{"value":{"type":"wallet_action.earn_deposit.created","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"earn_deposit","status":"pending","caip2":"eip155:8453","vault_id":"cm7oxq1el000e11o8iwp7d0d0","vault_address":"0x1234567890abcdef1234567890abcdef12345678","asset":"usdc","asset_address":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","decimals":6,"amount":"1","raw_amount":"1000000"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.earn_deposit.succeeded":{"post":{"summary":"Wallet action earn_deposit succeeded","description":"Fired when all steps of a wallet action have been confirmed on-chain. The action is complete.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionEarnDepositSucceededWebhookPayload"},"examples":{"wallet-action-earn_deposit-succeeded":{"value":{"type":"wallet_action.earn_deposit.succeeded","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"earn_deposit","status":"succeeded","caip2":"eip155:8453","vault_id":"cm7oxq1el000e11o8iwp7d0d0","vault_address":"0x1234567890abcdef1234567890abcdef12345678","asset":"usdc","asset_address":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","decimals":6,"amount":"1","raw_amount":"1000000","share_amount":"999500","steps":[{"type":"evm_user_operation","status":"confirmed","caip2":"eip155:8453","user_operation_hash":"0x2446f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c","bundle_transaction_hash":"0x3557f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c","entrypoint_version":"0.7"}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.earn_deposit.rejected":{"post":{"summary":"Wallet action earn_deposit rejected","description":"Fired when a wallet action fails before any on-chain effects (e.g. policy rejection, simulation failure). Safe to retry.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionEarnDepositRejectedWebhookPayload"},"examples":{"wallet-action-earn_deposit-rejected":{"value":{"type":"wallet_action.earn_deposit.rejected","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"earn_deposit","status":"rejected","caip2":"eip155:8453","vault_id":"cm7oxq1el000e11o8iwp7d0d0","vault_address":"0x1234567890abcdef1234567890abcdef12345678","asset":"usdc","asset_address":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","decimals":6,"amount":"1","raw_amount":"1000000","failure_reason":{"message":"Transaction simulation reverted"},"steps":[{"type":"evm_user_operation","status":"rejected","caip2":"eip155:8453","user_operation_hash":null,"bundle_transaction_hash":null,"entrypoint_version":"0.7","failure_reason":{"message":"Transaction simulation reverted"}}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.earn_deposit.failed":{"post":{"summary":"Wallet action earn_deposit failed","description":"Fired when a wallet action fails after at least one transaction was broadcast. There may be on-chain state changes; inspect the steps for details.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionEarnDepositFailedWebhookPayload"},"examples":{"wallet-action-earn_deposit-failed":{"value":{"type":"wallet_action.earn_deposit.failed","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"earn_deposit","status":"failed","caip2":"eip155:8453","vault_id":"cm7oxq1el000e11o8iwp7d0d0","vault_address":"0x1234567890abcdef1234567890abcdef12345678","asset":"usdc","asset_address":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","decimals":6,"amount":"1","raw_amount":"1000000","failure_reason":{"message":"Transaction execution reverted"},"steps":[{"type":"evm_user_operation","status":"reverted","caip2":"eip155:8453","user_operation_hash":"0x2446f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c","bundle_transaction_hash":"0x3557f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c","entrypoint_version":"0.7","failure_reason":{"message":"Transaction execution reverted"}}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.earn_withdraw.created":{"post":{"summary":"Wallet action earn_withdraw created","description":"Fired when a wallet action is created and execution has begun. The action is now pending.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionEarnWithdrawCreatedWebhookPayload"},"examples":{"wallet-action-earn_withdraw-created":{"value":{"type":"wallet_action.earn_withdraw.created","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"earn_withdraw","status":"pending","caip2":"eip155:8453","vault_id":"cm7oxq1el000e11o8iwp7d0d0","vault_address":"0x1234567890abcdef1234567890abcdef12345678","asset":"usdc","asset_address":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","decimals":6,"amount":"1","raw_amount":"1000000"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.earn_withdraw.succeeded":{"post":{"summary":"Wallet action earn_withdraw succeeded","description":"Fired when all steps of a wallet action have been confirmed on-chain. The action is complete.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionEarnWithdrawSucceededWebhookPayload"},"examples":{"wallet-action-earn_withdraw-succeeded":{"value":{"type":"wallet_action.earn_withdraw.succeeded","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"earn_withdraw","status":"succeeded","caip2":"eip155:8453","vault_id":"cm7oxq1el000e11o8iwp7d0d0","vault_address":"0x1234567890abcdef1234567890abcdef12345678","asset":"usdc","asset_address":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","decimals":6,"amount":"1","raw_amount":"1000000","share_amount":"999500","steps":[{"type":"evm_transaction","status":"confirmed","caip2":"eip155:8453","transaction_hash":"0x2446f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c"}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.earn_withdraw.rejected":{"post":{"summary":"Wallet action earn_withdraw rejected","description":"Fired when a wallet action fails before any on-chain effects (e.g. policy rejection, simulation failure). Safe to retry.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionEarnWithdrawRejectedWebhookPayload"},"examples":{"wallet-action-earn_withdraw-rejected":{"value":{"type":"wallet_action.earn_withdraw.rejected","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"earn_withdraw","status":"rejected","caip2":"eip155:8453","vault_id":"cm7oxq1el000e11o8iwp7d0d0","vault_address":"0x1234567890abcdef1234567890abcdef12345678","asset":"usdc","asset_address":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","decimals":6,"amount":"1","raw_amount":"1000000","failure_reason":{"message":"Transaction simulation reverted"},"steps":[{"type":"evm_transaction","status":"rejected","caip2":"eip155:8453","transaction_hash":null,"failure_reason":{"message":"Transaction simulation reverted"}}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.earn_withdraw.failed":{"post":{"summary":"Wallet action earn_withdraw failed","description":"Fired when a wallet action fails after at least one transaction was broadcast. There may be on-chain state changes; inspect the steps for details.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionEarnWithdrawFailedWebhookPayload"},"examples":{"wallet-action-earn_withdraw-failed":{"value":{"type":"wallet_action.earn_withdraw.failed","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"earn_withdraw","status":"failed","caip2":"eip155:8453","vault_id":"cm7oxq1el000e11o8iwp7d0d0","vault_address":"0x1234567890abcdef1234567890abcdef12345678","asset":"usdc","asset_address":"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","decimals":6,"amount":"1","raw_amount":"1000000","failure_reason":{"message":"Transaction execution reverted"},"steps":[{"type":"evm_transaction","status":"reverted","caip2":"eip155:8453","transaction_hash":"0x2222222222222222222222222222222222222222222222222222222222222222","failure_reason":{"message":"Transaction execution reverted"}}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.earn_incentive_claim.created":{"post":{"summary":"Wallet action earn_incentive_claim created","description":"Fired when a wallet action is created and execution has begun. The action is now pending.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionEarnIncentiveClaimCreatedWebhookPayload"},"examples":{"wallet-action-earn_incentive_claim-created":{"value":{"type":"wallet_action.earn_incentive_claim.created","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"earn_incentive_claim","status":"pending","chain":"base","rewards":null}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.earn_incentive_claim.succeeded":{"post":{"summary":"Wallet action earn_incentive_claim succeeded","description":"Fired when all steps of a wallet action have been confirmed on-chain. The action is complete.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionEarnIncentiveClaimSucceededWebhookPayload"},"examples":{"wallet-action-earn_incentive_claim-succeeded":{"value":{"type":"wallet_action.earn_incentive_claim.succeeded","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"earn_incentive_claim","status":"succeeded","chain":"base","rewards":[{"token_address":"0x58D97B57BB95320F9a05dC918Aef65434969c2B2","token_symbol":"MORPHO","amount":"1000000000000000000"}],"steps":[{"type":"evm_transaction","status":"confirmed","caip2":"eip155:8453","transaction_hash":"0x2446f1fd773fbb9f080e674b60c6a033c7ed7427b8b9413cf28a2a4a6da9b56c"}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.earn_incentive_claim.rejected":{"post":{"summary":"Wallet action earn_incentive_claim rejected","description":"Fired when a wallet action fails before any on-chain effects (e.g. policy rejection, simulation failure). Safe to retry.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionEarnIncentiveClaimRejectedWebhookPayload"},"examples":{"wallet-action-earn_incentive_claim-rejected":{"value":{"type":"wallet_action.earn_incentive_claim.rejected","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"earn_incentive_claim","status":"rejected","chain":"base","rewards":null,"failure_reason":{"message":"No claimable rewards found"},"steps":[{"type":"evm_transaction","status":"rejected","caip2":"eip155:8453","transaction_hash":null,"failure_reason":{"message":"No claimable rewards found"}}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"wallet_action.earn_incentive_claim.failed":{"post":{"summary":"Wallet action earn_incentive_claim failed","description":"Fired when a wallet action fails after at least one transaction was broadcast. There may be on-chain state changes; inspect the steps for details.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletActionEarnIncentiveClaimFailedWebhookPayload"},"examples":{"wallet-action-earn_incentive_claim-failed":{"value":{"type":"wallet_action.earn_incentive_claim.failed","wallet_action_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","wallet_id":"fmfdj6yqly31huorjqzq38zc","action_type":"earn_incentive_claim","status":"failed","chain":"base","rewards":[{"token_address":"0x58D97B57BB95320F9a05dC918Aef65434969c2B2","token_symbol":"MORPHO","amount":"1000000000000000000"}],"failure_reason":{"message":"Transaction execution reverted"},"steps":[{"type":"evm_transaction","status":"reverted","caip2":"eip155:8453","transaction_hash":"0x2222222222222222222222222222222222222222222222222222222222222222","failure_reason":{"message":"Transaction execution reverted"}}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"mfa.enabled":{"post":{"summary":"MFA enabled","description":"Fired when a user enables multi-factor authentication.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MfaEnabledWebhookPayload"},"examples":{"mfa-enabled":{"value":{"type":"mfa.enabled","user_id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","method":"totp"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"mfa.disabled":{"post":{"summary":"MFA disabled","description":"Fired when a user disables multi-factor authentication.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MfaDisabledWebhookPayload"},"examples":{"mfa-disabled":{"value":{"type":"mfa.disabled","user_id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","method":"sms"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"intent.created":{"post":{"summary":"Intent created","description":"Fired when a new intent is created.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentCreatedWebhookPayload"},"examples":{"intent-creation":{"value":{"type":"intent.created","intent_id":"cm5abc123def456ghi789jkl","intent_type":"WALLET","status":"pending","created_by_id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","created_by_display_name":"alice@example.com","resource_id":"fmfdj6yqly31huorjqzq38zc","created_at":1772193600000,"expires_at":1772452800000,"authorization_details":[{"threshold":2,"display_name":"Admin Key Quorum","members":[{"type":"user","user_id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","signed_at":null},{"type":"user","user_id":"did:privy:xyzabc123def456ghi789","signed_at":1709128800000}]}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"intent.authorized":{"post":{"summary":"Intent authorized","description":"Fired when a user authorizes (signs) an intent.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentAuthorizedWebhookPayload"},"examples":{"intent-authorized":{"value":{"type":"intent.authorized","intent_id":"cm5abc123def456ghi789jkl","intent_type":"WALLET","status":"pending","created_by_id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","created_by_display_name":"alice@example.com","resource_id":"fmfdj6yqly31huorjqzq38zc","created_at":1772193600000,"expires_at":1772452800000,"authorized_at":1772202600000,"member":{"type":"user","user_id":"did:privy:xyzabc123def456ghi789","signed_at":1709042400000}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"intent.executed":{"post":{"summary":"Intent executed","description":"Fired when an intent is successfully executed (2xx response from enclave).","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentExecutedWebhookPayload"},"examples":{"intent-executed":{"value":{"type":"intent.executed","intent_id":"cm5abc123def456ghi789jkl","intent_type":"WALLET","status":"executed","created_by_id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","created_by_display_name":"alice@example.com","created_at":1772193600000,"expires_at":1772452800000,"action_result":{"status_code":200,"executed_at":1772210000000,"authorized_by_id":"kq_abc123def456","authorized_by_display_name":"Admin Key Quorum","response_body":{"id":"wallet_123","chain_type":"ethereum"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"intent.failed":{"post":{"summary":"Intent failed","description":"Fired when an intent execution fails (non-2xx response from enclave).","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentFailedWebhookPayload"},"examples":{"intent-failed":{"value":{"type":"intent.failed","intent_id":"cm5abc123def456ghi789jkl","intent_type":"RPC","status":"failed","created_by_id":"did:privy:cfbsvtqo2c22202mo08847jdux2z","created_by_display_name":"alice@example.com","created_at":1772193600000,"expires_at":1772452800000,"action_result":{"status_code":500,"executed_at":1772210000000,"authorized_by_id":"kq_abc123def456","authorized_by_display_name":"Admin Key Quorum","response_body":{"error":"Transaction reverted"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"yield.deposit.confirmed":{"post":{"summary":"Yield deposit confirmed","description":"Fired when a deposit into an ERC-4626 yield vault is confirmed on-chain.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/YieldDepositConfirmedWebhookPayload"},"examples":{"yield-deposit-confirmed":{"value":{"type":"yield.deposit.confirmed","vault_address":"0x1234567890abcdef1234567890abcdef12345678","caip2":"eip155:1","sender":"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045","owner":"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045","assets":"1000000000000000000","shares":"950000000000000000"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"yield.withdraw.confirmed":{"post":{"summary":"Yield withdraw confirmed","description":"Fired when a withdrawal from an ERC-4626 yield vault is confirmed on-chain.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/YieldWithdrawConfirmedWebhookPayload"},"examples":{"yield-withdraw-confirmed":{"value":{"type":"yield.withdraw.confirmed","vault_address":"0x1234567890abcdef1234567890abcdef12345678","caip2":"eip155:1","sender":"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045","owner":"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045","receiver":"0x71C7656EC7ab88b098defB751B7401B5f6d8976F","assets":"1000000000000000000","shares":"950000000000000000"}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}},"yield.claim.confirmed":{"post":{"summary":"Yield claim confirmed","description":"Fired when a yield reward claim transaction is confirmed on-chain.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/YieldClaimConfirmedWebhookPayload"},"examples":{"yield-claim-confirmed":{"value":{"type":"yield.claim.confirmed","wallet_id":"fmfdj6yqly31huorjqzq38zc","caip2":"eip155:1","transaction_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","rewards":[{"token_address":"0x1234567890abcdef1234567890abcdef12345678","token_symbol":"MORPHO","amount":"115631364898103632676"}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the webhook was received successfully."}}}}}}