---
title: "Load External Account Links"
method: POST
path: "/loadExternalAccountLinks"
tags: ["External Account Links"]
---

# Load External Account Links

`POST /loadExternalAccountLinks`

## Request

- Base URL: `{corename}.payment-hub.{env}.gpsrv.com/payment-hub/1.0`
- URL: `{corename}.payment-hub.{env}.gpsrv.com/payment-hub/1.0/loadExternalAccountLinks`
- Auth: none declared. Required headers: `x-gft-idempotency-key`, `Authorization`

Use the Load External Account Links endpoint to initiate a link between external account(s) and the caller account when a user inputs their external account credentials during a secure session in your application. The external account will be usable for transfers over FedWire or credit rails, depending on your configuration.

## Headers

- `x-gft-idempotency-key` string, uuid4, required
- `Authorization` string, required

## Request body

- object
  - `accountNo` string, required: The <<glossary:PRN>> to which the new external account will be linked. Pattern: PRN Example: `"074103447228"`
  - `integration` object, required: Contains the account and customer identifiers from the specified third-party provider.
    - `type` 'FINICITY' | 'PLAID', required: Third-party provider used to link the account. Example: FINICITY
    - `customerId` string, nullable: Unique customer identifier provided by the integration partner. Pattern: Alphanumeric string Example: `"1005061234"`
    - `accountId` string, nullable: Unique account identifier provided by the integration partner. Pattern: Alphanumeric string Example: `"5011648377"`
  - `validation` object, nullable
    - `type` 'CLIENT' | 'LEGACY' | 'CARD' | 'FINICITY' | 'NONE' | 'MICRO_ENTRY': Specifies the validation method required for the external account link. Pattern: enum Example: `"CLIENT"`
    - `status` 'PENDING' | 'FAILED' | 'PASSED' | 'NO_VALIDATION': Indicates the current status of the validation process. Pattern: enum Example: `"PENDING"`
    - `status_reason` string, nullable: Provides additional context or a reason for the current validation status. Pattern: Alphanumeric string Example: `"Validated successfully"`
    - `sameDay` boolean: Whether to originate the microdeposits as same-day ACH instead of next business day. Only valid when `type` is `MICRO_ENTRY`. Requests after the Nacha same-day cutoff are originated the next business day. Pattern: true or false Example: true

## Response `200`

Successful Response

- object[]
  - `externalAccountLinkId` string, required: Unique identifier that identifies the external account link in the system.
  - `status` string: Status of the external account link.
  - `integration` object, required: Contains information about the third-party provider.
    - `type` 'FINICITY' | 'PLAID', required: Third-party provider such as FINICITY, PLAID, etc
    - `customerId` string, nullable: The customer ID of the account.
    - `accountId` string, nullable: The account ID of the account.
    - `institutionId` string, nullable: The institution ID of the account.

## Other responses

- `400`: Bad Request
- `401`: No valid API credentials provided.
- `403`: The provided API credential does not allow this operation.
- `404`: Not Found
- `409`: Conflict
- `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)