Setup a Bank Link
The GS Advisor Solutions bank link and cash transaction APIs allow users to set up a bank link and move funds in and out of a brokerage account.
This page provides instructions on how to add a bank link to a GSAS brokerage account.
Bank Link Setup
The following steps describe the workflow for setting up a bank link for ACH and Wire bank account.
Step 1 - Create Bank Link
This endpoint will create a bank link for a given account number.
Endpoint: POST /restapi/v2/users/{loginId}/external-accounts
All bank links go through auto-verification to validate bank and owner verification.
The bankLinkId
returned in the response’s location header can be used to retrieve additional information about the bank link such as bank link and verification status.
An email alert is automatically sent to the client when a bank link is created.
Bank links are restricted upon initial creation and cannot be used until the Items for Attention (IFAs) are addressed.
Note
Once a bank links is created, it cannot be modified. You will need to cancel and create a new bank link.
Step 2 - Owner Verify the Bank Link
This request collects the e-signature to complete the owner verification of the bank link
Endpoint: PUT /api/v2/ifas/bank-link-owner-verifications/{accountNumber}/{bankLinkId}
Upon creation, the banklink will be restricted pending an owner verification Item for Attention (IFA), which will be resolved once we receive the signature of the account owner.
Step 3 - Create a Cash Transaction
This request posts an ACH or Wire transaction to the specified account number.
Endpoint: POST /api/v2/accounts/{accountNumber}/cash-transactions
Please see ACH Transactions Workflow for a detailed guide on creating ACH transactions.
Was this page useful?
Give feedback to help us improve developer.gs.com and serve you better.