AISP
Last changes: 10-28-2022
Most API methods require to specify the customer account number (parameter "accno") and the program code (parameter "programCode"), which acts as an identifier for the marketplace.
To obtain these parameters, call the API Method 1.17 Find User Account and specify the customer email address in the parameter "userId".
Find User Account Request
Path:
GET {baseURL}/account/find?partnerReference=50F45B51E07D4CE1ABB1676E3DF5BB44&programCode=COMPANY&userId=user@example.com&localDate=2019-09-17&localTime=131415
Header:
Content-Type: application/json
Accept-Language: en-US
Find User Account Response
Status Code:
200 (OK)
Header:
Content-Type: application/json
Accept-Language: en-US
{
"accno": "1000104149",
"partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
"programCode": "COMPANY",
"localDate": "2019-09-17",
"localTime": "131415",
"sysDate": "2019-09-17",
"sysTime": "121420",
"responseCode": "0000",
"responseDescription": "Successful execution",
"additionalInformation": {
"requestId": "aff2728481a181dc36daedc14055b516"
}
}Our API allows you to retrieve various information regarding the customer account.
Balance Enquiry
The API method 1.8 Balance Enquiry returns the current available balance on the account as shown in the sample below.
Balance Enquiry Request
-
Path:
-
GET {baseURL}/account/1000104149/balance?partnerReference=50F45B51E07D4CE1ABB1676E3DF5BB44&progr amCode=COMPANY&accnoType=01&localDate=2019-09-17&localTime=131415
-
Header:
-
Content-Type: application/json
Accept-Language: en-US
Balance Enquiry Response
-
Status Code:
-
200 (OK)
-
Header:
-
Content-Type: application/json
Accept-Language: en-US
{
"accno": "1000104149",
"psBal": 0,
"avlBal": 120.34,
"bkBal": 120.34,
"blkAmt": 0,
"pooledAmt": 0,
"currCode": "EUR",
"partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
"programCode": "COMPANY",
"localDate": "2019-09-17",
"localTime": "000000",
"sysDate": "2019-09-17",
"sysTime": "131950",
"responseCode": "0000",
"responseDescription": "Successful execution",
"additionalInformation": {
"requestId": "aff2728481a181dc36daedc14055b516"
}
}
Account Enquiry
Additionally, you can call 1.7 Account Enquiry to obtain the performed (and pending) transactions by the account holder.
Account Enquiry Request
-
Path:
-
GET {Base URL}/account/1000104149/enquiry?partnerReference=50F45B51E07D4CE1ABB1676E3DF5BB44&programCode=COMPANY&accnoType=01&startDate=2019-09-01&endDate=2019-09-10&top=100&includePendingTransactions=false&localDate=2019-09-17&localTime=163835
-
Header:
-
Content-Type: application/json
Accept-Language: en-US
Accpunt Enquiry Response
-
Status Code:
-
200 (OK)
-
Header:
-
Content-Type: application/json
Accept-Language: en-US
{
"partnerReference": "50F45B51E07D4CE1ABB1676E3DF5BB44",
"programCode": "COMPANY",
"accno": "1000104149",
"count": 2,
"entries": [
{
"isPending": false,
"bookingDate": "2019-09-02",
"bookingTime": "221133",
"valueDate": "2019-09-02",
"valueTime": "102030",
"sourceAmount": 5.00,
"sourceCurrCode": "EUR",
"amount": 5.00,
"currCode": "EUR",
"exchangeRate": 1.00,
"balance": 45.00,
"entryIndicator": "DBIT",
"description": "XXXXXXXXXXXXXXXXXX",
"name": "John Doe",
"entryType": "Payment",
"reference": "3150a55a754c443d86398dfab1be7afa",
"statusCode": "SETTLED",
"paymentOptionCode": "MSTRCRD"
},
{
"isPending": false,
"bookingDate": "2019-09-05",
"bookingTime": "221133",
"valueDate": "2019-09-05",
"valueTime": "102030",
"sourceAmount": 5.00,
"sourceCurrCode": "EUR",
"amount": 5.00,
"currCode": "EUR",
"exchangeRate": 1.00,
"balance": 40.00,
"entryIndicator": "DBIT",
"description": "XXXXXXXXXXXXXXXXXX",
"name": "John Doe",
"entryType": "Payment",
"reference": "f7e4fb07f0364d1288d535274bc02da6",
"statusCode": "SETTLED",
"paymentOptionCode": "MSTRCRD"
}
],
"localDate": "2019-09-17",
"localTime": "163835",
"sysDate": "2019-09-17",
"sysTime": "153837",
"responseCode": "0000",
"responseDescription": "Successful execution.",
"additionalInformation": {
"requestId": "aff2728481a181dc36daedc14055b516"
}
}