> ## Documentation Index
> Fetch the complete documentation index at: https://docs.velafi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 删除收款人

> 通过用户支付 ID 永久删除已注册的收款人。已删除的收款人不能用于后续的出金或全球支付订单。

当某个收款人不再需要或其底层账户信息发生变更时，可将其删除。您可以通过创建收款人时返回的 `userPaymentId`（或从 `GET /v2/payments` 获取）来标识该记录。已删除的记录无法恢复——如需再次使用同一账户，请将其作为新的收款人添加。

## 端点

```text theme={null}
DELETE https://api.velafi.com/v2/payments/{userPaymentId}
```

> [!NOTE]
>
> 沙盒环境测试请使用 `https://api-test.velafi.com/v2/payments/{userPaymentId}`。

## 路径参数

**userPaymentId** `integer` *required*

要删除的收款人的唯一数字 ID。可从 `GET /v2/payments` 响应中的 `id` 字段获取。

## 响应字段

**code** `integer`

响应状态码。`200` 表示成功。

**msg** `string`

人类可读的响应消息。

**data** `boolean`

如果收款人已成功删除，则为 `true`。

## 示例

```bash theme={null}
curl -X DELETE "https://api.velafi.com/v2/payments/228" \
  -H "X-BH-TOKEN: YOUR_TOKEN"
```

```json theme={null}
{
  "code": 200,
  "msg": "SUCCESS",
  "data": true
}
```

> [!WARNING]
>
> 删除前，请确认该 `userPaymentId` 当前未被任何进行中或待处理的订单引用。删除正在使用的收款人可能会导致订单处理出现问题。


## Related topics

- [管理收款人](https://docs.velafi.com/cn/docs/guides/managing-beneficiaries.md)
- [添加收款人](https://docs.velafi.com/cn/api-reference/beneficiary/add-beneficiary.md)
- [删除 Webhook](https://docs.velafi.com/cn/api-reference/webhooks/delete-a-webhook.md)
- [获取收款人列表](https://docs.velafi.com/cn/api-reference/beneficiary/get-beneficiary.md)
- [删除白名单地址](https://docs.velafi.com/cn/api-reference/crypto-wallet/delete-whitelist-address.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.