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

# Update Payee

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

Update existing payee information. This endpoint allows an existing payee’s information to be updated using the payeeIdentifier. The payee can be a merchant or a person. You must provide the payeeIdentifier, accountIdentifier, and the updated payee details in the request body. The response contains the result of the update operation.

## Path parameters

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

## Headers

- `X-GD-RequestId` string, required

## Request body

- UpdatePayeeRequest — Update Payee Request – Represents the data required to update an existing bill payee for an account. Used to update payee details such as name, type, address, and contact information for a merchant or person payee.
  - `payeeIdentifier` string, nullable — The unique identifier of the payee to update. Must be a valid GUID.
  - `payeeType` string, nullable — The type of payee. Expected values: "Merchant" or "Person".
  - `name` string, nullable — The name of the payee (merchant or person).
  - `nickName` string, nullable — An optional nickname for the payee.
  - `address1` string, nullable — The first line of the payee's address.
  - `address2` string, nullable — The second line of the payee's address (optional).
  - `city` string, nullable — The city of the payee's address.
  - `state` string, nullable — The state or province of the payee's address.
  - `zip` string, nullable — The ZIP or postal code of the payee's address.
  - `country` string, nullable — The country of the payee's address (e.g., "US").
  - `accountNumber` string, nullable — The account number associated with the payee, if applicable.
  - `phoneNumber` string, nullable — The payee's phone number.
  - `email` string, nullable — The payee's email address.

## Response `200`

OK

- UpdatePayeeResponse — Update Payee Response – Contains the result of a payee update operation. Used to confirm the outcome of updating an existing payee, including response metadata and any status or error details. Inherits standard response header and response details from Gd.Bos.DataTransfer.Response.ResponseBase.
  - `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)