External Account Links

Modify External Account Link

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.

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

Headers

Authorizationstring required

Example:Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5

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

Request body

accountNostring required

The <glossary:PRN> to which the external account is linked. Pattern: PRN Example: "074103447228"

externalAccountLinkIdstring required

Unique identifier for the specific external account link to modify. Pattern: 1–40 digits Example: "0359320859384728394827182394832834"

nicknamestring nullable

Display name for the remote account. Not considered to be sensitive data. Pattern: 1–34 characters Example: "My Savings Account"

Example request

{
  "accountNo": "074103447228",
  "externalAccountLinkId": "0359320859384728394827182394832834",
  "nickname": "Celia College Fund",
  "owner": {
    "address": {
      "line1": "123 sesame street",
      "line2": "apt 4321",
      "city": "Brooklyn",
      "state": "NY",
      "zipCode": "11201",
      "country": "US"
    },
    "consumerFirstName": "John",
    "consumerLastName": "Smith",
    "businessName": "ABC Corp"
  },
  "details": {
    "bankAddress": {
      "line1": "123 sesame street",
      "line2": "apt 4321",
      "city": "Brooklyn",
      "state": "NY",
      "zipCode": "11201",
      "country": "US"
    },
    "bankAccountNumber": "324839572834",
    "bankName": "AbcBank"
  }
}

Response

Successful Response

externalAccountLinkIdstring required

The unique identifier that identifies the external account link in the system.

Changes

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