Create escrow (Partner API)
Creates a pending escrow pot for one later collect.
Start its collect with POST /partner_api/escrows/{id}/collect.
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 In: header
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" }, "createdAt": "2019-08-24T14:15:22Z", "collect": { "type": "payment_request", "status": "pending", "errorReason": "string", "reference": "string", "redirectUrl": "string", "link": "string", "amount": { "amount": 0, "currency": "string" }, "fees": { "amount": 0, "currency": "string" }, "paymentMethod": "string", "counterpartIdentifier": "string" }, "release": { "amount": { "amount": 0, "currency": "string" }, "fees": { "amount": 0, "currency": "string" }, "autoRelease": true }, "refund": { "status": "pending", "amount": { "amount": 0, "currency": "string" }, "fees": { "amount": 0, "currency": "string" }, "paymentMethod": "string", "counterpartIdentifier": "string" }}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.