跳转到主要内容
POST
curl
Didit 的取消银行链接 endpoint 会终止用户尚未完成的链接,使其 url 和 token 失效。 当用户中途放弃流程,或您为同一用户创建新链接时,请使用此 endpoint。 取消已完成的链接不会产生任何变化,并返回 200,链接保持不变。如需停止访问,请改用 撤销。

授权

x-api-key
string
header
必填

您的应用 API 密钥,可在 Business Console 的开发者 -> API 密钥中获取。主密钥拥有完全访问权限。命名密钥可以设置范围:可按资源设置无权限、只读或读写,可限定为部分工作流或已批准的会话,可限定为一组 IP 地址,并可设置过期日期。401 表示密钥错误、已被撤销或已过期;403 表示未发送密钥、密钥无权访问该资源或执行该操作,或请求来自其 IP 列表之外的地址;会话相关路由返回 404,表示该会话不在密钥的工作流或状态范围内。没有媒体访问权限的密钥会将图片、视频和 PDF 的 URL 返回为 null;没有会话写入权限的密钥会将会话链接和令牌返回为 null。请参阅 https://docs.didit.me/console/api-keys。

请求头

Idempotency-Key
string

您为单次操作选择的可选重试安全密钥,最长 255 个字符(可使用 UUID)。使用相同密钥、endpoint、查询参数和请求体重复发送的请求,会返回第一次的响应,状态码和响应体均相同,且不会再次运行或计费。同一密钥若用于其他 endpoint、查询参数或请求体,将返回 409 idempotency_key_reused;若第一个请求仍在处理中,则返回 409 idempotency_key_in_progress 及 Retry-After。失败的请求(任何 4xx 或 5xx)不会被存储,因此您可以使用相同密钥再次发送。无论您使用 API 密钥还是访问 token 调用,密钥都归属于您的应用。请参阅重试与幂等性。

Required string length: 1 - 255

路径参数

id
string<uuid>
必填

链接 ID。

响应

链接已被取消,状态为 cancelled;如果链接已处于最终状态,则保持不变。

为单个用户执行的一次银行链接运行:连接银行,或续期连接。请使用 get_link 自行确认链接,切勿信任浏览器发送的 ID。

id
string<uuid>
必填

链接的标识符。

mode
enum<string>
必填
可用选项:
connect,
renew
access
enum<string>
必填
可用选项:
one_time,
ongoing
status
enum<string>
必填

链接状态。completed、cancelled、expired 和 failed 为最终状态。

可用选项:
created,
opened,
connecting,
completed,
cancelled,
expired,
failed
url
string<uri> | null
必填

要引导用户前往的托管页面。仅在创建链接时返回;后续读取时为 null,因为令牌不会被存储。

client_token
string | null
必填

Didit 嵌入式银行链接的令牌,目前尚未发布:今天请打开 url。仅在创建链接时返回;之后的读取中为 null。用途单一且有效期短,不包含任何个人数据。切勿记录该令牌。

expires_at
string<date-time>
必填

未使用的链接失效的时间。

connection_id
string<uuid> | null
必填

当 status 为 completed 时,该链接所创建或续期的连接。

check_id
string<uuid> | null
必填

当请求了 ownership.compare(值不为 none)时,此链接的股权结构比对结果。

reused
boolean
必填

当用户已共享完全相同的账户,链接因而作为现有连接的续期完成时(duplicates: reuse),返回 true。不会重复收费。

error
object | null
必填

当 status 为 failed 时,链接失败的原因。否则为 null。

quote
object
必填

链接的价格,在创建时固定。收取的费用为报价的金额。读取操作从不计费。

vendor_data
string | null
必填

请求中的您方引用。

最后修改于 2026年11月22日