Escrow API Documentation

Programmatic access to TBUSD Escrow for business integrations

Overview

The TBUSD Escrow API allows businesses to programmatically create and manage escrows. Perfect for marketplaces, freelance platforms, or any application that needs secure payment holding.

Authentication

The API is currently open and does not require authentication. Rate limits apply: 100 requests per minute per IP.

Escrow Types

Endpoints

{
  "name": "TBUSD Escrow API",
  "version": "1.0.0",
  "network": "Base Mainnet",
  "chainId": 8453,
  "contracts": {
    "factory": "0x73BEf257850A977D84E6e02b62dedBbb5757dbc2",
    "tbusd": "0x0d02E2E2a7ADaF2372ca0C69845c8b159A24a595"
  }
}

{
  "totalEscrows": 42,
  "factory": "0x73BEf257850A977D84E6e02b62dedBbb5757dbc2",
  "tbusd": "0x0d02E2E2a7ADaF2372ca0C69845c8b159A24a595",
  "network": "Base Mainnet"
}

{
  "address": "0x1234...5678",
  "depositor": "0xBuyer...",
  "recipient": "0xSeller...",
  "amount": "1000000000",
  "amountFormatted": "1000.00",
  "escrowType": "BuyerProtected",
  "escrowTypeId": 1,
  "status": "Funded",
  "statusId": 2,
  "description": "Domain purchase - example.com",
  "deadline": null,
  "acceptance": {
    "buyer": true,
    "seller": true
  }
}

{
  "wallet": "0x1234...5678",
  "asDepositor": 3,
  "asRecipient": 2,
  "total": 5,
  "escrows": [
    { ... escrow details ... }
  ]
}

curl -X POST https://tbusd-escrow-api.jkm1317.workers.dev/api/v1/escrow/build \
  -H "Content-Type: application/json" \
  -d '{
    "depositor": "0xBuyerAddress...",
    "recipient": "0xSellerAddress...",
    "amount": "500.00",
    "escrowType": 1,
    "description": "Website purchase"
  }'

{
  "to": "0x73BEf257850A977D84E6e02b62dedBbb5757dbc2",
  "value": "0x0",
  "chainId": 8453,
  "params": {
    "depositor": "0xBuyerAddress...",
    "recipient": "0xSellerAddress...",
    "amount": "500000000",
    "escrowType": 1,
    "deadline": 0,
    "description": "Website purchase"
  },
  "note": "Sign this transaction with your wallet to create the escrow"
}

Integration Example

Here's a complete example using JavaScript and ethers.js:

import { ethers } from 'ethers';

const API_BASE = 'https://tbusd-escrow-api.jkm1317.workers.dev';

// 1. Build the transaction via API
const response = await fetch(`${API_BASE}/api/v1/escrow/build`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    depositor: buyerWallet,
    recipient: sellerWallet,
    amount: '500.00',
    escrowType: 1, // BuyerProtected
    description: 'Order #12345'
  })
});
const txData = await response.json();

// 2. User signs and sends transaction
const provider = new ethers.BrowserProvider(window.ethereum);
const signer = await provider.getSigner();
const factory = new ethers.Contract(txData.to, FACTORY_ABI, signer);

const tx = await factory.createEscrow(
  txData.params.depositor,
  txData.params.recipient,
  txData.params.amount,
  txData.params.escrowType,
  txData.params.deadline,
  txData.params.description
);

const receipt = await tx.wait();
console.log('Escrow created:', receipt);

// 3. Poll for status updates
const escrowAddress = '0x...'; // from receipt events
const details = await fetch(`${API_BASE}/api/v1/escrow/${escrowAddress}`);
console.log(await details.json());

Status Codes

Support

For API support or integration help, contact us at [email protected]