commerce
POST /v1/orders/{orderId}/customer-action
Reopen the checkout for a payment that is waiting on the customer.
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 POST https://api.zinndigital.com/v1/orders/{orderId}/customer-action \
-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
Returns where the customer finishes paying an order that is already part-way through a payment — the NOWPayments hosted crypto invoice, a PayPal approval page, or a fresh Stripe SCA credential. This is what makes a crypto order payable: the gateway supplies that link once, at the instant the invoice is opened, and until this endpoint existed nothing gave it to the customer. **It never charges.** `POST /v1/orders/{orderId}/pay` is the guarded surface that opens a payment; this one only reopens the checkout for a payment already in progress, so it sits behind none of the card-testing defences and needs none. Call `/pay` first; come back here to send the customer to the checkout, and again whenever they return to it later. **A crypto action always returns the SAME invoice.** The confirming IPN is matched on the invoice id recorded against the payment, so a second invoice for one order would take the customer's money against a record that does not exist. NOWPayments has no read-invoice endpoint either, so the link captured when the invoice was opened is the only one there is.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
orderId (path) | Uuid | Sim | The order's id. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
kind | string<pay, approve, authenticate> | Sim | What the customer is being asked to do. `pay` — open a crypto invoice and send payment; `approve` — approve the payment in their PayPal account; `authenticate` — confirm the pay… |
url | string | Não | The hosted page to send the customer to, or `""` when this action is a credential instead. For crypto this is the NOWPayments invoice and it is **stable for the life of the orde… |
token | string | Não | A short-lived client-side credential for the gateway's browser SDK (Stripe's client secret), or `""`. Never stored by the platform — it is re-read from the gateway each time thi… |
provider | string | Sim | The payments driver that owns this action (`nowpayments`, `paypal`, `stripe`). |
Erros que este endpoint pode retornar
401 · 403 · 404 · 422 · 429