Responsible for modifying the "flag" property of a specific milestone in the escrow to approve that milestone.

URL: /escrow/change-milestone-flag

Body params:

contractId: ID (address) that identifies the escrow contract

milestoneIndex: Position that identifies the milestone within the group of milestones in the escrow

newFlag: New value for the "flag" property within the escrow milestone

client: Address of the client who will approve the milestone

Example:

Handles the resolution of disputes within an escrow by transferring the amounts entered so far in the escrow to the client and service provider according to what the dispute resolver deems appropriate.

URL: /escrow/resolving-disputes

Body params:

contractId: ID (address) that identifies the escrow contract

disputeResolver: Address of the user defined to resolve disputes in an escrow

clientFunds: Amount to transfer to the client for dispute resolution

serviceProviderFunds: Amount to transfer to the service provider for dispute resolution

Example:

{
	contractId: "GC3DJY4LLQYJHEONXFDLQVVRCFZQCPFX7VD33KP4P7QSVZY3SJHQBZGV",
	disputeResolver: "GBY3PAJY5R3ZIXTYBGFW4URB4RINEXQBC3T4RWDDKJ5TZXQYZUN6A4TP", 
	clientFunds: "100",
	serviceProviderFunds: "50"
};

Responsible for setting the escrow in dispute state. Changes the value of the escrow's "dispute_flag" property to true.

URL: /escrow/change-dispute-flag

Body params:

contractId: ID (address) that identifies the escrow contract

signer: Address of the user who will sign the transaction

Example:

{
	contractId: "GC3DJY4LLQYJHEONXFDLQVVRCFZQCPFX7VD33KP4P7QSVZY3SJHQBZGV",
	signer: "GBY3PAJY5R3ZIXTYBGFW4URB4RINEXQBC3T4RWDDKJ5TZXQYZUN6A4TP"
};

Returns the balance of an escrow

URL: /helper/get-escrow-balance

Body params:

contractId: ID (address) that identifies the escrow contract

signer: Address of the user who will sign the transaction

Example:

{
	contractId: "GC3DJY4LLQYJHEONXFDLQVVRCFZQCPFX7VD33KP4P7QSVZY3SJHQBZGV",
	signer: "GBY3PAJY5R3ZIXTYBGFW4URB4RINEXQBC3T4RWDDKJ5TZXQYZUN6A4TP"
};

Allows flexible USDC amounts to be transferred to the escrow contract.

URL: /escrow/fund-escrow

Body params:

contractId: ID (address) that identifies the escrow contract

signer: Address of the user signing the contract transaction

amount: Amount to transfer to the escrow contract

Example:

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

Previous Version:

POST escrow/fund-escrow

Headers

Body

Example of Request Body:

{
  "engagementId": "test",
  "contractId": "GD2SVFOJ...",
  "signer": "SCMXDC..."
}

Possible Responses

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

{
  "error": "Only the signer can fund the escrow"
}

{
  "error": "Escrow already funded"
}

{
  "error": "This escrow is already fully funded"
}

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

{
  "error": "Escrow not found"
}

{
  "error": "Not enough allowance to fund this escrow"
}

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

{
    "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.

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

Body

Example of Request Body:

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

Possible Responses

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

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

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

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

Distributes escrow earnings after the escrow is marked as complete.

URL: /escrow/distribute-escrow-earnings

Body params:

contractId: ID (address) that identifies the escrow contract

releaseSigner: Address of the user defined to release the funds

Example:

{
	contractId: "GC3DJY4LLQYJHEONXFDLQVVRCFZQCPFX7VD33KP4P7QSVZY3SJHQBZGV",
	releaseSigner: "GBY3PAJY5R3ZIXTYBGFW4URB4RINEXQBC3T4RWDDKJ5TZXQYZUN6A4TP", 
};

This was previously called complete escrow:

POST escrow/complete-escrow

Headers

Body

Example of Request Body:

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

Possible Responses

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

{
  "error": "Only the signer can complete the escrow"
}

{
  "error": "Escrow not funded"
}

{
    "error": "Escrow already completed"
}

{
  "error": "Escrow not found"
}

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

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

{
    "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.

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

URL: /escrow/change-milestone-status

Body params:

contractId: ID (address) that identifies the escrow contract

milestoneIndex: Position that identifies the milestone within the group of milestones in the escrow

newStatus: New value for the "status" property within the escrow milestone

serviceProvider: Address of the service provider who will modify the contract's "status" property

Example: