---
title: "Update Scheduled Bill Payment"
method: PUT
path: "/programs/{programCode}/accounts/{accountIdentifier}/billpayPayments/{paymentIdentifier}"
tags: ["BillPay"]
---

# Update Scheduled Bill Payment

`PUT /programs/{programCode}/accounts/{accountIdentifier}/billpayPayments/{paymentIdentifier}`

Update Scheduled Bill Payment. This endpoint allows the scheduled bill payment to be updated, using the paymentIdentifier.
        <br/>• A one-time Bill Pay schedule cannot be changed to a recurring schedule by changing the frequencyType, because one time and recurring bill pay are under different model schema.
        <br/>• To change Bill Pay schedules, the customer must delete the one-time bill Pay schedule and create a new recurring bill Pay schedule.
        <br/>• The frequencyType for recurring bill Pay schedules cannot be changed to oneTime or the frequencyType that was previously set for the bill Pay schedule.
        <br/>• The frequencyType of 'oneTime' cannot be updated to another frequencyType. Recurring frequencyType can be updated to another recurring frequencyType (i.e. weekly or every2weeks, etc.), except oneTime.

## Path parameters

- `programCode` string, required
- `accountIdentifier` string, required
- `paymentIdentifier` string, required

## Headers

- `X-GD-RequestId` string, required

## Request body

- UpdatePaymentRequest — Update Payment Request – Represents the data required to update the details of a scheduled bill payment. Used to update payment attributes such as amount, schedule, memo, and frequency for a specific payment and account.
  - `accountIdentifier` string, nullable — The unique identifier of the account associated with the payment. Must be a valid GUID.
  - `paymentIdentifier` string, nullable — The unique identifier of the payment to update. Must be a valid GUID.
  - `amount` number, double — The new amount to be paid to the payee.
  - `paymentDate` string, nullable — The new date the payment is to be sent (format: yyyy-MM-dd).
  - `paymentEndDate` string, nullable — The new end date for recurring payments (format: yyyy-MM-dd). Null for one-time payments.
  - `frequencyType` string, nullable — The new frequency type for the payment (e.g., "oneTime", "weekly", "monthly").
  - `paymentMemo` string, nullable — An optional memo to include with the payment.
  - `note` string, nullable — An optional note for the payment.

## Response `200`

OK

- UpdatePaymentResponse — Update Payment Response – Contains the result of a payment update operation. Used to confirm the outcome of updating a scheduled bill payment, 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)