(Tcl) Isabel Connect List Transactions

See more Ibanity Examples

Get a list of transactions for an account.

For more information, see https://documentation.ibanity.com/isabel-connect/api#list-accounts

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# Implements the following CURL command:

# curl -X GET https://api.ibanity.com/isabel-connect/accounts/93ecb1fdbfb7848e7b7896c0f2d207aed3d8b4c1/transactions \
# --cert certificate.pem:qwertyuiop1 \
# --key private_key.pem  \
# -H "Authorization: Bearer access_token_1603365408" \
# -H "Accept: application/vnd.api+json"  

# 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.)
set success [CkHttp_SetSslClientCertPfx $http "qa_data/pfx/my_ibanity_certificate.pfx" "my_pfx_password"]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    exit
}

# Load the previously obtained access token.
set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/isabel_access_token.json"]
if {$success == 0} then {
    puts "No existing access token."
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    exit
}

# This causes the "Authorization: Bearer ***" header to be added to the HTTP request.
CkHttp_put_AuthToken $http [CkJsonObject_stringOf $jsonToken "access_token"]

CkHttp_put_Accept $http "application/vnd.api+json"

CkHttp_SetUrlVar $http "id" "93ecb1fdbfb7848e7b7896c0f2d207aed3d8b4c1"
set jsonStr [CkHttp_quickGetStr $http "https://api.ibanity.com/isabel-connect/accounts/{$id}/transactions"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_Load $jResp $jsonStr
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastResponseHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    delete_CkJsonObject $jResp
    exit
}

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

# {
#   "data": [
#     {
#       "attributes": {
#         "amount": 80000,
#         "counterpartAccountReference": "BE21210123456703",
#         "counterpartFinancialInstitutionBic": "GEBABEBB",
#         "counterpartName": "MYBESTCLIENT",
#         "endToEndId": "UNIQUE CODE CUSTOMER",
#         "executionDate": "2018-10-15T08:34:17.417Z",
#         "internalId": "UNIQUE CODE BANK",
#         "remittanceInformation": "123456789002",
#         "remittanceInformationType": "structured-be",
#         "status": "Booked",
#         "valueDate": "2018-10-15T08:52:43.962Z"
#       },
#       "id": "14e2bff5-e365-4bc7-bf48-76b7bcd464e9",
#       "type": "transaction"
#     },
#     {
#       "attributes": {
#         "amount": 40000,
#         "counterpartAccountReference": "BE58400101010179",
#         "counterpartFinancialInstitutionBic": "KREDBEBB",
#         "counterpartName": "MYGOODCLIENT",
#         "endToEndId": null,
#         "executionDate": "2018-10-15T08:34:17.417Z",
#         "internalId": null,
#         "remittanceInformation": "FREE COMMUNICATION",
#         "remittanceInformationType": "unstructured",
#         "status": "Booked",
#         "valueDate": "2018-10-15T08:52:43.962Z"
#       },
#       "id": "29b0f52e-a389-4ff8-88e1-cc30c12b789f",
#       "type": "transaction"
#     },
#     {
#       "attributes": {
#         "amount": -20000,
#         "counterpartAccountReference": "BE56300694353788",
#         "counterpartFinancialInstitutionBic": null,
#         "counterpartName": "MY SUPPLIER",
#         "endToEndId": null,
#         "executionDate": "2018-10-15T08:34:17.417Z",
#         "internalId": null,
#         "remittanceInformation": "999000000171",
#         "remittanceInformationType": "structured-be",
#         "status": "Booked",
#         "valueDate": "2018-10-15T08:52:43.962Z"
#       },
#       "id": "7d79a28e-b45d-4595-b98e-7c18871ee208",
#       "type": "transaction"
#     }
#   ],
#   "meta": {
#     "paging": {
#       "offset": 0,
#       "total": 3
#     }
#   }
# }

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

set metaPagingOffset [CkJsonObject_IntOf $jResp "meta.paging.offset"]
set metaPagingTotal [CkJsonObject_IntOf $jResp "meta.paging.total"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set attributesAmount [CkJsonObject_IntOf $jResp "data[i].attributes.amount"]
    set attributesCounterpartAccountReference [CkJsonObject_stringOf $jResp "data[i].attributes.counterpartAccountReference"]
    set attributesCounterpartFinancialInstitutionBic [CkJsonObject_stringOf $jResp "data[i].attributes.counterpartFinancialInstitutionBic"]
    set attributesCounterpartName [CkJsonObject_stringOf $jResp "data[i].attributes.counterpartName"]
    set attributesEndToEndId [CkJsonObject_stringOf $jResp "data[i].attributes.endToEndId"]
    set attributesExecutionDate [CkJsonObject_stringOf $jResp "data[i].attributes.executionDate"]
    set attributesInternalId [CkJsonObject_stringOf $jResp "data[i].attributes.internalId"]
    set attributesRemittanceInformation [CkJsonObject_stringOf $jResp "data[i].attributes.remittanceInformation"]
    set attributesRemittanceInformationType [CkJsonObject_stringOf $jResp "data[i].attributes.remittanceInformationType"]
    set attributesStatus [CkJsonObject_stringOf $jResp "data[i].attributes.status"]
    set attributesValueDate [CkJsonObject_stringOf $jResp "data[i].attributes.valueDate"]
    set id [CkJsonObject_stringOf $jResp "data[i].id"]
    set v_type [CkJsonObject_stringOf $jResp "data[i].type"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $jsonToken
delete_CkJsonObject $jResp