(Delphi ActiveX) 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

Chilkat for Delphi Downloads Chilkat ActiveX DLL for Delphi Chilkat non-ActiveX DLL for Delphi * The examples here use the ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

...

procedure TForm1.Button1Click(Sender: TObject);
var
cert: TChilkatCert;
success: Integer;
dtNow: TCkDateTime;
created: WideString;
crypt2: TChilkatCrypt2;
sbDigestHdrValue: TChilkatStringBuilder;
request_target: WideString;
sbSigningString: TChilkatStringBuilder;
signed_headers_list: WideString;
privKey: TPrivateKey;
rsa: TChilkatRsa;
sigBase64: WideString;
sbSigHeaderValue: TChilkatStringBuilder;
http: TChilkatHttp;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
attributesBic: WideString;
attributesBulkPaymentsEnabled: Integer;
attributesCountry: WideString;
attributesFinancialInstitutionCustomerReferenceRequired: Integer;
attributesFutureDatedPaymentsAllowed: Integer;
attributesLogoUrl: WideString;
attributesMaintenanceFrom: WideString;
attributesMaintenanceTo: WideString;
attributesMaintenanceType: WideString;
attributesMaxRequestedAccountReferences: WideString;
attributesMinRequestedAccountReferences: Integer;
attributesName: WideString;
attributesPaymentsEnabled: Integer;
attributesPeriodicPaymentsEnabled: Integer;
attributesPrimaryColor: WideString;
attributesRequiresCredentialStorage: Integer;
attributesRequiresCustomerIpAddress: Integer;
attributesSandbox: Integer;
attributesSecondaryColor: WideString;
attributesSharedBrandName: WideString;
attributesSharedBrandReference: WideString;
attributesStatus: WideString;
id: WideString;
linksSelf: WideString;
v_type: WideString;
j: Integer;
count_j: Integer;
strVal: WideString;
linksFirst: WideString;
metaPagingLimit: Integer;
i: Integer;
count_i: Integer;

begin
// 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 := TChilkatCert.Create(Self);
success := cert.LoadPfxFile('qa_data/pfx/my_ibanity_certificate.pfx','my_pfx_password');
if (success = 0) then
  begin
    Memo1.Lines.Add(cert.LastErrorText);
    Exit;
  end;

// 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.

dtNow := TCkDateTime.Create(Self);
dtNow.SetFromCurrentSystemTime();
created := dtNow.GetAsUnixTimeStr(0);

crypt2 := TChilkatCrypt2.Create(Self);
crypt2.HashAlgorithm := 'sha512';
crypt2.EncodingMode := 'base64';

sbDigestHdrValue := TChilkatStringBuilder.Create(Self);
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(''));

Memo1.Lines.Add('Generated Digest');
Memo1.Lines.Add(sbDigestHdrValue.GetAsString());

request_target := 'get /xs2a/financial-institutions';

sbSigningString := TChilkatStringBuilder.Create(Self);
sbSigningString.Append('(request-target): ');
sbSigningString.AppendLine(request_target,0);
sbSigningString.Append('host: ');
sbSigningString.AppendLine('api.ibanity.com',0);
sbSigningString.Append('digest: ');
sbSigningString.AppendLine(sbDigestHdrValue.GetAsString(),0);
sbSigningString.Append('(created): ');
sbSigningString.Append(created);
// ibanity-idempotency-key is not used with GET requests.

Memo1.Lines.Add('Signing String:');
Memo1.Lines.Add(sbSigningString.GetAsString());

signed_headers_list := '(request-target) host digest (created)';

privKey := TPrivateKey.Create(Self);
success := privKey.LoadEncryptedPemFile('my_ibanity_signature_private_key.pem','pem_password');
if (success = 0) then
  begin
    Memo1.Lines.Add(privKey.LastErrorText);
    Exit;
  end;

rsa := TChilkatRsa.Create(Self);
rsa.PssSaltLen := 32;
rsa.EncodingMode := 'base64';
// Use the RSASSA-PSS signature algorithm
rsa.OaepPadding := 1;

success := rsa.ImportPrivateKeyObj(privKey.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(rsa.LastErrorText);
    Exit;
  end;

// Sign the signing string.
sigBase64 := rsa.SignStringENC(sbSigningString.GetAsString(),'sha-256');
if (rsa.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(rsa.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add('Signature:');
Memo1.Lines.Add(sigBase64);

// Build the signature header value.
sbSigHeaderValue := TChilkatStringBuilder.Create(Self);
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 := TChilkatHttp.Create(Self);

success := http.SetSslClientCert(cert.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

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

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://api.ibanity.com/xs2a/financial-institutions',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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

linksFirst := jResp.StringOf('links.first');
metaPagingLimit := jResp.IntOf('meta.paging.limit');
i := 0;
count_i := jResp.SizeOfArray('data');
while i < count_i do
  begin
    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 do
      begin
        jResp.J := j;
        strVal := jResp.StringOf('data[i].attributes.authorizationModels[j]');
        j := j + 1;
      end;

    j := 0;
    count_j := jResp.SizeOfArray('data[i].attributes.bulkPaymentsProductTypes');
    while j < count_j do
      begin
        jResp.J := j;
        strVal := jResp.StringOf('data[i].attributes.bulkPaymentsProductTypes[j]');
        j := j + 1;
      end;

    j := 0;
    count_j := jResp.SizeOfArray('data[i].attributes.paymentsProductTypes');
    while j < count_j do
      begin
        jResp.J := j;
        strVal := jResp.StringOf('data[i].attributes.paymentsProductTypes[j]');
        j := j + 1;
      end;

    j := 0;
    count_j := jResp.SizeOfArray('data[i].attributes.periodicPaymentsProductTypes');
    while j < count_j do
      begin
        jResp.J := j;
        strVal := jResp.StringOf('data[i].attributes.periodicPaymentsProductTypes[j]');
        j := j + 1;
      end;

    i := i + 1;
  end;
end;