platform-transfers
POST /v1/platform-transfers/{transferId}/pay
Pay for a transfer and queue it for a specialist.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز billing.payment.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/platform-transfers/{transferId}/pay \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
Charges the tier through the extras rails — wallet first, then the gateway — and moves the transfer to queued with its SLA set. Requires billing.payment.manage, because it moves money; creating the draft needs only billing.view. A decline returns 422 and leaves the transfer in payment_failed; nothing is charged and the same transfer can be paid again with another method. An organization with no chargeable payment method gets 422 PAYMENT_METHOD_REQUIRED instead — nothing was presented to a gateway, so it is not a decline: the remedy is to choose a payment method (getPaymentOptions lists the rails this account can use) rather than to fix a card (docs/491 §7).
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
transferId (path) | string | بله | — |
بدنه درخواست
| نام | نوع | الزامی | چیست |
|---|---|---|---|
currency | object | خیر | The currency the customer was quoted in. Refused if no gateway can charge it — silently substituting the base currency would bill a different number from the one on the screen. |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
id | Uuid | بله | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
source_platform | string | بله | — |
source_platform_name | string | خیر | — |
target_platform | string | بله | — |
target_platform_name | string | خیر | — |
source_url | string | بله | — |
target_site_id | object | خیر | — |
tier_code | string | بله | — |
tier_name | string | خیر | — |
entity_count_estimate | integer | خیر | — |
status | PlatformTransferStatus | بله | — |
status_label | string | خیر | — |
price_amount_minor | integer | بله | — |
price_currency | string | بله | — |
redirects_mapped | boolean | خیر | — |
redirect_count | integer | خیر | — |
canonicals_verified | boolean | خیر | — |
sitemap_submitted | boolean | خیر | — |
structured_data_preserved | boolean | خیر | — |
seo_checks_complete | boolean | خیر | — |
customer_note | string | خیر | — |
sla_due_at | object | خیر | — |
created_at | string | بله | — |
completed_at | object | خیر | — |
events | PlatformTransferEvent[] | خیر | The customer-visible trail only. Staff notes name vendors and what a job cost us, and never appear here. |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 422 · 429