Chilkat Online Tools

PureBasic / Broker API / ACH Relationship

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "{{api_key}}")
    CkHttp::setCkPassword(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.

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

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"account_owner_name","Christie Ruales")
    CkJsonObject::ckUpdateString(json,"bank_account_type","CHECKING")
    CkJsonObject::ckUpdateString(json,"bank_account_number","01020304abc")
    CkJsonObject::ckUpdateString(json,"bank_routing_number","121000358")
    CkJsonObject::ckUpdateString(json,"nickname","Bank of America Checking")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/v1/accounts/:account_id/ach_relationships","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

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