commerce

GET /v1/orders/{orderId}/payment-options

The payment gateways this order may be settled on.

Todos os endpoints de commerce

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

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 GET https://api.zinndigital.com/v1/orders/{orderId}/payment-options \
  -H "Authorization: Bearer zdk_live_…"

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

What the pay screen offers the customer, so an overdue bill can be settled through whichever enabled gateway they pick rather than only the one the subscription was created with. The answer is **per order, not per platform**. A reseller's client always receives exactly one entry — their reseller's connected gateway — whatever the platform has enabled, because that is the only merchant account their money may land in. `payOrder` refuses any `gateway` that is not in this list. Answers for a settled order too, with the same list: the question "what could pay this?" is meaningful for a receipt, and refusing would make the screen depend on a race with the webhook that settled it.

Parâmetros

NomeTipoObrigatórioO que é
orderId (path)UuidSimThe order's id.

Resposta

NomeTipoObrigatórioO que é
gatewaysstring[]SimProvider codes (`stripe`, `paypal`, `nowpayments`). Never empty — `stripe` is always present, because an unreadable provider registry must not be reported as "nothing is enabled".

Erros que este endpoint pode retornar

401 · 403 · 404 · 429