Skip to main content
A standard escrow is a single-payment link: the buyer funds it once, and the full amount is released to the seller on confirmation. This group covers creating the link, editing it before it’s funded, and the seller’s claim path. For the full state machine see Escrow lifecycle; for the call-by-call walkthrough see How it works.
customer-id = the seller when creating. Edit, delete and claim are seller-only and act on the escrow’s paymentToken. Buyer-side actions (funding, confirming) live under Payments and Disputes.

​
Endpoints

RouteMethod & pathWhat it does
Create escrowPOST /v1/escrow/createGenerates a standard escrow link. multipart/form-data (up to 5 images). Required: amount, purpose, whoPays. Returns id + paymentToken; state: AWAITING_PAYMENT. customer-id = seller. A merchant can’t create an escrow for itself.
Edit escrowPUT /v1/escrow/edit/{paymentToken}Update amount/purpose/delivery/images. Allowed only while AWAITING_PAYMENT and only by the seller. New images are appended.
Delete escrowDELETE /v1/escrow/delete/{paymentToken}Removes an unfunded escrow. Allowed only while AWAITING_PAYMENT.
Verify payment tokenGET /v1/escrow/verify/{paymentToken}Resolves a link to its full escrow details — used by the buyer to preview before paying.
Claim fundsGET /v1/escrow/claim-funds/{paymentToken}Seller releases funds to themselves. Allowed only when OPENED and the delivery window has elapsed. Closes as CLAIMED.
List escrow transactionsGET /v1/escrow/transactionsPaginated escrows for the caller. type (sales or buy) is required. Optional status, categoryId, page, limit.

​
How a standard escrow flows

1

Create (seller)

POST /v1/escrow/create → AWAITING_PAYMENT. Editable/deletable until funded.
2

Fund (buyer)

Buyer pays via Pay escrow → OPENED.
3

Release

Buyer confirms → COMPLETED, or the seller claims after the window → CLAIMED.
Selling more than one unit from a single link (totalQuantity > 1) changes this behaviour — each buyer gets a cloned escrow. Read Multi-quantity escrows.