Chilkat Online Tools

phpAx / Broker API / ACH Relationship

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

$http->BasicAuth = 1;
$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"
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("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 is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/v1/accounts/:account_id/ach_relationships','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

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": [
  ]
}