IBAN删除接口(软删除)
说明:软删除 IBAN 记录(不物理删除,更新 deleted_at = 当前时间戳)。同步会把 iban_generated 里关联 is_used=1 的号码池记录也软删。
生产环境 API URL:#/api/iban/delete
测试环境 API URL:https://ibantest.yabandpay.com/api/iban/delete
Method:POST
Header:
Authorization: Bearer {api_account_token}
Content-Type: application/json
1. 请求参数(顶层)
| 字段 | 类型 | 描述 | 是否必填 |
|---|---|---|---|
| uid | string | API 账户 UID | 必填 |
| timestamp | integer | 请求时间戳 | 必填 |
| nonce | string | 随机字符串 | 必填 |
| sign | string | 签名 | 必填 |
| data | object | 删除条件集 | 必填 |
2. data 对象(支持写在顶层或 data 内)
| Parameter | Type | Description | 是否必填 |
|---|---|---|---|
| request_id | string | 请求号,响应原样回传 | 非必填 |
| id | integer | IBAN 记录 ID | 必填 |
权限隔离:只能删除
api_account_id = 当前账户ID的记录,否则返回-3001 IBAN record not found(不暴露该记录是否存在,避免枚举攻击)。
3. 提交示例
{
"uid": "900001",
"timestamp": 1750000000,
"nonce": "Qe3CkH2xP8",
"sign": "A1AC665F9B40F7C51212BCE080F5B987",
"data": {
"request_id": "req_20260820_del_001",
"id": 1,
}
}
4. 返回示例
成功
{
"status": true,
"code": 200,
"message": "",
"data": {
"id": 1,
"deleted_at": 1750000005,
"request_id": "req_20260820_del_001"
}
}
失败:记录不存在 / 不属于当前账户 / 已删过
{
"status": false,
"code": -3001,
"message": "IBAN record not found or delete failed",
"data": {}
}
失败:缺少 id 或 id <= 0
{
"status": false,
"code": -3002,
"message": "The given data was invalid.",
"data": {}
}