commerce

POST /v1/orders/{orderId}/payment-step-abandoned

Tell staff the customer left an in-place payment step without paying.

All commerce endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The endpoint checks billing.payment.manage; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Q225. Called when a customer closes the on-session payment step of a one-click purchase (PaymentStep) without paying. It moves no money and changes no status — the order stays payable from Billing and nothing was declined — and raises the staff alert "Checkout abandoned at payment" once per order, never for one of our own internal or test organisations. Always 204: an order that is paid, not a one-click purchase, or already reported is simply nothing to tell anyone.

Parameters

NameTypeRequiredWhat it is
orderId (path)UuidYesThe order's id.

Errors this endpoint can return

401 · 403 · 404 · 429