GRgreendot
Transfers

Create New ACH Transfer

Creates a new ACH Out or ACH Pull transfer to move funds between a Green Dot account and an external bank account. Supports daily limits for ACH Out transfers. On success, returns details of the created ACH transfer. Refer to the API documentation for event types and webhook behavior.

post/programs/{programCode}/transfers/ach

Request

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

Path parameters

programCodestring required

The program code associated with the partner implementation. This identifies the specific partner or program for which the transfer is being created.

Headers

X-GD-RequestIdstring required

A unique identifier (GUID) for tracking the request across multiple components. Must be provided for each new request.

Request body

transferIdentifierstring nullable

Required: A unique identifier for the transfer. This value is generated by the client and used for idempotency and tracking.

transferTypestring nullable

Required: The type of ACH transfer to perform. Valid values: "achOut" (move funds to an external bank account), "achPull" (pull funds from an external bank account).

currencystring nullable

Required: The ISO 4217 currency code for the transfer (e.g., "USD") in string.

deviceType'Unknown' | 'Web' | 'IOS' | 'Android'

Required: The device type from which the transfer is initiated. Valid values: Unknown, Web, IOS, Android.

verificationIdentifierstring nullable

Optional: The identifier for the bank account verification process. Required for ACH Pull transfers when bank account verification is needed.

userIdentifierstring nullable

Optional: The unique identifier of the user initiating the transfer. Required for both ACH Out and ACH Pull transfers.

transferDescriptionstring nullable

An optional description for the transfer, such as the purpose or reference for the transaction.

Response

OK

Changes

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