---
title: "Update Direct Deposit Switch Attempt"
method: PATCH
path: "/programs/{programCode}/accounts/{accountIdentifier}/directdeposit/switches/{switchId}"
tags: ["DirectDeposit"]
---

# Update Direct Deposit Switch Attempt

`PATCH /programs/{programCode}/accounts/{accountIdentifier}/directdeposit/switches/{switchId}`

Updates an existing direct deposit switch attempt for the specified account and switch ID. The request payload must include the patch object with the fields to update.

## Path parameters

- `programCode` string, required
- `accountIdentifier` string, required
- `switchId` string, required

## Headers

- `X-GD-RequestId` string, required

## Request body

- UpdateDirectDepositSwitchAttemptRequest — Represents a request to update a direct deposit switch attempt. Contains a dynamic patch object specifying the fields to update. Inherits standard request metadata from Gd.Bos.DataTransfer.Request.RequestBase.
  - `patchObj` object, nullable — The dynamic object containing the fields and values to patch on the direct deposit switch attempt.

## Response `200`

OK

- UpdateDirectDepositSwitchAttemptResponse — Represents the response returned after updating a direct deposit switch attempt. Contains reference numbers, vendor details, status, and event information. Inherits standard response metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
  - `referenceNumber` string, nullable — The unique reference number for the direct deposit switch attempt.
  - `id` string, nullable — The unique identifier for the switch attempt.
  - `vendor` string, nullable — The name of the vendor handling the direct deposit switch.
  - `vendorReference` string, nullable — The reference identifier provided by the vendor for this switch attempt.
  - `amount` string, nullable — The amount associated with the direct deposit switch attempt.
  - `amountType` string, nullable — The type of amount for the switch attempt.
  - `status` string, nullable — The current status of the direct deposit switch attempt.
  - `statusReason` string, nullable — The reason for the current status, if applicable.
  - `lastEventDateUtc` string, date-time — The UTC date and time of the last event related to this switch attempt.
  - `depositor` string, nullable — The name of the depositor associated with the switch attempt.
  - `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)