Sample code for 30+ languages & platforms
Java Requires Chilkat v11.0.0+

Ibanity XS2A List Financial Institutions

See more Ibanity Examples

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

Chilkat Java Downloads

Chilkat2 Java
import com.chilkatsoft.chilkat2.Cert;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Crypt2;
import com.chilkatsoft.chilkat2.DateTime;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.PrivateKey;
import com.chilkatsoft.chilkat2.Rsa;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

    public static void main(String[] args) {
        // 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.)
        Cert cert = new Cert();
        try {
            cert.loadPfxFile("qa_data/pfx/my_ibanity_certificate.pfx", "my_pfx_password");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            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.

        DateTime dtNow = new DateTime();
        dtNow.setFromCurrentSystemTime();
        String created = dtNow.getAsUnixTimeStr(false);

        Crypt2 crypt2 = new Crypt2();
        crypt2.setHashAlgorithm("sha512");
        crypt2.setEncodingMode("base64");

        StringBuilder sbDigestHdrValue = new 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(""));

        System.out.println("Generated Digest");
        System.out.println(sbDigestHdrValue.getAsString());

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

        StringBuilder sbSigningString = new 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.

        System.out.println("Signing String:");
        System.out.println(sbSigningString.getAsString());

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

        PrivateKey privKey = new PrivateKey();
        try {
            privKey.loadEncryptedPemFile("my_ibanity_signature_private_key.pem", "pem_password");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        Rsa rsa = new Rsa();
        rsa.setPssSaltLen(32);
        rsa.setEncodingMode("base64");
        // Use the RSASSA-PSS signature algorithm
        rsa.setPkcsPadding(false);

        String sigBase64;
        try {
            rsa.usePrivateKey(privKey);

            // Sign the signing string.
            sigBase64 = rsa.signStringENC(sbSigningString.getAsString(), "sha-256");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println("Signature:");
        System.out.println(sigBase64);

        // Build the signature header value.
        StringBuilder sbSigHeaderValue = new 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..
        Http http = new Http();

        try {
            http.setSslClientCert(cert);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        http.setRequestHeader("Signature", sbSigHeaderValue.getAsString());
        http.setRequestHeader("Digest", sbDigestHdrValue.getAsString());

        StringBuilder sbResponseBody = new StringBuilder();
        try {
            http.quickGetSb("https://api.ibanity.com/xs2a/financial-institutions", sbResponseBody);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        JsonObject jResp = new JsonObject();
        jResp.loadSb(sbResponseBody);
        jResp.setEmitCompact(false);

        System.out.println("Response Body:");
        System.out.println(jResp.emit());

        int respStatusCode = http.getLastStatus();
        System.out.println("Response Status Code = " + respStatusCode);
        if (respStatusCode >= 400) {
            System.out.println("Response Header:");
            System.out.println(http.getLastHeader());
            System.out.println("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

        String attributesBic = "";
        boolean attributesBulkPaymentsEnabled = false;
        String attributesCountry = "";
        boolean attributesFinancialInstitutionCustomerReferenceRequired = false;
        boolean attributesFutureDatedPaymentsAllowed = false;
        String attributesLogoUrl = "";
        String attributesMaintenanceFrom = "";
        String attributesMaintenanceTo = "";
        String attributesMaintenanceType = "";
        String attributesMaxRequestedAccountReferences = "";
        int attributesMinRequestedAccountReferences = 0;
        String attributesName = "";
        boolean attributesPaymentsEnabled = false;
        boolean attributesPeriodicPaymentsEnabled = false;
        String attributesPrimaryColor = "";
        boolean attributesRequiresCredentialStorage = false;
        boolean attributesRequiresCustomerIpAddress = false;
        boolean attributesSandbox = false;
        String attributesSecondaryColor = "";
        String attributesSharedBrandName = "";
        String attributesSharedBrandReference = "";
        String attributesStatus = "";
        String id = "";
        String linksSelf = "";
        String v_type = "";
        int j = 0;
        int count_j = 0;
        String strVal = "";

        String linksFirst = jResp.stringOf("links.first");
        int metaPagingLimit = jResp.intOf("meta.paging.limit");
        int i = 0;
        int count_i = jResp.sizeOfArray("data");
        while (i < count_i) {
            jResp.setI(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.setJ(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.setJ(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.setJ(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.setJ(j);
                strVal = jResp.stringOf("data[i].attributes.periodicPaymentsProductTypes[j]");
                j = j + 1;
            }

            i = i + 1;
        }
    }
}