Skip to main content

Validate External Account

Suggest Edits


Overview

Validate an external account to reduce ACH returns and mitigate fraud. Ahrvo supports three validation types:

Validation TypeWhat It DoesProcessing Time
PrenoteSends a $0 test credit; live transactions permitted after 3-business-day window.~3 business days
EWSReal-time check of account status and recent returns.Instant
Micro-depositSends 1–2 small credits; customer must confirm the amounts. System later debits the same total.~3 business days

System Rule – An external account can be validated either by Prenote or Micro-deposit (not both simultaneously). EWS can be combined with either method.


Resource Access

Production (api.ahrvo.network)

POST https://api.ahrvo.network/banking/us2/v1/customer/id/{customerId}/externalAccount/id/{externalAccountId}/validate

Staging (gateway.ahrvo.network)

POST https://gateway.ahrvo.network/banking/us2/v1/customer/id/{customerId}/externalAccount/id/{externalAccountId}/validate

Arguments

FieldMandatory?
validateAccount.ewsYes
prenoteYes
microDepositYes

Example Request (production) — validate using EWS with Prenote fallback

POST /banking/us2/v1/customer/id/4052981/externalAccount/id/2/validate HTTP/1.1
Host: api.ahrvo.network
Authorization: Bearer {jwtToken}
x-api-key: {apiKey}
Content-Type: application/json
{
"validateAccount": [
{ "ews": true }
],
"prenote": "ON_FAILURE",
"microDeposit": "NEVER"
}

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


Example Response

HTTP/1.1 200 OK
Content-Type: application/json
{
"validateAccount": [
{
"ews": {
"status": "PENDING",
"statusReason": "PENDING",
"statusDate": "05/11/2023 18:19:03"
}
}
],
"prenote": {
"prenoteValidation": "ON_FAILURE"
},
"microDeposit": {
"microDepositValidation": "NEVER"
}
}