platform-transfers
POST /v1/platform-transfers/{transferId}/pay
Pay for a transfer and queue it for a specialist.
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
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
transferId (path) | string | Oui | — |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
currency | object | Non | 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. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
source_platform | string | Oui | — |
source_platform_name | string | Non | — |
target_platform | string | Oui | — |
target_platform_name | string | Non | — |
source_url | string | Oui | — |
target_site_id | object | Non | — |
tier_code | string | Oui | — |
tier_name | string | Non | — |
entity_count_estimate | integer | Non | — |
status | PlatformTransferStatus | Oui | — |
status_label | string | Non | — |
price_amount_minor | integer | Oui | — |
price_currency | string | Oui | — |
redirects_mapped | boolean | Non | — |
redirect_count | integer | Non | — |
canonicals_verified | boolean | Non | — |
sitemap_submitted | boolean | Non | — |
structured_data_preserved | boolean | Non | — |
seo_checks_complete | boolean | Non | — |
customer_note | string | Non | — |
sla_due_at | object | Non | — |
created_at | string | Oui | — |
completed_at | object | Non | — |
events | PlatformTransferEvent[] | Non | The 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