GRgreendot
DirectDeposit

Add Direct Deposit Switch Attempt

Creates a new direct deposit switch attempt for the specified account, initiating the process to switch direct deposit to a new account. The response includes vendor and switch details.

post/programs/{programCode}/accounts/{accountIdentifier}/directdeposit/switches

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.

Headers

X-GD-RequestIdstring required

A unique request identifier for tracking and logging.

Response

OK

vendorTokenstring nullable

The token provided by the vendor for tracking or authorizing the direct deposit switch attempt.

switchIdstring nullable

The unique identifier for the direct deposit switch attempt.

vendorNamestring nullable

The name of the vendor handling the direct deposit switch process.

Changes

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