billing

POST `/v1/payment-methods/paypal`

Begin saving a PayPal account as a payment method.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن billing.payment.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

حيث يتم إدخال معرف مؤسستك

تقبل هذه نقطة النهاية org_id حقلًا في نص JSON.

معرف مؤسستك موجود على شاشة مفاتيح واجهة برمجة التطبيقات (API) في لوحة تحكمك، بجوار المفتاح نفسه. وهو نفس المعرف في كل طلب تجريه.

جربه الآن

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

curl -X POST https://api.zinndigital.com/v1/payment-methods/paypal \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

التفاصيل

Opens a PayPal vault setup token and returns the approval_url the buyer must visit to consent. No payment method is created by this call — a mandate is consent, and the row is written only once PayPal confirms it, either through POST /v1/payment-methods/paypal/confirm when the buyer returns or through PayPal's own VAULT.PAYMENT-TOKEN.CREATED webhook (ADR 0011 §3). Requires billing.payment.manage in the target organization. A saved PayPal mandate is chargeable off-session, so it may be nominated as the account's primary or its backup — including as the backup behind a card primary, which the platform charges on PayPal's rail when the card declines.

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`org_id`	`string`	لا	Organization to attach the mandate to. The caller must hold `billing.payment.manage` in that organization.

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`setup_token_id`	`string`	نعم	—
`approval_url`	`string`	نعم	Where to send the buyer to approve the mandate. `null` when PayPal returned no approval link, in which case the setup cannot be completed and the customer should try again.

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

401 · 403 · 409 · 422 · 429 · 503