billing
POST /v1/payment-methods/form-failures
Report that the add-a-payment-method form failed in the browser.
Authentication
Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
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/payment-methods/form-failures \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "gateway": <string<stripe, paypal>>, "stage": <string<load, mount, confirm>> }'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
The browser half of the payment form failed — the vendor's script did not load, the form did not mount, or saving broke for a reason that is not the customer's — so nothing reached the gateway and the engine would otherwise never know. The customer is already shown a translated error with a retry; this records the failure (log + zinn_payment_form_failures_total) and, when a card-required trial funnel is open for the organization, tells it, so the operator alert names the cause instead of reporting a silent "card stuck". Requires billing.payment.manage in the target organization. Nothing is charged or stored.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | No | Organization the form was adding a method to. Defaults to the caller's own; the caller must hold billing.payment.manage there. |
gateway | string<stripe, paypal> | Yes | Which payment form failed. |
stage | string<load, mount, confirm> | Yes | load — the vendor's script did not load (blocked, offline, CSP); mount — the script loaded but the form did not render; confirm — saving broke for a reason that is not the… |
reason | string | No | The SDK's own message, trimmed. Optional. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
recorded | boolean | Yes | Always true — the failure was logged and counted. |
funnel_signalled | boolean | Yes | Whether a card-required trial funnel was open for this organization and was told (it then reports the failure as card_form with this reason). |
Errors this endpoint can return
401 · 403 · 422 · 429