platform-transfers
POST /v1/platform-transfers/{transferId}/pay
Pay for a transfer and queue it for a specialist.
認証
ベアラー トークンとして API キーを送信します。キーには billing.payment.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織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