API Reference

Link External Bank Account via ACH

post
https://example.com/programs//account//externalbankaccount

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.

Path Params
string
required

The program code for the partner implementation.

string
required

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

Body Params

The M:Gd.Bos.Controllers.TransfersController.AchLinkExternalAccountRequest(System.String,System.String,Gd.Bos.DataTransfer.Request.AchLinkExternalAccountRequest,System.String) containing selected external bank accounts and provider information.

string | null

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.

selectedBankAccounts
array of objects | null

A list of external bank accounts selected by the user to be linked. Each entry contains institution and account identifiers, provider type, and customer/account references.

selectedBankAccounts
string
enum

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

Allowed:
Headers
string
required

A unique identifier (GUID) for tracking the request.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago