(Node.js) Ibanity XS2A List Financial Institutions

See more Ibanity Examples

Demonstrates how to send a request to get a list of financial institutions.

For more information, see https://documentation.ibanity.com/xs2a/api/curl#authentication

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

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 requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    //  Send the following request:

    // $ curl -X GET https://api.ibanity.com/xs2a/financial-institutions \
    // --cert certificate.pem \
    // --key private_key.pem \
    // -H 'Signature: keyId="75b5d796-de5c-400a-81ce-e72371b01cbc",created=1599659223,algorithm="hs2019",headers="(request-target) digest (created) host",signature="BASE64(RSA-SHA256(SIGNING_STRING))"' \
    // -H 'Digest: SHA-512=beDaRguyEb8fhh5wnl37bOTDtvhuYZyZNkTZ9LiC9Wc='

    // Ibanity provides the certificate + private key in PFX format.  This example will use the .pfx instead of the pair of PEM files.
    // (It is also possible to implement using Chilkat with the PEM files, but PFX is easier.)
    var cert = new chilkat.Cert();
    var success = cert.LoadPfxFile("qa_data/pfx/my_ibanity_certificate.pfx","my_pfx_password");
    if (success == false) {
        console.log(cert.LastErrorText);
        return;
    }

    // We need to calculate the Digest and Signature header fields.
    // For a detailed explanation, see Calculate Ibanity HTTP Signature Example

    // We'll just write the code here as briefly as possible.

    var dtNow = new chilkat.CkDateTime();
    dtNow.SetFromCurrentSystemTime();
    var created = dtNow.GetAsUnixTimeStr(false);

    var crypt2 = new chilkat.Crypt2();
    crypt2.HashAlgorithm = "sha512";
    crypt2.EncodingMode = "base64";

    var sbDigestHdrValue = new chilkat.StringBuilder();
    sbDigestHdrValue.Append("SHA-512=");
    // GET requests have empty payloads.  The SHA-512 hash of the empty string is the same for all GET requests.
    // Therefore all GET requests will use "z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg=="
    // You can eliminate the explicit hash computation (for GET requests) and simply use the above literal string.
    sbDigestHdrValue.Append(crypt2.HashStringENC(""));

    console.log("Generated Digest");
    console.log(sbDigestHdrValue.GetAsString());

    var request_target = "get /xs2a/financial-institutions";

    var sbSigningString = new chilkat.StringBuilder();
    sbSigningString.Append("(request-target): ");
    sbSigningString.AppendLine(request_target,false);
    sbSigningString.Append("host: ");
    sbSigningString.AppendLine("api.ibanity.com",false);
    sbSigningString.Append("digest: ");
    sbSigningString.AppendLine(sbDigestHdrValue.GetAsString(),false);
    sbSigningString.Append("(created): ");
    sbSigningString.Append(created);
    // ibanity-idempotency-key is not used with GET requests.

    console.log("Signing String:");
    console.log(sbSigningString.GetAsString());

    var signed_headers_list = "(request-target) host digest (created)";

    var privKey = new chilkat.PrivateKey();
    success = privKey.LoadEncryptedPemFile("my_ibanity_signature_private_key.pem","pem_password");
    if (success == false) {
        console.log(privKey.LastErrorText);
        return;
    }

    var rsa = new chilkat.Rsa();
    rsa.PssSaltLen = 32;
    rsa.EncodingMode = "base64";
    // Use the RSASSA-PSS signature algorithm
    rsa.OaepPadding = true;

    success = rsa.ImportPrivateKeyObj(privKey);
    if (success == false) {
        console.log(rsa.LastErrorText);
        return;
    }

    // Sign the signing string.
    var sigBase64 = rsa.SignStringENC(sbSigningString.GetAsString(),"sha-256");
    if (rsa.LastMethodSuccess == false) {
        console.log(rsa.LastErrorText);
        return;
    }

    console.log("Signature:");
    console.log(sigBase64);

    // Build the signature header value.
    var sbSigHeaderValue = new chilkat.StringBuilder();
    sbSigHeaderValue.Append("keyId=\"");
    // Use your identifier for the application's signature certificate, obtained from the Developer Portal
    sbSigHeaderValue.Append("a0ce296d-84c8-4bd5-8eb4-de0339950cfa");
    sbSigHeaderValue.Append("\",created=");
    sbSigHeaderValue.Append(created);
    sbSigHeaderValue.Append(",algorithm=\"hs2019\",headers=\"");
    sbSigHeaderValue.Append(signed_headers_list);
    sbSigHeaderValue.Append("\",signature=\"");
    sbSigHeaderValue.Append(sigBase64);
    sbSigHeaderValue.Append("\"");

    // Send the GET request..
    var http = new chilkat.Http();

    success = http.SetSslClientCert(cert);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    http.SetRequestHeader("Signature",sbSigHeaderValue.GetAsString());
    http.SetRequestHeader("Digest",sbDigestHdrValue.GetAsString());

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://api.ibanity.com/xs2a/financial-institutions",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = http.LastStatus;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(http.LastHeader);
        console.log("Failed.");
        return;
    }

    // Sample output:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "data": [
    //     {
    //       "attributes": {
    //         "authorizationModels": [
    //           "detailed",
    //           "financialInstitutionOffered"
    //         ],
    //         "bic": "NBBEBEBB203",
    //         "bulkPaymentsEnabled": true,
    //         "bulkPaymentsProductTypes": [
    //           "sepaCreditTransfer"
    //         ],
    //         "country": null,
    //         "financialInstitutionCustomerReferenceRequired": false,
    //         "futureDatedPaymentsAllowed": true,
    //         "logoUrl": "https://s3.eu-central-1.amazonaws.com/ibanity-production-financial-institution-assets/sandbox.png",
    //         "maintenanceFrom": null,
    //         "maintenanceTo": null,
    //         "maintenanceType": null,
    //         "maxRequestedAccountReferences": null,
    //         "minRequestedAccountReferences": 0,
    //         "name": "Bogus Financial",
    //         "paymentsEnabled": true,
    //         "paymentsProductTypes": [
    //           "sepaCreditTransfer"
    //         ],
    //         "periodicPaymentsEnabled": true,
    //         "periodicPaymentsProductTypes": [
    //           "sepaCreditTransfer"
    //         ],
    //         "primaryColor": "#7d39ff",
    //         "requiresCredentialStorage": false,
    //         "requiresCustomerIpAddress": false,
    //         "sandbox": true,
    //         "secondaryColor": "#3DF2C2",
    //         "sharedBrandName": null,
    //         "sharedBrandReference": null,
    //         "status": "beta"
    //       },
    //       "id": "2d3d70a4-cb3c-477c-97e1-cbe495b82841",
    //       "links": {
    //         "self": "https://api.ibanity.com/xs2a/financial-institutions/2d3d70a4-cb3c-477c-97e1-cbe495b82841"
    //       },
    //       "type": "financialInstitution"
    //     },
    //     {
    //       "attributes": {
    //         "authorizationModels": [
    //           "detailed",
    //           "financialInstitutionOffered"
    //         ],
    //         "bic": "NBBEBEBB203",
    //         "bulkPaymentsEnabled": true,
    //         "bulkPaymentsProductTypes": [
    //           "sepaCreditTransfer"
    //         ],
    //         "country": null,
    //         "financialInstitutionCustomerReferenceRequired": false,
    //         "futureDatedPaymentsAllowed": true,
    //         "logoUrl": "https://s3.eu-central-1.amazonaws.com/ibanity-production-financial-institution-assets/sandbox.png",
    //         "maintenanceFrom": null,
    //         "maintenanceTo": null,
    //         "maintenanceType": null,
    //         "maxRequestedAccountReferences": null,
    //         "minRequestedAccountReferences": 0,
    //         "name": "XYZ Trust",
    //         "paymentsEnabled": true,
    //         "paymentsProductTypes": [
    //           "sepaCreditTransfer"
    //         ],
    //         "periodicPaymentsEnabled": true,
    //         "periodicPaymentsProductTypes": [
    //           "sepaCreditTransfer"
    //         ],
    //         "primaryColor": "#7d39ff",
    //         "requiresCredentialStorage": false,
    //         "requiresCustomerIpAddress": false,
    //         "sandbox": true,
    //         "secondaryColor": "#3DF2C2",
    //         "sharedBrandName": null,
    //         "sharedBrandReference": null,
    //         "status": "beta"
    //       },
    //       "id": "d4100f28-936b-4379-a3f8-86314a2014fb",
    //       "links": {
    //         "self": "https://api.ibanity.com/xs2a/financial-institutions/d4100f28-936b-4379-a3f8-86314a2014fb"
    //       },
    //       "type": "financialInstitution"
    //     }
    //   ],
    //   "links": {
    //     "first": "https://api.ibanity.com/xs2a/financial-institutions"
    //   },
    //   "meta": {
    //     "paging": {
    //       "limit": 10
    //     }
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use the following online tool to generate parsing code from sample JSON:
    // Generate Parsing Code from JSON

    var attributesBic;
    var attributesBulkPaymentsEnabled;
    var attributesCountry;
    var attributesFinancialInstitutionCustomerReferenceRequired;
    var attributesFutureDatedPaymentsAllowed;
    var attributesLogoUrl;
    var attributesMaintenanceFrom;
    var attributesMaintenanceTo;
    var attributesMaintenanceType;
    var attributesMaxRequestedAccountReferences;
    var attributesMinRequestedAccountReferences;
    var attributesName;
    var attributesPaymentsEnabled;
    var attributesPeriodicPaymentsEnabled;
    var attributesPrimaryColor;
    var attributesRequiresCredentialStorage;
    var attributesRequiresCustomerIpAddress;
    var attributesSandbox;
    var attributesSecondaryColor;
    var attributesSharedBrandName;
    var attributesSharedBrandReference;
    var attributesStatus;
    var id;
    var linksSelf;
    var v_type;
    var j;
    var count_j;
    var strVal;

    var linksFirst = jResp.StringOf("links.first");
    var metaPagingLimit = jResp.IntOf("meta.paging.limit");
    var i = 0;
    var count_i = jResp.SizeOfArray("data");
    while (i < count_i) {
        jResp.I = i;
        attributesBic = jResp.StringOf("data[i].attributes.bic");
        attributesBulkPaymentsEnabled = jResp.BoolOf("data[i].attributes.bulkPaymentsEnabled");
        attributesCountry = jResp.StringOf("data[i].attributes.country");
        attributesFinancialInstitutionCustomerReferenceRequired = jResp.BoolOf("data[i].attributes.financialInstitutionCustomerReferenceRequired");
        attributesFutureDatedPaymentsAllowed = jResp.BoolOf("data[i].attributes.futureDatedPaymentsAllowed");
        attributesLogoUrl = jResp.StringOf("data[i].attributes.logoUrl");
        attributesMaintenanceFrom = jResp.StringOf("data[i].attributes.maintenanceFrom");
        attributesMaintenanceTo = jResp.StringOf("data[i].attributes.maintenanceTo");
        attributesMaintenanceType = jResp.StringOf("data[i].attributes.maintenanceType");
        attributesMaxRequestedAccountReferences = jResp.StringOf("data[i].attributes.maxRequestedAccountReferences");
        attributesMinRequestedAccountReferences = jResp.IntOf("data[i].attributes.minRequestedAccountReferences");
        attributesName = jResp.StringOf("data[i].attributes.name");
        attributesPaymentsEnabled = jResp.BoolOf("data[i].attributes.paymentsEnabled");
        attributesPeriodicPaymentsEnabled = jResp.BoolOf("data[i].attributes.periodicPaymentsEnabled");
        attributesPrimaryColor = jResp.StringOf("data[i].attributes.primaryColor");
        attributesRequiresCredentialStorage = jResp.BoolOf("data[i].attributes.requiresCredentialStorage");
        attributesRequiresCustomerIpAddress = jResp.BoolOf("data[i].attributes.requiresCustomerIpAddress");
        attributesSandbox = jResp.BoolOf("data[i].attributes.sandbox");
        attributesSecondaryColor = jResp.StringOf("data[i].attributes.secondaryColor");
        attributesSharedBrandName = jResp.StringOf("data[i].attributes.sharedBrandName");
        attributesSharedBrandReference = jResp.StringOf("data[i].attributes.sharedBrandReference");
        attributesStatus = jResp.StringOf("data[i].attributes.status");
        id = jResp.StringOf("data[i].id");
        linksSelf = jResp.StringOf("data[i].links.self");
        v_type = jResp.StringOf("data[i].type");
        j = 0;
        count_j = jResp.SizeOfArray("data[i].attributes.authorizationModels");
        while (j < count_j) {
            jResp.J = j;
            strVal = jResp.StringOf("data[i].attributes.authorizationModels[j]");
            j = j+1;
        }

        j = 0;
        count_j = jResp.SizeOfArray("data[i].attributes.bulkPaymentsProductTypes");
        while (j < count_j) {
            jResp.J = j;
            strVal = jResp.StringOf("data[i].attributes.bulkPaymentsProductTypes[j]");
            j = j+1;
        }

        j = 0;
        count_j = jResp.SizeOfArray("data[i].attributes.paymentsProductTypes");
        while (j < count_j) {
            jResp.J = j;
            strVal = jResp.StringOf("data[i].attributes.paymentsProductTypes[j]");
            j = j+1;
        }

        j = 0;
        count_j = jResp.SizeOfArray("data[i].attributes.periodicPaymentsProductTypes");
        while (j < count_j) {
            jResp.J = j;
            strVal = jResp.StringOf("data[i].attributes.periodicPaymentsProductTypes[j]");
            j = j+1;
        }

        i = i+1;
    }


}

chilkatExample();