Initialize Escrow

Deploy the escrow contract and define the escrow properties.

Headers

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

Milestone

Name	Type	Description
description	string	Text describing the function of the milestone
status	string	Milestone status. Ex: Approved, In dispute, etc...
approved_flag	boolean	Flag indicating whether a milestone has been approved by the approver

Open API

post

Body

signerstringRequired

Entity that signs the transaction that deploys and initializes the escrow

Example: GABC...XYZ

engagementIdstringRequired

Unique identifier for the escrow

Example: ENG12345

titlestringRequired

Name of the escrow

Example: Escrow Test

descriptionstringRequired

Text describing the function of the escrow

Example: Escrow Test description

approverstringRequired

Address of the entity requiring the service

Example: GAPPROVER...XYZ

serviceProviderstringRequired

Address of the entity providing the service

Example: GSERVICE...XYZ

platformAddressstringRequired

Address of the platform that owns the escrow

Example: GPLATFORM...XYZ

amountstringRequired

Amount to be transferred upon completion of escrow milestones

Example: 1000

platformFeestringRequired

Commission that the platform will receive when the escrow is completed

Example: 5 -> 5%

milestonesobject[]Required

Objectives to be completed to define the escrow as completed.

releaseSignerstringRequired

Address of the user in charge of releasing the escrow funds to the service provider

Example: GREL...XYZ

disputeResolverstringRequired

Address in charge of resolving disputes within the escrow

Example: GDISPUTE...XYZ

receiverstringRequired

Address of the user to whom the escrow funds will be destined to

Example: GRECEIVER...XYZ

receiverMemonumberOptional

Field used to identify the recipient's address in transactions through an intermediary account. This value is included as a memo in the transaction and allows the funds to be correctly routed to the wallet of the specified recipient

Example: 123456

trustlinestringRequired

Address of the token that will manage USDC movements

Example: GTRUST...XYZ

trustlineDecimalsnumberRequired

Number of decimal places determining the divisibility of the token base unit (trustline)

Example: 68890890

Responses

201

This endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.

400

Bad request

401

Unauthorized access

429

Too Many Requests

500

Possible errors:

• { status: "FAILED", message: "Amount cannot be zero" }
• { status: "FAILED", message: "Escrow already initialized" }
• { status: "500", message: "An unexpected error occurred" }

post

HTTPcURLJavaScriptPython

POST /deployer/invoke-deployer-contract HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 621

{
  "signer": "GAPPROVER1234567890...",
  "engagementId": "ENG12345",
  "title": "Project Title",
  "description": "This is a detailed description of the project.",
  "approver": "GAPPROVER1234567890...",
  "serviceProvider": "GAPPROVER1234567890...",
  "platformAddress": "GAPPROVER1234567890...",
  "amount": "1000",
  "platformFee": "50",
  "milestones": [
    {
      "description": "Initial phase of the project"
    },
    {
      "description": "Completion of design work"
    }
  ],
  "releaseSigner": "GAPPROVER1234567890...",
  "disputeResolver": "GAPPROVER1234567890...",
  "receiver": "GAPPROVER1234567890...",
  "receiverMemo": 456789,
  "trustline": "GAPPROVER1234567890...",
  "trustlineDecimals": 6233233223
}

No content

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:

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();

    // Execute the endpoint
    const response = await http.post(
      "/deployer/invoke-deployer-contract",
      {
        // 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,
      returnEscrowDataIsRequired: true,
    });

    const { data } = tx;

    return data; 
}