Chilkat Online Tools

Node.js / Broker API / Journal

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.

    // {
    //   "from_account": "7a9e91a4-ed56-44cf-8e10-f6c1aeed05d7",
    //   "entry_type": "JNLC",
    //   "to_account": "b8abc578-35ed-4bc0-bb55-6dc846f932eb",
    //   "amount": "51",
    //   "description": "test text /fixtures/status=rejected/fixtures/"
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("from_account","7a9e91a4-ed56-44cf-8e10-f6c1aeed05d7");
    json.UpdateString("entry_type","JNLC");
    json.UpdateString("to_account","b8abc578-35ed-4bc0-bb55-6dc846f932eb");
    json.UpdateString("amount","51");
    json.UpdateString("description","test text /fixtures/status=rejected/fixtures/");

    // resp: HttpResponse
    var resp = http.PostJson3("https://domain.com/v1/journals","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 '{
  "from_account": "7a9e91a4-ed56-44cf-8e10-f6c1aeed05d7",
  "entry_type": "JNLC",
  "to_account": "b8abc578-35ed-4bc0-bb55-6dc846f932eb",
  "amount": "51",
  "description": "test text /fixtures/status=rejected/fixtures/"
}'
https://domain.com/v1/journals

Postman Collection Item JSON

{
  "name": "Journal",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"from_account\": \"7a9e91a4-ed56-44cf-8e10-f6c1aeed05d7\",\n  \"entry_type\": \"JNLC\",\n  \"to_account\": \"b8abc578-35ed-4bc0-bb55-6dc846f932eb\",\n  \"amount\": \"51\",\n  \"description\": \"test text /fixtures/status=rejected/fixtures/\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HOST}}/v1/journals",
      "host": [
        "{{HOST}}"
      ],
      "path": [
        "v1",
        "journals"
      ]
    },
    "description": "| Attribute                         | Type           | Requirement | Notes |\n|-----------------------------------|----------------|-------------|:-----:|\n| `to_account`                        | string         | Required    | The `account_id` you wish to journal to |\n| `from_account`                      | string         | Required    | the `account_id you` wish to journal from |\n| `entry_type`                        | string         | Required    | ENUM: `JNLC` or `JNLS` |\n| `amount`                            | string/numeric | Required    | Required if `entry_type = JNLC` |\n| `symbol`                            | string         | Required    | Required if `entry_type = JNLS` |\n| `qty`                               | string/numeric | Required    | Required if `entry_type = JNLS` |\n| `description`                       | string         | Optional    | Max 1024 characters. Can include fixtures for amounts that are above the transaction limit |\n| `transmitter_name`                  | string         | Optional    | Max 255 characters. See more details about Travel Rule. |\n| `transmitter_account_number`        | string         | Optional    | Max 255 characters. See more details about Travel Rule. |\n| `transmitter_address`               | string         | Optional    | Max 255 characters. See more details about Travel Rule. |\n| `transmitter_financial_institution` | string         | Optional    | Max 255 characters. See more details about Travel Rule. |\n| `transmitter_timestamp`             | string         | Optional    | RFC 3339 format. See more details about Travel Rule. |"
  },
  "response": [
  ]
}