Trustless Work
English
English
  • Welcome
    • Why Escrows Matter
    • Who Should Use This
    • Links
  • ⚒️Core Concepts
    • Smart Escrow Design
      • What does a Smart Escrow "look like"?
    • Roles in Trustless Work
    • Escrow Lifecycle
      • Initiation Phase
      • Funding Phase
      • Complete phase
      • Approval phase
      • Release phase
      • Dispute Resolution
    • USDC: The Stablecoin Powering Trustless Work
    • Stellar & Soroban: The Backbone of Trustless Work
  • 💻Developer Guide
    • 🚀Developer Quickstart
    • Authentication
      • Request Api Key
    • Schema
    • Architecture
    • Stellar Wallets
      • Freighter Wallet
      • Albedo Wallet
      • xBull Wallet
      • Rabet Wallet
      • Lobstr Wallet
      • Hana Wallet
      • Additional Resources
      • Troubleshooting & FAQs
    • How to Get Testnet Tokens
  • API Reference
    • Introduction
    • Types
      • Basic
      • Entities
      • Payloads
      • Responses
      • Errors
    • Single Release Escrow
      • Deploy
      • Fund Escrow
      • Approve Milestone
      • Change Milestone Status
      • Release Funds
      • Dispute Escrow
      • Resolve Dispute
      • Get Escrow
      • Update Escrow
    • Multi Release Escrow
      • Deploy
      • Fund Escrow
      • Approve Milestone
      • Change Milestone Status
      • Release Milestone Funds
      • Dispute Milestone
      • Resolve Milestone Dispute
      • Update Escrow
      • Get Escrow
    • Helpers
      • Set Trustline
      • Send Transaction
      • Get Multiple Escrow Balance
    • 🚀Smart Escrow API
  • React Library
    • Getting Started
    • useSendTransaction
    • useGetEscrow
    • useGetMultipleEscrowBalances
    • useInitializeEscrow
    • useUpdateEscrow
    • useFundEscrow
    • useChangeMilestoneApprovedFlag
    • useChangeMilestoneStatus
    • useReleaseFunds
    • useStartDispute
    • useResolveDispute
  • Templates & Components
    • 🤖Using the dApp
      • Step 1: Accessing the Trustless Work Dapp and Logging In
      • Step 2: Creating a Profile and Requesting an API Key
      • Step 3: Creating an Escrow
      • Step 4: Funding an Escrow
      • Step 5: Marking a Milestone as Done ✅
      • Step 6: Approving the Milestone
      • Step 7: Releasing the Payment
      • Resolving Disputes
    • Integration Demo Project
      • Getting Started
      • Configuration
      • Context API
      • Wallet Setup
      • Trustlines
      • Services
      • Helpers
      • Error Handling
      • Forms
        • Initialize Escrow
        • Fund Escrow
        • Get Escrow
        • Get Multiple Escrow Balances
        • Resolve Dispute
        • Change Milestone Status
        • Change Milestone Flag
        • Change Dispute Flag
        • Release Funds
        • Update Escrow
      • UI Components
        • Pages
        • Cards
        • Tabs
        • Utils
  • Tools & Utilities
  • 🌍Use Cases by Industry
    • Marketplaces & E-commerce
    • Grants, Bounties, and Hackathons
    • P2P Exchanges and OTC Desks
    • Security Deposits
    • Milestone-based Freelance & Contract Work
    • Crowdfunding & Pre-orders
    • DAO Treasury & Working Group Budgets
    • Education & Online Courses
    • Subscription + Performance-based Retainers
  • 🏴‍☠️Community & Contribution
    • 🌎Spotlight: Kindfi
    • 🛣️Roadmap: The Journey Ahead
    • Contributor's Guide
    • 📂Open-Source Templates & Developer Tools
  • 📢Appendix & Archive
    • Contact and Support
    • Notion for Startups
    • Meru
    • ✒️Background & Theory
      • 📘Core Concepts & Escrow Glossary
      • 🎒Historical Context
        • 📜Escrow History:
          • 🗿Ancient to Colonial Era
          • 🏦Banking Era (19th - 20th Century)
          • 💻The Digital Era and Online Escrow
        • ⛓️Blockchain Era: Smart Escrows
Powered by GitBook
LogoLogo

Links

  • Website
On this page
  • Core Functions of the API
  • Technical Reference 📑

Was this helpful?

Export as PDF
  1. API Reference

Smart Escrow API

Escrow API 2.0 is around the Corner, this section is in construction

There will be a fixed 0.3% fee on released funds from escrows on Mainnet.

That's our business model. As a platform you will be able to add a flexible fee on top of that 0.3%, which will automaticaly route to the address of your choice.

The Trustless Work API is a developer-friendly interface that enables you to integrate escrow functionalities seamlessly into your platform. Whether you're building a marketplace, a SaaS product, or any platform that requires trust in transactions, the API offers everything you need to easily manage the lifecycle of an escrow.

Core Functions of the API

Initialize Escrows 🏁

  • Kickstart a new escrow by specifying key parameters such as amount, recipient, and conditions.

  • The API handles the creation of a unique escrow smart contract, eliminating the need for manual blockchain interactions.

Fund and Manage Escrows 💰

  • Fund Escrows: Deposit funds into the escrow securely—whether it's USDC or another asset supported by the Stellar Network.

  • Manage Conditions: Define conditions and milestones to align with your project requirements. The API lets you monitor and update these as needed.

Approve and Release Funds ✔️

  • Once the conditions are met, use the API to approve fund release. The open-source smart contracts ensure funds are released only when both parties fulfill their obligations.

  • By making approvals programmatic, the Trustless Work API helps automate workflows, reducing the need for manual checks and verifications.

Track Escrow Status 📊

  • Stay up to date with the escrow's status at every step. From initiation to completion, the API lets you retrieve information about the escrow state, milestones, and remaining conditions in real-time.

How It Simplifies Escrow Integration

  • Abstracts Blockchain Complexity: No need to be a blockchain expert. The Trustless Work API makes interacting with smart contracts as easy as a standard API call—no need for specialized blockchain engineers or understanding complicated crypto processes.

  • Secure and Transparent: The API integrates directly with open-source escrow smart contracts, deployed on the Stellar blockchain, ensuring that funds are managed securely and that every transaction is transparent and traceable.

  • Seamless User Experience: You can configure the conditions, roles, and actions for an escrow without needing to touch any of the underlying blockchain logic. The Trustless Work API manages everything for you, allowing you to focus on building your platform’s unique features.

When to Use the Trustless Work API

  • Marketplaces and Platforms: Ensure buyer and seller trust with secure milestone payments.

  • Freelance Platforms: Protect clients and freelancers by releasing funds only upon verified completion.

  • Rental and Security Deposits: Hold deposits safely until conditions are met, such as returning a rental item or completing an inspection.

  • Crowdfunding Campaigns: Ensure contributors' funds are only used once milestones are achieved, providing trust and transparency for backers.


Technical Reference 📑

Ready to explore more? Visit our API Reference for technical details, and begin integrating trustless escrow solutions today!

PreviousGet Multiple Escrow BalanceNextReact Library

Last updated 3 months ago

Was this helpful?

🚀