platform-transfers

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

Pay for a transfer and queue it for a specialist.

Tous les points de terminaison platform-transfers

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation billing.payment.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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

Paramètres

NomTypeObligatoireQu'est-ce que c'est
transferId (path)stringOui

Corps de la requête

NomTypeObligatoireQu'est-ce que c'est
currencyobjectNonThe 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.

Réponse

NomTypeObligatoireQu'est-ce que c'est
idUuidOuiUUIDv7 identifier — sortable by creation time (docs/02 §8).
source_platformstringOui
source_platform_namestringNon
target_platformstringOui
target_platform_namestringNon
source_urlstringOui
target_site_idobjectNon
tier_codestringOui
tier_namestringNon
entity_count_estimateintegerNon
statusPlatformTransferStatusOui
status_labelstringNon
price_amount_minorintegerOui
price_currencystringOui
redirects_mappedbooleanNon
redirect_countintegerNon
canonicals_verifiedbooleanNon
sitemap_submittedbooleanNon
structured_data_preservedbooleanNon
seo_checks_completebooleanNon
customer_notestringNon
sla_due_atobjectNon
created_atstringOui
completed_atobjectNon
eventsPlatformTransferEvent[]NonThe customer-visible trail only. Staff notes name vendors and what a job cost us, and never appear here.

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422 · 429