v1

latestOpenAPI 3.0.32026-07-2621102.1 MB

External Account Links

Load External Account Links

Use the Load External Account Links endpoint to initiate a link between external account(s) and the caller account when a user inputs their external account credentials during a secure session in your application. The external account will be usable for transfers over FedWire or credit rails, depending on your configuration.

post/loadExternalAccountLinks

Headers

x-gft-idempotency-keystring uuid4 required

Authorizationstring required

Example:Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5

Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)

Request body

accountNostring required

The <glossary:PRN> to which the new external account will be linked. Pattern: PRN Example: "074103447228"

Response

Successful Response

externalAccountLinkIdstring required

Unique identifier that identifies the external account link in the system.

statusstring

Status of the external account link.