---
title: "Modify External Account Link"
method: POST
path: "/modifyExternalAccountLink"
tags: ["External Account Links"]
---

# Modify External Account Link

`POST /modifyExternalAccountLink`

## Request

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

Use the Modify External Account Link endpoint to update an existing external bank account that sends and receives transactions.

Specify only the parameter(s) you wish to modify. Do not pass parameters with `null` or empty values.

## 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 modify. Pattern: 1–40 digits Example: `"0359320859384728394827182394832834"`
  - `nickname` string, nullable: Display name for the remote account. Not considered to be sensitive data. Pattern: 1–34 characters Example: `"My Savings Account"`
  - `owner` object, nullable: Specifies the owner-related fields to update.
    - `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)
    - `consumerFirstName` string, nullable: First name of the individual who owns the account. Pattern: 1-40 characters Example: `"Jane"`
    - `consumerLastName` string, nullable: Last name of the individual who owns the account. Pattern: 1-40 characters Example: `"Doe"`
    - `businessName` string, nullable: Legal name of the business that owns the account. Pattern: 1-40 characters Example: `"ABC Corporation"`
  - `details` union: Specifies the account or card details to update.
    - ModifiableExternalBankAccountDetails: Base class for modifiable account details
      - `type` 'BANK' | 'CARD' | 'WALLET_CARD', required: Type of external account being linked.
      - `bankAddress` object, nullable
        - `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)
      - `bankAccountNumber` string, nullable: Full account number for the external bank account. Pattern: Alphanumeric string Example: `"324839572835"`
      - `bankRoutingInfo` object[], nullable: List of routing objects for the external account.
        - `type` 'ROUTING_NO' | 'BIC', required: Type of routing information provided. Values: ROUTING_NO, BIC - ROUTING_NO: ABA/RTN routing number - BIC: SWIFT/BIC code Example: `ROUTING_NO`
        - `paymentType` 'ACH' | 'FEDNOW' | 'FEDWIRE' | 'CARD', required: Payment rail that will use this routing information. Example: FEDWIRE
        - `value` string, required: Routing identifier value. - For ROUTING_NO: 9-digit ABA routing number. Example: `"124001234"` - For BIC: 8 or 11-character SWIFT/BIC code. Example: `"CHASUS33"`, `"NWBKGB2LXXX"`
      - `bankName` string, nullable: Name of the financial institution for the external account. Pattern: 1-40 characters Example: `"AbcBank"`
    - ModifiableExternalCardAccountDetails: Base class for modifiable account details
      - `type` 'BANK' | 'CARD' | 'WALLET_CARD', required: Type of external account being linked.
      - `cardNumber` string, nullable: Full card number of the external card. Pattern: 15-16 digit <<glossary:PAN>> Example: `"4111111111111112"`
      - `cardAddress` object, nullable: Billing address for the card.
        - `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)
      - `cardUseOwnerAddress` boolean, nullable: Whether to use the account owner's address for the `card_address` field. Example: false
      - `cardExpirationDate` string, nullable: Expiration date of the external card. Pattern: YYYY-MM Example: `"2029-11"`
  - `validation` object, nullable: Specifies the validation information to update.
    - `type` 'CLIENT' | 'LEGACY' | 'CARD' | 'FINICITY' | 'NONE' | 'MICRO_ENTRY', nullable: Validation method for the external account. Example: CLIENT
    - `status` 'PENDING' | 'FAILED' | 'PASSED' | 'NO_VALIDATION', nullable: Validation status of the external account. Example: VERIFIED

## Response `200`

Successful Response

- object
  - `externalAccountLinkId` string, required: The unique identifier that identifies the external account link in the system.

## 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)