Chilkat Online Tools

phpAx / Broker API / Bank 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.

// {
//   "name": "Test Bank XYZ",
//   "bank_code_type": "ABA",
//   "bank_code": "123456789",
//   "account_number": "123456789abc"
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('name','Test Bank XYZ');
$json->UpdateString('bank_code_type','ABA');
$json->UpdateString('bank_code','123456789');
$json->UpdateString('account_number','123456789abc');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/v1/accounts/:account_id/recipient_banks','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 '{
  "name": "Test Bank XYZ",
  "bank_code_type": "ABA",
  "bank_code": "123456789",
  "account_number": "123456789abc"
}'
https://domain.com/v1/accounts/:account_id/recipient_banks

Postman Collection Item JSON

{
  "name": "Bank Relationship",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"name\": \"Test Bank XYZ\",\n  \"bank_code_type\": \"ABA\",\n  \"bank_code\": \"123456789\",\n  \"account_number\": \"123456789abc\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HOST}}/v1/accounts/:account_id/recipient_banks",
      "host": [
        "{{HOST}}"
      ],
      "path": [
        "v1",
        "accounts",
        ":account_id",
        "recipient_banks"
      ],
      "variable": [
        {
          "key": "account_id",
          "value": null
        }
      ]
    },
    "description": "| Parameter        | Type                | Requirement | Notes             |\n| -----------------|---------------------|-------------|:-----------------:|\n| `name`           | string              | Required    | Name of recipient bank |\n| `bank_code_type` | enum.IdentifierType | Required    | `ABA`(Domestic) or `BIC`(International) |\n| `bank_code`      | string              | Required    | 9-Digit ABA RTN (Routing Number or BIC |\n| `country`        | string              | Required    | Only for international banks |\n| `state_province` | string              | Required    | Only for international banks |\n| `postal_code`    | string              | Required    | Only for international banks |\n| `city`           | string              | Required    | Only for international banks |\n| street_address | string              | Required    | Only for international banks |\n| account_number | string              | Required    |                   |"
  },
  "response": [
  ]
}