v1

latestOpenAPI 3.0.32026-07-2621102.1 MB

External Account Links

Create External Account Link

👍 Availability

Some of the field descriptions for this endpoint reference FedNow or Fedwire, which are future capabilities not yet available for clients. Right now, this endpoint supports only Mastercard Data Connect: Account Linking and Mastercard Data Connect: Balance Check.

Use the Create External Account Link endpoint to create a link from an account at an external bank to the caller account when a user manually inputs their external account information. This account will be usable for transfers over FedWire or credit rails, depending on your configuration.

post/createExternalAccountLink

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> of the account. Pattern: PRN Example: "074103447228"

nicknamestring

Display name for the remote account. Not considered to be sensitive data. Pattern: 1–34 characters with at least one non-whitespace character. Example: "Celia College Fund"

Response

Successful Response

externalAccountLinkIdstring required

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