Claim Escrow Earnings

Allows a user to withdraw their locked earnings from an escrow contract.

POST escrow/claim-escrow-earnings

Headers

Name	Value
Content-Type	application/json

Body

Name	Type	Description
engagementId	string	The unique identifier linking this escrow to a specific project or transaction.
serviceProvider	string | Address	The address of the entity receiving the payment.
contractId	string	The unique identifier of the contract.

Example of Request Body:

{
  "engamentId": "test", 
  "serviceProvider": "GD2SVFOJ...",
  "contractId": "SCMXDC..."
}

Possible Responses

200 OK

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

500 Server Error

Complete Claim Earnings

{
  "error": "The escrow must be completed to claim earnings"
}

Only Service Provider

{
  "error": "Only the service provider can claim escrow earnings"
}

Not Found

{
  "error": "Escrow not found"
}

Amount

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

Cancelled

{
  "error": "The escrow has already been cancelled"
}

Funds

{
  "error": "The contract does not have sufficient funds"
}

400 Bad Request

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

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.