GAgalileo-ft
External Account Links

List External Account Links

Use the List External Account Links endpoint to retrieve a list of remote accounts that were created by <a href="ref:paymenthub_post_createexternalaccountlink" target="_blank">Create External Account Link</a> for the specified accountNo.

post/listExternalAccountLinks

Request

  • Base URL
    {corename}.payment-hub.{env}.gpsrv.com/payment-hub/1.0
  • URL
    {corename}.payment-hub.{env}.gpsrv.com/payment-hub/1.0/listExternalAccountLinks
  • 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 required

All external account links associated with this <glossary:PRN>. Pattern: PRN Example: "074103447228"

limitinteger

Maximum number of account links to return in the response. Pattern: Integer, max 15 Example: 15

pagestring nullable

Pass the nextPage token from a previous response to fetch the subsequent page. Pattern: Alphanumeric token Example: "NO34BNT04TV234N6V274692376G32NNFNNF7988247923865017061N"

Example request

{
  "accountNo": "074103447228",
  "limit": 1,
  "page": "NO34BNT04TV234N6V274692376G32NNFNNF7988247923865017061N"
}

Response

Successful Response

nextPagestring nullable

Token to use to retrieve the next page. If this field is missing, there are no more pages to return.

Example response

{
  "externalAccountLinks": [
    {
      "nickname": "Celia College Fund",
      "owner": {
        "address": {
          "line1": "123 sesame street",
          "line2": "apt 4321",
          "city": "Brooklyn",
          "state": "NY",
          "zipCode": "11201",
          "country": "US"
        }
      }
    }
  ]
}

Changes

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