Account

Retrieves an Account

Retrieves an Account - Please note that extra fields are optional and can differ between financial institutions.

SecurityBearer
Request
path Parameters
uuid
required
string <uuid>
Responses
200

Account resource

404

Resource not found

get/accounts/{uuid}
Request samples 
Response samples 
{
  • "uuid": "string",
  • "fiscalId": "string",
  • "accountId": "string",
  • "providerName": "string",
  • "providerCountry": "string",
  • "name": "string",
  • "nature": "string",
  • "balance": "string",
  • "currencyCode": "string",
  • "enabled": true,
  • "consentExpiresAt": "2019-08-24T14:15:22Z",
  • "iban": "string",
  • "bban": "string",
  • "swift": "string",
  • "accountNumber": "string",
  • "extra": {
    },
  • "systems": [
    ]
}
Enables/Disables an Account
Enables/Disables an Account. Disabling an account also clears its balance, extra data and transactions.


SecurityBearer 
Request 
path Parameters
uuid
required
string <uuid> 
 
Request Body schema: 
required
The updated Account resource


enabled
boolean
 
Responses 
200
Account resource updated


400
Invalid input


404
Resource not found


422
Unprocessable entity


put/accounts/{uuid}
Request samples 
{
  • "enabled": true
}
Response samples 
{
  • "uuid": "string",
  • "fiscalId": "string",
  • "accountId": "string",
  • "providerName": "string",
  • "providerCountry": "string",
  • "name": "string",
  • "nature": "string",
  • "balance": "string",
  • "currencyCode": "string",
  • "enabled": true,
  • "consentExpiresAt": "2019-08-24T14:15:22Z",
  • "iban": "string",
  • "bban": "string",
  • "swift": "string",
  • "accountNumber": "string",
  • "extra": {
    },
  • "systems": [
    ]
}
Starts reconnection process for an Account
This API starts the reconnection process for an account and for all the other accounts coming from the same financial institution. 
                    Reconnection is needed after 90 days days from the first connection to renew consent to read financial data.
                    During this process the user will be redirected to a page where it will be possible to select reconnection options. 
                    Please note that extra fields are optional and can differ between financial institutions.


SecurityBearer 
Request 
path Parameters
uuid
required
string <uuid> 
 
Responses 
200
Account resource


404
Resource not found


get/accounts/{uuid}/reconnect
Request samples 
Response samples 
{
  • "reconnectUrl": "string"
}
Retrieves the collection of Account resources for a given business registry.
Retrieves the collection of Account resources for a given business registry.
                    You can optionally filter accounts by a single IBAN or a set of IBANs. 
                    For filtering multiple IBANs use this syntax 


                /business-registry/{fiscalId}/accounts?iban[]=SAMPLE_1&iban[]=SAMPLE_2



SecurityBearer 
Request 
path Parameters
fiscalId
required
string
 
query Parameters
page
integer
 Default:  1
The collection page number


 
itemsPerPage
integer  [ 0 .. 100 ] 
 Default:  30
The number of items per page


 
enabled
boolean
 
iban
string
 
iban[]
Array of strings
 
Responses 
200
Account collection


get/business-registry/{fiscalId}/accounts
Request samples 
Response samples 
[
  • {
    }
]