Jèko
Escrows

Get escrow by ID (Partner API)

GET
/partner_api/escrows/{id}

Returns one escrow by id, including hold lifecycle status.

Access: platform key only. Other merchants receive 404.

Authorization

ApiKey ApiKeyId
X-API-KEY<token>

In: header

X-API-KEY-ID<token>

In: header

Path Parameters

id*string

Escrow identifier

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/partner_api/escrows/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "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"  }}

Create escrow (Partner API) POST

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.

Collect escrow (Partner API) POST

Starts the collect of a pending escrow, as a payment request or a payment link. `type` selects the collect and `data` carries its fields (the store comes from the escrow). Retry on a `failed` escrow once its previous payment request can no longer be paid; the new collect replaces the old one. Payment links never fail the escrow: the payer retries on the link. **Access:** platform key only.