Create New ACH Transfer

post

https://example.com/programs/{programCode}/transfers/ach

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.

Path Params

programCode

string

required

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

Body Params

The Gd.Bos.DataTransfer.Request.CreateACHRequest object containing details for the ACH transfer, including source and destination account information, amount, and transfer type.

transferIdentifier

string | null

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

transferType

string | null

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).

currency

string | null

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

deviceType

string

enum

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

Allowed:

verificationIdentifier

string | null

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

userIdentifier

string | null

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

transferRoute

object

Represents the routing details and required data for initiating a transfer operation. Contains transaction amount, delivery type, source and target endpoints, recurring and verification details, and ACH-specific flags. Used to define and process the flow of funds between accounts or external endpoints, supporting ACH, purse-to-purse, and partner-to-account transfers.

transferDescription

string | null

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

Headers

X-GD-RequestId

string

required

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

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

200OK

403Forbidden

500Internal Server Error

503Service Unavailable