---
title: "Delete Payee"
method: DELETE
path: "/programs/{programCode}/accounts/{accountIdentifier}/billpayPayees/{payeeIdentifier}"
tags: ["BillPay"]
---

# Delete Payee

`DELETE /programs/{programCode}/accounts/{accountIdentifier}/billpayPayees/{payeeIdentifier}`

Deletes an existing payee from a user’s account using the payeeIdentifier. Once the payee is deleted, all associated scheduled bill payments will be canceled as well.

## Path parameters

- `programCode` string, required
- `accountIdentifier` string, required
- `payeeIdentifier` string, required

## Headers

- `X-GD-RequestId` string, required

## Response `200`

OK

- DeletePayeeResponse — Delete Payee Response – Contains the result of a payee deletion operation. Used to confirm the outcome of deleting a payee from an account, including the resulting payee status. Inherits standard response header and response details from Gd.Bos.DataTransfer.Response.ResponseBase.
  - `payeeStatus` string, nullable — The status of the payee after deletion. Typical values are "inactive" or "deleted" to indicate the payee is no longer available for bill payments.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)