Chilkat Online Tools

Node.js / Broker API / ACH Relationship

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "{{api_key}}";
    http.Password = "{{api_secret}}";

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "account_owner_name": "Christie Ruales",
    //   "bank_account_type": "CHECKING",
    //   "bank_account_number": "01020304abc",
    //   "bank_routing_number": "121000358",
    //   "nickname": "Bank of America Checking"
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("account_owner_name","Christie Ruales");
    json.UpdateString("bank_account_type","CHECKING");
    json.UpdateString("bank_account_number","01020304abc");
    json.UpdateString("bank_routing_number","121000358");
    json.UpdateString("nickname","Bank of America Checking");

    // resp: HttpResponse
    var resp = http.PostJson3("https://domain.com/v1/accounts/:account_id/ach_relationships","application/json",json);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

Curl Command

curl -X POST
	-u '{{api_key}}:{{api_secret}}'
	-d '{
  "account_owner_name": "Christie Ruales",
  "bank_account_type": "CHECKING",
  "bank_account_number": "01020304abc",
  "bank_routing_number": "121000358",
  "nickname": "Bank of America Checking"
}'
https://domain.com/v1/accounts/:account_id/ach_relationships

Postman Collection Item JSON

{
  "name": "ACH Relationship",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"account_owner_name\": \"Christie Ruales\",\n  \"bank_account_type\": \"CHECKING\",\n  \"bank_account_number\": \"01020304abc\",\n  \"bank_routing_number\": \"121000358\",\n  \"nickname\": \"Bank of America Checking\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HOST}}/v1/accounts/:account_id/ach_relationships",
      "host": [
        "{{HOST}}"
      ],
      "path": [
        "v1",
        "accounts",
        ":account_id",
        "ach_relationships"
      ],
      "variable": [
        {
          "key": "account_id",
          "value": null
        }
      ]
    },
    "description": "| Parameter             | Type   | Requirement | Notes             |\n| ----------------------|--------|-------------|:-----------------:|\n| `account_owner_name`  | string | Required    |                   |\n| `bank_account_type`   | string | Required    | Must be `CHECKINGS` or `SAVINGS` |\n| `bank_account_number` | string | Required    | In sandbox, this must be valid format |\n| `bank_routing_number` | string | Required    | In sandbox, this must be valid format                  |\n| `nickname`            | string | Optional    |                   |"
  },
  "response": [
  ]
}