Change Milestone Status

Responsible for modifying the "status" property of a specific milestone in the escrow.

Headers

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

Open API

post

Body

contractIdstringRequired

ID (address) that identifies the escrow contract

Example: CAZ6UQX7...

milestoneIndexstringRequired

milestone within the group of milestones in the escrow

Example: 1

newStatusstringRequired

New value for the status property within the escrow milestone

Example: Completed

serviceProviderstringRequired

Address of the entity providing the service

Example: Completed

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: "Escrow not found" }
• { status: "FAILED", message: "Only the service provider can change milestone status" }
• { status: "FAILED", message: "Invalid milestone index" }
• { status: "FAILED", message: "Escrow initialized without milestone" }
• { status: "500", message: "An unexpected error occurred" }

post

HTTPcURLJavaScriptPython

POST /escrow/change-milestone-status HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "contractId": "CAZ6UQX7...",
  "milestoneIndex": "1",
  "newStatus": "Completed",
  "serviceProvider": "GAPPROVER1234567890..."
}

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

    const response = await http.post(
      "/escrow/change-milestone-status",
      {
        // 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,
    });

    const { data } = tx;

    return data;
}