agency-invoicing

POST /v1/agency-invoicing/portal/{token}/checkout

Start a payment on the AGENCY's own gateway. Unauthenticated.

所有 agency-invoicing 端点

身份验证

此端点是公开的。它不需要任何凭据或组织——这是我们自己的营销网站和 AI 问答引擎所读取的内容。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

curl -X POST https://api.zinndigital.com/v1/agency-invoicing/portal/{token}/checkout \
  -H "Content-Type: application/json" \
  -d '{  }'

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

⛔⛔ 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.

参数

名称类型必填内容简介
token (path)string

请求正文

名称类型必填内容简介
providerstringWhich of the agency's connected gateways to use. Their default when omitted.

响应

名称类型必填内容简介
statusstring`captured` when the rail settled synchronously, `pending` for a crypto invoice or an unconfirmed intent, `requires_action` for 3-D Secure.
provider_codestring
client_tokenstringA short-lived client-side credential for the gateway's browser SDK. ⛔ Never persisted anywhere.
redirect_urlstringWhere to send the payer for rails that use an approval or hosted page.
action_kindstring<authenticate, approve, pay, add_payment_method>
amount_minorinteger
currencystring

此端点可能返回的错误

404 · 409 · 429 · 503