# 收款方删除

> 删除不再使用的收款人。

```yaml
openapi: 3.1.0
info:
  title: 收款方删除
  version: 1.0.0
  description: 删除不再使用的收款人。
paths:
  /api/v1/beneficiary/remove:
    post:
      summary: 收款方删除
      description: 删除不再使用的收款人。
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                merchantNo:
                  type: string
                  description: Onerway 分配的商户号。通常在沙盒或生产商户开通后，从商户后台或开户材料中获取。
                beneficiaryId:
                  type: string
                  description: 需要删除的收款人 ID。
                sign:
                  type: string
                  description: 请求签名字符串，需使用商户私钥按 Transfer 请求签名规则生成。
              required:
                - merchantNo
                - beneficiaryId
                - sign
            examples:
              delete-beneficiary:
                summary: 收款方删除请求示例
                value:
                  beneficiaryId: 1899696430844878800
                  merchantNo: "800181"
                  sign: 12312sdfadsf
      responses:
        "200":
          description: 收款方删除响应示例
          content:
            application/json:
              schema:
                type: object
                properties:
                  respCode:
                    type: string
                    description: Onerway 返回的响应码。
                  respMsg:
                    type:
                      - string
                      - "null"
                    description: Onerway 返回的响应信息。
                    x-onerway-value:
                      nullable: true
                      when:
                        en: No response message is returned.
                        zh: 未返回响应信息时为 `null`。
                  data:
                    type: object
                    properties:
                      beneficiaryId:
                        type: string
                        description: 已删除的收款人 ID。
                      status:
                        type: string
                        description: 该收款人记录的删除状态。
                    description: 删除收款人的结果。
              examples:
                beneficiary-deleted:
                  summary: 收款方删除响应示例
                  value:
                    respCode: "20000"
                    respMsg: Success
                    data:
                      beneficiaryId: 1899696430844878800
                      status: DELETED
```