commerce

POST `/v1/orders/{orderId}/paypal/capture`

Capture a PayPal order the buyer completed.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API) كرمز حامل (bearer token). لا يحدد نقطة النهاية هذه إذنًا محددًا في المواصفات، لذا امنح مفتاحك الحد الأدنى الذي محتاجه وتحقق من الاستجابة بدلاً من الافتراض.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/paypal/capture \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "paypal_order_id": <string> }'

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

Settles the order against a PayPal order the buyer has approved (wallet) or paid by card (including any 3-D Secure step). ⛔ **The browser is not believed.** It reports that the buyer finished; only PayPal's capture response says money moved, and only the engine writes a payment. Posting an invented `paypal_order_id` produces a gateway error, never a paid order. A **declined card answers 200** with the order `payment_failed`, for the same reason `payOrder` does — the attempt was processed exactly as asked.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`orderId (path)`	`Uuid`	نعم	The order's id.

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`paypal_order_id`	`string`	نعم	The id returned by `openPayPalOrder` and completed in the browser.

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`human_ref`	`string`	نعم	Human-friendly order reference.
`status`	`OrderStatus`	نعم	An order's lifecycle state (docs/31 §4.3).
`currency`	`CurrencyCode`	نعم	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`subtotal_minor`	`integer`	نعم	—
`tax_minor`	`integer`	نعم	—
`discount_minor`	`integer`	نعم	—
`total_minor`	`integer`	نعم	—
`billing_country`	`object`	لا	—
`placed_at`	`object`	لا	—
`created_at`	`string`	نعم	—
`updated_at`	`string`	لا	—
`lines`	`OrderLine[]`	نعم	—
`payments`	`Payment[]`	نعم	—

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 422 · 429 · 503

POST /v1/orders/{orderId}/paypal/capture