Distribute Escrow Earnings

You release the escrow funds to the service provider through the approver.

POST escrow/distribute-escrow-earnings

Headers

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

Body

Name	Type	Description
contractId	string	ID (address) that identifies the escrow contract
releaseSigner	string	Address of the signatory in charge of releasing the escrow funds.

Example of request body:

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

200 Success

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

500 Server Error

Not found

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

Only release signer can distribute the escrow earnings

{
    status: "FAILED"
    message: "Only the release signer can claim escrow earnings"
}

No milestone defined

{
    status: "FAILED"
    message: "Escrow initialized without milestone"
}

Escrow not completed

{
    status: "FAILED"
    message: "The escrow must be completed to distribute earnings"
}

Escrow in dispute

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

Escrow balance not enough

{
    status: "FAILED"
    message: "The escrow balance must be equal to the amount of earnings defined for the escrow"
}

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/distribute-escrow-earnings",
      {
        // 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;
}