Jèko
Escrows

Create escrow (Partner API)

POST
/partner_api/escrows

Creates a pending escrow pot for one later collect.

Bind the pot by passing escrowId on POST /partner_api/payment_requests or POST /partner_api/payment_links. This endpoint does not collect money.

Access: merchant-scoped platform key (Service Provider–issued) only. Owner / Dashboard keys and the Service Provider business key receive 403.

Authorization

ApiKey ApiKeyId
X-API-KEY<token>

In: header

X-API-KEY-ID<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/partner_api/escrows" \  -H "Content-Type: application/json" \  -d '{    "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",  "status": "pending",  "holdUntil": "2019-08-24T14:15:22Z",  "amount": {    "amount": 0,    "currency": "string"  },  "paymentRequestId": "e1d5fdf3-f4c6-4ab6-a2c0-11174dd3f66b",  "paymentLinkId": "65854dcb-f544-4848-b04d-cccad43b01a8",  "createdAt": "2019-08-24T14:15:22Z"}

List escrows (Partner API) GET

Lists escrows for the authenticated merchant. Store-scoped platform keys only see their store. Lifecycle lives here — Partner `GET /transactions` stays operating-wallet only. **Access:** platform key only.

Get escrow by ID (Partner API) GET

Returns one escrow by id, including hold lifecycle status. **Access:** platform key only. Other merchants receive 404.