billing
POST /v1/payment-methods/paypal
Begin saving a PayPal account as a payment method.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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 در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول 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