GRgreendot
DirectDeposit

Update Direct Deposit Switch Attempt

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.

patch/programs/{programCode}/accounts/{accountIdentifier}/directdeposit/switches/{switchId}

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

The program code for the direct deposit context.

accountIdentifierstring required

The unique identifier for the account. Required.

switchIdstring required

The unique identifier for the switch attempt to update.

Headers

X-GD-RequestIdstring required

A unique request identifier for tracking and logging.

Request body

patchObjobject nullable

The dynamic object containing the fields and values to patch on the direct deposit switch attempt.

Response

OK

referenceNumberstring nullable

The unique reference number for the direct deposit switch attempt.

idstring nullable

The unique identifier for the switch attempt.

vendorstring nullable

The name of the vendor handling the direct deposit switch.

vendorReferencestring nullable

The reference identifier provided by the vendor for this switch attempt.

amountstring nullable

The amount associated with the direct deposit switch attempt.

amountTypestring nullable

The type of amount for the switch attempt.

statusstring nullable

The current status of the direct deposit switch attempt.

statusReasonstring nullable

The reason for the current status, if applicable.

lastEventDateUtcstring date-time

The UTC date and time of the last event related to this switch attempt.

depositorstring nullable

The name of the depositor associated with the switch attempt.

Changes

No recorded changes to this operation across all 2 revisions of this API.