v1

latestOpenAPI 3.0.32026-07-2621102.1 MB

External Account Links

Get 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 Get External Account Link endpoint to retrieve a remote account that was created by <a href="ref:paymenthub_post_createexternalaccountlink" target="_blank">Create External Account Link</a> for the specified accountNo.

post/getExternalAccountLink

Headers

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 external account is linked. Pattern: PRN Example: "074103447228"

externalAccountLinkIdstring required

Unique identifier for the specific external account link to retrieve. Example: "0359320859384728394827182394832834"

includeBalanceboolean

Specifies whether to include the external account's live balance in the response. Example: true

Response

Successful Response

externalAccountLinkIdstring required

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

status'ACTIVE' | 'DELETED' | 'PENDING' | 'FAILED'

Status of the external account link.

nicknamestring

Display name for the remote account. Not considered to be sensitive data. Pattern: Max 34 alphanumeric, punctuation Example: "Celia College Fund"