跳转到主要内容
POST
curl
Didit 的撤销银行连接端点会停止访问该银行,撤销请求发出后,银行数据拉取会立即停止。 撤销不会删除任何内容。如需删除,请使用删除。 同意记录的状态先显示为 revocation_pending,银行确认后变为 revoked。

授权

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。

响应

包含撤销状态的连接。

该用户授权您的应用读取一家银行数据的许可。续期会保留连接 id 和所有账户 id。已删除的连接只返回 id、status、status_reason、created_at 和 erasure,其他字段均不存在,且其中不再保留任何银行、用户或账户数据。

id
string<uuid>
必填

连接的标识符。

status
enum<string>
必填

pending:首次同步正在进行。active:同意有效。renewal_required:同意已结束,或银行要求用户重新登录;可读取到上次同步的数据,且不计费。paused:当月余额不足。revoked:用户、银行或您已停止访问。deleted:仅保留 id、status、status_reason、created_at 和 erasure。failed:首次同步从未成功。

可用选项:
pending,
active,
renewal_required,
paused,
revoked,
deleted,
failed
status_reason
enum<string> | null
必填

连接处于该状态的原因。paused_by_customer 为保留值。若连接为 deleted:deleted_by_customer、consent_lapsed、retention_elapsed 或 application_deleted。

可用选项:
collection_complete,
consent_expired,
consent_lapsed,
bank_requires_sign_in,
revoked_by_end_user,
revoked_by_bank,
revoked_by_customer,
insufficient_balance,
paused_by_customer,
first_sync_failed,
deleted_by_customer,
retention_elapsed,
application_deleted,
null
erasure
object | null
必填

在 delete_connection 之后设置;否则为 null。

created_at
string<date-time>
必填
environment
enum<string>
可用选项:
live,
sandbox
access
enum<string>
可用选项:
one_time,
ongoing
institution
object

连接或链接所对应的银行。

segment
enum<string> | null
可用选项:
personal,
business,
null
data
enum<string>[]

用户接受的权限范围。

可用选项:
accounts,
balances,
transactions

该用户对此连接的同意。

sync
object

连接的同步状态。

accounts
object[]

连接中每个账户的摘要。使用 get_account 读取完整账户信息。

ownership
object

可选的账户持有人与个人或企业的比对结果。

end_user
object
manage_url
string<uri> | null

该用户自己的访问页面。在访问页面可用之前为 null。

billing
object

此连接的费用。沙盒环境从不计费。

possible_duplicate_of
string<uuid> | null

当此连接可能与另一个有效连接重复,但没有任何 end_user.reference 能确认匹配时设置。

vendor_data
string | null
updated_at
string<date-time>
最后修改于 2026年11月22日