Account Information API
Test
You can easily test the APIs in the Ecster Sandbox https://openbanking.sandbox.ecster.com by using the certificate ecstersandbox.tpp27_cert.pfx (password: secret)
Sweden
Use our test persona who's National ID is 'SE430818-9440'. She has one account with 6 transactions, all of which are dated 2020-01-28.
Finland
Use our test persona who's National ID is 'FI270251-979S'. She has one account with 6 transactions, all of which are dated 2021-09-23.
Live
For live data you must be registered as an Account Information Service Provider (AISP) and have a valid eIDAS certificate.
Consent API
Create consent
POST /v1/consents/
Request
- nationalId (String) [0-1] : e.g. SE430818-9440
- id (String) [1] : consent ID
- status (String) [1] : "RECEIVED"
- created(Date) [1] : UTC format, e.g. "2020-01-23T09:27:06.761+01:00"
- expires(Date) [1]: UTC format, e.g. "2020-04-22T09:27:06.761+02:00"
code 4003 (400): invalid nationalId
code 4303 (403): certificate is not ETSI compliant or is not of QWAC type
code 4303 (403): missing role AIS in certificate
code 5001 (500): system error
Get consent
GET /v1/consents/{{consentId}}
- <ID> (String) [1] : consent ID
- id (String) [1] : consent ID
- status (String) [1] : "RECEIVED", "REJECTED", "SIGNED", "REVOKED", "EXPIRED", "TERMINATED"
- created(Date) [1] : UTC format, e.g. "2020-01-23T09:27:06.761+01:00"
- expires(Date) [1]: UTC format, e.g. "2020-04-22T09:27:06.761+02:00"
code 4303 (403): not authorized to requested resource
code 4303 (403): certificate is not ETSI compliant or is not of QWAC type
code 4303 (403): missing role AIS in certificate
code 4100 (404): requested resource not found
code 5001 (500): system error
Inititate signing consent
POST /v1/consents/{{consentId}}/signatures
- <ID> (String) [1] : consent ID
- identificationMethod(String) [1]
- id (String) [1] : signing ID
- status (String) [1] : "OUTSTANDING_TRANSACTION"
- startURL(String): e.g. "bankid:///?autostarttoken=DUMMY-AUTOSTART"
- pollTime(int)[1]:
code 4003 (400): invalid identificationMethod
code 4303 (403): not authorized to requested resource
code 4303 (403): certificate is not ETSI compliant or is not of QWAC type
code 4303 (403): missing role AIS in certificate
code 4100 (404): requested resource not found
code 4424 (422): consent in invalid state
code 5001 (500): system error
Get status signing
GET /consents/{{consentId}}/signatures/{{signId}}
- <consentId> (String) [1] : consentIdID
- <signId> (String) [1] : signing ID
- id (String) [1] : signing ID
- status (String) [1] : "COMPLETE", "TECHNICAL_ERROR", "CANCELLED", "OUTSTANDING_TRANSACTION", "NO_CLIENT", "STARTED", "USER_SIGN", "ALREADY_IN_PROGRESS", "EXPIRED_TRANSACTION", "CERTIFICATE_ERROR", "USER_CANCEL", "START_FAILED"
- pollTime(int)[1]:
code 4303 (403): not authorized to requested resource
code 4303 (403): certificate is not ETSI compliant or is not of QWAC type
code 4303 (403): missing role AIS in certificate
code 4100 (404): requested resource not found
code 5001 (500): system error
Delete consent
DELETE /v1/consents/{{consentId}}
- id (String) [1] : consent ID
- status (String) [1] : "TERMINATED"
- created(Date) [1] : UTC format, e.g. "2020-01-23T09:27:06.761+01:00"
- expires(Date) [1]: UTC format, e.g. "2020-04-22T09:27:06.761+02:00"
code 4303 (403): not authorized to requested resource
code 4303 (403): certificate is not ETSI compliant or is not of QWAC type
code 4303 (403): missing role AIS in certificate
code 4100 (404): requested resource not found
code 5001 (500): system error
Account Information API
Get Accounts
GET /v1/accounts
X-ECSTER-consent-id | {{consentId}} |
---|
Response
accounts [0-*] :
- accountNumber(String): account number
- reference(String): account reference
- product
- id(String): id of product , only for SE
- name(String): name of product
- status(String): "ACTIVE", "TERMINATED"
- limit(int): approved limit on account in cents, local currency
- used(int): used limit on account in cents, local currency
{ "accounts" : [ { "accountNumber" : "9852859536039808" , "reference" : "CHwNc38BDlRXD3QBSnNlSwRWNzdGVyLVNIQgxxxxx" , "product" : { "id" : "MCARD001" , "name" : "ECSTER" }, "status" : "ACTIVE" , "limit" : 1700000 , "used" : 1550000 } ] } |
{ "accounts" : [ {
"accountNumber": "0000276489315675488",
"reference": "AXQIcXUDAVVcAHcDRn1iRnwPAARWNzdGVyLVNIQgx", "product": {
"name": "Kodin remontointi" },
"status": "ACTIVE",
"limit": 1000000,
"used": 322500
} ] } |
Get account
GET /v1/accounts/{{reference}}
X-ECSTER-consent-id | {{consentId}} |
---|
- <reference> (String) [1] : account reference
- accountNumber(String): account number
- product
- id(String): id of product, only for SE
- name(String): name of product
- status(String): "ACTIVE", "TERMINATED"
- limit(int): approved limit on account in cents, local currency
- used(int): used limit on account in cents, local currency
{ "accountNumber" : "9852859536039808" , "product" : { "id" : "MCARD001" , "name" : "ECSTER" }, "status" : "ACTIVE" , "limit" : 1700000 , "used" : 1550000 } |
{ "accountNumber": "0000276489315675488", "product": { "name": "Kodin remontointi" }, "status": "ACTIVE", "limit": 1000000, "used": 322500 } |
Get account transactions
GET /v1/accounts/{{reference}}/transactions?from=<fromDate>&to=<toDate>
X-ECSTER-consent-id | {{consentId}} |
---|
- <reference> (String) [1] : account reference
- <fromDate> (Date) [0-1]: UTC format, YYYY-MM-DD fetch transactions from this date (if not sent fromDate is set to todays date minus 3 months)
- <toDate> (Date) [0-1]: UTC format, YYYY-MM-DD fetch transactions to this date (if not sent toDate is set to todays date)
transactions [0-*] :
- id (String) [1]: an identifier that uniquely identifies the transaction
- date(Date) [1]: date when transaction occurred
- description(String): description of transaction
- amount(int)[1]: transaction amount in cents
- currency(String): ex. "SEK"
- foreign [0-1]:
- amount (Amount) [1]: amount in foreign currency in cents
- currency (String) [1]: foreign currency
- exchangeRate (double) [1]: exchange rate between currencies at transaction time
- type(String): "DEBIT", "CREDIT", "RESERVED_AMOUNT"
{ "transactions" : [ { "id" : "ACSX_1956800274_1435008090" , "date" : "2020-01-28T13:54:04+01:00" , "description" : "STORE" , "amount" : 50000 , "currency" : "SEK" , "type" : "DEBIT" }, { "id" : "ACSX_1716118228_394540276" , "date" : "2020-01-28T13:54:38+01:00" , "description" : "STORE" , "amount" : 100000 , "currency" : "SEK" , "type" : "DEBIT" }, { "id" : "ACSX_2007944557_814816897" , "date" : "2020-01-28T13:54:44+01:00" , "description" : "STORE" , "amount" : 200000 , "currency" : "SEK" , "foreign" : { "amount" : 23484 , "currency" : "USD" , "exchangeRate" : 852 }, "type" : "DEBIT" }, { "id" : "ACSX_1776405562_797961953" , "date" : "2020-01-28T13:54:51+01:00" , "description" : "STORE" , "amount" : 300000 , "currency" : "SEK" , "type" : "DEBIT" }, { "id" : "ACSX_651332047_206840303" , "date" : "2020-01-28T13:54:57+01:00" , "description" : "STORE" , "amount" : 400000 , "currency" : "SEK" , "type" : "DEBIT" }, { "id" : "ACSX_934931316_1852861035" , "date" : "2020-01-28T13:55:01+01:00" , "description" : "STORE" , "amount" : 500000 , "currency" : "SEK" , "type" : "DEBIT" } ] }
|
{ "transactions": [
{
"id": "1160945585_1586762245",
"date": "2021-09-27T10:46:40+02:00", "description": "Ecster Finland", "amount": 10000, "currency": "EUR", "type": "DEBIT" }, { "id": "1563633320_82054339", "date": "2021-09-27T10:49:19+02:00", "description": "Ecster Finland", "amount": 5000, "currency": "EUR", "type": "DEBIT" }, { "id": "1282980576_1016557217", "date": "2021-09-27T10:49:57+02:00", "description": "Ecster Finland", "amount": 250000, "currency": "EUR", "foreign": { "amount": 107228, "currency": "OMR", "exchangeRate": 233 }, "type": "DEBIT" }, { "id": "820290398_112739828", "date": "2021-09-27T10:51:01+02:00", "description": "Ecster Finland", "amount": 7500, "currency": "EUR", "type": "DEBIT" }, { "id": "2108131051_986641293", "date": "2021-09-27T10:51:50+02:00", "description": "Ecster Finland", "amount": 20000, "currency": "EUR", "type": "DEBIT" }, { "id": "2088596315_831481638", "date": "2021-09-27T10:51:55+02:00", "description": "Ecster Finland", "amount": 30000, "currency": "EUR", "type": "DEBIT" } ] } |