platform-transfers

POST /v1/platform-transfers/{transferId}/pay

Pay for a transfer and queue it for a specialist.

Tutti gli endpoint platform-transfers

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione billing.payment.manage; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

curl -X POST https://api.zinndigital.com/v1/platform-transfers/{transferId}/pay \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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).

Parametri

NomeTipoObbligatorioChe cos'è
transferId (path)string

Corpo della richiesta

NomeTipoObbligatorioChe cos'è
currencyobjectNoThe 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.

Risposta

NomeTipoObbligatorioChe cos'è
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
source_platformstring
source_platform_namestringNo
target_platformstring
target_platform_namestringNo
source_urlstring
target_site_idobjectNo
tier_codestring
tier_namestringNo
entity_count_estimateintegerNo
statusPlatformTransferStatus
status_labelstringNo
price_amount_minorinteger
price_currencystring
redirects_mappedbooleanNo
redirect_countintegerNo
canonicals_verifiedbooleanNo
sitemap_submittedbooleanNo
structured_data_preservedbooleanNo
seo_checks_completebooleanNo
customer_notestringNo
sla_due_atobjectNo
created_atstring
completed_atobjectNo
eventsPlatformTransferEvent[]NoThe customer-visible trail only. Staff notes name vendors and what a job cost us, and never appear here.

Errori che questo endpoint può restituire

401 · 403 · 404 · 422 · 429