Initialize Escrow

Funds are deposited into the escrow contract, either manually by a party or automatically via an API call.

Initialize escrow

Deploys the escrow contract and defines its properties.

URL: /deployer/invoke-deployer-contract

Body params:

signer: Entity that signs the transaction that deploys and initializes the escrow engagementId: Unique identifier for the escrow

title: Name of the escrow

description: Text describing the function of the escrow

client: Address of the entity requiring the service

serviceProvider: Address of the entity providing the service

platformAddress: Address of the platform that owns the escrow

amount: Amount to be transferred upon completion of escrow milestones

platformFee: Commission that the platform will receive when the escrow is completed

milestones: Objectives to be completed to define the escrow as completed releaseSigner: Address of the entity in charge of releasing escrow funds

disputeResolver: Address in charge of resolving disputes within the escrow

Example:

{
	signer: "GAD4T6Z63N5NJLQYY3J5MVYFHH5I5UB7NDUUYZD7HHB3RMS6X3H4YK7P", 
	engagementId: "ENG12345",
	title: "Project Title",
	description: "This is a detailed description of the project.",
	client: "GAHJZHVKFLATA7RVGXSFKXAKT5H4RXJ4LU2UR2W2IDFXOJQ2BR7RHW62",
	serviceProvider: "GDWPCWWH7IXQJHDF7FJUI7VOGD5IT72T7YX55F4BR2H4WXFRBVMBK6A3", 
	platformAddress: "GBC5DVYUBTBSXJ3ZMRPGXDDDLKTALIFGRW73B33AF5EFSZBUECKSFO4R",
	amount: "1000.00",
	platformFee: "50.00", 
	milestones: [
		{ description: "Initial phase of the project", status: "Pending" },
		{ description: "Completion of design work", status: "Pending" }
	],
	releaseSigner: "GBDKXCG6FHJMTUBWGAVVOD5PB5QXLYTRJGCH4NR4IMJVPXHHTBBXPY3V",
	disputeResolver: "GDJVCNR5GPOJH7XMOVMHBKZV7V7WQ3B7QK75C76HLOBD4AKHFG5OCARJ"
};

---

Prievious Version:

POST escrow/initialize-escrow

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.
description	string	A brief summary or metadata describing the scope of the service/product.
issuer	string | Address	The address of the party that created the escrow contract.
serviceProvider	string | Address	The address of the entity receiving the payment.
amount	string	The amount pacted (price of product/service).
signer	string | Address	The address authorized to approve the release of funds.

Example of Request Body:

{
  "engagementId": "test",
  "description": "description test",
  "issuer": "GD2SVFOJ...",
  "serviceProvider": "GD2SVFOJ...",
  "amount": "100",
  "signer": "GD2SVFOJ..."
}

Possible Responses

201 Created

{
    "status": "SUCCESS",
    "message": "The escrow has been successfully initialized"
}

500 Server Error

Prices

{
  "error": "Amount cannot be zero"
}

400 Bad Request

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

429 Rate Limit

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