---
title: "Get External Account Link"
method: POST
path: "/getExternalAccountLink"
tags: ["External Account Links"]
---

# Get External Account Link

`POST /getExternalAccountLink`

## Request

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

> 👍 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`.

## Headers

- `Authorization` string, required

## Request body

- object
  - `accountNo` string, required: The <<glossary:PRN>> to which the external account is linked. Pattern: PRN Example: `"074103447228"`
  - `externalAccountLinkId` string, required: Unique identifier for the specific external account link to retrieve. Example: `"0359320859384728394827182394832834"`
  - `includeBalance` boolean, nullable: Specifies whether to include the external account's live balance in the response. Example: `true`

## Response `200`

Successful Response

- object
  - `externalAccountLinkId` string, required: Unique identifier that identifies the external account link in the system.
  - `status` 'ACTIVE' | 'DELETED' | 'PENDING' | 'FAILED', nullable: Status of the external account link.
  - `nickname` string, nullable: Display name for the remote account. Not considered to be sensitive data. Pattern: Max 34 alphanumeric, punctuation Example: `"Celia College Fund"`
  - `owner` object, required: Owner information for the linked external account.
    - `type` 'CORPORATE' | 'CONSUMER' | 'GALILEO', required: Type of account owner:
    - `ownershipType` 'FIRST_PARTY' | 'THIRD_PARTY', required: Relationship of the account owner to the program account.
    - `address` object, nullable: Primary address for the account owner.
      - `line1` string, nullable: First line of the address. Pattern: - Default: 1-105 characters with at least one non-whitespace character - FEDWIRE: 1-105 characters, limited to alphanumeric and special characters
      - `line2` string, nullable: Second line of the address (apartment, suite, etc.). Pattern: - Default: 1-35 characters with at least one non-whitespace character - FEDWIRE: 1-35 characters, limited to alphanumeric and special characters
      - `city` string, nullable: City name. Pattern: - Default: 1-35 characters with at least one non-whitespace character - FEDWIRE: 1-35 characters, limited to alphanumeric and special characters
      - `state` string, nullable: State or province code. Pattern: - Default: 2-35 characters with at least one non-whitespace character. For US addresses, typically 2-letter state code (e.g., 'NY', 'CA') - FEDWIRE: 2-35 characters, limited to alphanumeric and special characters
      - `zipCode` string, nullable: Postal code or ZIP code. Pattern: - Default: 1-15 characters with at least one non-whitespace character. For US addresses, typically 5-digit ZIP code (e.g., '11201') - FEDWIRE: 1-15 characters, limited to alphanumeric and special characters
      - `country` string, nullable: Country code following ISO 3166-1 alpha-2 format. Pattern: Exactly 2 uppercase letters. Examples: 'US' (United States), 'MX' (Mexico)
  - `details` object, required: Card or bank details for the linked external account.
    - `type` 'BANK' | 'CARD' | 'WALLET_CARD', required: Type of external account being linked.
  - `validation` object, required: Validation details for the linked external account.
    - `type` 'CLIENT' | 'LEGACY' | 'CARD' | 'FINICITY' | 'NONE' | 'MICRO_ENTRY', required: Type of validation:
    - `status` 'PENDING' | 'FAILED' | 'PASSED' | 'NO_VALIDATION', required: Status of the validation:
    - `status_reason` string, nullable: Reason for the validation status.

## Other responses

- `400`: Bad Request
- `401`: No valid API credentials provided.
- `403`: The provided API credential does not allow this operation.
- `404`: Not Found
- `422`: Validation Error
- `429`: Too many requests.
- `500`: Internal Server Error
- `502`: Bad Gateway.
- `503`: Service Unavailable.

---

[API](https://skmtc.dev/galileo-ft/apis/payment-hub-api-2-0.md) - [All operations](https://skmtc.dev/galileo-ft/apis/payment-hub-api-2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/galileo-ft/apis/payment-hub-api-2-0/revisions/20e06b09d5e4?raw)