Fabrick Pass Access
Il pacchetto API Access consente agli FPP di ottenere informazioni sullo stato dei workflow e sugli utenti finali con i relativi saldi, transazioni e consensi.
I servizi API descritti di seguito sono validi sia per il prodotto Standard AIS Pass sia per il prodotto One Shot AIS Pass.
Get the ASPSPs list
Per visualizzare l’elenco delle banche disponibili, è possibile invocare la API POST Search Banks.
Per PISP
POST /v4.0/initiate/lite-banks/search
e per AISP
POST /v4.0/access/lite-banks/search
Ogni elemento dell’elenco conterrà informazioni relative alla banca e utili per completare un’interfaccia grafica, come il labelName.
È inoltre possibile ottenere il dettaglio di una singola banca tramite la API GET Get Bank:
per il prodotto PIS
GET /v4.0/initiate/banks/{{bankId}}
e per il prodotto AIS
GET /v4.0/access/banks/{{bankId}}
Per i dettagli fare riferimento al documento "Bank details".
Search Users
Questo endpoint consente di ottenere l’elenco di tutti gli utenti che hanno sottoscritto un servizio con l’FPP. Nella request l’FPP può inserire una serie di filtri come parametri oppure non inserire alcun parametro.
Request
POST api/fabrick/pass/v4.0/access/users/search
{
"status": "OK",
"payload": {
"list": [
{
"userCompanyCode": "USER_CODE",
"userId": "900002870",
"companyId": "22",
"hasActiveContract": true,
"hasActiveAuthorizations": true
},
{
"userCompanyCode": "nathan.romano@fabrick.com",
"userId": "900002871",
"companyId": "22",
"hasActiveContract": true,
"hasActiveAuthorizations": true
}
]
}
}
Filtri con cui l’FPP può ricercare gli utenti:
- companyUserCode codice con cui l’FPP identifica univocamente ciascuno dei propri clienti e grazie al quale sarà possibile mappare le informazioni dell’utente in Fabrick;
- hasActiveContracts, boolean che identifica se un contratto FPP è attivo (true) o inattivo (false)
- hasActiveAuthorizations: boolean che identifica se un utente ha autorizzazioni su conto attive (true) o inattive (false)
- companyId, codice identificativo dell’FPP
- userId, codice che identifica univocamente un utente all’interno di Fabrick
L’oggetto "user" viene creato all’interno dei database di Fabrick al termine della fase di accettazione durante il processo di onBoarding: il servizio POST SearchUser non restituirà uno specifico utente se non ha ancora completato i passaggi necessari.
Se l’FPP desidera ottenere tutti gli utenti inclusi quelli con contratto inattivo, può inserire un query parameter allUsers = true nell’endpoint
POST api/fabrick/pass/v4.0/access/users/search?allUsers=true
{
"status": "OK",
"payload": {
"list": [
{
"userCompanyCode": "USER_CODE",
"userId": "900002870",
"companyId": "22",
"hasActiveContract": true,
"hasActiveAuthorizations": true
},
{
"userCompanyCode": "nathan.romano@fabrick.com",
"userId": "900002871",
"companyId": "22",
"hasActiveContract": true,
"hasActiveAuthorizations": true
}
]
}
}
Get the customers accounts list
Per ottenere l’elenco dei conti di un cliente sarà sufficiente invocare la API GET Accounts:
GET /v4.0/access/users/{userId}/accounts
In risposta si otterrà l’elenco dei conti dell’utente, ogni elemento dell’array contiene tutte le informazioni relative al conto stesso come mostrato nell’esempio seguente, ottenuto invocando la API GET Get Account
GET /v4.0/access/users/{userId}/accounts/{accountId}
Per i dettagli e un esempio di risposta fare riferimento a Accounts Details.
Get customers balances
Per ottenere i saldi l’FPP dovrà invocare GET Get Account Balances. L’FPP può ottenere le informazioni di saldo per un singolo conto
GET /v4.0/access/users/{userId}/accounts/{accountId}/balances
oppure per tutti i conti di un singolo utente
GET api/fabrick/pass/v4.0/access/user/{{userId}}/account-balances
Per i dettagli e un esempio di risposta fare riferimento a Balances Details.
Get customers transactions (deprecated)
Per ottenere le transazioni l’FPP dovrà invocare GET Get Account Transactions
GET /v4.0/access/users/{userId}/accounts/{accountId}/transactions
Ovviamente è possibile filtrare per data:
GET /v4.0/access/users/{userId}/accounts/{accountId}/transactions?from=2021-02-05&to=2021-05-05
Se i parametri from e to non sono indicati, verranno recuperati i movimenti degli ultimi 90 giorni.
È possibile ottenere l’intero elenco delle transazioni di uno specifico utente
GET api/fabrick/pass/v4.0/access/user/{{userId}}/account-transactions
Per i dettagli e un esempio di risposta fare riferimento a Transactions Details.
Get PFM Movements
Fabrick Pass dispone di un servizio per ottenere le transazioni cliente arricchite grazie a Fabrick PFM.
GET /v4.0/access/users/{{userId}}/accounts/movements/transactions?accountId=401&fromDate=1617573600000&toDate=1617583600000
In questo caso, se si desidera filtrare per data, il timestamp è in millisecondi.
È possibile aggiungere diversi accountId:
GET /v4.0/access/users/{{userId}}/accounts/movements/transactions?accountId=1&accountId=2
Per i dettagli e un esempio di risposta fare riferimento a PFM Details.