platform-transfers
POST /v1/platform-transfers/{transferId}/pay
Pay for a transfer and queue it for a specialist.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.payment.manage 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/platform-transfers/{transferId}/pay \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 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 and the remedy is to add 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