platform-transfers
POST /v1/platform-transfers/{transferId}/pay
Pay for a transfer and queue it for a specialist.
Authentication
Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/platform-transfers/{transferId}/pay \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
transferId (path) | string | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
currency | object | No | 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. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
source_platform | string | Yes | — |
source_platform_name | string | No | — |
target_platform | string | Yes | — |
target_platform_name | string | No | — |
source_url | string | Yes | — |
target_site_id | object | No | — |
tier_code | string | Yes | — |
tier_name | string | No | — |
entity_count_estimate | integer | No | — |
status | PlatformTransferStatus | Yes | — |
status_label | string | No | — |
price_amount_minor | integer | Yes | — |
price_currency | string | Yes | — |
redirects_mapped | boolean | No | — |
redirect_count | integer | No | — |
canonicals_verified | boolean | No | — |
sitemap_submitted | boolean | No | — |
structured_data_preserved | boolean | No | — |
seo_checks_complete | boolean | No | — |
customer_note | string | No | — |
sla_due_at | object | No | — |
created_at | string | Yes | — |
completed_at | object | No | — |
events | PlatformTransferEvent[] | No | The customer-visible trail only. Staff notes name vendors and what a job cost us, and never appear here. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429