platform-transfers
POST /v1/platform-transfers/{transferId}/pay
Pay for a transfer and queue it for a specialist.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение 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 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