platform-transfers

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

Pay for a transfer and queue it for a specialist.

Todos os endpoints de platform-transfers

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão billing.payment.manage; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

NomeTipoObrigatórioO que é
transferId (path)stringSim

Corpo da requisição

NomeTipoObrigatórioO que é
currencyobjectNãoThe 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.

Resposta

NomeTipoObrigatórioO que é
idUuidSimUUIDv7 identifier — sortable by creation time (docs/02 §8).
source_platformstringSim
source_platform_namestringNão
target_platformstringSim
target_platform_namestringNão
source_urlstringSim
target_site_idobjectNão
tier_codestringSim
tier_namestringNão
entity_count_estimateintegerNão
statusPlatformTransferStatusSim
status_labelstringNão
price_amount_minorintegerSim
price_currencystringSim
redirects_mappedbooleanNão
redirect_countintegerNão
canonicals_verifiedbooleanNão
sitemap_submittedbooleanNão
structured_data_preservedbooleanNão
seo_checks_completebooleanNão
customer_notestringNão
sla_due_atobjectNão
created_atstringSim
completed_atobjectNão
eventsPlatformTransferEvent[]NãoThe customer-visible trail only. Staff notes name vendors and what a job cost us, and never appear here.

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429