Modify an ACH Relationship

Modify the name of an existing ACH Relationship

Overview

This PUT endpoint enables you to modify an existing ACH relationship.

There are six required parameters that must be provided in the request:

1. Et-App-Key (header). This is the unique key of your app that identifies your app when communicating with our service. Contact your administrator to get this key.

2. Authorization (header). This is the authorization token from the very first token request.

3. API version (path). Unless necessary, leave it at "1.0".

4. accountId (path). This is the internal identifier of the trading account in Autoshares Trader.

5. id (path). This is the ID of the ACH relationship in Autoshares Trader.

6. model (body). This is a JSON dictionary that contains updated information about the ACH relationship.

Request Body

The body of this request represents the updated name of ACH relationship.

Parameter	Description
Name	This is the new name of the target bank.

{
  "Name": "Main Citi Bank Account"
}

Here's the final template for this API request:

PUT apiURL/v1.0/accounts/{accountId}/ach-relationships/{id}

Response

In response to this API request, you will receive a JSON dictionary containing detailed information about the newly created ACH relationship.

{
  "Id": "40ee3617-7a67-45dd-0609-08d7bacaad26",
  "AccountId": 0,
  "ExternalId": "5e6f80963c3477ba9dc1f98a",
  "RoutingNumber": "051000017",
  "AccountNumber": "987654321222",
  "AccountOwnerName": "Eugeny",
  "Name": "Main Citi Bank Account",
  "Status": "Approved",
  "CreatedAt": "2020-03-16T13:35:18.0133333Z",
  "ApprovalMethod": "Instant",
  "Default": false
}

where:

Parameter	Description
Id	This is the internal identifier of the newly created ACH relationship in Autoshares Trader.
AccountId	This is an Autoshares Trader's trading account to which the ACH relationship.
RoutingNumber	This is the routing number of the bank who opened the banking account. You can view sample routing number on this page.
AccountNumber	This is the number of the banking account in the target bank. For example: 987654321222.
AccountOwnerName	This is the name of the banking account owner. For example: Robert.
Name	This is the name of the target bank. For example: Citi Bank.
Status	This is the status of the ACH relationship.
CreatedAt	This is the precise time and date at which the ACH relationship was created.
ApprovalMethod	This is the approval method. The value of this parameter can be either Instant (Plaid) or Manual (Micro deposits).
Default	This boolean value indicates if this ACH relationship is a default one for this trading account.

Common Mistakes

Here are some of the common mistakes that developers make when attempting to send a request to update an existing ACH relationship.

Failing to Specify the Et-App-Key Parameter

If you specify the wrong Et-App-Key parameter or fail to include it in the header altogether, you'll get the following error:

{
    "error": "Application key is not defined or does not exist"
}