Skip to main content

Update External Account


Overview​

You can update selected details of an existing external account by sending a POST request to either the production or staging environment.


Resource Access​

Production (api.ahrvo.network)

POST https://api.ahrvo.network/banking/us2/v1/customer/id/{placeholder("id")}/externalAccount/id/{placeholder("id")}

Staging (gateway.ahrvo.network)

POST https://gateway.ahrvo.network/banking/us2/v1/customer/id/{placeholder("id")}/externalAccount/id/{placeholder("id")}


Arguments​

AttributeCan be updated?Notes
externalIdConditionalOnce set, cannot be changed.
holderNameYesIf the EA is Active, only holderName may change (triggers OFAC).
accountNumberNo—
routingNumberNo—
wireRoutingNumberNo—
typeYesOnly when EA is Inactive.
holderTypeNo—
purposeYes—
validateAccount.ewsYesOnly when EA is Inactive.
prenoteYesOnly when EA is Inactive.
microDepositYes—
metaDataYesUp to 20 key-value pairs.
tagsYesArray of labels.
linkedDocumentYesSee mandatory sub-fields below.
  purposeMPurpose of document.
  document.documentTypeMMIME/enum value.
  document.nameMFile name.
  document.base64encodedContentMBase-64 payload.
  document.externalIdODocument reference.
commentYesInternal note.

M = Mandatory    O = Optional


Example Request (production)​

Perform account validation on an Inactive external account

POST /banking/us2/v1/customer/id/4052981/externalAccount/id/3 HTTP/1.1
Host: api.ahrvo.network
Authorization: Bearer {placeholder("JWT token")}
x-api-key: {apiKey}
Content-Type: application/json
{
"validateAccount": [
{
"ews": true
}
]
}

(For staging, replace api.ahrvo.network with gateway.ahrvo.network in both the Host header and the URL.)


Example Response​

HTTP/1.1 299 Warning Content-Type: application/json WARN-0201: The external account will not be available for transaction processing until re-verified by Ahrvo.


OpenAPI Specification​