Chilkat Online Tools

TCL / Broker API / Bank Relationship

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "{{api_key}}"
CkHttp_put_Password $http "{{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"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "name" "Test Bank XYZ"
CkJsonObject_UpdateString $json "bank_code_type" "ABA"
CkJsonObject_UpdateString $json "bank_code" "123456789"
CkJsonObject_UpdateString $json "account_number" "123456789abc"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/v1/accounts/:account_id/recipient_banks" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

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