commerce

POST /v1/orders/{orderId}/customer-action

Reopen the checkout for a payment that is waiting on the customer.

すべての commerce エンドポイント

認証

ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/customer-action \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

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.

パラメータ

名前タイプ必須これがその内容です
orderId (path)UuidはいThe order's id.

返信

名前タイプ必須これがその内容です
kindstring<pay, approve, authenticate>はい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…
urlstringいいえ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…
tokenstringいいえ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…
providerstringはいThe payments driver that owns this action (`nowpayments`, `paypal`, `stripe`).

このエンドポイントが返すエラー

401 · 403 · 404 · 422 · 429