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 کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو 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