Introduction
Trustcrow provides instant escrow services to individuals and businesses. The API allows you create, accept, and manage escrow transactions between yourself and another party, or between two other parties. It also safeguard customers on your platform - allowing your customers to create, initiate, fund, hold and release payments from our escrow vault.
To interact with this API, you need to create an account on Trustcrow platform and retrieve your API keys.
Core concepts
This section describes the core concepts in the API.
A user represents an account on Trustcrow.
An escrow transaction represents an arrangement where Trustcrow holds and releases funds for a transaction once specified conditions are met.
A milestone in escrow is a defined stage in a transaction where funds are held until the specified milestone is achieved.
A milestone delivery represents when a seller delivers the agreed upon items to the buyer.
This represents when a buyer confirms the satisfaction of the items delivered.
This occurs when a buyer declines a delivered item and returns it to the seller, often because the item does not meet their expectations.
This occurs when a seller accepts the item returned. In this case, the funds will be released to the buyer.
Seller can decline a returned item, and they have the option to initiate a dispute following the rejection.
A dispute arises when there is a conflict between the buyer and seller, such as when the seller rejects a returned item, necessitating resolution by the platform due to differing transaction terms.
How it works
This section describes how the API works in simple terms, so you can get a general sense of the different concepts in the API reference. To illustrate this, we'll use a hypothetical example of a seller and buyer creating an escrow transaction via an eCommerce marketplace.
Upon selecting their preferred vendor (seller) and goods on the eCommerce marketplace, the buyer chooses to pay via escrow.
The seller and buyer is created using the create a user endpoint. Simultaneously, an escrow transaction will be created using the create a transaction endpoint.
Buyer will then be prompted to fund the transaction.
The seller, notified of the funded escrow transaction, ships the goods to the buyer's designated address and confirm proof of delivery using the deliver item endpoint
Upon receiving the product, the buyer inspects it to ensure it meets their expectations and matches the description provided.
If satisfied with the product, the buyer accepts the delivery using the accept item endpoint, and funds will be released to the seller
If dissatisfied, the buyer rejects the delivery using the reject item endpoint. Seller is notified of the rejected item and they are given the option to either accept or rejects the rejected goods.
If accepted, funds will be released to the buyer. Otherwise, seller gives reason for rejection and a dispute will be created.
Last updated