Fund Escrow

Allows users to deposit funds into an existing escrow contract, securing them until the agreed conditions are met.

Allows flexible USDC amounts to be transferred to the escrow contract.

POST escrow/fund-escrow

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
contractId	string	ID (address) that identifies the escrow contract
signer	string	Address of the user signing the contract transaction
amount	string	Amount to transfer to the escrow contract

Example of Request Body:

{
	"contractId": "GC3DJY4LLQYJHEONXFDLQVVRCFZQCPFX7VD33KP4P7QSVZY3SJHQBZGV",
	"signer": "GBY3PAJY5R3ZIXTYBGFW4URB4RINEXQBC3T4RWDDKJ5TZXQYZUN6A4TP", 
	"amount": "500.00"
}

Possible Responses

201 Success

{
    "status": "SUCCESS",
    "unsignedTransaction": "AAAAAgAAAABfQAm/gS..."  // XDR Hash Transaction
}

500 Server Error

Escrow in dispute

{
  "status": "FAILED"
  "messgae": "Escrow has been opened for dispute resolution"
}

Fully Funded

{
  "status": "FAILED"
  "message": "This escrow is already fully funded"
}

Amount to deposit is greater than escrow amount

{
  "status": "FAILED"
  "message": "Amount to deposit is greater than the escrow amount"
}

Insufficient Founds

{
  "status": "FAILED"
  "message": "The signer does not have sufficient funds"
}

Not Found

{
  "status": "FAILED"
  "message": "Escrow not found"
}

400 Bad Request

{
    "message": "Message",
    "error": "Bad Request",
    "statusCode": 400
}

401 Unauthorized

{
  "statusCode": 401,
  "message": "Unauthorized",
  "error": "Unauthorized"
}

429 Rate Limit

{
    "statusCode": 429,
    "message": "ThrottlerException: Too Many Requests"
}

What this Endpoint returns?

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.

Use example (Using axios):

import axios from "axios";

const http = axios.create({
  baseURL: "https://dev.api.trustlesswork.com",
  timeout: 10000,
  headers: {
    "Content-Type": "application/json",
    Authorization: `Bearer your_api_key`,
  },
});

export const useExample = async () => {
    // Get the signer address
    const { address } = await kit.getAddress();

    const response = await http.post(
      "/escrow/fund-escrow",
      {
        // body requested for the endpoint
      },
    ); 
    
    // Get the unsigned transaction hash
    const { unsignedTransaction } = response.data;

    // Sign the transaction by wallet
    const { signedTxXdr } = await signTransaction(unsignedTransaction, {
      address,
      networkPassphrase: WalletNetwork.TESTNET,
    });

    // Send the transaction to Stellar Network
    const tx = await http.post("/helper/send-transaction", {
      signedXdr: signedTxXdr,
      returnValueIsRequired: true,
    });

    const { data } = tx;

    return data;
}