External Account Links

Get External Account Link Access

Use the Get External Account Link Access endpoint to initiate a secure, user-facing session for linking an external account. This endpoint generates a temporary link for the user to securely provide their credentials to a third-party partner like Finicity.

post/getExternalAccountLinkAccess

Request

  • Base URL
    {corename}.payment-hub.{env}.gpsrv.com/payment-hub/1.0
  • URL
    {corename}.payment-hub.{env}.gpsrv.com/payment-hub/1.0/getExternalAccountLinkAccess
  • Auth
    none declared. Required headers: Authorization

Headers

Authorizationstring required
Example:Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5

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

Request body

accountNostring nullable

The <glossary:PRN> for which to generate the secure linking session. Required for GALILEO_CARD_CAPTURE integration. Pattern: PRN Example: 074103447228

integration'FINICITY' | 'GALILEO_CARD_CAPTURE' required

Third-party partner to use for the secure account-linking session. Example: FINICITY

Example request

{
  "accountNo": "074103447228"
}

Response

Successful Response

expirationTimestampstring required

ISO 8601 timestamp when the access token expires. Pattern: ISO 8601 format Example: "2025-06-11T09:49:20.055367-06:00"

expirationDatestring required

Deprecated: Use expirationTimestamp instead. ISO 8601 timestamp when the access token expires. Pattern: ISO 8601 format Example: "2025-06-11T09:49:20.055367-06:00"

Example response

{
  "token": {
    "type": "JWT",
    "value": "fqnu103294.g4234g234f.42g2345gteg",
    "appKey": "abc123def456"
  },
  "expirationTimestamp": "2025-06-11T09:49:20.055367-06:00",
  "expirationDate": "2025-06-11T09:49:20.055367-06:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.