capture_escrow_hold
Settle a hold (status captured). amount captures part (default: all); the uncaptured remainder returns to the holder. With to_user_id/to_user_email the captured credits go to that user (created if new) — marketplace/P2P settlement; otherwise they stay deducted (settled to the platform). 409 HOLD_NOT_ACTIVE if already settled, 400 CAPTURE_EXCEEDS_HELD. Costs 1 CRD (platform credit) per call, charged even when the call is then rejected (a 429 RATE_LIMITED costs nothing). Error results include request_id; quote it to support.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| amount | No | Credits to capture (default: the full hold) | |
| reason | No | ||
| api_key | No | Cred API key (optional if set via the x-api-key header) | |
| hold_id | Yes | Hold ID | |
| metadata | No | ||
| project_id | No | Cred project ID (optional; the API key already identifies the project) | |
| to_user_id | No | External ID of the recipient | |
| x402_payment | No | Base64 x402 PaymentPayload, only when a previous call failed with an x402 PaymentRequired because the account is out of CRD | |
| to_user_email | No | Email of the recipient |