platform-transfers
POST /v1/platform-transfers/{transferId}/pay
Pay for a transfer and queue it for a specialist.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso billing.payment.manage; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X POST https://api.zinndigital.com/v1/platform-transfers/{transferId}/pay \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
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).
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
transferId (path) | string | Sí | — |
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
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. |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | Uuid | Sí | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
source_platform | string | Sí | — |
source_platform_name | string | No | — |
target_platform | string | Sí | — |
target_platform_name | string | No | — |
source_url | string | Sí | — |
target_site_id | object | No | — |
tier_code | string | Sí | — |
tier_name | string | No | — |
entity_count_estimate | integer | No | — |
status | PlatformTransferStatus | Sí | — |
status_label | string | No | — |
price_amount_minor | integer | Sí | — |
price_currency | string | Sí | — |
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 | Sí | — |
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. |
Errores que este endpoint puede devolver
401 · 403 · 404 · 422 · 429