Chilkat Online Tools

Node.js / Broker API / Batch Journal Transaction

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.

    // {
    //   "entry_type": "JNLC",
    //   "from_account": "7a9e91a4-ed56-44cf-8e10-f6c1aeed05d7",
    //   "entries": [
    //     {
    //       "to_account": "b8abc578-35ed-4bc0-bb55-6dc846f932eb",
    //       "amount": "10"
    //     },
    //     {
    //       "to_account": "fce64594-8d8c-4cda-97d5-3f9cdafbf4ef",
    //       "amount": "100"
    //     }
    //   ]
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("entry_type","JNLC");
    json.UpdateString("from_account","7a9e91a4-ed56-44cf-8e10-f6c1aeed05d7");
    json.UpdateString("entries[0].to_account","b8abc578-35ed-4bc0-bb55-6dc846f932eb");
    json.UpdateString("entries[0].amount","10");
    json.UpdateString("entries[1].to_account","fce64594-8d8c-4cda-97d5-3f9cdafbf4ef");
    json.UpdateString("entries[1].amount","100");

    // resp: HttpResponse
    var resp = http.PostJson3("https://domain.com/v1/journals/batch","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 '{
  "entry_type": "JNLC",
  "from_account": "7a9e91a4-ed56-44cf-8e10-f6c1aeed05d7",
  "entries": [
    {
      "to_account": "b8abc578-35ed-4bc0-bb55-6dc846f932eb",
      "amount": "10"
    },
    {
      "to_account": "fce64594-8d8c-4cda-97d5-3f9cdafbf4ef",
      "amount": "100"
    }
  ]
}'
https://domain.com/v1/journals/batch

Postman Collection Item JSON

{
  "name": "Batch Journal Transaction",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"entry_type\": \"JNLC\",\n  \"from_account\": \"7a9e91a4-ed56-44cf-8e10-f6c1aeed05d7\",\n  \"entries\": [\n    {\n      \"to_account\": \"b8abc578-35ed-4bc0-bb55-6dc846f932eb\",\n      \"amount\": \"10\"\n    },\n    {\n      \"to_account\": \"fce64594-8d8c-4cda-97d5-3f9cdafbf4ef\",\n      \"amount\": \"100\"\n    }\n  ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HOST}}/v1/journals/batch",
      "host": [
        "{{HOST}}"
      ],
      "path": [
        "v1",
        "journals",
        "batch"
      ]
    },
    "description": "| Attribute      | Type          | Requirement                           | Notes                                                           |\n| -------------- | ------------- | ------------------------------------- | --------------------------------------------------------------- |\n| `entry_type`   | string        | Required | ENUM: `JNLC` or `JNLS`                                          |\n| `from_account` | string        | Required | The originator of funds. Most likely is your Sweep Firm Account |\n| `to_account`   | string        | Required | The ID of the `to_account` that you want to journal into        |\n| `amount`       | string/number | Required | Journal amount in `USD`                                         |\n| `description`  | string        | Optional | Journal description, gets returned in the response              |"
  },
  "response": [
  ]
}