agency-invoicing
POST /v1/agency-invoicing/portal/{token}/checkout
Start a payment on the AGENCY's own gateway. Unauthenticated.
Autenticación
Este endpoint es público. No requiere credenciales ni organización; es lo que leen nuestro propio sitio de marketing y los motores de respuesta de IA.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X POST https://api.zinndigital.com/v1/agency-invoicing/portal/{token}/checkout \
-H "Content-Type: application/json" \
-d '{ }'¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
⛔⛔ 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.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
token (path) | string | Sí | — |
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
provider | string | No | Which of the agency's connected gateways to use. Their default when omitted. |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
status | string | Sí | `captured` when the rail settled synchronously, `pending` for a crypto invoice or an unconfirmed intent, `requires_action` for 3-D Secure. |
provider_code | string | No | — |
client_token | string | No | A short-lived client-side credential for the gateway's browser SDK. ⛔ Never persisted anywhere. |
redirect_url | string | No | Where to send the payer for rails that use an approval or hosted page. |
action_kind | string<authenticate, approve, pay, add_payment_method> | No | — |
amount_minor | integer | Sí | — |
currency | string | Sí | — |
Errores que este endpoint puede devolver
404 · 409 · 429 · 503