Collect escrow (Partner API)
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.
Authorization
ApiKey ApiKeyId In: header
In: header
Path Parameters
Escrow identifier
uuidRequest 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
application/json
curl -X POST "https://example.com/partner_api/escrows/497f6eca-6276-4993-bfeb-53cbbbba6f08/collect" \ -H "Content-Type: application/json" \ -d '{ "type": "payment_request", "data": { "amountCents": 100, "currency": "str", "reference": "string", "paymentDetails": { "type": "redirect", "data": { "paymentMethod": "orange", "successUrl": "http://example.com", "errorUrl": "http://example.com" } } } }'{ "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" }}Get escrow by ID (Partner API) GET
Returns one escrow by id, including hold lifecycle status. **Access:** platform key only. Other merchants receive 404.
Refund escrow (Partner API) POST
Refunds a held escrow to the original payer. Principal leaves the escrow wallet via the PSP change path. Partner GET /transactions stays empty for this job. **Access:** platform key only.