Update Account
Overview
You can update an account by modifying the information or adding information for a non-mandatory field not provided earlier, by using the POST method, as described below. Once created, you cannot update the owner of the account.
Resource Access
Production (api.ahrvo.network)
POST https://api.ahrvo.network/banking/us2/v1/customer/id/{customerId}/account/id/{accountId}
Staging (gateway.ahrvo.network)
POST https://gateway.ahrvo.network/banking/us2/v1/customer/id/{customerId}/account/id/{accountId}
Authentication
| Header | Description |
|---|---|
Authorization | Bearer {JWT token} |
x-api-key | Your API key |
Content-Type | application/json |
Path Parameters
| Parameter | Type | Description |
|---|---|---|
customerId | integer | Internal customer ID |
accountId | integer | Internal account ID |
Arguments — Updatability Reference
| Attribute | Can be Updated? | Notes |
|---|---|---|
externalId | Conditional | Once specified, cannot be updated |
purpose | Yes | |
nickName | Yes | |
isPrimary | Yes | |
linkedDocument | Conditional | Once specified, cannot be updated. Can be linked through Update API if no document was linked at creation. |
configuration.sweep.enable | Yes | |
configuration.sweep.cadence | Yes | |
configuration.sweep.destination.externalAccount.id | Yes | |
configuration.sweep.destination.externalAccount.externalId | Yes | |
configuration.sweep.minBalance | Yes | |
configuration.sweep.method | Yes | |
configuration.sweep.processingMode | Yes | |
configuration.sweep.cadenceDetails.sweepTime | Yes | |
configuration.credit.realizationInterval.ach | Yes | |
configuration.credit.realizationInterval.card | Yes | |
configuration.credit.realizationInterval.check | Yes | |
configuration.credit.quickSettle.ach | Yes | |
configuration.credit.quickSettle.check | Yes | |
configuration.credit.statementDescriptor.ach.companyDescription | Yes | |
configuration.credit.statementDescriptor.ach.companyName | Yes | |
configuration.credit.statementDescriptor.card.descriptor | Yes | |
configuration.debit.statementDescriptor.ach.companyDescription | Yes | |
configuration.debit.statementDescriptor.ach.companyName | Yes | |
configuration.debit.statementDescriptor.wire.originator | Yes | |
configuration.debit.checkProcessing.defaultRemittanceTemplate.id | Yes | |
acceptanceMode | Yes | |
acceptanceDetails | Yes | |
metaData | Yes | |
tags | Yes | |
comment | Yes | |
debitCardIssuance.cardProgram[].name | Yes | |
debitCardIssuance.cardProgram[].id | Yes | |
virtualCardIssuance.cardProgram[].name | Yes | |
virtualCardIssuance.cardProgram[].id | Yes |
Example Request
Update Sweep Min Balance
POST /banking/us2/v1/customer/id/4052981/account/id/4024062 HTTP/1.1
Host: api.ahrvo.network
Authorization: Bearer {placeholder("JWT token")}
x-api-key: {placeholder("your-api-key")}
Content-Type: application/json
{
"configuration": {
"sweep": {
"minBalance": "1050"
}
}
}
Example Response
HTTP Status: 204 No Content
Important Notes
Immutable Owner
Once created, you cannot update the owner of the account.
External ID — Set Once
The externalId can be set once but cannot be updated after initial assignment.
Linked Documents
If no document was linked at the time of account creation, it can be linked through the Update API. However, once a document is linked, it cannot be updated.
Partial Updates
You only need to include the fields you want to update. Fields not included in the request body will remain unchanged.