GRgreendot
Transfers

Link External Bank Account via ACH

Links one or more external bank accounts to a specified account using ACH. Requires selected bank account tokens and provider information. Returns reference IDs for linked accounts.

post/programs/{programCode}/account/{accountIdentifier}/externalbankaccount

Request

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

Path parameters

programCodestring required

The program code for the partner implementation.

accountIdentifierstring required

The unique identifier for the account to link the external bank account to.

Headers

X-GD-RequestIdstring required

A unique identifier (GUID) for tracking the request.

Request body

publicTokenstring nullable

The public token received from the external account provider (e.g., Plaid) after user authentication. Used to securely exchange for access tokens and retrieve account details.

externalAccountProvider'None' | 'Plaid' | 'PlaidLinkToken'

The type of external account provider (e.g., Plaid, Finicity) used for token exchange and account linking.

Response

OK

externalAccountProfileReferenceIdstring nullable

The unique reference identifier for the external account profile created as a result of the link operation. Used to reference the external account profile in subsequent operations.

externalBankAccountReferenceIdsstring[] nullable

A list of unique reference identifiers for the external bank accounts that were linked. Each identifier corresponds to a successfully linked external bank account.

Changes

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