agency-invoicing
POST /v1/agency-invoicing/portal/{token}/checkout
Start a payment on the AGENCY's own gateway. Unauthenticated.
Authentifizierung
Dieser Endpunkt ist öffentlich. Er erfordert weder Anmeldedaten noch eine Organisation – er wird auch von unserer eigenen Marketing-Website und den KI-Antwort-Engines gelesen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X POST https://api.zinndigital.com/v1/agency-invoicing/portal/{token}/checkout \
-H "Content-Type: application/json" \
-d '{ }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
⛔⛔ The money settles into the **agency's** merchant account and never touches Zinn®'s balance. An agency with no connected gateway gets a `409` — there is no fallback, because there is no relationship under which we could take money for a document our name is nowhere near. Returns a `client_token` for a browser SDK, a `redirect_url` for an approval or hosted-invoice rail, or a completed capture.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
token (path) | string | Ja | — |
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
provider | string | Nein | Which of the agency's connected gateways to use. Their default when omitted. |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
status | string | Ja | `captured` when the rail settled synchronously, `pending` for a crypto invoice or an unconfirmed intent, `requires_action` for 3-D Secure. |
provider_code | string | Nein | — |
client_token | string | Nein | A short-lived client-side credential for the gateway's browser SDK. ⛔ Never persisted anywhere. |
redirect_url | string | Nein | Where to send the payer for rails that use an approval or hosted page. |
action_kind | string<authenticate, approve, pay, add_payment_method> | Nein | — |
amount_minor | integer | Ja | — |
currency | string | Ja | — |
Fehler, die dieser Endpunkt zurückgeben kann
404 · 409 · 429 · 503