budgea_client 4.0.3 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/README.md +50 -5
- data/budgea_openapi.json +1888 -383
- data/docs/Account.md +2 -0
- data/docs/AccountLog.md +1 -0
- data/docs/AdministrationApi.md +366 -55
- data/docs/AuthenticationApi.md +15 -13
- data/docs/BanksApi.md +988 -194
- data/docs/Client.md +1 -1
- data/docs/Connection.md +2 -0
- data/docs/ConnectionLog.md +1 -0
- data/docs/ConnectionSource.md +18 -0
- data/docs/ConnectionsApi.md +618 -25
- data/docs/Connector.md +1 -1
- data/docs/ConnectorSource.md +15 -0
- data/docs/DocumentsApi.md +72 -72
- data/docs/Field.md +1 -0
- data/docs/InlineResponse20011.md +1 -1
- data/docs/InlineResponse20012.md +1 -1
- data/docs/InlineResponse20013.md +1 -1
- data/docs/InlineResponse20014.md +1 -1
- data/docs/InlineResponse20015.md +1 -1
- data/docs/InlineResponse20016.md +1 -1
- data/docs/InlineResponse20017.md +1 -1
- data/docs/InlineResponse20018.md +1 -1
- data/docs/InlineResponse20019.md +2 -1
- data/docs/InlineResponse20030.md +1 -1
- data/docs/InlineResponse20031.md +1 -1
- data/docs/InlineResponse20032.md +1 -1
- data/docs/InlineResponse20033.md +1 -1
- data/docs/InlineResponse20034.md +1 -1
- data/docs/InlineResponse20035.md +1 -1
- data/docs/InlineResponse20036.md +1 -1
- data/docs/InlineResponse20037.md +1 -1
- data/docs/InlineResponse20038.md +1 -1
- data/docs/InlineResponse20039.md +1 -1
- data/docs/InlineResponse20040.md +1 -1
- data/docs/InlineResponse20041.md +9 -0
- data/docs/InlineResponse20042.md +9 -0
- data/docs/OIDCApi.md +3 -3
- data/docs/Order.md +14 -0
- data/docs/PFMApi.md +87 -39
- data/docs/ProvidersApi.md +979 -122
- data/docs/RecipientsApi.md +4 -4
- data/docs/Subscription.md +1 -0
- data/docs/SubscriptionLog.md +15 -0
- data/docs/TermsApi.md +3 -3
- data/docs/Transaction.md +1 -0
- data/docs/Transfer.md +5 -1
- data/docs/TransferApi.md +77 -0
- data/docs/TransfersApi.md +39 -39
- data/docs/UsersManagementApi.md +13 -13
- data/docs/WealthApi.md +24 -24
- data/lib/budgea_client.rb +7 -2
- data/lib/budgea_client/api/administration_api.rb +381 -71
- data/lib/budgea_client/api/authentication_api.rb +16 -13
- data/lib/budgea_client/api/banks_api.rb +1034 -211
- data/lib/budgea_client/api/connections_api.rb +648 -30
- data/lib/budgea_client/api/documents_api.rb +85 -85
- data/lib/budgea_client/api/oidc_api.rb +3 -3
- data/lib/budgea_client/api/pfm_api.rb +87 -40
- data/lib/budgea_client/api/providers_api.rb +1045 -151
- data/lib/budgea_client/api/recipients_api.rb +4 -4
- data/lib/budgea_client/api/terms_api.rb +3 -3
- data/lib/budgea_client/api/transfer_api.rb +94 -0
- data/lib/budgea_client/api/transfers_api.rb +39 -39
- data/lib/budgea_client/api/users_management_api.rb +14 -14
- data/lib/budgea_client/api/wealth_api.rb +25 -25
- data/lib/budgea_client/models/account.rb +24 -4
- data/lib/budgea_client/models/account_log.rb +16 -1
- data/lib/budgea_client/models/client.rb +11 -11
- data/lib/budgea_client/models/connection.rb +23 -4
- data/lib/budgea_client/models/connection_log.rb +11 -1
- data/lib/budgea_client/models/connection_source.rb +309 -0
- data/lib/budgea_client/models/connector.rb +18 -15
- data/lib/budgea_client/models/connector_source.rb +273 -0
- data/lib/budgea_client/models/field.rb +14 -4
- data/lib/budgea_client/models/inline_response_200_11.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_12.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_13.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_14.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_15.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_16.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_17.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_18.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_19.rb +21 -11
- data/lib/budgea_client/models/inline_response_200_30.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_31.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_32.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_33.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_34.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_35.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_36.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_37.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_38.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_39.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_40.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_41.rb +200 -0
- data/lib/budgea_client/models/inline_response_200_42.rb +200 -0
- data/lib/budgea_client/models/order.rb +259 -0
- data/lib/budgea_client/models/subscription.rb +11 -1
- data/lib/budgea_client/models/subscription_log.rb +269 -0
- data/lib/budgea_client/models/transaction.rb +11 -1
- data/lib/budgea_client/models/transfer.rb +49 -2
- data/lib/budgea_client/models/user.rb +2 -2
- data/lib/budgea_client/version.rb +1 -1
- data/original_budgea_openapi.json +1980 -351
- data/pkg/budgea_client-2.0.0.gem +0 -0
- data/pkg/budgea_client-3.0.1.gem +0 -0
- data/pkg/budgea_client-4.0.0.gem +0 -0
- data/spec/api/transfer_api_spec.rb +54 -0
- data/spec/models/connection_source_spec.rb +101 -0
- data/spec/models/connector_source_spec.rb +83 -0
- data/spec/models/inline_response_200_41_spec.rb +47 -0
- data/spec/models/inline_response_200_42_spec.rb +47 -0
- data/spec/models/order_spec.rb +77 -0
- data/spec/models/subscription_log_spec.rb +83 -0
- metadata +34 -9
- data/config.yaml +0 -15
- data/pkg/budgea_client-2.0.1.gem +0 -0
- data/pkg/budgea_client-2.0.2.gem +0 -0
- data/pkg/budgea_client-3.0.0.gem +0 -0
- data/pkg/budgea_client-4.0.1.gem +0 -0
- data/pkg/budgea_client-4.0.2.gem +0 -0
|
@@ -89,6 +89,9 @@ module BudgeaClient
|
|
|
89
89
|
# Value in the original currency
|
|
90
90
|
attr_accessor :original_value
|
|
91
91
|
|
|
92
|
+
# Gross value in the original currency
|
|
93
|
+
attr_accessor :original_gross_value
|
|
94
|
+
|
|
92
95
|
# Original currency
|
|
93
96
|
attr_accessor :original_currency
|
|
94
97
|
|
|
@@ -135,6 +138,7 @@ module BudgeaClient
|
|
|
135
138
|
:'last_update' => :'last_update',
|
|
136
139
|
:'deleted' => :'deleted',
|
|
137
140
|
:'original_value' => :'original_value',
|
|
141
|
+
:'original_gross_value' => :'original_gross_value',
|
|
138
142
|
:'original_currency' => :'original_currency',
|
|
139
143
|
:'commission' => :'commission',
|
|
140
144
|
:'commission_currency' => :'commission_currency',
|
|
@@ -172,6 +176,7 @@ module BudgeaClient
|
|
|
172
176
|
:'last_update' => :'DateTime',
|
|
173
177
|
:'deleted' => :'DateTime',
|
|
174
178
|
:'original_value' => :'Float',
|
|
179
|
+
:'original_gross_value' => :'Float',
|
|
175
180
|
:'original_currency' => :'Object',
|
|
176
181
|
:'commission' => :'Float',
|
|
177
182
|
:'commission_currency' => :'Object',
|
|
@@ -295,6 +300,10 @@ module BudgeaClient
|
|
|
295
300
|
self.original_value = attributes[:'original_value']
|
|
296
301
|
end
|
|
297
302
|
|
|
303
|
+
if attributes.has_key?(:'original_gross_value')
|
|
304
|
+
self.original_gross_value = attributes[:'original_gross_value']
|
|
305
|
+
end
|
|
306
|
+
|
|
298
307
|
if attributes.has_key?(:'original_currency')
|
|
299
308
|
self.original_currency = attributes[:'original_currency']
|
|
300
309
|
end
|
|
@@ -423,6 +432,7 @@ module BudgeaClient
|
|
|
423
432
|
last_update == o.last_update &&
|
|
424
433
|
deleted == o.deleted &&
|
|
425
434
|
original_value == o.original_value &&
|
|
435
|
+
original_gross_value == o.original_gross_value &&
|
|
426
436
|
original_currency == o.original_currency &&
|
|
427
437
|
commission == o.commission &&
|
|
428
438
|
commission_currency == o.commission_currency &&
|
|
@@ -440,7 +450,7 @@ module BudgeaClient
|
|
|
440
450
|
# Calculates hash code according to all attributes.
|
|
441
451
|
# @return [Fixnum] Hash code
|
|
442
452
|
def hash
|
|
443
|
-
[id, id_account, webid, application_date, date, value, gross_value, nature, original_wording, simplified_wording, stemmed_wording, wording, id_category, state, date_scraped, rdate, vdate, bdate, coming, active, id_cluster, comment, last_update, deleted, original_value, original_currency, commission, commission_currency, country, counterparty, card].hash
|
|
453
|
+
[id, id_account, webid, application_date, date, value, gross_value, nature, original_wording, simplified_wording, stemmed_wording, wording, id_category, state, date_scraped, rdate, vdate, bdate, coming, active, id_cluster, comment, last_update, deleted, original_value, original_gross_value, original_currency, commission, commission_currency, country, counterparty, card].hash
|
|
444
454
|
end
|
|
445
455
|
|
|
446
456
|
# Builds the object from hash
|
|
@@ -48,7 +48,7 @@ module BudgeaClient
|
|
|
48
48
|
# WebID of the transfer
|
|
49
49
|
attr_accessor :webid
|
|
50
50
|
|
|
51
|
-
# State of the transfer (created, scheduled, validating, pending, coming, done, canceled,
|
|
51
|
+
# State of the transfer (created, scheduled, validating, pending, coming, done, canceled, transactionNotFound, deleted, error, bug)
|
|
52
52
|
attr_accessor :state
|
|
53
53
|
|
|
54
54
|
# Error message during transfer, if any
|
|
@@ -63,6 +63,18 @@ module BudgeaClient
|
|
|
63
63
|
# If found, ID of the related transaction
|
|
64
64
|
attr_accessor :id_transaction
|
|
65
65
|
|
|
66
|
+
# Type of beneficiary number, for example: 'recipient' (in bank recipient list), 'iban' or 'phone_number'
|
|
67
|
+
attr_accessor :beneficiary_type
|
|
68
|
+
|
|
69
|
+
# Beneficiary bank identifier value like recipient webid, iban: EX6713281847025300290000062 or phone_number: 06XXXXXX
|
|
70
|
+
attr_accessor :beneficiary_number
|
|
71
|
+
|
|
72
|
+
# Label of the beneficiary (needed for transfer to other beneficiary type than 'recipient')
|
|
73
|
+
attr_accessor :beneficiary_label
|
|
74
|
+
|
|
75
|
+
# Authentication method used to validate transfer (credentials or webauth)
|
|
76
|
+
attr_accessor :validate_mechanism
|
|
77
|
+
|
|
66
78
|
# Currency of the object
|
|
67
79
|
attr_accessor :currency
|
|
68
80
|
|
|
@@ -85,6 +97,10 @@ module BudgeaClient
|
|
|
85
97
|
:'label' => :'label',
|
|
86
98
|
:'account_balance' => :'account_balance',
|
|
87
99
|
:'id_transaction' => :'id_transaction',
|
|
100
|
+
:'beneficiary_type' => :'beneficiary_type',
|
|
101
|
+
:'beneficiary_number' => :'beneficiary_number',
|
|
102
|
+
:'beneficiary_label' => :'beneficiary_label',
|
|
103
|
+
:'validate_mechanism' => :'validate_mechanism',
|
|
88
104
|
:'currency' => :'currency'
|
|
89
105
|
}
|
|
90
106
|
end
|
|
@@ -108,6 +124,10 @@ module BudgeaClient
|
|
|
108
124
|
:'label' => :'String',
|
|
109
125
|
:'account_balance' => :'Float',
|
|
110
126
|
:'id_transaction' => :'Integer',
|
|
127
|
+
:'beneficiary_type' => :'String',
|
|
128
|
+
:'beneficiary_number' => :'String',
|
|
129
|
+
:'beneficiary_label' => :'String',
|
|
130
|
+
:'validate_mechanism' => :'String',
|
|
111
131
|
:'currency' => :'Object'
|
|
112
132
|
}
|
|
113
133
|
end
|
|
@@ -184,6 +204,24 @@ module BudgeaClient
|
|
|
184
204
|
self.id_transaction = attributes[:'id_transaction']
|
|
185
205
|
end
|
|
186
206
|
|
|
207
|
+
if attributes.has_key?(:'beneficiary_type')
|
|
208
|
+
self.beneficiary_type = attributes[:'beneficiary_type']
|
|
209
|
+
else
|
|
210
|
+
self.beneficiary_type = 'recipient'
|
|
211
|
+
end
|
|
212
|
+
|
|
213
|
+
if attributes.has_key?(:'beneficiary_number')
|
|
214
|
+
self.beneficiary_number = attributes[:'beneficiary_number']
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
if attributes.has_key?(:'beneficiary_label')
|
|
218
|
+
self.beneficiary_label = attributes[:'beneficiary_label']
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
if attributes.has_key?(:'validate_mechanism')
|
|
222
|
+
self.validate_mechanism = attributes[:'validate_mechanism']
|
|
223
|
+
end
|
|
224
|
+
|
|
187
225
|
if attributes.has_key?(:'currency')
|
|
188
226
|
self.currency = attributes[:'currency']
|
|
189
227
|
end
|
|
@@ -213,6 +251,10 @@ module BudgeaClient
|
|
|
213
251
|
invalid_properties.push('invalid value for "state", state cannot be nil.')
|
|
214
252
|
end
|
|
215
253
|
|
|
254
|
+
if @beneficiary_type.nil?
|
|
255
|
+
invalid_properties.push('invalid value for "beneficiary_type", beneficiary_type cannot be nil.')
|
|
256
|
+
end
|
|
257
|
+
|
|
216
258
|
invalid_properties
|
|
217
259
|
end
|
|
218
260
|
|
|
@@ -224,6 +266,7 @@ module BudgeaClient
|
|
|
224
266
|
return false if @register_date.nil?
|
|
225
267
|
return false if @amount.nil?
|
|
226
268
|
return false if @state.nil?
|
|
269
|
+
return false if @beneficiary_type.nil?
|
|
227
270
|
true
|
|
228
271
|
end
|
|
229
272
|
|
|
@@ -248,6 +291,10 @@ module BudgeaClient
|
|
|
248
291
|
label == o.label &&
|
|
249
292
|
account_balance == o.account_balance &&
|
|
250
293
|
id_transaction == o.id_transaction &&
|
|
294
|
+
beneficiary_type == o.beneficiary_type &&
|
|
295
|
+
beneficiary_number == o.beneficiary_number &&
|
|
296
|
+
beneficiary_label == o.beneficiary_label &&
|
|
297
|
+
validate_mechanism == o.validate_mechanism &&
|
|
251
298
|
currency == o.currency
|
|
252
299
|
end
|
|
253
300
|
|
|
@@ -260,7 +307,7 @@ module BudgeaClient
|
|
|
260
307
|
# Calculates hash code according to all attributes.
|
|
261
308
|
# @return [Fixnum] Hash code
|
|
262
309
|
def hash
|
|
263
|
-
[id, id_account, id_user, id_recipient, account_iban, recipient_iban, exec_date, register_date, amount, fees, webid, state, error, label, account_balance, id_transaction, currency].hash
|
|
310
|
+
[id, id_account, id_user, id_recipient, account_iban, recipient_iban, exec_date, register_date, amount, fees, webid, state, error, label, account_balance, id_transaction, beneficiary_type, beneficiary_number, beneficiary_label, validate_mechanism, currency].hash
|
|
264
311
|
end
|
|
265
312
|
|
|
266
313
|
# Builds the object from hash
|
|
@@ -106,7 +106,7 @@ module BudgeaClient
|
|
|
106
106
|
return false if @id.nil?
|
|
107
107
|
return false if @signin.nil?
|
|
108
108
|
return false if @platform.nil?
|
|
109
|
-
platform_validator = EnumAttributeValidator.new('String', ['web', 'iPad', 'iPhone', 'Android', 'CAstore', 'requestAccess', 'sharedAccess', 'transfer'])
|
|
109
|
+
platform_validator = EnumAttributeValidator.new('String', ['web', 'iPad', 'iPhone', 'Android', 'CAstore', 'requestAccess', 'sharedAccess', 'transfer', 'refresh_token'])
|
|
110
110
|
return false unless platform_validator.valid?(@platform)
|
|
111
111
|
true
|
|
112
112
|
end
|
|
@@ -114,7 +114,7 @@ module BudgeaClient
|
|
|
114
114
|
# Custom attribute writer method checking allowed values (enum).
|
|
115
115
|
# @param [Object] platform Object to be assigned
|
|
116
116
|
def platform=(platform)
|
|
117
|
-
validator = EnumAttributeValidator.new('String', ['web', 'iPad', 'iPhone', 'Android', 'CAstore', 'requestAccess', 'sharedAccess', 'transfer'])
|
|
117
|
+
validator = EnumAttributeValidator.new('String', ['web', 'iPad', 'iPhone', 'Android', 'CAstore', 'requestAccess', 'sharedAccess', 'transfer', 'refresh_token'])
|
|
118
118
|
unless validator.valid?(platform)
|
|
119
119
|
fail ArgumentError, 'invalid value for "platform", must be one of #{validator.allowable_values}.'
|
|
120
120
|
end
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"info": {
|
|
3
3
|
"version": "2.0",
|
|
4
|
-
"description": "",
|
|
4
|
+
"description": "# Budgea Development Guides\n\nWelcome to **Budgea**'s documentation.\n\nThis documentation is intended to get you up-and-running with our APIs and advise on the implementation of some regulatory aspects of your application, following the DSP2's guidelines.\n\n## Getting Started\n**IMPORTANT**\nDepending on your status with regard of the DSP2 regulation, **agent** or **partner**, you may call our APIs or simply use our Webview and callbacks to get the financial data of your users.\nAs an **agent**, you are allowed to call directly our APIs and implement your own form to get the user's credentials.\nAs a **partner**, you cannot manipulate the credentials, and have to delegate this step to us through our webview.\n\nThe sections below will document how to use our APIs, make sure you have the **agent** status to do so.\nFor the **partner**, please refer to the section *Webview* and *Callbacks* of this documentation.\n\n### Overview\nYour API is a REST API which requires a communication through https to send and receive JSON documents.\nDuring your tests, we recommend to make calls to the API with curl or any other HTTP client of your choice.\nYou can watch a video demonstration on this [URL](https://asciinema.org/a/FsaFyt3WAPyDm7sfaZPkwal3V).\nFor the examples we'll use the demo API with address `https://demo.biapi.pro`, you should change that name to your API's name.\n\n### Hello World\nLet's start by calling the service `/banks` which lists all available banks.\n```\ncurl https://demo.biapi.pro/2.0/banks/\n```\nTo log in to a bank webpage, you'll need to know for a given bank, the fields your user should fill in the form.\nLet's call a specific bank and ask for an additional resource *fields*.\n```\ncurl https://demo.biapi.pro/2.0/banks/59?expand=fields\n```\nThe response here concerns only 1 bank (since we specified an id) and the resource _Fields_ is added to the response thanks to the query parameter `expand`.\n\nTo get more interesting things done, you'll need to send authenticated requests.\n\n### Authentication\nThe way to authenticate is by passing the `Authorization: Bearer <token>` header in your request.\nAt the setup a _manage token_ have been generated, you can use this token for now, when creating your user we'll see how to generate a user's token.\n```\ncurl https://demo.biapi.pro/2.0/config \\\n -H 'Authorization: Bearer <token>'\n```\nThis endpoint will list all the parameters you can change to adapt Budgea to your needs.\n\nWe've covered the very first calls. Before diving deeper, let's see some general information about the APIs.\n\n## Abstract\n\n### API URL\n`https://demo.biapi.pro/2.0`\n\n### Requests format\nData format: **application/x-www-form-urlencoded** or **application/json** (suggested)\n\nAdditional headers: Authorization: User's token (private)\n\n### Responses format\nData format: **application/json** ([http://www.json.org](http://www.json.org/))\nCharset: **UTF-8**\n\n### Resources\nEach call on an endpoint will return resources. The main resources are:\n| Resource | Description |\n| ---------------------|:------------------------------------------------------------------------------------------------------------------ |\n|Users |Represent a user |\n|Connection |A set of data used to authenticate on a website (usually a login and password). There is 1 connection for each website|\n|Account |A bank account contained in a connection |\n|Transaction |An entry in a bank account |\n|Investment |An asset in a bank account |\n\nThe chain of resources is as follow: **Users ∈ Connections ∈ Accounts ∈ Transactions or Investments**\n\n### RESTful API\n\nThis API is RESTful, which means it is stateless and each resource is accessed with an unique URI.\n\nSeveral HTTP methods are available:\n\n| Method | Description |\n| ------------------------|:-------------------------------|\n| GET /resources | List resources |\n| GET /resources/{ID} | Get a resource from its ID |\n| POST /resources | Create a new resource |\n| POST /resources/{ID} | Update a resource |\n| PUT /resources /{ID} | Update a resource |\n| DELETE /resources | Remove every resources |\n| DELETE /resources/{ID} | Delete a resource |\n\n\nEach resource can contain sub-resources, for example:\n`/users/me/connections/2/accounts/23/transactions/48`\n\n### HTTP response codes\n\n| Code | Message | Description |\n| ----------- |:---------------------:|-----------------------------------------------------------------------------------------------|\n| 200 | OK |Default response when a GET or POST request has succeed |\n| 202 | Accepted |For a new connection this code means it is necessary to provide complementary information (2FA)|\n| 204 | No content |Default response when a POST request succeed without content |\n| 400 | Bad request |Supplied parameters are incorrect |\n| 403 | Forbidden |Invalid token |\n| 500 | Internal Servor Error |Server error |\n| 503 | Service Unavailable |Service is temporarily unavailable |\n\n### Errors management\nIn case an error occurs (code 4xx or 5xx), the response can contain a JSON object describing this error:\n```json\n{\n \"code\": \"authFailure\",\n \"message\": \"Wrong password\" // Optional\n}\n```\nIf an error is displayed on the website, Its content is returned in error_message field.\nThe list of all possible errors is listed further down this page.\n\n### Authentication\nA user is authenticated by an access_token which is sent by the API during a call on one of the authentication services, and can be supplied with this header:\n`Authorization: Bearer YYYYYYYYYYYYYYYYYYYYYYYYYYY`\n\n There are two user levels:\n\n - Normal user, which can only access to his own accounts\n - Administrator, with extended rights\n\n### Default filters\nDuring a call to an URI which lists resources, some filters can be passed as query parameters:\n\n| Parameter | Type | Description |\n| ----------- |:---------:|-----------------------------------------------------------|\n| offset | Integer |Offset of the first returned resource |\n| limit | Integer |Limit number of results |\n| min_date | Date |Minimal date (if supported by service), format: YYYY-MM-DD |\n| max_date | Date |Maximal date (if supported by service), format: YYYY-MM-DD |\n\n### Extend requests\nDuring a GET on a set of resources or on a unique resource, it is possible to add a parameter expand to the request to extend relations with other resources:\n\n`GET /2.0/users/me/accounts/123?expand=transactions[category],connection`\n\n```json\n{\n \"id\" : 123\n \"name\" : \"Compte chèque\"\n \"balance\" : 1561.15\n \"transactions\" : [\n {\n \"id\" : 9849,\n \"simplified_wording\" : \"HALL'S BEER\",\n \"value\" : -513.20,\n ...\n \"category\" : {\n \"id\" : 561,\n \"name\" : \"Sorties / Bar\",\n ...\n }\n },\n ...\n ],\n \"id_user\" : 1,\n \"connection\" : {\n \"id\" : 1518,\n \"id_bank\" : 41,\n \"id_user\" : 1,\n \"error\" : null,\n ...\n }\n}\n```\n\n### Request example\n```http\nGET /2.0/banks?offset=0&limit=10&expand=fields\nHost: demo.biapi.pro\nAccept: application/json\nAuthorization: Bearer <token>\n```\n```http\nHTTP/1.1 200 OK\nContent-Type: application/json\nContent-Length: 3026\nServer: Apache\nDate: Fri, 14 Mar 2014 08:24:02 GMT\n\n{\n \"banks\" : [\n {\n \"id_weboob\" : \"bnporc\",\n \"name\" : \"BNP Paribas\",\n \"id\" : 3,\n \"hidden\" : false,\n \"fields\" : [\n {\n \"id\" : 1,\n \"id_bank\" : 3,\n \"regex\" : \"^[0-9]{5,10}$\",\n \"name\" : \"login\",\n \"type\" : \"text\",\n \"label\" : \"Numéro client\"\n },\n {\n \"id\" : 2,\n \"id_bank\" : 3,\n \"regex\" : \"^[0-9]{6}$\",\n \"name\" : \"password\",\n \"type\" : \"password\",\n \"label\" : \"Code secret\"\n }\n ]\n },\n ...\n ]\n \"total\" : 41\n}\n```\n\n### Constants\n#### List of bank account types\n| Type |Description |\n| ----------- |-----------------------------------|\n| checking |Checking account |\n| savings |Savings account |\n| deposit |Deposit accounts |\n| loan |Loan |\n| market | Market accounts |\n| joint |Joint account |\n| card |Card |\n| lifeinsurance |Life insurance accounts |\n| pee |Plan Épargne Entreprise |\n| perco |Plan Épargne Retraite |\n| article83 |Article 83 |\n| rsp |Réserve spéciale de participation |\n| pea |Plan d'épargne en actions |\n| capitalisation|Contrat de capitalisation |\n| perp |Plan d'épargne retraite populaire |\n| madelin |Contrat retraite Madelin |\n| unknown |Inconnu |\n\n#### List of transaction types\n\n| Type |Description |\n| ----------- |-----------------------------------|\n|transfer |Transfers |\n|order |Orders |\n|check |Checks |\n|deposit |Cash deposit |\n|payback |Payback |\n|withdrawal |Withdrawal |\n|loan_payment |Loan payment |\n|bank |Bank fees |\n|card |Card operation |\n|deferred_card |Deferred card operation |\n|card_summary |Mensual debit of a deferred card |\n\n#### List of synchronization errors\n##### Error on Connection object\nThe error field may take one of the below values in case of error when accessing the user space.\n\n| Error |Description |\n| ----------------------- |--------------------------------------------------------------------------------------------------|\n|wrongpass |The authentication on website has failed |\n|additionalInformationNeeded |Additional information is needed such as an OTP |\n|websiteUnavailable |The website is unavailable, for instance we get a HTTP 503 response when requesting the website |\n|actionNeeded |An action is needed on the website by the user, scraping is blocked |\n|SCARequired |An SCA process must be done by updating the connection |\n|decoupled |Requires a user validation (ex: digital key)|\n|passwordExpired |The password has expired and needs to be changed on the website. |\n|webauthRequired |A complete authentication process is required by update the connection via redirect |\n|bug |A bug has occurred during the synchronization. An alert has been sent to Budget Insight |\n\n#### Error on Account object\nErrors can be filled at the account level in case we access the user's dashboard but some account related data cannot be retrieved.\nFor instance, we may not access the transactions or investments for a specific account.\nGetting an error during an account synchronization does not impact the scraping of other acccounts.\n\n| Error |Description |\n| ----------------------- |--------------------------------------------------------------------------------------------------|\n|websiteUnavailable |The website or a page is unavailable |\n|actionNeeded |An action is needed on the website by the user, scraping is blocked |\n|bug |A bug has occurred during the synchronization. An alert has been sent to Budget Insight |\n\nNow you know the basics of Budgea API\n- Basic call to retrieve resources\n- Add query parameters to aplly filters\n- Expand resources\n- Authenticated calls\n\nWe're good for the basics! Now let's see how to integrate Budgea in your app and create your first user.\n\n## Integrate Budgea *(protocol or Webview)*\n### The workflow\nUsers of your application exist in the Budgea API.\nEvery User is identified by an access_token which is the shared secret between your application and our API.\n\nThe workflow is as below:\n1. The user is on your application and wants to share his bank accounts or invoices.\n2. A call is made **client side** (browser's javascript or desktop application) to create a temporarily token which will be used to make API calls.\n3. A form is built, allowing the user to select the connector to use (bank or provider, depending on context). Every connector requires different kind of credentials.\n4. A call on the API is made with the temporarily token to add a **Connection** with the credentials supplied by user.\n5. In case of success, the user chooses what bank accounts (**Account**) or subscriptions (**Subscription**) he wants to share with your application.\n6. When he validates the share, the temporarily token is transmitted to your server. This one will call the Budgea API with this token to get a permanent token.\n\n**Note**\nIn case your application works without a server (for example a desktop application), the permanent token can be obtained on the 1st step, by supplying a client_secret to /auth/init and the step 6 is omitted. To get more information, read the protocol.\n\nThere are 3 steps to integrate Budgea in your application:\n1. Provide a way for your users to share their credentials with you\n2. Get the data scraped from Budgea\n3. Be sure to follow the good practices before going into production\n\n### Get credentials from users\nYou have 2 options here:\n- Integrate the Budget Insight's Webview, a turnkey solution to get user's credentials\n- Create your own form following the protocol (must have the *agent* status)\n\n### Budgea webview\n\nThe Budgea webview complements REST API endpoints with web-based services to handle sensitive or complex operations:\n- add a connection (to a bank or a provider), or edit/repare access to a connection;\n- manage connections (add/remove/edit);\n- edit and validate bank transfers (alpha preview).\n\nUsage of the webview is mandatory if you don't hold an Agent status, since you are not allowed to use API endpoints carrying user credentials, and optional otherwise.\n\n#### Implementation guidelines\n\n##### Base URL\n\nThe base URL of all services must be customized: \n`https://{{domain}}.biapi.pro/2.0/auth/webview/` \n`https://{{domain}}.biapi.pro/2.0/auth/webview/{{lang}}/` \n- `{{domain}}`: substitute with you API domain;\n- `{{lang}}`: optionally specify the language of the webview, `en` or `fr` (if not specified, an automatic redirection will be performed following the language of the browser).\n\n##### Browser integration\n\nServices available as part of the webview are designed as parameterized URLs intended to be opened in a web browser. A callback URI must be specified by callers to be notified at the end of the operation flow, similar to OAuth 2 specification.\n\nYou are encouraged to integrate web-based steps in your product following UX best practices:\n- in a web environment, perform a full-page redirect to the URL (using either [HTTP redirect](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/302) or [scripting](https://developer.mozilla.org/fr/docs/Web/API/Location)), and avoid new tabs or popups;\n- in a native Android app, prefer opening the default browser or relying on [Chrome Custom Tabs](https://developer.chrome.com/multidevice/android/customtabs) to integrating a WebView;\n- in a native iOS app, prefer using a [SFSafariViewController](https://developer.apple.com/documentation/safariservices/sfsafariviewcontroller) to integrating a WKWebView.\n\n##### Callback handling\n\nMost flows redirect to a callback URI at the end of the process. Query parameters are added to the URI to identify successful or failed operations.\n\nSuccessful parameters are specific to each flow. In case of an error, the following parameters are added:\n\n| Parameter | Description |\n| - | - |\n| `error` | An lowercase string error code identifying the kind of error that occurred. When the parameter is not present, the response is successful. |\n| `error_description` | A longer string description of the error (not intended for user display). |\n\nCommon error codes include:\n\n| Code | Description |\n| - | - |\n| `access_denied` | The user explicitly cancelled the flow. |\n| `server_error` | Oops, a technical failure occurred during the process. |\n\n**Forward compatibility requirement**: Additional error codes may be added in the future to describe specific cases. When implementing error codes handling, always fallback to a generic case for unknown codes.\n\n##### Browser compatibility\n\nThe webview is designed and tested to work with browsers supported by the Angular framework: \nhttps://angular.io/guide/browser-support\n\n##### Privacy / GDPR status\n\nThe webview itself does not use any kind of long-term data persistence mechanism such as cookies or local storage, but some authentication or authorization steps may delegate to third-party web services that may implement them.\n\n#### Configuration\n\nYou can configure the appearance and behaviour of the webview by configuring the associated *Client Application* in the console:\n\n| Key | Format | Description |\n| - | - | - |\n| `primary_color` | String | Optional. An accent color (hexadecimal string without '#' prefix) to personalize the UI elements of the webview. If absent, the default color is grey. |\n| `redirect_uri` | String | Optional. A recommended security whitelist configuration. The `redirect_uri` parameter sent to any endpoint of the webview is checked against the configuration, if any. |\n| `config.disable_connector_hints` | Boolean | Optional. This flags hides the list of most-used entries in the connector selection step. The default is `false`, i.e. the list is shown. |\n| `config.use_app_layout` | Boolean | Optional. Use this flag to enable presenting your log as an app icon. The default value is ` false`, i.e. the logo is shown in the top bar of the UI. |\n| `config.disable_accounts_pre_check` | Boolean | Optional. An optional boolean flag to prevent bank accounts to be automatically pre-checked when the user enters the activation step. The default value is ` false`, i.e. the bank accounts are pre-checked. |\n\n#### Endpoints reference\n\n##### Add connection flow\n```\nhttps://{{domain}}.biapi.pro/2.0/auth/webview/{{lang}}/connect\n```\n\nThis flow allows an end-user to add a new connection to the API. The flow handles the following steps:\n- selecting a connector;\n- authenticating & authorizing with the connector, by collecting credentials or delegating;\n- managing consent to aggregate accounts/subscriptions;\n- collecting required information for professional accounts.\n\n###### Endpoint parameters\n\n| Parameter | Description |\n| - | - |\n| `client_id` | Required. The ID of the requesting client application. You can manage client applications of your domain in the admin console. |\n| `redirect_uri` | Required. An absolute callback URI. The webview will redirect to it at the end of the flow. |\n| `code` | Optional. A user-scoped temporary code to use with the Budgea API.<br>If you don't provide a code, a new anonymous user will be created before the connection is added, and you will be returned an access token code scoped to it with the success callback. |\n| `state` | Optional. An opaque string parameter that you can use to carry state across the flow. The parameter will be set \"as is\" on the callback URI. Make sure that the `state` you provide is properly URL-encoded. |\n| `connector_ids` | Optional. A comma-separated list of connector IDs available to pick from.<br>If the parameter is omitted, all active connectors are available.<br>If you pass a single value, the user is not prompted to choose the connector.<br>This parameter is mutually exclusive with `connector_uuids`. |\n| `connector_uuids` | Optional. A comma-separated list of connector UUIDs available to pick from.<br>If the parameter is omitted, all active connectors are available.<br>If you pass a single value, the user is not prompted to choose the connector.<br>This parameter is mutually exclusive with `connector_ids`. |\n| `connector_capabilities` | Optional. A comma-separated list of capabilities to filter available connectors.<br>If the parameter is omitted, `bank` is inferred.<br>If multiple values are provided, only connectors that expose all the requested capabilities are available.<br>To request a bank connection, use `bank`.<br>To request a provider connection, use `document`. |\n| `account_ibans` | Optional. A comma-separated list of IBANs to filter accounts available for activation in a bank connection context. Other accounts will not be selectable. |\n| `account_types` | Optional. A comma-separated list of account types to filter accounts available for activation in a bank connection context. Other accounts will not be selectable. |\n| `account_usages` | Optional. A comma-separated list of account usages to filter accounts available for activation in a bank connection context. Other accounts will not be selectable. |\n\n###### Successful callback parameters\n\n| Parameter | Description |\n| - | - |\n| `connection_id` | The id of the newly created connection. Please note that when redirecting to the callback URI, the accounts and/or subscriptions are available in the API, but bank transactions or documents may still be syncing in background. |\n| `code` | Optional. If a `code` was *not* initially specified, an API code that you must exchange to obtain a permanent access token associated with the newly-created anonymous user holding the connection. The parameter is URL-encoded, make sure to handle it accordingly. |\n| `state` | Optional. Identical to the `state` parameter that was initially specified. |\n\n###### Additional error codes\n\n| Code | Description |\n| - | - |\n| `tos_declined` | The end-user refused to validate the terms of service. |\n\n##### Re-auth / edit connection credentials flow\n\n```\nhttps://{{domain}}.biapi.pro/2.0/auth/webview/{{lang}}/reconnect\n```\n\nThis flow allows an end-user to re-authenticate against a bank or a provider in order to recover an existing connection, or to completely reset credentials associated with a connection.\n\n###### Endpoint parameters\n\n| Parameter | Description |\n| - | - |\n| `client_id` | Required. The ID of the requesting client application. You can manage client applications of your domain in the admin console. |\n| `redirect_uri` | Required. An absolute callback URI. The webview will redirect to it at the end of the flow. |\n| `code` | Required. A user-scoped temporary code to use with the Budgea API. |\n| `connection_id` | Required. The id of the existing connection. |\n| `state` | Optional. An opaque string parameter that you can use to carry state across the flow. The parameter will be set \"as is\" on the callback URI. Make sure that the `state` you provide is properly URL-encoded. |\n| `reset_credentials` | Optional. In the default mode (`false`), the service will try to recover the connection and prompt the user only with outdated or transient information (new password, OTP...).<br>Set the parameter to `true` to force resetting all the credentials associated with the connection. This parameter may not apply to all connectors. |\n\n###### Successful callback parameters\n\nThis flow adds no parameter to the callback URI in case of success, except from `state`.\n\n##### Manage connections\n\n```\nhttps://{{domain}}.biapi.pro/2.0/auth/webview/{{lang}}/manage\n```\nThis flow allows an end-user to manage the connections associated with his account in the API. The user can add new connections, remove existing ones, fix connection errors, reset credentials or activate/deactivate bank accounts.\n\nSupport of `redirect_uri` in this flow is optional, as it can be integrated or presented as a terminal step, without relying on a final redirection.\n\n###### Endpoint parameters\n\n| Parameter | Description |\n| - | - |\n| `client_id` | Required. The ID of the requesting client application. You can manage client applications of your domain in the admin console. |\n| `code` | Required. A user-scoped temporary code to use with the Budgea API. |\n| `redirect_uri` | Optional. An absolute callback URI. When provided, the webview will display a close button that redirects to it. |\n| `state` | Optional. An opaque string parameter that you can use to carry state across the flow when providing a `redirect_uri`. The parameter will be set \"as is\" on the callback URI. Make sure that the `state` you provide is properly URL-encoded. |\n| `connector_capabilities` | Optional. A comma-separated list of capabilities to filter available connectors when adding a new connection.<br>If the parameter is omitted, `bank` is inferred.<br>If multiple values are provided, only connectors that expose all the requested capabilities are available.<br>To request a bank connection, use `bank`.<br>To request a provider connection, use `document`. |\n| `account_types` | Optional. A comma-separated list of account types to filter accounts available for activation on adding a new bank connection or updating existing connections. Other accounts will not be selectable. |\n| `account_usages` | Optional. A comma-separated list of account usages to filter accounts available for activation in a bank connection context. Other accounts will not be selectable. |\n\n###### Callback parameters\n\nThis flow adds no parameter to the callback URI, except from `state`.\n\n##### Execute a bank transfer (preview)\n\n**Disclaimer**: Transfer or payment services are available as a preview, protocols and parameters are subject to change in upcoming beta/final releases.\n\n```\nhttps://{{domain}}.biapi.pro/2.0/auth/webview/{{lang}}/transfer\n```\nThis flow allows an end-user to execute a bank transfer. The flow handles the following steps:\n- if the transfer is not already created, all steps to authenticate with a bank, select the recipient, the emitter account, the amount and label;\n- executing the transfer, including managing SCAs for recipient registration and/or transfer validation.\n\n###### Endpoint parameters\n\n| Parameter | Description |\n| - | - |\n| `client_id` | Required. The ID of the requesting client application. You can manage client applications of your domain in the admin console. |\n| `redirect_uri` | Required. An absolute callback URI. The webview will redirect to it at the end of the flow. |\n| `code` | Required. A user-scoped temporary code to use with the Budgea API.<br>If you don't provide a code, a new anonymous user will be created before a connection is added and the transfer is executed, and you will be returned an access token code scoped to it with the success callback. |\n| `state` | Optional. An opaque string parameter that you can use to carry state across the flow. The parameter will be set \"as is\" on the callback URI. Make sure that the `state` you provide is properly URL-encoded. |\n| `transfer_id`| Optional. The ID of an prepared transfer to be validated in the webview. The user cannot edit anything on the transfer before validation. |\n\n###### Successfull callback parameters\n\n| Parameter | Description |\n| - | - |\n| `transfer_id` | The ID of the transfer that was created and executed. |\n| `code` | Optional. If a `code` was *not* initially specified, an API code that you can exchange to obtain a permanent access token associated with the newly-created anonymous user holding the transfer. The parameter is URL-encoded, make sure to handle it accordingly. |\n| `state` | Optional. Identical to the `state` parameter that was initially specified. |\n\n###### Additional error codes\n\n| Code | Description |\n| - | - |\n| `tos_declined` | The end-user refused to validate the terms of service. |\n\n#### Migrating from v3\n\nWe provide a full backward compatibility layer with current implementations of the webview v3 to ease the transition. All endpoints remains accessible, with the same parameters and callback behaviour. Migration instructions are provided below.\n\n*The v3 compatibility mode is expected to be removed on 31 December 2019.* You should migrate your implementation a soon as possible to new endpoints and parameters.\n\n##### Add connection flow / Edit connection credentials \n```\n/connect/select\n```\n\nThis endpoint has been superseded by `/connect` (no suffix) for adding a new connection, and `/reconnect` for resetting or updating an existing connection.\n\n| Endpoint parameter | Migration instructions |\n| - | - |\n| `client_id` | No change. |\n| `redirect_uri`, `state` | No change. |\n| `response_type` | This parameter is not used anymore. |\n| `id_connector`, `connectors` | Superseded by `connector_ids` sent to the `/connect` endpoint. |\n| `types` | Superseded by `connector_capabilities` sent to the `/connect` endpoint.<br>Use`connector_capabilities=bank` (bank connection) or `connector_capabilities=document` (provider connection). |\n| `id_connection` | Superseded by `connection_id` sent to the `/reconnect` endpoint. |\n\nPassing the code or access token as an URL fragment is no longer supported, use the `code` query parameter.\n\n| Callback parameter | Migration instructions |\n| - | - |\n| `id_connection` | Superseded by `connection_id`.<br>In the `/reconnect` flow, this parameter is not returned anymore. |\n| `code` | Still named `code`, but in the `/connect` flow the parameter is now **only** added if an anonymous user was created, i.e. the `code` parameter was **not** provided as a query parameter or fragment.<br>In the `/reconnect` flow, this parameter is not returned anymore. |\n| `state` | No change. |\n\n##### Manage connections\n\n```\n/accounts\n```\n\nThis endpoint has been superseded by `/manage`, that now fully allows users to add/remove connections, reset their credentials or recover from error states.\n\n| Endpoint parameter | Migration instructions |\n| - | - |\n| `client_id` | No change. |\n| `redirect_uri`, `state` | No change, these parameters are now optional. |\n| `response_type` | This parameter is not used anymore. |\n| `types` | Superseded by `connector_capabilities`.<br>Use`connector_capabilities=bank` (bank connection) or `connector_capabilities=document` (provider connection). |\n\nPassing the code or access token as an URL fragment is no longer supported, use the `code` query parameter.\n\n| Callback parameter | Migration instructions |\n| - | - |\n| `code` | This parameter is not returned anymore. |\n| `state` | No change. |\n\n##### Behaviour change\n\nIn v3, the `/accounts` flow used to redirect to the `redirect_uri` after a connection addition. This is no longer the case in v4, where redirection is only performed when the user explicitly closes the flow. If you need to perform actions when a connection is added or removed, you should rely on webhooks.\n\n#### Protocol\nThis section describes the protocol used to set bank and provider accounts of a user, in case you don't want to use the webview.\n\nThe idea is to call the following services client-side (with AJAX in case of a web application), to ensure the bank and providers credentials will not be sent to your servers.\n\n1. /auth/init\n```http\nPOST /auth/init\n```\n```json\n{\n \"auth_token\" : \"fBqjMZbYddebUGlkR445JKPA6pCoRaGb\",\n \"type\" : \"temporary\",\n \"expires_in\" : 1800,\n \"id_user\": 1\n}\n```\nThis service creates a temporarily token, to use in the \"Authorization\" header in next calls to the API\n\nThe returned token has a life-time of 30 minutes, and should be transfered to the API then (cf Permanent Token), so that your server can get a permanent access_token.\n\nIt is possible to generate a permanent token immediately, by calling the service with the manage_token, or by supply parameters client_id and client_secret.\n\n2. /banks or /providers\n```http\nGET /banks?expand=fields\nAuthorization: Bearer <token>\n```\n```json\n{\n \"hidden\" : false,\n \"charged\" : true,\n \"name\" : \"American Express\",\n \"id\" : 30,\n \"fields\" : [\n {\n \"values\" : [\n {\n \"label\" : \"Particuliers/Professionnels\",\n \"value\" : \"pp\"\n },\n {\n \"value\" : \"ent\",\n \"label\" : \"Entreprises\"\n }\n ],\n \"label\" : \"Type de compte\",\n \"regex\" : null,\n \"name\" : \"website\",\n \"type\" : \"list\"\n },\n {\n \"type\" : \"password\",\n \"label\" : \"Code secret\",\n \"name\" : \"password\",\n \"regex\" : \"^[0-9]{6}$\"\n }\n ],\n },\n ...\n ],\n \"total\" : 44,\n}\n```\nYou get a list of connectors, and all associated fields needed to build the form at step 3.\nYou can also use that list to show to your user, all available banks.\n\n3. /users/me/connections\nMake a POST request and supply the id_bank (ID of the chosen bank) or id_provider (ID of provider), and all requested fields as key/value parameters.\nFor example:\n```http\nPOST /users/me/connections\nAuthorization: Bearer <token>\n-F login=12345678\n-F password=123456\n-F id_bank=59\n```\nYou can get the following return codes:\n\n|Code |Description |\n|---------------|------------------------------------------------------------ |\n|200 |The connection has succeed and has been created |\n|202 |It is necessary to provide complementary information. This occurs on the first connection on some kind of Boursorama accounts for example, where a SMS is sent to the customer. It is necessary to ask the user to fill fields requested in the fields, and do a POST again on /users/me/connections/ID, with the connection ID in id_connection. |\n|400 |Unable to connect to the website, the field error in the JSON can be **websiteUnavailable** or **wrongpass** |\n|403 |Invalid token |\n\n4. Activate accounts\nThe accounts the user wants to aggregate must be activated before any transaction or investment is retrieved.\nSeveral accounts can be activated in 1 request by separating the account ids with commas.\n```http\nPUT /users/me/connections/<id_connection>/accounts/<id_account>?all\n```\n\n5. Permanent token\nIf the user validates the share of his accounts, it is necessary to transform the temporary code to a permanent access_token (so that the user won't expire).\n\nTo do that, make a POST request on /auth/token/access with the following parameters:\n|Parameter |Description |\n|---------------------|----------------------------------------------------------------|\n|code |The temporarily token which will let you get the access_token |\n|client_id |The ID of your client application |\n|client_secret |The secret of your client application |\n\n```json\nPOST /auth/token/access\n\n{\n \"client_id\" : 17473055,\n \"client_secret\" : \"54tHJHjvodbANVzaRtcLzlHGXQiOgw80\",\n \"code\" : \"fBqjMZbYddebUGlkR445JKPA6pCoRaGb\"\n}\n```\n```http\nHTTP/1.1 200 OK\n\n{\n \"access_token\" : \"7wBPuFfb1Hod82f1+KNa0AmrkIuQ3h1G\",\n \"token_type\":\"Bearer\"\n}\n```\n\n### Update accounts\nAnother important call is when a user wants to add/remove connections to banks or providers, or to change the password on one of them, it is advised to give him a temporarily code from the permanent access_token, with the following call (using the access_token as bearer):\n```http\nPOST /auth/token/code\nAuthorization: Bearer <token>\n```\n```json\n{\n \"code\" : \"/JiDppWgbmc+5ztHIUJtHl0ynYfw682Z\",\n \"type\" : \"temporary\",\n \"expires_in\" : 1800,\n}\n```\nIts life-time is 30 minutes, and let the browser to list connections and accounts, via `GET /users/me/connections?expand=accounts` for example.\n\n To update the password of a connection, you can do a POST on the *connection* resource, with the field *password* in the data. The new credentials are checked to make sure they are valid, and the return codes are the same as when adding a connection.\n\n## Getting the data (Webhooks)\nYou have created your users and their connections, now it's time to get the data.\nThere are 2 ways to retrieve it, the 2 can be complementary:\n- make regular calls to the API\n- use the webhooks (recommended)\n\n### Manual Synchronization\nIt is possible to do a manual synchronization of a user. We recommend to use this method in case the user wants fresh data after logging in.\n\nTo trigger the synchronization, call the API as below:\n`PUT /users/ID/connections`\nThe following call is blocking until the synchronization is terminated.\n\nEven if it is not recommended, it's possible to fetch synchronously new data. To do that, you can use the *expand* parameter:\n` /users/ID/connections?expand=accounts[transactions,investments[type]],subscriptions`\n```json\n{\n \"connections\" : [\n {\n \"accounts\" : [\n {\n \"balance\" : 7481.01,\n \"currency\" : {\n \"symbol\" : \"€\",\n \"id\" : \"EUR\",\n \"prefix\" : false\n },\n \"deleted\" : null,\n \"display\" : true,\n \"formatted_balance\" : \"7 481,01 €\",\n \"iban\" : \"FR76131048379405300290000016\",\n \"id\" : 17,\n \"id_connection\" : 7,\n \"investments\" : [\n {\n \"code\" : \"FR0010330902\",\n \"description\" : \"\",\n \"diff\" : -67.86,\n \"id\" : 55,\n \"id_account\" : 19,\n \"id_type\" : 1,\n \"label\" : \"Agressor PEA\",\n \"portfolio_share\" : 0.48,\n \"prev_diff\" : 2019.57,\n \"quantity\" : 7.338,\n \"type\" : {\n \"color\" : \"AABBCC\",\n \"id\" : 1,\n \"name\" : \"Fonds action\"\n },\n \"unitprice\" : 488.98,\n \"unitvalue\" : 479.73,\n \"valuation\" : 3520.28\n }\n ],\n \"last_update\" : \"2015-07-04 15:17:30\",\n \"name\" : \"Compte chèque\",\n \"number\" : \"3002900000\",\n \"transactions\" : [\n {\n \"active\" : true,\n \"application_date\" : \"2015-06-17\",\n \"coming\" : false,\n \"comment\" : null,\n \"commission\" : null,\n \"country\" : null,\n \"date\" : \"2015-06-18\",\n \"date_scraped\" : \"2015-07-04 15:17:30\",\n \"deleted\" : null,\n \"documents_count\" : 0,\n \"formatted_value\" : \"-16,22 €\",\n \"id\" : 309,\n \"id_account\" : 17,\n \"id_category\" : 9998,\n \"id_cluster\" : null,\n \"last_update\" : \"2015-07-04 15:17:30\",\n \"new\" : true,\n \"original_currency\" : null,\n \"original_value\" : null,\n \"original_wording\" : \"FACTURE CB HALL'S BEER\",\n \"rdate\" : \"2015-06-17\",\n \"simplified_wording\" : \"HALL'S BEER\",\n \"state\" : \"parsed\",\n \"stemmed_wording\" : \"HALL'S BEER\",\n \"type\" : \"card\",\n \"value\" : -16.22,\n \"wording\" : \"HALL'S BEER\"\n }\n ],\n \"type\" : \"checking\"\n }\n ],\n \"error\" : null,\n \"expire\" : null,\n \"id\" : 7,\n \"id_user\" : 7,\n \"id_bank\" : 41,\n \"last_update\" : \"2015-07-04 15:17:31\"\n }\n ],\n \"total\" : 1,\n}\n```\n\n### Background synchronizations & Webhooks\nWebhooks are callbacks sent to your server, when an event is triggered during a synchronization.\nSynchronizations are automatic, the frequency can be set using the configuration key `autosync.frequency`.\nUsing webhooks allows you to get the most up-to-date data of your users, after each synchronization.\n\nThe automatic synchronization makes it possible to recover new bank entries, or new invoices, at a given frequency.\nYou have the possibility to add webhooks on several events, and choose to receive each one on a distinct URL.\nTo see the list of available webhooks you can call the endpoint hereunder:\n```\ncurl https://demo.biapi.pro/2.0/webhooks_events \\\n -H 'Authorization: Bearer <token>'\n```\n\nThe background synchronizations for each user are independent, and their plannings are spread over the day so that they do not overload any website.\n\nOnce the synchronization of a user is over, a POST request is sent on the callback URL you have defined, including all webhook data.\nA typical json sent to your server is as below:\n```http\nPOST /callback HTTP/1.1\nHost: example.org\nContent-Length: 959\nAccept-Encoding: gzip, deflate, compress\nAccept: */*\nUser-Agent: Budgea API/2.0\nContent-Type: application/json; charset=utf-8\nAuthorization: Bearer sl/wuqgD2eOo+4Zf9FjvAz3YJgU+JKsJ\n\n{\n \"connections\" : [\n {\n \"accounts\" : [\n {\n \"balance\" : 7481.01,\n \"currency\" : {\n \"symbol\" : \"€\",\n \"id\" : \"EUR\",\n \"prefix\" : false\n },\n \"deleted\" : null,\n \"display\" : true,\n \"formatted_balance\" : \"7 481,01 €\",\n \"iban\" : \"FR76131048379405300290000016\",\n \"id\" : 17,\n \"id_connection\" : 7,\n \"investments\" : [\n {\n \"code\" : \"FR0010330902\",\n \"description\" : \"\",\n \"diff\" : -67.86,\n \"id\" : 55,\n \"id_account\" : 19,\n \"id_type\" : 1,\n \"label\" : \"Agressor PEA\",\n \"portfolio_share\" : 0.48,\n \"prev_diff\" : 2019.57,\n \"quantity\" : 7.338,\n \"type\" : {\n \"color\" : \"AABBCC\",\n \"id\" : 1,\n \"name\" : \"Fonds action\"\n },\n \"unitprice\" : 488.98,\n \"unitvalue\" : 479.73,\n \"valuation\" : 3520.28\n }\n ],\n \"last_update\" : \"2015-07-04 15:17:30\",\n \"name\" : \"Compte chèque\",\n \"number\" : \"3002900000\",\n \"transactions\" : [\n {\n \"active\" : true,\n \"application_date\" : \"2015-06-17\",\n \"coming\" : false,\n \"comment\" : null,\n \"commission\" : null,\n \"country\" : null,\n \"date\" : \"2015-06-18\",\n \"date_scraped\" : \"2015-07-04 15:17:30\",\n \"deleted\" : null,\n \"documents_count\" : 0,\n \"formatted_value\" : \"-16,22 €\",\n \"id\" : 309,\n \"id_account\" : 17,\n \"id_category\" : 9998,\n \"id_cluster\" : null,\n \"last_update\" : \"2015-07-04 15:17:30\",\n \"new\" : true,\n \"original_currency\" : null,\n \"original_value\" : null,\n \"original_wording\" : \"FACTURE CB HALL'S BEER\",\n \"rdate\" : \"2015-06-17\",\n \"simplified_wording\" : \"HALL'S BEER\",\n \"state\" : \"parsed\",\n \"stemmed_wording\" : \"HALL'S BEER\",\n \"type\" : \"card\",\n \"value\" : -16.22,\n \"wording\" : \"HALL'S BEER\"\n }\n ],\n \"type\" : \"checking\"\n }\n ],\n \"bank\" : {\n \"id_weboob\" : \"ing\",\n \"charged\" : true,\n \"name\" : \"ING Direct\",\n \"id\" : 7,\n \"hidden\" : false\n },\n \"error\" : null,\n \"expire\" : null,\n \"id\" : 7,\n \"id_user\" : 7,\n \"id_bank\" : 41,\n \"last_update\" : \"2015-07-04 15:17:31\"\n }\n ],\n \"total\" : 1,\n \"user\" : {\n \"signin\" : \"2015-07-04 15:17:29\",\n \"id\" : 7,\n \"platform\" : \"sharedAccess\"\n }\n}\n```\nThe authentication on the callback is made with the access_token of the user (which is a shared secret between your server and the Budgea API).\n\nWhen you are in production, it is needed to define a HTTPS URL using a valid certificate, delivered by a recognized authority. If this is not the case, you can contact us to add your CA (Certificate Authority) to our PKI (Public Key Infrastructure).\n\nImportant: it is necessary to send back a HTTP 200 code, without what we consider that data is not correctly taken into account on your system, and it will be sent again at the next user synchronization.\n\n## Guidelines for production\nNow you should have integrated the API inside your application. Make sure your Webhooks URLs are in HTTPS, if so you can enable the production state of the API.\n\nTo make things great, here are some good practices, please check you have respected them:\n- You have provided to your users a way to configure their accounts\n- You have provided to your users a way to change their account passwords\n- You consider the **error** field of Connections, to alert the user in case the state is **wrongpass**\n- You map IDs of Accounts, Subscriptions, Transactions and Documents in your application, to be sure to correctly match them\n- When the deleted field is set on a bank transaction, you delete it in your database\n- You don't loop on all users to launch synchronizations, this might saturate the service\n\nIf you have questions about above points, please contact us. Otherwise, you can put into production!\n\n### Going further\nIf you want to raise the bar for your app and add features such as the ability to do transfers, get invoices, aggregate patrimony and more, please refer to the sections below.\nWe'll discuss complementary APIs building upon the aggregation, allowing for the best of financial apps.\n\n## Budgea API Pay\nThis API allows for the emition of transfers between the aggregated accounts.\nJust like the simple aggregation, BI provides a webview or a protocol to follow, to implement this feature.\n\n### API pay protocol\nThis section describes how the transfer and recipient protocol work, in case you don't want to integrate the webview.\nThe idea is to do following calls client side (with AJAX in case of a web application), so that the interaction with the Budgea API is transparent.\n\n#### Executing a transfer\n1. /auth/token/code\nIf you do calls client side, get a new temporary code for the user, from the access_token. This will prevent security issues.\n```\ncurl -d '' \\\n https://demo.biapi.pro/2.0/auth/token/code \\\n -H 'Authorization: Bearer <token>'\n```\n```json\n{\n \"code\": \"/JiDppWgbmc+5ztHIUJtHl0ynYfw682Z\",\n \"type\": \"temporary\",\n \"expires_in\": 1800\n}\n```\nThe returned token has a life-time of 30 minutes.\n\n2. /users/me/accounts?able_to_transfer=1\nList all the accounts that can do transfers. Authenticate the call with the code you got at step 1.\n```\ncurl https://demo.biapi.pro/2.0/users/me/accounts?able_to_transfer=1 \\\n -H 'Authorization: Bearer /JiDppWgbmc+5ztHIUJtHl0ynYfw682Z'\n```\n```json\n{\n \"accounts\" : [\n {\n \"display\" : true,\n \"balance\" : 2893.36,\n \"id_type\" : 2,\n \"number\" : \"****1572\",\n \"type\" : \"checking\",\n \"deleted\" : null,\n \"bic\" : \"BNPAFRPPXXX\",\n \"bookmarked\" : false,\n \"coming\" : -2702.74,\n \"id_user\" : 1,\n \"original_name\" : \"Compte de chèques\",\n \"currency\" : {\n \"symbol\" : \"€\",\n \"id\" : \"EUR\",\n \"prefix\" : false\n },\n \"name\" : \"lol\",\n \"iban\" : \"FR7630004012550000041157244\",\n \"last_update\" : \"2016-12-28 12:31:04\",\n \"id\" : 723,\n \"formatted_balance\" : \"2893,36 €\",\n \"able_to_transfer\" : true,\n \"id_connection\" : 202\n }\n ],\n \"total\" : 1\n}\n```\n\n3. /users/me/accounts/ID/recipients\nList all available recipients for a given account.\n```\ncurl https://demo.biapi.pro/2.0/users/me/accounts/723/recipients?limit=1 \\\n -H 'Authorization: Bearer /JiDppWgbmc+5ztHIUJtHl0ynYfw682Z'\n```\n```json\n{\n \"total\" : 27,\n \"recipients\" : [\n {\n \"bank_name\" : \"BNP PARIBAS\",\n \"bic\" : \"BNPAFRPPXXX\",\n \"category\" : \"Interne\",\n \"deleted\" : null,\n \"enabled_at\" : \"2016-10-31 18:52:53\",\n \"expire\" : null,\n \"iban\" : \"FR7630004012550003027641744\",\n \"id\" : 1,\n \"id_account\" : 1,\n \"id_target_account\" : 2,\n \"label\" : \"Livret A\",\n \"last_update\" : \"2016-12-05 12:07:24\",\n \"time_scraped\" : \"2016-10-31 18:52:54\",\n \"webid\" : \"2.4.188268268091098819849694548441184167285851255682796371\"\n }\n ]\n}\n```\n\n4. /users/me/accounts/ID/recipients/ID/transfers\nCreate the transfer\n```\ncurl \\\n https://demo.biapi.pro/2.0/users/me/accounts/1/recipients/1/transfers \\\n -H 'Authorization: Bearer /JiDppWgbmc+5ztHIUJtHl0ynYfw682Z' \\\n -F amount=10, \\\n -F label=\"Test virement\", \\\n -F exec_date=\"2018-09-12\" // optional\n```\n```json\n{\n \"account_iban\" : \"FR7630004012550000041157244\",\n \"amount\" : 10,\n \"currency\" : {\n \"id\" : \"EUR\",\n \"prefix\" : false,\n \"symbol\" : \"€\"\n },\n \"exec_date\" : \"2018-09-12\",\n \"fees\" : null\n \"formatted_amount\" : \"10,00 €\",\n \"id\" : 22,\n \"id_account\" : 1,,\n \"id_recipient\" : 1,\n \"label\" : \"Test virement\",\n \"recipient_iban\" : \"FR7630004012550003027641744\",\n \"register_date\" : \"2018-09-12 10:34:59\",\n \"state\" : \"created\",\n \"webid\" : null\n}\n```\n\n5. /users/me/transfers/ID\nExecute the transfer\n```\ncurl \\\n https://demo.biapi.pro/2.0/users/me/transfers/22 \\\n -H 'Authorization: Bearer /JiDppWgbmc+5ztHIUJtHl0ynYfw682Z' \\\n -F validated=true\n```\n```json\n{\n \"account_iban\" : \"FR7630004012550000041157244\",\n \"amount\" : 10,\n \"currency\" : {\n \"id\" : \"EUR\",\n \"prefix\" : false,\n \"symbol\" : \"€\"\n },\n \"exec_date\" : \"2016-12-19\",\n \"fees\" : null,\n \"fields\" : [\n {\n \"label\" : \"Code secret BNP Paribas\",\n \"type\" : \"password\",\n \"regex\" : \"^[0-9]{6}$\",\n \"name\" : \"password\"\n }\n ],\n \"formatted_amount\" : \"10,00 €\",\n \"id\" : 22,\n \"id_account\" : 1,\n \"id_recipient\" : 1,\n \"label\" : \"Test virement\",\n \"recipient_iban\" : \"FR7630004012550003027641744\",\n \"register_date\" : \"2016-12-19 10:34:59\",\n \"state\" : \"created\",\n \"webid\" : null\n}\n```\nHere, an authentication step asks user to enter his bank password. The transfer can be validated with:\n\n```\ncurl \\\n https://demo.biapi.pro/2.0/users/me/transfers/22 \\\n -H 'Authorization: Bearer /JiDppWgbmc+5ztHIUJtHl0ynYfw682Z' \\\n -F validated=true \\\n -F password=\"123456\"\n```\n```json\n{\n \"account_iban\" : \"FR7630004012550000041157244\",\n \"currency\" : {\n \"id\" : \"EUR\",\n \"prefix\" : false,\n \"symbol\" : \"€\"\n },\n \"amount\" : 10,\n \"exec_date\" : \"2016-12-19\",\n \"fees\" : 0,\n \"formatted_amount\" : \"10,00 €\",\n \"id\" : 22,\n \"id_account\" : 1,\n \"id_recipient\" : 1,\n \"label\" : \"Test virement\",\n \"recipient_iban\" : \"FR7630004012550003027641744\",\n \"register_date\" : \"2016-12-19 10:34:59\",\n \"state\" : \"pending\",\n \"webid\" : \"ZZ10C4FKSNP05TK95\"\n}\n```\nThe field state is changed to *pending*, telling that the transfer has been correctly executed on the bank. A connection synchronization is then launched, to find the bank transaction in the movements history. In this case, the transfer state will be changed to *done*.\n\n#### Adding a recipient\n1. /auth/token/code\nGet a temporary token for the user. Same procedure than step 1 for a transfer.\n\n2. /users/me/accounts?able_to_transfer=1\nList accounts allowing transfers. Same procedure than step 2 for a transfer.\n\n3. /users/me/accounts/ID/recipients/\nAdd a new recipient.\n```\ncurl \\\n https://demo.biapi.pro/2.0/users/me/accounts/1/recipients \\\n -H 'Authorization: Bearer /JiDppWgbmc+5ztHIUJtHl0ynYfw682Z' \\\n -F iban=FR7613048379405300290000355 \\\n -F label=\"Papa\", \\\n -F category=\"Famille\" // optional\n```\n```json\n{\n \"bank_name\" : \"BNP PARIBAS\",\n \"bic\" : \"BNPAFRPPXXX\",\n \"category\" : \"Famille\",\n \"deleted\" : null,\n \"enabled_at\" : null,\n \"expire\" : \"2017-04-29 16:56:20\",\n \"fields\" : [\n {\n \"label\" : \"Veuillez entrer le code reçu par SMS\",\n \"type\" : \"password\",\n \"regex\" : \"^[0-9]{6}$\",\n \"name\" : \"sms\"\n }\n ],\n \"iban\" : \"FR7613048379405300290000355\",\n \"id\" : 2,\n \"id_account\" : 1,\n \"id_target_account\" : null,\n \"label\" : \"Papa\",\n \"last_update\" : \"2017-04-29 16:26:20\",\n \"time_scraped\" : null,\n \"webid\" : null\n}\n```\nIt is necessary to post on the object Recipient with the requested fields (here sms), until the add is validated:\n```\ncurl \\\n https://demo.biapi.pro/2.0/users/me/accounts/1/recipients/2 \\\n -H 'Authorization: Bearer /JiDppWgbmc+5ztHIUJtHl0ynYfw682Z' \\\n -F sms=\"123456\"\n```\n```json\n{\n \"bank_name\" : \"BNP PARIBAS\",\n \"bic\" : \"BNPAFRPPXXX\",\n \"category\" : \"Famille\",\n \"deleted\" : null,\n \"enabled_at\" : \"2017-05-01 00:00:00\",\n \"expire\" : null,\n \"iban\" : \"FR7613048379405300290000355\",\n \"id\" : 2,\n \"id_account\" : 1,\n \"id_target_account\" : null,\n \"label\" : \"Papa\",\n \"last_update\" : \"2017-04-29 16:26:20\",\n \"time_scraped\" : null,\n \"webid\" : \"2.4.188268268091098819849694548441184167285851255682796371\"\n}\n```\nIf the field enabled_at is in the future, it means that it isn't possible yet to execute a transfer, as the bank requires to wait a validation period.\n\n### API Pay Webview\nThis section describes how to integrate the webview of the Budgea Pay API inside your application, to let your users do transfers to their recipients.\n\n#### User redirection\nTo redirect the user to the webview, it is necessary to build a URI authenticated with a temporary token.\nThis can be done from our library, or by calling the endpoint `/auth/token/code` (see the protocol section for an example).\nIf the parameter **redirect_uri** is supplied, the user will be redirected to that page once the transfer is done.\n\n#### List of pages\nHere are a list a pages you may call to redirect your user directly on a page of the process:\n|Path |Description of the page |\n|-------------------------------------|----------------------------------------------------------------------------------|\n|/transfers |List Transfers |\n|/transfers/accounts |List emitter accounts |\n|/transfers/accounts/id/recipients |List recipients |\n|/transfers/accounts/id/recipients/id |Initialization of a transfer between the account and the recipient |\n|/transfers/id |Detail of a given transfer |\n\n## Deprecated\n\nThis section lists all the deprecated features in Budgea API. The associated date is the date of its removal.\n**Do not use them**.\n\n### Key Investments (**2019-06-24**)\n\nAdding a temporary new key \"all_investments\" that will include deleted investments in the **webhooks**.\n\n### No automatic expand on User objects (**2019-07-30**)\nIn the API responses, by default, User objects won't display the keys \"config\", \"alert_settings\" and \"invites\" anymore.\nYou will still be able to access this data by expanding the request.\nExample: GET /users/me/?expand=alert_settings,config\n\n### Renaming of \"type\" field for jwt tokens (**2019-07-30**)\nFor user's tokens in the jwt format, the \"type\" field will be renamed from \"shared_access\" to \"sharedAccess\".\n",
|
|
5
5
|
"title": "Budgea API Documentation"
|
|
6
6
|
},
|
|
7
7
|
"paths": {
|
|
@@ -329,7 +329,7 @@
|
|
|
329
329
|
"exp": 1538596697,
|
|
330
330
|
"iat": 1538594897,
|
|
331
331
|
"scope": "",
|
|
332
|
-
"type": "
|
|
332
|
+
"type": "sharedAccess"
|
|
333
333
|
}
|
|
334
334
|
}
|
|
335
335
|
}
|
|
@@ -456,6 +456,21 @@
|
|
|
456
456
|
"summary": "Register to API"
|
|
457
457
|
}
|
|
458
458
|
},
|
|
459
|
+
"/auth/resendConfirmEmail": {
|
|
460
|
+
"post": {
|
|
461
|
+
"responses": {
|
|
462
|
+
"200": {
|
|
463
|
+
"description": "standard HTTP response"
|
|
464
|
+
}
|
|
465
|
+
},
|
|
466
|
+
"tags": [
|
|
467
|
+
"PFM"
|
|
468
|
+
],
|
|
469
|
+
"description": "Sent token can be re-generated as it might be expired. Note that requesting email confirmation on already confirmed profile will raise a BadRequest.<br><br>",
|
|
470
|
+
"parameters": [],
|
|
471
|
+
"summary": "Resend an email to confirm email address."
|
|
472
|
+
}
|
|
473
|
+
},
|
|
459
474
|
"/auth/token": {
|
|
460
475
|
"post": {
|
|
461
476
|
"responses": {
|
|
@@ -1021,6 +1036,55 @@
|
|
|
1021
1036
|
"summary": "Get all links to the files associated with this connector."
|
|
1022
1037
|
}
|
|
1023
1038
|
},
|
|
1039
|
+
"/banks/{id_connector}/sources": {
|
|
1040
|
+
"get": {
|
|
1041
|
+
"responses": {
|
|
1042
|
+
"200": {
|
|
1043
|
+
"description": "sources",
|
|
1044
|
+
"schema": {
|
|
1045
|
+
"required": [
|
|
1046
|
+
"sources"
|
|
1047
|
+
],
|
|
1048
|
+
"type": "object",
|
|
1049
|
+
"properties": {
|
|
1050
|
+
"sources": {
|
|
1051
|
+
"items": {
|
|
1052
|
+
"$ref": "#/definitions/ConnectorSource"
|
|
1053
|
+
},
|
|
1054
|
+
"type": "array"
|
|
1055
|
+
},
|
|
1056
|
+
"total": {
|
|
1057
|
+
"type": "number",
|
|
1058
|
+
"description": "total number of results"
|
|
1059
|
+
}
|
|
1060
|
+
}
|
|
1061
|
+
}
|
|
1062
|
+
}
|
|
1063
|
+
},
|
|
1064
|
+
"tags": [
|
|
1065
|
+
"Connections",
|
|
1066
|
+
"Banks",
|
|
1067
|
+
"Providers"
|
|
1068
|
+
],
|
|
1069
|
+
"description": "",
|
|
1070
|
+
"parameters": [
|
|
1071
|
+
{
|
|
1072
|
+
"required": true,
|
|
1073
|
+
"in": "path",
|
|
1074
|
+
"type": "integer",
|
|
1075
|
+
"name": "id_connector",
|
|
1076
|
+
"description": ""
|
|
1077
|
+
},
|
|
1078
|
+
{
|
|
1079
|
+
"required": false,
|
|
1080
|
+
"type": "string",
|
|
1081
|
+
"name": "expand",
|
|
1082
|
+
"in": "query"
|
|
1083
|
+
}
|
|
1084
|
+
],
|
|
1085
|
+
"summary": "Get list of connector sources"
|
|
1086
|
+
}
|
|
1087
|
+
},
|
|
1024
1088
|
"/categories": {
|
|
1025
1089
|
"get": {
|
|
1026
1090
|
"responses": {
|
|
@@ -1285,9 +1349,9 @@
|
|
|
1285
1349
|
{
|
|
1286
1350
|
"required": false,
|
|
1287
1351
|
"in": "formData",
|
|
1288
|
-
"type": "
|
|
1289
|
-
"name": "
|
|
1290
|
-
"description": "
|
|
1352
|
+
"type": "array",
|
|
1353
|
+
"name": "redirect_uris",
|
|
1354
|
+
"description": "list of allowed redirect uris"
|
|
1291
1355
|
},
|
|
1292
1356
|
{
|
|
1293
1357
|
"required": false,
|
|
@@ -1319,7 +1383,7 @@
|
|
|
1319
1383
|
"tags": [
|
|
1320
1384
|
"Administration"
|
|
1321
1385
|
],
|
|
1322
|
-
"description": "If you use the manage_token or a configuration token, you will get also the
|
|
1386
|
+
"description": "If you use the manage_token or a configuration token, you will get also the client secret.<br><br>",
|
|
1323
1387
|
"parameters": [
|
|
1324
1388
|
{
|
|
1325
1389
|
"required": true,
|
|
@@ -1382,9 +1446,9 @@
|
|
|
1382
1446
|
{
|
|
1383
1447
|
"required": false,
|
|
1384
1448
|
"in": "formData",
|
|
1385
|
-
"type": "
|
|
1386
|
-
"name": "
|
|
1387
|
-
"description": "
|
|
1449
|
+
"type": "array",
|
|
1450
|
+
"name": "redirect_uris",
|
|
1451
|
+
"description": "list of allowed redirect uris"
|
|
1388
1452
|
},
|
|
1389
1453
|
{
|
|
1390
1454
|
"required": false,
|
|
@@ -1709,6 +1773,134 @@
|
|
|
1709
1773
|
"summary": "Get connections without a user"
|
|
1710
1774
|
}
|
|
1711
1775
|
},
|
|
1776
|
+
"/connections/{id_connection}/logs": {
|
|
1777
|
+
"get": {
|
|
1778
|
+
"responses": {
|
|
1779
|
+
"200": {
|
|
1780
|
+
"description": "connectionlogs",
|
|
1781
|
+
"schema": {
|
|
1782
|
+
"required": [
|
|
1783
|
+
"connectionlogs"
|
|
1784
|
+
],
|
|
1785
|
+
"type": "object",
|
|
1786
|
+
"properties": {
|
|
1787
|
+
"total": {
|
|
1788
|
+
"type": "number",
|
|
1789
|
+
"description": "total number of results"
|
|
1790
|
+
},
|
|
1791
|
+
"connectionlogs": {
|
|
1792
|
+
"items": {
|
|
1793
|
+
"$ref": "#/definitions/ConnectionLog"
|
|
1794
|
+
},
|
|
1795
|
+
"type": "array"
|
|
1796
|
+
}
|
|
1797
|
+
}
|
|
1798
|
+
}
|
|
1799
|
+
}
|
|
1800
|
+
},
|
|
1801
|
+
"tags": [
|
|
1802
|
+
"Connections",
|
|
1803
|
+
"Banks",
|
|
1804
|
+
"Providers"
|
|
1805
|
+
],
|
|
1806
|
+
"description": "Get logs about connections.<br><br>",
|
|
1807
|
+
"parameters": [
|
|
1808
|
+
{
|
|
1809
|
+
"required": true,
|
|
1810
|
+
"in": "path",
|
|
1811
|
+
"type": "integer",
|
|
1812
|
+
"name": "id_connection",
|
|
1813
|
+
"description": ""
|
|
1814
|
+
},
|
|
1815
|
+
{
|
|
1816
|
+
"required": false,
|
|
1817
|
+
"in": "query",
|
|
1818
|
+
"type": "integer",
|
|
1819
|
+
"name": "limit",
|
|
1820
|
+
"description": "limit number of results"
|
|
1821
|
+
},
|
|
1822
|
+
{
|
|
1823
|
+
"required": false,
|
|
1824
|
+
"in": "query",
|
|
1825
|
+
"type": "integer",
|
|
1826
|
+
"name": "offset",
|
|
1827
|
+
"description": "offset of first result"
|
|
1828
|
+
},
|
|
1829
|
+
{
|
|
1830
|
+
"name": "min_date",
|
|
1831
|
+
"format": "date",
|
|
1832
|
+
"required": false,
|
|
1833
|
+
"in": "query",
|
|
1834
|
+
"type": "string",
|
|
1835
|
+
"description": "minimal date"
|
|
1836
|
+
},
|
|
1837
|
+
{
|
|
1838
|
+
"name": "max_date",
|
|
1839
|
+
"format": "date",
|
|
1840
|
+
"required": false,
|
|
1841
|
+
"in": "query",
|
|
1842
|
+
"type": "string",
|
|
1843
|
+
"description": "maximum date"
|
|
1844
|
+
},
|
|
1845
|
+
{
|
|
1846
|
+
"required": false,
|
|
1847
|
+
"in": "query",
|
|
1848
|
+
"type": "integer",
|
|
1849
|
+
"name": "state",
|
|
1850
|
+
"description": "state of user"
|
|
1851
|
+
},
|
|
1852
|
+
{
|
|
1853
|
+
"required": false,
|
|
1854
|
+
"in": "query",
|
|
1855
|
+
"type": "string",
|
|
1856
|
+
"name": "period",
|
|
1857
|
+
"description": "period to group logs"
|
|
1858
|
+
},
|
|
1859
|
+
{
|
|
1860
|
+
"required": false,
|
|
1861
|
+
"in": "query",
|
|
1862
|
+
"type": "integer",
|
|
1863
|
+
"name": "id_user",
|
|
1864
|
+
"description": "ID of a user"
|
|
1865
|
+
},
|
|
1866
|
+
{
|
|
1867
|
+
"required": false,
|
|
1868
|
+
"in": "query",
|
|
1869
|
+
"type": "integer",
|
|
1870
|
+
"name": "id_connection",
|
|
1871
|
+
"description": "ID of a connection"
|
|
1872
|
+
},
|
|
1873
|
+
{
|
|
1874
|
+
"required": false,
|
|
1875
|
+
"in": "query",
|
|
1876
|
+
"type": "integer",
|
|
1877
|
+
"name": "id_connector",
|
|
1878
|
+
"description": "ID of a connector"
|
|
1879
|
+
},
|
|
1880
|
+
{
|
|
1881
|
+
"required": false,
|
|
1882
|
+
"in": "query",
|
|
1883
|
+
"type": "boolean",
|
|
1884
|
+
"name": "charged",
|
|
1885
|
+
"description": "consider only logs for charged connectors"
|
|
1886
|
+
},
|
|
1887
|
+
{
|
|
1888
|
+
"required": false,
|
|
1889
|
+
"in": "query",
|
|
1890
|
+
"type": "integer",
|
|
1891
|
+
"name": "id_source",
|
|
1892
|
+
"description": "ID of a source"
|
|
1893
|
+
},
|
|
1894
|
+
{
|
|
1895
|
+
"required": false,
|
|
1896
|
+
"type": "string",
|
|
1897
|
+
"name": "expand",
|
|
1898
|
+
"in": "query"
|
|
1899
|
+
}
|
|
1900
|
+
],
|
|
1901
|
+
"summary": "Get connection logs"
|
|
1902
|
+
}
|
|
1903
|
+
},
|
|
1712
1904
|
"/connectors": {
|
|
1713
1905
|
"get": {
|
|
1714
1906
|
"responses": {
|
|
@@ -1831,6 +2023,36 @@
|
|
|
1831
2023
|
}
|
|
1832
2024
|
],
|
|
1833
2025
|
"summary": "Request a new connector"
|
|
2026
|
+
},
|
|
2027
|
+
"put": {
|
|
2028
|
+
"responses": {
|
|
2029
|
+
"200": {
|
|
2030
|
+
"description": "Successful PUT on Connector resource",
|
|
2031
|
+
"schema": {
|
|
2032
|
+
"$ref": "#/definitions/Connector"
|
|
2033
|
+
}
|
|
2034
|
+
}
|
|
2035
|
+
},
|
|
2036
|
+
"tags": [
|
|
2037
|
+
"Banks"
|
|
2038
|
+
],
|
|
2039
|
+
"description": "",
|
|
2040
|
+
"parameters": [
|
|
2041
|
+
{
|
|
2042
|
+
"required": false,
|
|
2043
|
+
"in": "formData",
|
|
2044
|
+
"type": "boolean",
|
|
2045
|
+
"name": "hidden",
|
|
2046
|
+
"description": "to enable or disable connector (bank or provider)"
|
|
2047
|
+
},
|
|
2048
|
+
{
|
|
2049
|
+
"required": false,
|
|
2050
|
+
"type": "string",
|
|
2051
|
+
"name": "expand",
|
|
2052
|
+
"in": "query"
|
|
2053
|
+
}
|
|
2054
|
+
],
|
|
2055
|
+
"summary": "Enable/disable several connectors"
|
|
1834
2056
|
}
|
|
1835
2057
|
},
|
|
1836
2058
|
"/connectors/{id_connector}": {
|
|
@@ -1846,6 +2068,7 @@
|
|
|
1846
2068
|
"code": "40618",
|
|
1847
2069
|
"name": "Boursorama",
|
|
1848
2070
|
"color": "f10389",
|
|
2071
|
+
"beta": true,
|
|
1849
2072
|
"capabilities": [
|
|
1850
2073
|
"profile",
|
|
1851
2074
|
"banktransferaddrecipient",
|
|
@@ -1854,7 +2077,7 @@
|
|
|
1854
2077
|
"banktransfer"
|
|
1855
2078
|
],
|
|
1856
2079
|
"id": 4,
|
|
1857
|
-
"
|
|
2080
|
+
"auth_mechanism": "credentials",
|
|
1858
2081
|
"hidden": false,
|
|
1859
2082
|
"slug": "BOU",
|
|
1860
2083
|
"categories": [
|
|
@@ -1897,6 +2120,13 @@
|
|
|
1897
2120
|
"name": "sync_frequency",
|
|
1898
2121
|
"description": "Allows you to overload global sync_frequency param"
|
|
1899
2122
|
},
|
|
2123
|
+
{
|
|
2124
|
+
"required": false,
|
|
2125
|
+
"in": "formData",
|
|
2126
|
+
"type": "string",
|
|
2127
|
+
"name": "auth_mechanism",
|
|
2128
|
+
"description": "the authentication mechanism to use for this connector"
|
|
2129
|
+
},
|
|
1900
2130
|
{
|
|
1901
2131
|
"required": false,
|
|
1902
2132
|
"type": "string",
|
|
@@ -2191,37 +2421,45 @@
|
|
|
2191
2421
|
"summary": "Delete a single Logo object."
|
|
2192
2422
|
}
|
|
2193
2423
|
},
|
|
2194
|
-
"/
|
|
2424
|
+
"/connectors/{id_connector}/sources": {
|
|
2195
2425
|
"get": {
|
|
2196
2426
|
"responses": {
|
|
2197
2427
|
"200": {
|
|
2198
|
-
"description": "
|
|
2428
|
+
"description": "sources",
|
|
2199
2429
|
"schema": {
|
|
2200
2430
|
"required": [
|
|
2201
|
-
"
|
|
2431
|
+
"sources"
|
|
2202
2432
|
],
|
|
2203
2433
|
"type": "object",
|
|
2204
2434
|
"properties": {
|
|
2205
|
-
"
|
|
2206
|
-
"type": "number",
|
|
2207
|
-
"description": "total number of results"
|
|
2208
|
-
},
|
|
2209
|
-
"documenttypes": {
|
|
2435
|
+
"sources": {
|
|
2210
2436
|
"items": {
|
|
2211
|
-
"$ref": "#/definitions/
|
|
2437
|
+
"$ref": "#/definitions/ConnectorSource"
|
|
2212
2438
|
},
|
|
2213
2439
|
"type": "array"
|
|
2440
|
+
},
|
|
2441
|
+
"total": {
|
|
2442
|
+
"type": "number",
|
|
2443
|
+
"description": "total number of results"
|
|
2214
2444
|
}
|
|
2215
2445
|
}
|
|
2216
2446
|
}
|
|
2217
2447
|
}
|
|
2218
2448
|
},
|
|
2219
2449
|
"tags": [
|
|
2220
|
-
"
|
|
2221
|
-
"
|
|
2450
|
+
"Connections",
|
|
2451
|
+
"Banks",
|
|
2452
|
+
"Providers"
|
|
2222
2453
|
],
|
|
2223
2454
|
"description": "",
|
|
2224
2455
|
"parameters": [
|
|
2456
|
+
{
|
|
2457
|
+
"required": true,
|
|
2458
|
+
"in": "path",
|
|
2459
|
+
"type": "integer",
|
|
2460
|
+
"name": "id_connector",
|
|
2461
|
+
"description": ""
|
|
2462
|
+
},
|
|
2225
2463
|
{
|
|
2226
2464
|
"required": false,
|
|
2227
2465
|
"type": "string",
|
|
@@ -2229,24 +2467,121 @@
|
|
|
2229
2467
|
"in": "query"
|
|
2230
2468
|
}
|
|
2231
2469
|
],
|
|
2232
|
-
"summary": "Get
|
|
2470
|
+
"summary": "Get list of connector sources"
|
|
2233
2471
|
}
|
|
2234
2472
|
},
|
|
2235
|
-
"/
|
|
2473
|
+
"/connectors/{id_connector}/sources/{id_source}": {
|
|
2236
2474
|
"put": {
|
|
2237
2475
|
"responses": {
|
|
2238
2476
|
"200": {
|
|
2239
|
-
"description": "Successful PUT on
|
|
2477
|
+
"description": "Successful PUT on ConnectorSource resource",
|
|
2240
2478
|
"schema": {
|
|
2241
|
-
"$ref": "#/definitions/
|
|
2479
|
+
"$ref": "#/definitions/ConnectorSource"
|
|
2242
2480
|
}
|
|
2243
2481
|
}
|
|
2244
2482
|
},
|
|
2245
2483
|
"tags": [
|
|
2246
|
-
"
|
|
2247
|
-
"
|
|
2484
|
+
"Connections",
|
|
2485
|
+
"Banks",
|
|
2486
|
+
"Providers"
|
|
2248
2487
|
],
|
|
2249
|
-
"description": "
|
|
2488
|
+
"description": "",
|
|
2489
|
+
"parameters": [
|
|
2490
|
+
{
|
|
2491
|
+
"required": true,
|
|
2492
|
+
"in": "path",
|
|
2493
|
+
"type": "integer",
|
|
2494
|
+
"name": "id_connector",
|
|
2495
|
+
"description": ""
|
|
2496
|
+
},
|
|
2497
|
+
{
|
|
2498
|
+
"required": true,
|
|
2499
|
+
"in": "path",
|
|
2500
|
+
"type": "integer",
|
|
2501
|
+
"name": "id_source",
|
|
2502
|
+
"description": ""
|
|
2503
|
+
},
|
|
2504
|
+
{
|
|
2505
|
+
"required": false,
|
|
2506
|
+
"in": "formData",
|
|
2507
|
+
"type": "string",
|
|
2508
|
+
"name": "auth_mechanism",
|
|
2509
|
+
"description": "the authentication mechanism to use for this connector source"
|
|
2510
|
+
},
|
|
2511
|
+
{
|
|
2512
|
+
"name": "disabled",
|
|
2513
|
+
"format": "date-time",
|
|
2514
|
+
"required": false,
|
|
2515
|
+
"in": "formData",
|
|
2516
|
+
"type": "string",
|
|
2517
|
+
"description": "to enable or disable connector source"
|
|
2518
|
+
},
|
|
2519
|
+
{
|
|
2520
|
+
"required": false,
|
|
2521
|
+
"type": "string",
|
|
2522
|
+
"name": "expand",
|
|
2523
|
+
"in": "query"
|
|
2524
|
+
}
|
|
2525
|
+
],
|
|
2526
|
+
"summary": "Edit the provided connector source"
|
|
2527
|
+
}
|
|
2528
|
+
},
|
|
2529
|
+
"/documenttypes": {
|
|
2530
|
+
"get": {
|
|
2531
|
+
"responses": {
|
|
2532
|
+
"200": {
|
|
2533
|
+
"description": "documenttypes",
|
|
2534
|
+
"schema": {
|
|
2535
|
+
"required": [
|
|
2536
|
+
"documenttypes"
|
|
2537
|
+
],
|
|
2538
|
+
"type": "object",
|
|
2539
|
+
"properties": {
|
|
2540
|
+
"total": {
|
|
2541
|
+
"type": "number",
|
|
2542
|
+
"description": "total number of results"
|
|
2543
|
+
},
|
|
2544
|
+
"documenttypes": {
|
|
2545
|
+
"items": {
|
|
2546
|
+
"$ref": "#/definitions/DocumentType"
|
|
2547
|
+
},
|
|
2548
|
+
"type": "array"
|
|
2549
|
+
}
|
|
2550
|
+
}
|
|
2551
|
+
}
|
|
2552
|
+
}
|
|
2553
|
+
},
|
|
2554
|
+
"tags": [
|
|
2555
|
+
"Providers",
|
|
2556
|
+
"Documents"
|
|
2557
|
+
],
|
|
2558
|
+
"description": "",
|
|
2559
|
+
"parameters": [
|
|
2560
|
+
{
|
|
2561
|
+
"required": false,
|
|
2562
|
+
"type": "string",
|
|
2563
|
+
"name": "expand",
|
|
2564
|
+
"in": "query"
|
|
2565
|
+
}
|
|
2566
|
+
],
|
|
2567
|
+
"summary": "Get document types"
|
|
2568
|
+
}
|
|
2569
|
+
},
|
|
2570
|
+
"/documenttypes/{id_documenttype}": {
|
|
2571
|
+
"put": {
|
|
2572
|
+
"responses": {
|
|
2573
|
+
"200": {
|
|
2574
|
+
"description": "Successful PUT on DocumentType resource",
|
|
2575
|
+
"schema": {
|
|
2576
|
+
"$ref": "#/definitions/DocumentType"
|
|
2577
|
+
}
|
|
2578
|
+
}
|
|
2579
|
+
},
|
|
2580
|
+
"tags": [
|
|
2581
|
+
"Providers",
|
|
2582
|
+
"Documents"
|
|
2583
|
+
],
|
|
2584
|
+
"description": "Change value of a document type.<br><br>",
|
|
2250
2585
|
"parameters": [
|
|
2251
2586
|
{
|
|
2252
2587
|
"required": true,
|
|
@@ -2406,7 +2741,7 @@
|
|
|
2406
2741
|
"tags": [
|
|
2407
2742
|
"Banks"
|
|
2408
2743
|
],
|
|
2409
|
-
"description": "
|
|
2744
|
+
"description": "You can get all the invoicing data or just specific ones by using the available parameters.<br><br>If no parameters are specified, no invoicing data is returned.<br><br>",
|
|
2410
2745
|
"parameters": [
|
|
2411
2746
|
{
|
|
2412
2747
|
"name": "min_date",
|
|
@@ -2428,18 +2763,74 @@
|
|
|
2428
2763
|
"required": false,
|
|
2429
2764
|
"in": "query",
|
|
2430
2765
|
"type": "string",
|
|
2431
|
-
"name": "
|
|
2432
|
-
"description": "
|
|
2766
|
+
"name": "users_synced",
|
|
2767
|
+
"description": "the number of user synchronized during the period"
|
|
2768
|
+
},
|
|
2769
|
+
{
|
|
2770
|
+
"required": false,
|
|
2771
|
+
"in": "query",
|
|
2772
|
+
"type": "string",
|
|
2773
|
+
"name": "users_bank",
|
|
2774
|
+
"description": "the number of user of the Bank API synchronized during the period"
|
|
2775
|
+
},
|
|
2776
|
+
{
|
|
2777
|
+
"required": false,
|
|
2778
|
+
"in": "query",
|
|
2779
|
+
"type": "string",
|
|
2780
|
+
"name": "users_bill",
|
|
2781
|
+
"description": " the number of user of the Bill API synchronized during the period"
|
|
2782
|
+
},
|
|
2783
|
+
{
|
|
2784
|
+
"required": false,
|
|
2785
|
+
"in": "query",
|
|
2786
|
+
"type": "string",
|
|
2787
|
+
"name": "accounts_synced",
|
|
2788
|
+
"description": "the number of accounts synchronized during the period"
|
|
2789
|
+
},
|
|
2790
|
+
{
|
|
2791
|
+
"required": false,
|
|
2792
|
+
"in": "query",
|
|
2793
|
+
"type": "string",
|
|
2794
|
+
"name": "subscriptions_synced",
|
|
2795
|
+
"description": "the number of subscriptions synchronized during the period"
|
|
2796
|
+
},
|
|
2797
|
+
{
|
|
2798
|
+
"required": false,
|
|
2799
|
+
"in": "query",
|
|
2800
|
+
"type": "string",
|
|
2801
|
+
"name": "connections_synced",
|
|
2802
|
+
"description": "the number of connections synchronized during the period"
|
|
2803
|
+
},
|
|
2804
|
+
{
|
|
2805
|
+
"required": false,
|
|
2806
|
+
"in": "query",
|
|
2807
|
+
"type": "string",
|
|
2808
|
+
"name": "connections_account",
|
|
2809
|
+
"description": "the number of Bank API connections synchronized during the period"
|
|
2810
|
+
},
|
|
2811
|
+
{
|
|
2812
|
+
"required": false,
|
|
2813
|
+
"in": "query",
|
|
2814
|
+
"type": "string",
|
|
2815
|
+
"name": "transfers_synced",
|
|
2816
|
+
"description": "the number of transfers done during the period"
|
|
2433
2817
|
},
|
|
2434
2818
|
{
|
|
2435
2819
|
"required": false,
|
|
2436
2820
|
"in": "query",
|
|
2437
2821
|
"type": "string",
|
|
2438
2822
|
"name": "all",
|
|
2823
|
+
"description": "get all the invoicing data at once"
|
|
2824
|
+
},
|
|
2825
|
+
{
|
|
2826
|
+
"required": false,
|
|
2827
|
+
"in": "query",
|
|
2828
|
+
"type": "string",
|
|
2829
|
+
"name": "detail",
|
|
2439
2830
|
"description": "get full ids list instead of numbers"
|
|
2440
2831
|
}
|
|
2441
2832
|
],
|
|
2442
|
-
"summary": "Get
|
|
2833
|
+
"summary": "Get invoicing data for a given period (default is the current month)."
|
|
2443
2834
|
}
|
|
2444
2835
|
},
|
|
2445
2836
|
"/logs": {
|
|
@@ -2546,6 +2937,13 @@
|
|
|
2546
2937
|
"name": "charged",
|
|
2547
2938
|
"description": "consider only logs for charged connectors"
|
|
2548
2939
|
},
|
|
2940
|
+
{
|
|
2941
|
+
"required": false,
|
|
2942
|
+
"in": "query",
|
|
2943
|
+
"type": "integer",
|
|
2944
|
+
"name": "id_source",
|
|
2945
|
+
"description": "ID of a source"
|
|
2946
|
+
},
|
|
2549
2947
|
{
|
|
2550
2948
|
"required": false,
|
|
2551
2949
|
"type": "string",
|
|
@@ -2619,9 +3017,9 @@
|
|
|
2619
3017
|
{
|
|
2620
3018
|
"required": true,
|
|
2621
3019
|
"in": "formData",
|
|
2622
|
-
"type": "
|
|
2623
|
-
"name": "
|
|
2624
|
-
"description": "
|
|
3020
|
+
"type": "array",
|
|
3021
|
+
"name": "redirect_uris",
|
|
3022
|
+
"description": "list of allowed redirect uris"
|
|
2625
3023
|
},
|
|
2626
3024
|
{
|
|
2627
3025
|
"required": true,
|
|
@@ -3109,6 +3507,55 @@
|
|
|
3109
3507
|
"summary": "Get all links to the files associated with this connector."
|
|
3110
3508
|
}
|
|
3111
3509
|
},
|
|
3510
|
+
"/providers/{id_connector}/sources": {
|
|
3511
|
+
"get": {
|
|
3512
|
+
"responses": {
|
|
3513
|
+
"200": {
|
|
3514
|
+
"description": "sources",
|
|
3515
|
+
"schema": {
|
|
3516
|
+
"required": [
|
|
3517
|
+
"sources"
|
|
3518
|
+
],
|
|
3519
|
+
"type": "object",
|
|
3520
|
+
"properties": {
|
|
3521
|
+
"sources": {
|
|
3522
|
+
"items": {
|
|
3523
|
+
"$ref": "#/definitions/ConnectorSource"
|
|
3524
|
+
},
|
|
3525
|
+
"type": "array"
|
|
3526
|
+
},
|
|
3527
|
+
"total": {
|
|
3528
|
+
"type": "number",
|
|
3529
|
+
"description": "total number of results"
|
|
3530
|
+
}
|
|
3531
|
+
}
|
|
3532
|
+
}
|
|
3533
|
+
}
|
|
3534
|
+
},
|
|
3535
|
+
"tags": [
|
|
3536
|
+
"Connections",
|
|
3537
|
+
"Banks",
|
|
3538
|
+
"Providers"
|
|
3539
|
+
],
|
|
3540
|
+
"description": "",
|
|
3541
|
+
"parameters": [
|
|
3542
|
+
{
|
|
3543
|
+
"required": true,
|
|
3544
|
+
"in": "path",
|
|
3545
|
+
"type": "integer",
|
|
3546
|
+
"name": "id_connector",
|
|
3547
|
+
"description": ""
|
|
3548
|
+
},
|
|
3549
|
+
{
|
|
3550
|
+
"required": false,
|
|
3551
|
+
"type": "string",
|
|
3552
|
+
"name": "expand",
|
|
3553
|
+
"in": "query"
|
|
3554
|
+
}
|
|
3555
|
+
],
|
|
3556
|
+
"summary": "Get list of connector sources"
|
|
3557
|
+
}
|
|
3558
|
+
},
|
|
3112
3559
|
"/terms": {
|
|
3113
3560
|
"get": {
|
|
3114
3561
|
"responses": {
|
|
@@ -3491,7 +3938,7 @@
|
|
|
3491
3938
|
{
|
|
3492
3939
|
"name": "balance",
|
|
3493
3940
|
"format": "float",
|
|
3494
|
-
"required":
|
|
3941
|
+
"required": false,
|
|
3495
3942
|
"in": "formData",
|
|
3496
3943
|
"type": "number",
|
|
3497
3944
|
"description": "balance of account"
|
|
@@ -4134,7 +4581,7 @@
|
|
|
4134
4581
|
"tags": [
|
|
4135
4582
|
"Banks"
|
|
4136
4583
|
],
|
|
4137
|
-
"description": "Get logs of account
|
|
4584
|
+
"description": "Get logs of account. By default, it selects logs for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br>",
|
|
4138
4585
|
"parameters": [
|
|
4139
4586
|
{
|
|
4140
4587
|
"required": true,
|
|
@@ -4565,6 +5012,60 @@
|
|
|
4565
5012
|
"type": "string",
|
|
4566
5013
|
"name": "expand",
|
|
4567
5014
|
"in": "query"
|
|
5015
|
+
},
|
|
5016
|
+
{
|
|
5017
|
+
"required": false,
|
|
5018
|
+
"type": "string",
|
|
5019
|
+
"name": "category",
|
|
5020
|
+
"in": "query"
|
|
5021
|
+
},
|
|
5022
|
+
{
|
|
5023
|
+
"required": false,
|
|
5024
|
+
"type": "string",
|
|
5025
|
+
"name": "bank_name",
|
|
5026
|
+
"in": "query"
|
|
5027
|
+
},
|
|
5028
|
+
{
|
|
5029
|
+
"required": false,
|
|
5030
|
+
"type": "string",
|
|
5031
|
+
"name": "deleted",
|
|
5032
|
+
"in": "query"
|
|
5033
|
+
},
|
|
5034
|
+
{
|
|
5035
|
+
"required": false,
|
|
5036
|
+
"type": "string",
|
|
5037
|
+
"name": "bic",
|
|
5038
|
+
"in": "query"
|
|
5039
|
+
},
|
|
5040
|
+
{
|
|
5041
|
+
"required": false,
|
|
5042
|
+
"type": "string",
|
|
5043
|
+
"name": "label",
|
|
5044
|
+
"in": "query"
|
|
5045
|
+
},
|
|
5046
|
+
{
|
|
5047
|
+
"required": false,
|
|
5048
|
+
"type": "string",
|
|
5049
|
+
"name": "state",
|
|
5050
|
+
"in": "query"
|
|
5051
|
+
},
|
|
5052
|
+
{
|
|
5053
|
+
"required": false,
|
|
5054
|
+
"type": "string",
|
|
5055
|
+
"name": "iban",
|
|
5056
|
+
"in": "query"
|
|
5057
|
+
},
|
|
5058
|
+
{
|
|
5059
|
+
"required": false,
|
|
5060
|
+
"type": "string",
|
|
5061
|
+
"name": "error",
|
|
5062
|
+
"in": "query"
|
|
5063
|
+
},
|
|
5064
|
+
{
|
|
5065
|
+
"required": false,
|
|
5066
|
+
"type": "string",
|
|
5067
|
+
"name": "id",
|
|
5068
|
+
"in": "query"
|
|
4568
5069
|
}
|
|
4569
5070
|
],
|
|
4570
5071
|
"summary": "Returns the list of recipients."
|
|
@@ -4934,26 +5435,26 @@
|
|
|
4934
5435
|
"summary": "Cancel a transfer."
|
|
4935
5436
|
}
|
|
4936
5437
|
},
|
|
4937
|
-
"/users/{id_user}/accounts/{id_account}/
|
|
5438
|
+
"/users/{id_user}/accounts/{id_account}/sources": {
|
|
4938
5439
|
"get": {
|
|
4939
5440
|
"responses": {
|
|
4940
5441
|
"200": {
|
|
4941
|
-
"description": "
|
|
5442
|
+
"description": "sources",
|
|
4942
5443
|
"schema": {
|
|
4943
5444
|
"required": [
|
|
4944
|
-
"
|
|
5445
|
+
"sources"
|
|
4945
5446
|
],
|
|
4946
5447
|
"type": "object",
|
|
4947
5448
|
"properties": {
|
|
4948
|
-
"
|
|
4949
|
-
"type": "number",
|
|
4950
|
-
"description": "total number of results"
|
|
4951
|
-
},
|
|
4952
|
-
"transactions": {
|
|
5449
|
+
"sources": {
|
|
4953
5450
|
"items": {
|
|
4954
|
-
"$ref": "#/definitions/
|
|
5451
|
+
"$ref": "#/definitions/ConnectionSource"
|
|
4955
5452
|
},
|
|
4956
5453
|
"type": "array"
|
|
5454
|
+
},
|
|
5455
|
+
"total": {
|
|
5456
|
+
"type": "number",
|
|
5457
|
+
"description": "total number of results"
|
|
4957
5458
|
}
|
|
4958
5459
|
}
|
|
4959
5460
|
}
|
|
@@ -4962,7 +5463,7 @@
|
|
|
4962
5463
|
"tags": [
|
|
4963
5464
|
"Banks"
|
|
4964
5465
|
],
|
|
4965
|
-
"description": "
|
|
5466
|
+
"description": "",
|
|
4966
5467
|
"parameters": [
|
|
4967
5468
|
{
|
|
4968
5469
|
"required": true,
|
|
@@ -4980,13 +5481,67 @@
|
|
|
4980
5481
|
},
|
|
4981
5482
|
{
|
|
4982
5483
|
"required": false,
|
|
4983
|
-
"
|
|
4984
|
-
"
|
|
4985
|
-
"
|
|
4986
|
-
|
|
4987
|
-
|
|
4988
|
-
|
|
4989
|
-
|
|
5484
|
+
"type": "string",
|
|
5485
|
+
"name": "expand",
|
|
5486
|
+
"in": "query"
|
|
5487
|
+
}
|
|
5488
|
+
],
|
|
5489
|
+
"summary": "Get account sources"
|
|
5490
|
+
}
|
|
5491
|
+
},
|
|
5492
|
+
"/users/{id_user}/accounts/{id_account}/transactions": {
|
|
5493
|
+
"get": {
|
|
5494
|
+
"responses": {
|
|
5495
|
+
"200": {
|
|
5496
|
+
"description": "transactions",
|
|
5497
|
+
"schema": {
|
|
5498
|
+
"required": [
|
|
5499
|
+
"transactions"
|
|
5500
|
+
],
|
|
5501
|
+
"type": "object",
|
|
5502
|
+
"properties": {
|
|
5503
|
+
"total": {
|
|
5504
|
+
"type": "number",
|
|
5505
|
+
"description": "total number of results"
|
|
5506
|
+
},
|
|
5507
|
+
"transactions": {
|
|
5508
|
+
"items": {
|
|
5509
|
+
"$ref": "#/definitions/Transaction"
|
|
5510
|
+
},
|
|
5511
|
+
"type": "array"
|
|
5512
|
+
}
|
|
5513
|
+
}
|
|
5514
|
+
}
|
|
5515
|
+
}
|
|
5516
|
+
},
|
|
5517
|
+
"tags": [
|
|
5518
|
+
"Banks"
|
|
5519
|
+
],
|
|
5520
|
+
"description": "Get list of transactions.<br><br>By default, it selects transactions for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br>",
|
|
5521
|
+
"parameters": [
|
|
5522
|
+
{
|
|
5523
|
+
"required": true,
|
|
5524
|
+
"in": "path",
|
|
5525
|
+
"type": "string",
|
|
5526
|
+
"name": "id_user",
|
|
5527
|
+
"description": "Hint: you can use 'me' or 'all'"
|
|
5528
|
+
},
|
|
5529
|
+
{
|
|
5530
|
+
"required": true,
|
|
5531
|
+
"in": "path",
|
|
5532
|
+
"type": "integer",
|
|
5533
|
+
"name": "id_account",
|
|
5534
|
+
"description": ""
|
|
5535
|
+
},
|
|
5536
|
+
{
|
|
5537
|
+
"required": false,
|
|
5538
|
+
"in": "query",
|
|
5539
|
+
"type": "integer",
|
|
5540
|
+
"name": "limit",
|
|
5541
|
+
"description": "limit number of results"
|
|
5542
|
+
},
|
|
5543
|
+
{
|
|
5544
|
+
"required": false,
|
|
4990
5545
|
"in": "query",
|
|
4991
5546
|
"type": "integer",
|
|
4992
5547
|
"name": "offset",
|
|
@@ -7672,6 +8227,13 @@
|
|
|
7672
8227
|
"name": "id_user",
|
|
7673
8228
|
"description": "Hint: you can use 'me' or 'all'"
|
|
7674
8229
|
},
|
|
8230
|
+
{
|
|
8231
|
+
"required": false,
|
|
8232
|
+
"in": "query",
|
|
8233
|
+
"type": "string",
|
|
8234
|
+
"name": "source",
|
|
8235
|
+
"description": "optional comma-separated list of sources to use for the connection synchronization"
|
|
8236
|
+
},
|
|
7675
8237
|
{
|
|
7676
8238
|
"required": false,
|
|
7677
8239
|
"in": "formData",
|
|
@@ -7686,6 +8248,104 @@
|
|
|
7686
8248
|
"name": "connector_uuid",
|
|
7687
8249
|
"description": "optional uuid of the connector (replaces id_connector)"
|
|
7688
8250
|
},
|
|
8251
|
+
{
|
|
8252
|
+
"required": false,
|
|
8253
|
+
"in": "formData",
|
|
8254
|
+
"type": "string",
|
|
8255
|
+
"name": "birthday",
|
|
8256
|
+
"description": "bank additional login parameter"
|
|
8257
|
+
},
|
|
8258
|
+
{
|
|
8259
|
+
"required": false,
|
|
8260
|
+
"in": "formData",
|
|
8261
|
+
"type": "string",
|
|
8262
|
+
"name": "password",
|
|
8263
|
+
"description": "bank additional login parameter"
|
|
8264
|
+
},
|
|
8265
|
+
{
|
|
8266
|
+
"required": false,
|
|
8267
|
+
"in": "formData",
|
|
8268
|
+
"type": "string",
|
|
8269
|
+
"name": "oauth_token",
|
|
8270
|
+
"description": "bank additional login parameter"
|
|
8271
|
+
},
|
|
8272
|
+
{
|
|
8273
|
+
"required": false,
|
|
8274
|
+
"in": "formData",
|
|
8275
|
+
"type": "string",
|
|
8276
|
+
"name": "oauth_token_secret",
|
|
8277
|
+
"description": "bank additional login parameter"
|
|
8278
|
+
},
|
|
8279
|
+
{
|
|
8280
|
+
"required": false,
|
|
8281
|
+
"in": "formData",
|
|
8282
|
+
"type": "string",
|
|
8283
|
+
"name": "auth_type",
|
|
8284
|
+
"description": "bank additional login parameter"
|
|
8285
|
+
},
|
|
8286
|
+
{
|
|
8287
|
+
"required": false,
|
|
8288
|
+
"in": "formData",
|
|
8289
|
+
"type": "string",
|
|
8290
|
+
"name": "secret",
|
|
8291
|
+
"description": "bank additional login parameter"
|
|
8292
|
+
},
|
|
8293
|
+
{
|
|
8294
|
+
"required": false,
|
|
8295
|
+
"in": "formData",
|
|
8296
|
+
"type": "string",
|
|
8297
|
+
"name": "type",
|
|
8298
|
+
"description": "bank additional login parameter"
|
|
8299
|
+
},
|
|
8300
|
+
{
|
|
8301
|
+
"required": false,
|
|
8302
|
+
"in": "formData",
|
|
8303
|
+
"type": "string",
|
|
8304
|
+
"name": "birthdate",
|
|
8305
|
+
"description": "bank additional login parameter"
|
|
8306
|
+
},
|
|
8307
|
+
{
|
|
8308
|
+
"required": false,
|
|
8309
|
+
"in": "formData",
|
|
8310
|
+
"type": "string",
|
|
8311
|
+
"name": "nuser",
|
|
8312
|
+
"description": "bank additional login parameter"
|
|
8313
|
+
},
|
|
8314
|
+
{
|
|
8315
|
+
"required": false,
|
|
8316
|
+
"in": "formData",
|
|
8317
|
+
"type": "string",
|
|
8318
|
+
"name": "website",
|
|
8319
|
+
"description": "bank additional login parameter"
|
|
8320
|
+
},
|
|
8321
|
+
{
|
|
8322
|
+
"required": false,
|
|
8323
|
+
"in": "formData",
|
|
8324
|
+
"type": "string",
|
|
8325
|
+
"name": "openapiwebsite",
|
|
8326
|
+
"description": "bank additional login parameter"
|
|
8327
|
+
},
|
|
8328
|
+
{
|
|
8329
|
+
"required": false,
|
|
8330
|
+
"in": "formData",
|
|
8331
|
+
"type": "string",
|
|
8332
|
+
"name": "directaccesswebsite",
|
|
8333
|
+
"description": "bank additional login parameter"
|
|
8334
|
+
},
|
|
8335
|
+
{
|
|
8336
|
+
"required": false,
|
|
8337
|
+
"in": "formData",
|
|
8338
|
+
"type": "string",
|
|
8339
|
+
"name": "login",
|
|
8340
|
+
"description": "bank additional login parameter"
|
|
8341
|
+
},
|
|
8342
|
+
{
|
|
8343
|
+
"required": false,
|
|
8344
|
+
"in": "formData",
|
|
8345
|
+
"type": "integer",
|
|
8346
|
+
"name": "id_provider",
|
|
8347
|
+
"description": "ID of the provider"
|
|
8348
|
+
},
|
|
7689
8349
|
{
|
|
7690
8350
|
"required": false,
|
|
7691
8351
|
"type": "string",
|
|
@@ -7729,6 +8389,45 @@
|
|
|
7729
8389
|
}
|
|
7730
8390
|
},
|
|
7731
8391
|
"/users/{id_user}/connections/{id_connection}": {
|
|
8392
|
+
"get": {
|
|
8393
|
+
"responses": {
|
|
8394
|
+
"200": {
|
|
8395
|
+
"description": "connection",
|
|
8396
|
+
"schema": {
|
|
8397
|
+
"$ref": "#/definitions/Connection"
|
|
8398
|
+
}
|
|
8399
|
+
}
|
|
8400
|
+
},
|
|
8401
|
+
"tags": [
|
|
8402
|
+
"Connections",
|
|
8403
|
+
"Banks",
|
|
8404
|
+
"Providers"
|
|
8405
|
+
],
|
|
8406
|
+
"description": "Get connection by ID",
|
|
8407
|
+
"parameters": [
|
|
8408
|
+
{
|
|
8409
|
+
"required": true,
|
|
8410
|
+
"in": "path",
|
|
8411
|
+
"type": "string",
|
|
8412
|
+
"name": "id_user",
|
|
8413
|
+
"description": "Hint: you can use 'me' or 'all'"
|
|
8414
|
+
},
|
|
8415
|
+
{
|
|
8416
|
+
"required": true,
|
|
8417
|
+
"in": "path",
|
|
8418
|
+
"type": "integer",
|
|
8419
|
+
"name": "id_connection",
|
|
8420
|
+
"description": ""
|
|
8421
|
+
},
|
|
8422
|
+
{
|
|
8423
|
+
"required": false,
|
|
8424
|
+
"type": "string",
|
|
8425
|
+
"name": "expand",
|
|
8426
|
+
"in": "query"
|
|
8427
|
+
}
|
|
8428
|
+
],
|
|
8429
|
+
"summary": "Get connection"
|
|
8430
|
+
},
|
|
7732
8431
|
"post": {
|
|
7733
8432
|
"responses": {
|
|
7734
8433
|
"200": {
|
|
@@ -7974,7 +8673,7 @@
|
|
|
7974
8673
|
{
|
|
7975
8674
|
"name": "balance",
|
|
7976
8675
|
"format": "float",
|
|
7977
|
-
"required":
|
|
8676
|
+
"required": false,
|
|
7978
8677
|
"in": "formData",
|
|
7979
8678
|
"type": "number",
|
|
7980
8679
|
"description": "balance of account"
|
|
@@ -8694,7 +9393,7 @@
|
|
|
8694
9393
|
"tags": [
|
|
8695
9394
|
"Banks"
|
|
8696
9395
|
],
|
|
8697
|
-
"description": "Get logs of account
|
|
9396
|
+
"description": "Get logs of account. By default, it selects logs for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br>",
|
|
8698
9397
|
"parameters": [
|
|
8699
9398
|
{
|
|
8700
9399
|
"required": true,
|
|
@@ -9585,6 +10284,67 @@
|
|
|
9585
10284
|
"summary": "Cancel a transfer."
|
|
9586
10285
|
}
|
|
9587
10286
|
},
|
|
10287
|
+
"/users/{id_user}/connections/{id_connection}/accounts/{id_account}/sources": {
|
|
10288
|
+
"get": {
|
|
10289
|
+
"responses": {
|
|
10290
|
+
"200": {
|
|
10291
|
+
"description": "sources",
|
|
10292
|
+
"schema": {
|
|
10293
|
+
"required": [
|
|
10294
|
+
"sources"
|
|
10295
|
+
],
|
|
10296
|
+
"type": "object",
|
|
10297
|
+
"properties": {
|
|
10298
|
+
"sources": {
|
|
10299
|
+
"items": {
|
|
10300
|
+
"$ref": "#/definitions/ConnectionSource"
|
|
10301
|
+
},
|
|
10302
|
+
"type": "array"
|
|
10303
|
+
},
|
|
10304
|
+
"total": {
|
|
10305
|
+
"type": "number",
|
|
10306
|
+
"description": "total number of results"
|
|
10307
|
+
}
|
|
10308
|
+
}
|
|
10309
|
+
}
|
|
10310
|
+
}
|
|
10311
|
+
},
|
|
10312
|
+
"tags": [
|
|
10313
|
+
"Banks"
|
|
10314
|
+
],
|
|
10315
|
+
"description": "",
|
|
10316
|
+
"parameters": [
|
|
10317
|
+
{
|
|
10318
|
+
"required": true,
|
|
10319
|
+
"in": "path",
|
|
10320
|
+
"type": "string",
|
|
10321
|
+
"name": "id_user",
|
|
10322
|
+
"description": "Hint: you can use 'me' or 'all'"
|
|
10323
|
+
},
|
|
10324
|
+
{
|
|
10325
|
+
"required": true,
|
|
10326
|
+
"in": "path",
|
|
10327
|
+
"type": "integer",
|
|
10328
|
+
"name": "id_connection",
|
|
10329
|
+
"description": ""
|
|
10330
|
+
},
|
|
10331
|
+
{
|
|
10332
|
+
"required": true,
|
|
10333
|
+
"in": "path",
|
|
10334
|
+
"type": "integer",
|
|
10335
|
+
"name": "id_account",
|
|
10336
|
+
"description": ""
|
|
10337
|
+
},
|
|
10338
|
+
{
|
|
10339
|
+
"required": false,
|
|
10340
|
+
"type": "string",
|
|
10341
|
+
"name": "expand",
|
|
10342
|
+
"in": "query"
|
|
10343
|
+
}
|
|
10344
|
+
],
|
|
10345
|
+
"summary": "Get account sources"
|
|
10346
|
+
}
|
|
10347
|
+
},
|
|
9588
10348
|
"/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions": {
|
|
9589
10349
|
"get": {
|
|
9590
10350
|
"responses": {
|
|
@@ -12939,6 +13699,13 @@
|
|
|
12939
13699
|
"name": "charged",
|
|
12940
13700
|
"description": "consider only logs for charged connectors"
|
|
12941
13701
|
},
|
|
13702
|
+
{
|
|
13703
|
+
"required": false,
|
|
13704
|
+
"in": "query",
|
|
13705
|
+
"type": "integer",
|
|
13706
|
+
"name": "id_source",
|
|
13707
|
+
"description": "ID of a source"
|
|
13708
|
+
},
|
|
12942
13709
|
{
|
|
12943
13710
|
"required": false,
|
|
12944
13711
|
"type": "string",
|
|
@@ -13421,18 +14188,253 @@
|
|
|
13421
14188
|
"summary": "Cancel a transfer."
|
|
13422
14189
|
}
|
|
13423
14190
|
},
|
|
13424
|
-
"/users/{id_user}/connections/{id_connection}/
|
|
13425
|
-
"
|
|
14191
|
+
"/users/{id_user}/connections/{id_connection}/sources": {
|
|
14192
|
+
"get": {
|
|
13426
14193
|
"responses": {
|
|
13427
14194
|
"200": {
|
|
13428
|
-
"description": "
|
|
14195
|
+
"description": "sources",
|
|
13429
14196
|
"schema": {
|
|
13430
|
-
"
|
|
14197
|
+
"required": [
|
|
14198
|
+
"sources"
|
|
14199
|
+
],
|
|
14200
|
+
"type": "object",
|
|
14201
|
+
"properties": {
|
|
14202
|
+
"sources": {
|
|
14203
|
+
"items": {
|
|
14204
|
+
"$ref": "#/definitions/ConnectionSource"
|
|
14205
|
+
},
|
|
14206
|
+
"type": "array"
|
|
14207
|
+
},
|
|
14208
|
+
"total": {
|
|
14209
|
+
"type": "number",
|
|
14210
|
+
"description": "total number of results"
|
|
14211
|
+
}
|
|
14212
|
+
}
|
|
13431
14213
|
}
|
|
13432
14214
|
}
|
|
13433
14215
|
},
|
|
13434
14216
|
"tags": [
|
|
13435
|
-
"
|
|
14217
|
+
"Connections",
|
|
14218
|
+
"Banks",
|
|
14219
|
+
"Providers"
|
|
14220
|
+
],
|
|
14221
|
+
"description": "",
|
|
14222
|
+
"parameters": [
|
|
14223
|
+
{
|
|
14224
|
+
"required": true,
|
|
14225
|
+
"in": "path",
|
|
14226
|
+
"type": "string",
|
|
14227
|
+
"name": "id_user",
|
|
14228
|
+
"description": "Hint: you can use 'me' or 'all'"
|
|
14229
|
+
},
|
|
14230
|
+
{
|
|
14231
|
+
"required": true,
|
|
14232
|
+
"in": "path",
|
|
14233
|
+
"type": "integer",
|
|
14234
|
+
"name": "id_connection",
|
|
14235
|
+
"description": ""
|
|
14236
|
+
},
|
|
14237
|
+
{
|
|
14238
|
+
"required": false,
|
|
14239
|
+
"type": "string",
|
|
14240
|
+
"name": "expand",
|
|
14241
|
+
"in": "query"
|
|
14242
|
+
}
|
|
14243
|
+
],
|
|
14244
|
+
"summary": "Get connection sources"
|
|
14245
|
+
}
|
|
14246
|
+
},
|
|
14247
|
+
"/users/{id_user}/connections/{id_connection}/sources/{id_source}": {
|
|
14248
|
+
"post": {
|
|
14249
|
+
"responses": {
|
|
14250
|
+
"200": {
|
|
14251
|
+
"description": "Successful POST on ConnectionSource resource",
|
|
14252
|
+
"schema": {
|
|
14253
|
+
"$ref": "#/definitions/ConnectionSource"
|
|
14254
|
+
}
|
|
14255
|
+
}
|
|
14256
|
+
},
|
|
14257
|
+
"tags": [
|
|
14258
|
+
"Connections",
|
|
14259
|
+
"Banks",
|
|
14260
|
+
"Providers"
|
|
14261
|
+
],
|
|
14262
|
+
"description": "This will make it so the specified source will be able to be synchronized.<br><br>",
|
|
14263
|
+
"parameters": [
|
|
14264
|
+
{
|
|
14265
|
+
"required": true,
|
|
14266
|
+
"in": "path",
|
|
14267
|
+
"type": "string",
|
|
14268
|
+
"name": "id_user",
|
|
14269
|
+
"description": "Hint: you can use 'me' or 'all'"
|
|
14270
|
+
},
|
|
14271
|
+
{
|
|
14272
|
+
"required": true,
|
|
14273
|
+
"in": "path",
|
|
14274
|
+
"type": "integer",
|
|
14275
|
+
"name": "id_connection",
|
|
14276
|
+
"description": ""
|
|
14277
|
+
},
|
|
14278
|
+
{
|
|
14279
|
+
"required": true,
|
|
14280
|
+
"in": "path",
|
|
14281
|
+
"type": "integer",
|
|
14282
|
+
"name": "id_source",
|
|
14283
|
+
"description": ""
|
|
14284
|
+
},
|
|
14285
|
+
{
|
|
14286
|
+
"required": false,
|
|
14287
|
+
"type": "string",
|
|
14288
|
+
"name": "expand",
|
|
14289
|
+
"in": "query"
|
|
14290
|
+
}
|
|
14291
|
+
],
|
|
14292
|
+
"summary": "Enable connection source"
|
|
14293
|
+
},
|
|
14294
|
+
"put": {
|
|
14295
|
+
"responses": {
|
|
14296
|
+
"200": {
|
|
14297
|
+
"description": "Successful PUT on ConnectionSource resource",
|
|
14298
|
+
"schema": {
|
|
14299
|
+
"$ref": "#/definitions/ConnectionSource"
|
|
14300
|
+
}
|
|
14301
|
+
}
|
|
14302
|
+
},
|
|
14303
|
+
"tags": [
|
|
14304
|
+
"Connections",
|
|
14305
|
+
"Banks",
|
|
14306
|
+
"Providers"
|
|
14307
|
+
],
|
|
14308
|
+
"description": "This will make it so the specified source will be able to be synchronized.<br><br>",
|
|
14309
|
+
"parameters": [
|
|
14310
|
+
{
|
|
14311
|
+
"required": true,
|
|
14312
|
+
"in": "path",
|
|
14313
|
+
"type": "string",
|
|
14314
|
+
"name": "id_user",
|
|
14315
|
+
"description": "Hint: you can use 'me' or 'all'"
|
|
14316
|
+
},
|
|
14317
|
+
{
|
|
14318
|
+
"required": true,
|
|
14319
|
+
"in": "path",
|
|
14320
|
+
"type": "integer",
|
|
14321
|
+
"name": "id_connection",
|
|
14322
|
+
"description": ""
|
|
14323
|
+
},
|
|
14324
|
+
{
|
|
14325
|
+
"required": true,
|
|
14326
|
+
"in": "path",
|
|
14327
|
+
"type": "integer",
|
|
14328
|
+
"name": "id_source",
|
|
14329
|
+
"description": ""
|
|
14330
|
+
},
|
|
14331
|
+
{
|
|
14332
|
+
"required": false,
|
|
14333
|
+
"type": "string",
|
|
14334
|
+
"name": "expand",
|
|
14335
|
+
"in": "query"
|
|
14336
|
+
}
|
|
14337
|
+
],
|
|
14338
|
+
"summary": "Enable connection source"
|
|
14339
|
+
},
|
|
14340
|
+
"delete": {
|
|
14341
|
+
"responses": {
|
|
14342
|
+
"200": {
|
|
14343
|
+
"description": "Successful DELETE on ConnectionSource resource",
|
|
14344
|
+
"schema": {
|
|
14345
|
+
"$ref": "#/definitions/ConnectionSource"
|
|
14346
|
+
}
|
|
14347
|
+
}
|
|
14348
|
+
},
|
|
14349
|
+
"tags": [
|
|
14350
|
+
"Connections",
|
|
14351
|
+
"Banks",
|
|
14352
|
+
"Providers"
|
|
14353
|
+
],
|
|
14354
|
+
"description": "This will make it so the specified source will not be synchronized anymore.<br><br>",
|
|
14355
|
+
"parameters": [
|
|
14356
|
+
{
|
|
14357
|
+
"required": true,
|
|
14358
|
+
"in": "path",
|
|
14359
|
+
"type": "string",
|
|
14360
|
+
"name": "id_user",
|
|
14361
|
+
"description": "Hint: you can use 'me' or 'all'"
|
|
14362
|
+
},
|
|
14363
|
+
{
|
|
14364
|
+
"required": true,
|
|
14365
|
+
"in": "path",
|
|
14366
|
+
"type": "integer",
|
|
14367
|
+
"name": "id_connection",
|
|
14368
|
+
"description": ""
|
|
14369
|
+
},
|
|
14370
|
+
{
|
|
14371
|
+
"required": true,
|
|
14372
|
+
"in": "path",
|
|
14373
|
+
"type": "integer",
|
|
14374
|
+
"name": "id_source",
|
|
14375
|
+
"description": ""
|
|
14376
|
+
},
|
|
14377
|
+
{
|
|
14378
|
+
"required": false,
|
|
14379
|
+
"type": "string",
|
|
14380
|
+
"name": "expand",
|
|
14381
|
+
"in": "query"
|
|
14382
|
+
}
|
|
14383
|
+
],
|
|
14384
|
+
"summary": "Disable a connection source"
|
|
14385
|
+
}
|
|
14386
|
+
},
|
|
14387
|
+
"/users/{id_user}/connections/{id_connection}/subscriptions": {
|
|
14388
|
+
"put": {
|
|
14389
|
+
"responses": {
|
|
14390
|
+
"200": {
|
|
14391
|
+
"description": "Successful PUT on Subscription resource",
|
|
14392
|
+
"schema": {
|
|
14393
|
+
"$ref": "#/definitions/Subscription"
|
|
14394
|
+
}
|
|
14395
|
+
}
|
|
14396
|
+
},
|
|
14397
|
+
"tags": [
|
|
14398
|
+
"Providers"
|
|
14399
|
+
],
|
|
14400
|
+
"description": "",
|
|
14401
|
+
"parameters": [
|
|
14402
|
+
{
|
|
14403
|
+
"required": true,
|
|
14404
|
+
"in": "path",
|
|
14405
|
+
"type": "string",
|
|
14406
|
+
"name": "id_user",
|
|
14407
|
+
"description": "Hint: you can use 'me' or 'all'"
|
|
14408
|
+
},
|
|
14409
|
+
{
|
|
14410
|
+
"required": true,
|
|
14411
|
+
"in": "path",
|
|
14412
|
+
"type": "integer",
|
|
14413
|
+
"name": "id_connection",
|
|
14414
|
+
"description": ""
|
|
14415
|
+
},
|
|
14416
|
+
{
|
|
14417
|
+
"required": false,
|
|
14418
|
+
"type": "string",
|
|
14419
|
+
"name": "expand",
|
|
14420
|
+
"in": "query"
|
|
14421
|
+
}
|
|
14422
|
+
],
|
|
14423
|
+
"summary": "Update many subscriptions at once"
|
|
14424
|
+
}
|
|
14425
|
+
},
|
|
14426
|
+
"/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}": {
|
|
14427
|
+
"put": {
|
|
14428
|
+
"responses": {
|
|
14429
|
+
"200": {
|
|
14430
|
+
"description": "Successful PUT on Subscription resource",
|
|
14431
|
+
"schema": {
|
|
14432
|
+
"$ref": "#/definitions/Subscription"
|
|
14433
|
+
}
|
|
14434
|
+
}
|
|
14435
|
+
},
|
|
14436
|
+
"tags": [
|
|
14437
|
+
"Providers"
|
|
13436
14438
|
],
|
|
13437
14439
|
"description": "It updates a specific subscription<br><br>",
|
|
13438
14440
|
"parameters": [
|
|
@@ -14081,6 +15083,97 @@
|
|
|
14081
15083
|
"summary": "Delete a document"
|
|
14082
15084
|
}
|
|
14083
15085
|
},
|
|
15086
|
+
"/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/logs": {
|
|
15087
|
+
"get": {
|
|
15088
|
+
"responses": {
|
|
15089
|
+
"200": {
|
|
15090
|
+
"description": "subscriptionlogs",
|
|
15091
|
+
"schema": {
|
|
15092
|
+
"required": [
|
|
15093
|
+
"subscriptionlogs"
|
|
15094
|
+
],
|
|
15095
|
+
"type": "object",
|
|
15096
|
+
"properties": {
|
|
15097
|
+
"total": {
|
|
15098
|
+
"type": "number",
|
|
15099
|
+
"description": "total number of results"
|
|
15100
|
+
},
|
|
15101
|
+
"subscriptionlogs": {
|
|
15102
|
+
"items": {
|
|
15103
|
+
"$ref": "#/definitions/SubscriptionLog"
|
|
15104
|
+
},
|
|
15105
|
+
"type": "array"
|
|
15106
|
+
}
|
|
15107
|
+
}
|
|
15108
|
+
}
|
|
15109
|
+
}
|
|
15110
|
+
},
|
|
15111
|
+
"tags": [
|
|
15112
|
+
"Providers"
|
|
15113
|
+
],
|
|
15114
|
+
"description": "Get logs of subscription.<br><br>By default, it selects logs for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br>",
|
|
15115
|
+
"parameters": [
|
|
15116
|
+
{
|
|
15117
|
+
"required": true,
|
|
15118
|
+
"in": "path",
|
|
15119
|
+
"type": "string",
|
|
15120
|
+
"name": "id_user",
|
|
15121
|
+
"description": "Hint: you can use 'me' or 'all'"
|
|
15122
|
+
},
|
|
15123
|
+
{
|
|
15124
|
+
"required": true,
|
|
15125
|
+
"in": "path",
|
|
15126
|
+
"type": "integer",
|
|
15127
|
+
"name": "id_connection",
|
|
15128
|
+
"description": ""
|
|
15129
|
+
},
|
|
15130
|
+
{
|
|
15131
|
+
"required": true,
|
|
15132
|
+
"in": "path",
|
|
15133
|
+
"type": "integer",
|
|
15134
|
+
"name": "id_subscription",
|
|
15135
|
+
"description": ""
|
|
15136
|
+
},
|
|
15137
|
+
{
|
|
15138
|
+
"required": false,
|
|
15139
|
+
"in": "query",
|
|
15140
|
+
"type": "integer",
|
|
15141
|
+
"name": "limit",
|
|
15142
|
+
"description": "limit number of results"
|
|
15143
|
+
},
|
|
15144
|
+
{
|
|
15145
|
+
"required": false,
|
|
15146
|
+
"in": "query",
|
|
15147
|
+
"type": "integer",
|
|
15148
|
+
"name": "offset",
|
|
15149
|
+
"description": "offset of first result"
|
|
15150
|
+
},
|
|
15151
|
+
{
|
|
15152
|
+
"name": "min_date",
|
|
15153
|
+
"format": "date",
|
|
15154
|
+
"required": false,
|
|
15155
|
+
"in": "query",
|
|
15156
|
+
"type": "string",
|
|
15157
|
+
"description": "minimal (inclusive) date"
|
|
15158
|
+
},
|
|
15159
|
+
{
|
|
15160
|
+
"name": "max_date",
|
|
15161
|
+
"format": "date",
|
|
15162
|
+
"required": false,
|
|
15163
|
+
"in": "query",
|
|
15164
|
+
"type": "string",
|
|
15165
|
+
"description": "maximum (inclusive) date"
|
|
15166
|
+
},
|
|
15167
|
+
{
|
|
15168
|
+
"required": false,
|
|
15169
|
+
"type": "string",
|
|
15170
|
+
"name": "expand",
|
|
15171
|
+
"in": "query"
|
|
15172
|
+
}
|
|
15173
|
+
],
|
|
15174
|
+
"summary": "Get subscriptions logs."
|
|
15175
|
+
}
|
|
15176
|
+
},
|
|
14084
15177
|
"/users/{id_user}/connections/{id_connection}/transactions": {
|
|
14085
15178
|
"get": {
|
|
14086
15179
|
"responses": {
|
|
@@ -17292,6 +18385,13 @@
|
|
|
17292
18385
|
"name": "charged",
|
|
17293
18386
|
"description": "consider only logs for charged connectors"
|
|
17294
18387
|
},
|
|
18388
|
+
{
|
|
18389
|
+
"required": false,
|
|
18390
|
+
"in": "query",
|
|
18391
|
+
"type": "integer",
|
|
18392
|
+
"name": "id_source",
|
|
18393
|
+
"description": "ID of a source"
|
|
18394
|
+
},
|
|
17295
18395
|
{
|
|
17296
18396
|
"required": false,
|
|
17297
18397
|
"type": "string",
|
|
@@ -18332,6 +19432,38 @@
|
|
|
18332
19432
|
"summary": "Update synthesis configuration"
|
|
18333
19433
|
}
|
|
18334
19434
|
},
|
|
19435
|
+
"/users/{id_user}/subscriptions": {
|
|
19436
|
+
"put": {
|
|
19437
|
+
"responses": {
|
|
19438
|
+
"200": {
|
|
19439
|
+
"description": "Successful PUT on Subscription resource",
|
|
19440
|
+
"schema": {
|
|
19441
|
+
"$ref": "#/definitions/Subscription"
|
|
19442
|
+
}
|
|
19443
|
+
}
|
|
19444
|
+
},
|
|
19445
|
+
"tags": [
|
|
19446
|
+
"Providers"
|
|
19447
|
+
],
|
|
19448
|
+
"description": "",
|
|
19449
|
+
"parameters": [
|
|
19450
|
+
{
|
|
19451
|
+
"required": true,
|
|
19452
|
+
"in": "path",
|
|
19453
|
+
"type": "string",
|
|
19454
|
+
"name": "id_user",
|
|
19455
|
+
"description": "Hint: you can use 'me' or 'all'"
|
|
19456
|
+
},
|
|
19457
|
+
{
|
|
19458
|
+
"required": false,
|
|
19459
|
+
"type": "string",
|
|
19460
|
+
"name": "expand",
|
|
19461
|
+
"in": "query"
|
|
19462
|
+
}
|
|
19463
|
+
],
|
|
19464
|
+
"summary": "Update many subscriptions at once"
|
|
19465
|
+
}
|
|
19466
|
+
},
|
|
18335
19467
|
"/users/{id_user}/subscriptions/{id_subscription}": {
|
|
18336
19468
|
"put": {
|
|
18337
19469
|
"responses": {
|
|
@@ -18893,17 +20025,78 @@
|
|
|
18893
20025
|
"delete": {
|
|
18894
20026
|
"responses": {
|
|
18895
20027
|
"200": {
|
|
18896
|
-
"description": "Successful DELETE on Document resource",
|
|
20028
|
+
"description": "Successful DELETE on Document resource",
|
|
20029
|
+
"schema": {
|
|
20030
|
+
"$ref": "#/definitions/Document"
|
|
20031
|
+
}
|
|
20032
|
+
}
|
|
20033
|
+
},
|
|
20034
|
+
"tags": [
|
|
20035
|
+
"Providers",
|
|
20036
|
+
"Documents"
|
|
20037
|
+
],
|
|
20038
|
+
"description": "",
|
|
20039
|
+
"parameters": [
|
|
20040
|
+
{
|
|
20041
|
+
"required": true,
|
|
20042
|
+
"in": "path",
|
|
20043
|
+
"type": "string",
|
|
20044
|
+
"name": "id_user",
|
|
20045
|
+
"description": "Hint: you can use 'me' or 'all'"
|
|
20046
|
+
},
|
|
20047
|
+
{
|
|
20048
|
+
"required": true,
|
|
20049
|
+
"in": "path",
|
|
20050
|
+
"type": "integer",
|
|
20051
|
+
"name": "id_subscription",
|
|
20052
|
+
"description": ""
|
|
20053
|
+
},
|
|
20054
|
+
{
|
|
20055
|
+
"required": true,
|
|
20056
|
+
"in": "path",
|
|
20057
|
+
"type": "integer",
|
|
20058
|
+
"name": "id_document",
|
|
20059
|
+
"description": ""
|
|
20060
|
+
},
|
|
20061
|
+
{
|
|
20062
|
+
"required": false,
|
|
20063
|
+
"type": "string",
|
|
20064
|
+
"name": "expand",
|
|
20065
|
+
"in": "query"
|
|
20066
|
+
}
|
|
20067
|
+
],
|
|
20068
|
+
"summary": "Delete a document"
|
|
20069
|
+
}
|
|
20070
|
+
},
|
|
20071
|
+
"/users/{id_user}/subscriptions/{id_subscription}/logs": {
|
|
20072
|
+
"get": {
|
|
20073
|
+
"responses": {
|
|
20074
|
+
"200": {
|
|
20075
|
+
"description": "subscriptionlogs",
|
|
18897
20076
|
"schema": {
|
|
18898
|
-
"
|
|
20077
|
+
"required": [
|
|
20078
|
+
"subscriptionlogs"
|
|
20079
|
+
],
|
|
20080
|
+
"type": "object",
|
|
20081
|
+
"properties": {
|
|
20082
|
+
"total": {
|
|
20083
|
+
"type": "number",
|
|
20084
|
+
"description": "total number of results"
|
|
20085
|
+
},
|
|
20086
|
+
"subscriptionlogs": {
|
|
20087
|
+
"items": {
|
|
20088
|
+
"$ref": "#/definitions/SubscriptionLog"
|
|
20089
|
+
},
|
|
20090
|
+
"type": "array"
|
|
20091
|
+
}
|
|
20092
|
+
}
|
|
18899
20093
|
}
|
|
18900
20094
|
}
|
|
18901
20095
|
},
|
|
18902
20096
|
"tags": [
|
|
18903
|
-
"Providers"
|
|
18904
|
-
"Documents"
|
|
20097
|
+
"Providers"
|
|
18905
20098
|
],
|
|
18906
|
-
"description": "",
|
|
20099
|
+
"description": "Get logs of subscription.<br><br>By default, it selects logs for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br>",
|
|
18907
20100
|
"parameters": [
|
|
18908
20101
|
{
|
|
18909
20102
|
"required": true,
|
|
@@ -18920,11 +20113,34 @@
|
|
|
18920
20113
|
"description": ""
|
|
18921
20114
|
},
|
|
18922
20115
|
{
|
|
18923
|
-
"required":
|
|
18924
|
-
"in": "
|
|
20116
|
+
"required": false,
|
|
20117
|
+
"in": "query",
|
|
18925
20118
|
"type": "integer",
|
|
18926
|
-
"name": "
|
|
18927
|
-
"description": ""
|
|
20119
|
+
"name": "limit",
|
|
20120
|
+
"description": "limit number of results"
|
|
20121
|
+
},
|
|
20122
|
+
{
|
|
20123
|
+
"required": false,
|
|
20124
|
+
"in": "query",
|
|
20125
|
+
"type": "integer",
|
|
20126
|
+
"name": "offset",
|
|
20127
|
+
"description": "offset of first result"
|
|
20128
|
+
},
|
|
20129
|
+
{
|
|
20130
|
+
"name": "min_date",
|
|
20131
|
+
"format": "date",
|
|
20132
|
+
"required": false,
|
|
20133
|
+
"in": "query",
|
|
20134
|
+
"type": "string",
|
|
20135
|
+
"description": "minimal (inclusive) date"
|
|
20136
|
+
},
|
|
20137
|
+
{
|
|
20138
|
+
"name": "max_date",
|
|
20139
|
+
"format": "date",
|
|
20140
|
+
"required": false,
|
|
20141
|
+
"in": "query",
|
|
20142
|
+
"type": "string",
|
|
20143
|
+
"description": "maximum (inclusive) date"
|
|
18928
20144
|
},
|
|
18929
20145
|
{
|
|
18930
20146
|
"required": false,
|
|
@@ -18933,7 +20149,7 @@
|
|
|
18933
20149
|
"in": "query"
|
|
18934
20150
|
}
|
|
18935
20151
|
],
|
|
18936
|
-
"summary": "
|
|
20152
|
+
"summary": "Get subscriptions logs."
|
|
18937
20153
|
}
|
|
18938
20154
|
},
|
|
18939
20155
|
"/users/{id_user}/terms": {
|
|
@@ -21015,23 +22231,17 @@
|
|
|
21015
22231
|
}
|
|
21016
22232
|
},
|
|
21017
22233
|
"tags": [
|
|
21018
|
-
"Authentication"
|
|
22234
|
+
"Authentication",
|
|
22235
|
+
"Transfer"
|
|
21019
22236
|
],
|
|
21020
|
-
"description": "",
|
|
22237
|
+
"description": "The route encapsulate 2 functionalities: 1. Create or update a connection through oAuth2 session.<br><br>2. Execute a transfer through OAuth2 session.",
|
|
21021
22238
|
"parameters": [
|
|
21022
22239
|
{
|
|
21023
22240
|
"required": false,
|
|
21024
22241
|
"in": "formData",
|
|
21025
22242
|
"type": "integer",
|
|
21026
|
-
"name": "
|
|
21027
|
-
"description": "ID of the
|
|
21028
|
-
},
|
|
21029
|
-
{
|
|
21030
|
-
"required": false,
|
|
21031
|
-
"in": "formData",
|
|
21032
|
-
"type": "string",
|
|
21033
|
-
"name": "connector_uuid",
|
|
21034
|
-
"description": "Optional unique ID of the connector (replaces id_connector)"
|
|
22243
|
+
"name": "id_transfer",
|
|
22244
|
+
"description": "ID of the transfer"
|
|
21035
22245
|
},
|
|
21036
22246
|
{
|
|
21037
22247
|
"required": false,
|
|
@@ -21053,23 +22263,9 @@
|
|
|
21053
22263
|
"type": "string",
|
|
21054
22264
|
"name": "state",
|
|
21055
22265
|
"description": "Optional state"
|
|
21056
|
-
},
|
|
21057
|
-
{
|
|
21058
|
-
"required": false,
|
|
21059
|
-
"in": "formData",
|
|
21060
|
-
"type": "string",
|
|
21061
|
-
"name": "fields",
|
|
21062
|
-
"description": "Optional fields"
|
|
21063
|
-
},
|
|
21064
|
-
{
|
|
21065
|
-
"required": false,
|
|
21066
|
-
"in": "formData",
|
|
21067
|
-
"type": "integer",
|
|
21068
|
-
"name": "id_connection",
|
|
21069
|
-
"description": "Optional already existing connection to update"
|
|
21070
22266
|
}
|
|
21071
22267
|
],
|
|
21072
|
-
"summary": "
|
|
22268
|
+
"summary": "First step to establish an oAuth2 connection."
|
|
21073
22269
|
}
|
|
21074
22270
|
},
|
|
21075
22271
|
"/webhooks": {
|
|
@@ -21514,12 +22710,192 @@
|
|
|
21514
22710
|
"in": "query"
|
|
21515
22711
|
}
|
|
21516
22712
|
],
|
|
21517
|
-
"summary": "Updates a webhook"
|
|
22713
|
+
"summary": "Updates a webhook"
|
|
22714
|
+
},
|
|
22715
|
+
"put": {
|
|
22716
|
+
"responses": {
|
|
22717
|
+
"200": {
|
|
22718
|
+
"description": "Successful PUT on Webhook resource",
|
|
22719
|
+
"schema": {
|
|
22720
|
+
"$ref": "#/definitions/Webhook"
|
|
22721
|
+
}
|
|
22722
|
+
}
|
|
22723
|
+
},
|
|
22724
|
+
"tags": [
|
|
22725
|
+
"Administration"
|
|
22726
|
+
],
|
|
22727
|
+
"description": "",
|
|
22728
|
+
"parameters": [
|
|
22729
|
+
{
|
|
22730
|
+
"required": true,
|
|
22731
|
+
"in": "path",
|
|
22732
|
+
"type": "integer",
|
|
22733
|
+
"name": "id_webhook",
|
|
22734
|
+
"description": ""
|
|
22735
|
+
},
|
|
22736
|
+
{
|
|
22737
|
+
"required": false,
|
|
22738
|
+
"in": "formData",
|
|
22739
|
+
"type": "string",
|
|
22740
|
+
"name": "deleted",
|
|
22741
|
+
"description": "a date to delete the webhook or 'null' to enable it"
|
|
22742
|
+
},
|
|
22743
|
+
{
|
|
22744
|
+
"required": false,
|
|
22745
|
+
"in": "formData",
|
|
22746
|
+
"type": "integer",
|
|
22747
|
+
"name": "id_user",
|
|
22748
|
+
"description": "The user ID to associate with the webhook"
|
|
22749
|
+
},
|
|
22750
|
+
{
|
|
22751
|
+
"required": false,
|
|
22752
|
+
"in": "formData",
|
|
22753
|
+
"type": "integer",
|
|
22754
|
+
"name": "id_service",
|
|
22755
|
+
"description": "The service ID to associate with the webhook"
|
|
22756
|
+
},
|
|
22757
|
+
{
|
|
22758
|
+
"required": false,
|
|
22759
|
+
"in": "formData",
|
|
22760
|
+
"type": "integer",
|
|
22761
|
+
"name": "id_auth",
|
|
22762
|
+
"description": "The webhook authentication process to use"
|
|
22763
|
+
},
|
|
22764
|
+
{
|
|
22765
|
+
"name": "url",
|
|
22766
|
+
"format": "float",
|
|
22767
|
+
"required": false,
|
|
22768
|
+
"in": "formData",
|
|
22769
|
+
"type": "number",
|
|
22770
|
+
"description": "The webhook callback url"
|
|
22771
|
+
},
|
|
22772
|
+
{
|
|
22773
|
+
"required": false,
|
|
22774
|
+
"in": "formData",
|
|
22775
|
+
"type": "string",
|
|
22776
|
+
"name": "event",
|
|
22777
|
+
"description": "The webhook event"
|
|
22778
|
+
},
|
|
22779
|
+
{
|
|
22780
|
+
"required": false,
|
|
22781
|
+
"type": "string",
|
|
22782
|
+
"name": "expand",
|
|
22783
|
+
"in": "query"
|
|
22784
|
+
}
|
|
22785
|
+
],
|
|
22786
|
+
"summary": "Updates a webhook"
|
|
22787
|
+
},
|
|
22788
|
+
"delete": {
|
|
22789
|
+
"responses": {
|
|
22790
|
+
"200": {
|
|
22791
|
+
"description": "Successful DELETE on Webhook resource",
|
|
22792
|
+
"schema": {
|
|
22793
|
+
"$ref": "#/definitions/Webhook"
|
|
22794
|
+
}
|
|
22795
|
+
}
|
|
22796
|
+
},
|
|
22797
|
+
"tags": [
|
|
22798
|
+
"Administration"
|
|
22799
|
+
],
|
|
22800
|
+
"description": "Updates the deleted field with the date of the deletion<br><br>",
|
|
22801
|
+
"parameters": [
|
|
22802
|
+
{
|
|
22803
|
+
"required": true,
|
|
22804
|
+
"in": "path",
|
|
22805
|
+
"type": "integer",
|
|
22806
|
+
"name": "id_webhook",
|
|
22807
|
+
"description": ""
|
|
22808
|
+
},
|
|
22809
|
+
{
|
|
22810
|
+
"required": false,
|
|
22811
|
+
"type": "string",
|
|
22812
|
+
"name": "expand",
|
|
22813
|
+
"in": "query"
|
|
22814
|
+
}
|
|
22815
|
+
],
|
|
22816
|
+
"summary": "Deletes a webhook"
|
|
22817
|
+
}
|
|
22818
|
+
},
|
|
22819
|
+
"/webhooks/{id_webhook}/add_to_data": {
|
|
22820
|
+
"get": {
|
|
22821
|
+
"responses": {
|
|
22822
|
+
"200": {
|
|
22823
|
+
"description": "webhooks",
|
|
22824
|
+
"schema": {
|
|
22825
|
+
"required": [
|
|
22826
|
+
"webhooks"
|
|
22827
|
+
],
|
|
22828
|
+
"type": "object",
|
|
22829
|
+
"properties": {
|
|
22830
|
+
"webhooks": {
|
|
22831
|
+
"items": {
|
|
22832
|
+
"$ref": "#/definitions/Webhook"
|
|
22833
|
+
},
|
|
22834
|
+
"type": "array"
|
|
22835
|
+
},
|
|
22836
|
+
"total": {
|
|
22837
|
+
"type": "number",
|
|
22838
|
+
"description": "total number of results"
|
|
22839
|
+
}
|
|
22840
|
+
}
|
|
22841
|
+
}
|
|
22842
|
+
}
|
|
22843
|
+
},
|
|
22844
|
+
"tags": [
|
|
22845
|
+
"Administration"
|
|
22846
|
+
],
|
|
22847
|
+
"description": "",
|
|
22848
|
+
"parameters": [
|
|
22849
|
+
{
|
|
22850
|
+
"required": true,
|
|
22851
|
+
"in": "path",
|
|
22852
|
+
"type": "integer",
|
|
22853
|
+
"name": "id_webhook",
|
|
22854
|
+
"description": ""
|
|
22855
|
+
},
|
|
22856
|
+
{
|
|
22857
|
+
"required": false,
|
|
22858
|
+
"type": "string",
|
|
22859
|
+
"name": "expand",
|
|
22860
|
+
"in": "query"
|
|
22861
|
+
}
|
|
22862
|
+
],
|
|
22863
|
+
"summary": "retrieve the list of the value to add in webhooks when sending the requested webhook"
|
|
22864
|
+
},
|
|
22865
|
+
"post": {
|
|
22866
|
+
"responses": {
|
|
22867
|
+
"200": {
|
|
22868
|
+
"description": "Successful POST on Webhook resource",
|
|
22869
|
+
"schema": {
|
|
22870
|
+
"$ref": "#/definitions/Webhook"
|
|
22871
|
+
}
|
|
22872
|
+
}
|
|
22873
|
+
},
|
|
22874
|
+
"tags": [
|
|
22875
|
+
"Administration"
|
|
22876
|
+
],
|
|
22877
|
+
"description": "For each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the user configuration.<br><br>",
|
|
22878
|
+
"parameters": [
|
|
22879
|
+
{
|
|
22880
|
+
"required": true,
|
|
22881
|
+
"in": "path",
|
|
22882
|
+
"type": "integer",
|
|
22883
|
+
"name": "id_webhook",
|
|
22884
|
+
"description": ""
|
|
22885
|
+
},
|
|
22886
|
+
{
|
|
22887
|
+
"required": false,
|
|
22888
|
+
"type": "string",
|
|
22889
|
+
"name": "expand",
|
|
22890
|
+
"in": "query"
|
|
22891
|
+
}
|
|
22892
|
+
],
|
|
22893
|
+
"summary": "Setup a field to store in user config when calling the endpoint"
|
|
21518
22894
|
},
|
|
21519
|
-
"
|
|
22895
|
+
"delete": {
|
|
21520
22896
|
"responses": {
|
|
21521
22897
|
"200": {
|
|
21522
|
-
"description": "Successful
|
|
22898
|
+
"description": "Successful DELETE on Webhook resource",
|
|
21523
22899
|
"schema": {
|
|
21524
22900
|
"$ref": "#/definitions/Webhook"
|
|
21525
22901
|
}
|
|
@@ -21537,49 +22913,6 @@
|
|
|
21537
22913
|
"name": "id_webhook",
|
|
21538
22914
|
"description": ""
|
|
21539
22915
|
},
|
|
21540
|
-
{
|
|
21541
|
-
"required": false,
|
|
21542
|
-
"in": "formData",
|
|
21543
|
-
"type": "string",
|
|
21544
|
-
"name": "deleted",
|
|
21545
|
-
"description": "a date to delete the webhook or 'null' to enable it"
|
|
21546
|
-
},
|
|
21547
|
-
{
|
|
21548
|
-
"required": false,
|
|
21549
|
-
"in": "formData",
|
|
21550
|
-
"type": "integer",
|
|
21551
|
-
"name": "id_user",
|
|
21552
|
-
"description": "The user ID to associate with the webhook"
|
|
21553
|
-
},
|
|
21554
|
-
{
|
|
21555
|
-
"required": false,
|
|
21556
|
-
"in": "formData",
|
|
21557
|
-
"type": "integer",
|
|
21558
|
-
"name": "id_service",
|
|
21559
|
-
"description": "The service ID to associate with the webhook"
|
|
21560
|
-
},
|
|
21561
|
-
{
|
|
21562
|
-
"required": false,
|
|
21563
|
-
"in": "formData",
|
|
21564
|
-
"type": "integer",
|
|
21565
|
-
"name": "id_auth",
|
|
21566
|
-
"description": "The webhook authentication process to use"
|
|
21567
|
-
},
|
|
21568
|
-
{
|
|
21569
|
-
"name": "url",
|
|
21570
|
-
"format": "float",
|
|
21571
|
-
"required": false,
|
|
21572
|
-
"in": "formData",
|
|
21573
|
-
"type": "number",
|
|
21574
|
-
"description": "The webhook callback url"
|
|
21575
|
-
},
|
|
21576
|
-
{
|
|
21577
|
-
"required": false,
|
|
21578
|
-
"in": "formData",
|
|
21579
|
-
"type": "string",
|
|
21580
|
-
"name": "event",
|
|
21581
|
-
"description": "The webhook event"
|
|
21582
|
-
},
|
|
21583
22916
|
{
|
|
21584
22917
|
"required": false,
|
|
21585
22918
|
"type": "string",
|
|
@@ -21587,12 +22920,14 @@
|
|
|
21587
22920
|
"in": "query"
|
|
21588
22921
|
}
|
|
21589
22922
|
],
|
|
21590
|
-
"summary": "
|
|
21591
|
-
}
|
|
21592
|
-
|
|
22923
|
+
"summary": "delete all entries"
|
|
22924
|
+
}
|
|
22925
|
+
},
|
|
22926
|
+
"/webhooks/{id_webhook}/add_to_data/{key}": {
|
|
22927
|
+
"get": {
|
|
21593
22928
|
"responses": {
|
|
21594
22929
|
"200": {
|
|
21595
|
-
"description": "Successful
|
|
22930
|
+
"description": "Successful GET on Webhook resource",
|
|
21596
22931
|
"schema": {
|
|
21597
22932
|
"$ref": "#/definitions/Webhook"
|
|
21598
22933
|
}
|
|
@@ -21601,7 +22936,7 @@
|
|
|
21601
22936
|
"tags": [
|
|
21602
22937
|
"Administration"
|
|
21603
22938
|
],
|
|
21604
|
-
"description": "
|
|
22939
|
+
"description": "",
|
|
21605
22940
|
"parameters": [
|
|
21606
22941
|
{
|
|
21607
22942
|
"required": true,
|
|
@@ -21610,6 +22945,13 @@
|
|
|
21610
22945
|
"name": "id_webhook",
|
|
21611
22946
|
"description": ""
|
|
21612
22947
|
},
|
|
22948
|
+
{
|
|
22949
|
+
"required": true,
|
|
22950
|
+
"in": "path",
|
|
22951
|
+
"type": "string",
|
|
22952
|
+
"name": "key",
|
|
22953
|
+
"description": ""
|
|
22954
|
+
},
|
|
21613
22955
|
{
|
|
21614
22956
|
"required": false,
|
|
21615
22957
|
"type": "string",
|
|
@@ -21617,20 +22959,21 @@
|
|
|
21617
22959
|
"in": "query"
|
|
21618
22960
|
}
|
|
21619
22961
|
],
|
|
21620
|
-
"summary": "
|
|
21621
|
-
}
|
|
21622
|
-
|
|
21623
|
-
"/webhooks/{id_webhook}/add_to_data": {
|
|
21624
|
-
"get": {
|
|
22962
|
+
"summary": "retrieve the value to add in the requested webhook for the requested name"
|
|
22963
|
+
},
|
|
22964
|
+
"post": {
|
|
21625
22965
|
"responses": {
|
|
21626
22966
|
"200": {
|
|
21627
|
-
"description": "
|
|
22967
|
+
"description": "Successful POST on Webhook resource",
|
|
22968
|
+
"schema": {
|
|
22969
|
+
"$ref": "#/definitions/Webhook"
|
|
22970
|
+
}
|
|
21628
22971
|
}
|
|
21629
22972
|
},
|
|
21630
22973
|
"tags": [
|
|
21631
22974
|
"Administration"
|
|
21632
22975
|
],
|
|
21633
|
-
"description": "",
|
|
22976
|
+
"description": "For each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the user configuration.<br><br>",
|
|
21634
22977
|
"parameters": [
|
|
21635
22978
|
{
|
|
21636
22979
|
"required": true,
|
|
@@ -21638,20 +22981,36 @@
|
|
|
21638
22981
|
"type": "integer",
|
|
21639
22982
|
"name": "id_webhook",
|
|
21640
22983
|
"description": ""
|
|
22984
|
+
},
|
|
22985
|
+
{
|
|
22986
|
+
"required": true,
|
|
22987
|
+
"in": "path",
|
|
22988
|
+
"type": "string",
|
|
22989
|
+
"name": "key",
|
|
22990
|
+
"description": ""
|
|
22991
|
+
},
|
|
22992
|
+
{
|
|
22993
|
+
"required": false,
|
|
22994
|
+
"type": "string",
|
|
22995
|
+
"name": "expand",
|
|
22996
|
+
"in": "query"
|
|
21641
22997
|
}
|
|
21642
22998
|
],
|
|
21643
|
-
"summary": "
|
|
22999
|
+
"summary": "upate the requested field to store in user config when calling the endpoint"
|
|
21644
23000
|
},
|
|
21645
|
-
"
|
|
23001
|
+
"delete": {
|
|
21646
23002
|
"responses": {
|
|
21647
23003
|
"200": {
|
|
21648
|
-
"description": "
|
|
23004
|
+
"description": "Successful DELETE on Webhook resource",
|
|
23005
|
+
"schema": {
|
|
23006
|
+
"$ref": "#/definitions/Webhook"
|
|
23007
|
+
}
|
|
21649
23008
|
}
|
|
21650
23009
|
},
|
|
21651
23010
|
"tags": [
|
|
21652
|
-
"
|
|
23011
|
+
"Administration"
|
|
21653
23012
|
],
|
|
21654
|
-
"description": "
|
|
23013
|
+
"description": "",
|
|
21655
23014
|
"parameters": [
|
|
21656
23015
|
{
|
|
21657
23016
|
"required": true,
|
|
@@ -21659,9 +23018,22 @@
|
|
|
21659
23018
|
"type": "integer",
|
|
21660
23019
|
"name": "id_webhook",
|
|
21661
23020
|
"description": ""
|
|
23021
|
+
},
|
|
23022
|
+
{
|
|
23023
|
+
"required": true,
|
|
23024
|
+
"in": "path",
|
|
23025
|
+
"type": "string",
|
|
23026
|
+
"name": "key",
|
|
23027
|
+
"description": ""
|
|
23028
|
+
},
|
|
23029
|
+
{
|
|
23030
|
+
"required": false,
|
|
23031
|
+
"type": "string",
|
|
23032
|
+
"name": "expand",
|
|
23033
|
+
"in": "query"
|
|
21662
23034
|
}
|
|
21663
23035
|
],
|
|
21664
|
-
"summary": "
|
|
23036
|
+
"summary": "delete the requested entry"
|
|
21665
23037
|
}
|
|
21666
23038
|
},
|
|
21667
23039
|
"/webhooks/{id_webhook}/logs": {
|
|
@@ -21701,6 +23073,13 @@
|
|
|
21701
23073
|
"name": "id_webhook",
|
|
21702
23074
|
"description": ""
|
|
21703
23075
|
},
|
|
23076
|
+
{
|
|
23077
|
+
"required": false,
|
|
23078
|
+
"in": "query",
|
|
23079
|
+
"type": "integer",
|
|
23080
|
+
"name": "id_user",
|
|
23081
|
+
"description": "limit number of results to this user"
|
|
23082
|
+
},
|
|
21704
23083
|
{
|
|
21705
23084
|
"required": false,
|
|
21706
23085
|
"in": "query",
|
|
@@ -21740,9 +23119,7 @@
|
|
|
21740
23119
|
],
|
|
21741
23120
|
"summary": "Get webhooks logs."
|
|
21742
23121
|
}
|
|
21743
|
-
}
|
|
21744
|
-
"/services/interview/elambert": {},
|
|
21745
|
-
"/services/interview/vardisson": {}
|
|
23122
|
+
}
|
|
21746
23123
|
},
|
|
21747
23124
|
"host": "demo.biapi.pro",
|
|
21748
23125
|
"x-deactivated_services": [],
|
|
@@ -21754,10 +23131,10 @@
|
|
|
21754
23131
|
"required": [
|
|
21755
23132
|
"id",
|
|
21756
23133
|
"name",
|
|
21757
|
-
"id_weboob",
|
|
21758
23134
|
"charged",
|
|
21759
23135
|
"beta",
|
|
21760
|
-
"uuid"
|
|
23136
|
+
"uuid",
|
|
23137
|
+
"restricted"
|
|
21761
23138
|
],
|
|
21762
23139
|
"type": "object",
|
|
21763
23140
|
"properties": {
|
|
@@ -21769,9 +23146,6 @@
|
|
|
21769
23146
|
"type": "string",
|
|
21770
23147
|
"description": "Name of the bank or provider"
|
|
21771
23148
|
},
|
|
21772
|
-
"id_weboob": {
|
|
21773
|
-
"type": "string"
|
|
21774
|
-
},
|
|
21775
23149
|
"hidden": {
|
|
21776
23150
|
"default": false,
|
|
21777
23151
|
"type": "boolean",
|
|
@@ -21818,12 +23192,16 @@
|
|
|
21818
23192
|
"uuid": {
|
|
21819
23193
|
"type": "string",
|
|
21820
23194
|
"description": "Unique connector identifier"
|
|
23195
|
+
},
|
|
23196
|
+
"restricted": {
|
|
23197
|
+
"default": false,
|
|
23198
|
+
"type": "boolean",
|
|
23199
|
+
"description": "If true, new connections cannot be added with this connector"
|
|
21821
23200
|
}
|
|
21822
23201
|
},
|
|
21823
23202
|
"example": {
|
|
21824
23203
|
"id": 0,
|
|
21825
23204
|
"name": "",
|
|
21826
|
-
"id_weboob": "",
|
|
21827
23205
|
"hidden": false,
|
|
21828
23206
|
"charged": true,
|
|
21829
23207
|
"code": "",
|
|
@@ -21834,7 +23212,61 @@
|
|
|
21834
23212
|
"months_to_fetch": 0,
|
|
21835
23213
|
"auth_mechanism": "",
|
|
21836
23214
|
"siret": "",
|
|
21837
|
-
"uuid": ""
|
|
23215
|
+
"uuid": "",
|
|
23216
|
+
"restricted": false
|
|
23217
|
+
}
|
|
23218
|
+
},
|
|
23219
|
+
"ConnectorSource": {
|
|
23220
|
+
"required": [
|
|
23221
|
+
"id",
|
|
23222
|
+
"id_connector",
|
|
23223
|
+
"name",
|
|
23224
|
+
"id_weboob"
|
|
23225
|
+
],
|
|
23226
|
+
"type": "object",
|
|
23227
|
+
"properties": {
|
|
23228
|
+
"id": {
|
|
23229
|
+
"type": "integer",
|
|
23230
|
+
"description": "ID of the connector source"
|
|
23231
|
+
},
|
|
23232
|
+
"id_connector": {
|
|
23233
|
+
"type": "integer",
|
|
23234
|
+
"description": "ID of the connector"
|
|
23235
|
+
},
|
|
23236
|
+
"name": {
|
|
23237
|
+
"type": "string",
|
|
23238
|
+
"description": "Name of the source"
|
|
23239
|
+
},
|
|
23240
|
+
"id_weboob": {
|
|
23241
|
+
"type": "string"
|
|
23242
|
+
},
|
|
23243
|
+
"auth_mechanism": {
|
|
23244
|
+
"type": "string",
|
|
23245
|
+
"description": "Authentication mechanism to use"
|
|
23246
|
+
},
|
|
23247
|
+
"fallback": {
|
|
23248
|
+
"type": "string",
|
|
23249
|
+
"description": "Name of the source this fallback is for"
|
|
23250
|
+
},
|
|
23251
|
+
"disabled": {
|
|
23252
|
+
"type": "string",
|
|
23253
|
+
"description": "This source is not used to synchronize the connection",
|
|
23254
|
+
"format": "date-time"
|
|
23255
|
+
},
|
|
23256
|
+
"priority": {
|
|
23257
|
+
"type": "integer",
|
|
23258
|
+
"description": "The source priority order for the synchronization"
|
|
23259
|
+
}
|
|
23260
|
+
},
|
|
23261
|
+
"example": {
|
|
23262
|
+
"id": 0,
|
|
23263
|
+
"id_connector": 0,
|
|
23264
|
+
"name": "",
|
|
23265
|
+
"id_weboob": "",
|
|
23266
|
+
"auth_mechanism": "",
|
|
23267
|
+
"fallback": "",
|
|
23268
|
+
"disabled": "2019-12-27 16:17:55.183995",
|
|
23269
|
+
"priority": 0
|
|
21838
23270
|
}
|
|
21839
23271
|
},
|
|
21840
23272
|
"Field": {
|
|
@@ -21884,6 +23316,10 @@
|
|
|
21884
23316
|
"default": true,
|
|
21885
23317
|
"type": "boolean",
|
|
21886
23318
|
"description": "If true, field has to be set to synchronize the connection"
|
|
23319
|
+
},
|
|
23320
|
+
"auth_mechanisms": {
|
|
23321
|
+
"type": "string",
|
|
23322
|
+
"description": "Authentication mechanisms this field is used for"
|
|
21887
23323
|
}
|
|
21888
23324
|
},
|
|
21889
23325
|
"example": {
|
|
@@ -21895,7 +23331,8 @@
|
|
|
21895
23331
|
"type": "text",
|
|
21896
23332
|
"ephemeral": false,
|
|
21897
23333
|
"value": "",
|
|
21898
|
-
"required": true
|
|
23334
|
+
"required": true,
|
|
23335
|
+
"auth_mechanisms": ""
|
|
21899
23336
|
}
|
|
21900
23337
|
},
|
|
21901
23338
|
"ConnectorLogo": {
|
|
@@ -21954,7 +23391,8 @@
|
|
|
21954
23391
|
"CAstore",
|
|
21955
23392
|
"requestAccess",
|
|
21956
23393
|
"sharedAccess",
|
|
21957
|
-
"transfer"
|
|
23394
|
+
"transfer",
|
|
23395
|
+
"refresh_token"
|
|
21958
23396
|
],
|
|
21959
23397
|
"type": "string"
|
|
21960
23398
|
}
|
|
@@ -22055,8 +23493,8 @@
|
|
|
22055
23493
|
"id": 0,
|
|
22056
23494
|
"version": "",
|
|
22057
23495
|
"id_file": 0,
|
|
22058
|
-
"created": "2019-
|
|
22059
|
-
"deleted": "2019-
|
|
23496
|
+
"created": "2019-12-27 16:17:55.197166",
|
|
23497
|
+
"deleted": "2019-12-27 16:17:55.197240"
|
|
22060
23498
|
}
|
|
22061
23499
|
},
|
|
22062
23500
|
"Category": {
|
|
@@ -22129,7 +23567,7 @@
|
|
|
22129
23567
|
"id",
|
|
22130
23568
|
"name",
|
|
22131
23569
|
"secret",
|
|
22132
|
-
"
|
|
23570
|
+
"redirect_uris",
|
|
22133
23571
|
"pro"
|
|
22134
23572
|
],
|
|
22135
23573
|
"type": "object",
|
|
@@ -22150,7 +23588,7 @@
|
|
|
22150
23588
|
"private_key": {
|
|
22151
23589
|
"type": "string"
|
|
22152
23590
|
},
|
|
22153
|
-
"
|
|
23591
|
+
"redirect_uris": {
|
|
22154
23592
|
"default": "",
|
|
22155
23593
|
"type": "string"
|
|
22156
23594
|
},
|
|
@@ -22173,7 +23611,7 @@
|
|
|
22173
23611
|
"secret": "",
|
|
22174
23612
|
"public_key": "",
|
|
22175
23613
|
"private_key": "",
|
|
22176
|
-
"
|
|
23614
|
+
"redirect_uris": "",
|
|
22177
23615
|
"pro": false,
|
|
22178
23616
|
"id_logo": 0
|
|
22179
23617
|
}
|
|
@@ -22241,7 +23679,7 @@
|
|
|
22241
23679
|
"code": "",
|
|
22242
23680
|
"name": "",
|
|
22243
23681
|
"id_type": 0,
|
|
22244
|
-
"last_update": "2019-
|
|
23682
|
+
"last_update": "2019-12-27 16:17:55.203476"
|
|
22245
23683
|
}
|
|
22246
23684
|
},
|
|
22247
23685
|
"Webhook": {
|
|
@@ -22298,9 +23736,9 @@
|
|
|
22298
23736
|
},
|
|
22299
23737
|
"example": {
|
|
22300
23738
|
"id": 0,
|
|
22301
|
-
"created": "2019-
|
|
22302
|
-
"updated": "2019-
|
|
22303
|
-
"deleted": "2019-
|
|
23739
|
+
"created": "2019-12-27 16:17:55.205052",
|
|
23740
|
+
"updated": "2019-12-27 16:17:55.205127",
|
|
23741
|
+
"deleted": "2019-12-27 16:17:55.205189",
|
|
22304
23742
|
"id_service": 0,
|
|
22305
23743
|
"id_user": 0,
|
|
22306
23744
|
"id_event": 0,
|
|
@@ -22363,8 +23801,8 @@
|
|
|
22363
23801
|
"id_user": 0,
|
|
22364
23802
|
"id_resource": 0,
|
|
22365
23803
|
"mimetype": "",
|
|
22366
|
-
"created": "2019-
|
|
22367
|
-
"success": "2019-
|
|
23804
|
+
"created": "2019-12-27 16:17:55.207112",
|
|
23805
|
+
"success": "2019-12-27 16:17:55.207178"
|
|
22368
23806
|
}
|
|
22369
23807
|
},
|
|
22370
23808
|
"WebhookLog": {
|
|
@@ -22415,10 +23853,10 @@
|
|
|
22415
23853
|
"id_webhook_data": 0,
|
|
22416
23854
|
"id_service": 0,
|
|
22417
23855
|
"id_user": 0,
|
|
22418
|
-
"timestamp": "2019-
|
|
22419
|
-
"response_date": "2019-
|
|
23856
|
+
"timestamp": "2019-12-27 16:17:55.207847",
|
|
23857
|
+
"response_date": "2019-12-27 16:17:55.207908",
|
|
22420
23858
|
"response_code": 0,
|
|
22421
|
-
"next_try": "2019-
|
|
23859
|
+
"next_try": "2019-12-27 16:17:55.208014"
|
|
22422
23860
|
}
|
|
22423
23861
|
},
|
|
22424
23862
|
"DocumentType": {
|
|
@@ -22501,13 +23939,10 @@
|
|
|
22501
23939
|
"description": "Last successful update",
|
|
22502
23940
|
"format": "date-time"
|
|
22503
23941
|
},
|
|
22504
|
-
"
|
|
22505
|
-
"
|
|
22506
|
-
"description": "If the last update has failed, the error code"
|
|
22507
|
-
},
|
|
22508
|
-
"expire": {
|
|
23942
|
+
"created": {
|
|
23943
|
+
"default": "<function <lambda> at 0x7f8894ce1aa0>",
|
|
22509
23944
|
"type": "string",
|
|
22510
|
-
"description": "
|
|
23945
|
+
"description": "Creation date",
|
|
22511
23946
|
"format": "date-time"
|
|
22512
23947
|
},
|
|
22513
23948
|
"active": {
|
|
@@ -22530,47 +23965,11 @@
|
|
|
22530
23965
|
"id": 0,
|
|
22531
23966
|
"id_user": 0,
|
|
22532
23967
|
"id_connector": 0,
|
|
22533
|
-
"last_update": "2019-
|
|
22534
|
-
"
|
|
22535
|
-
"expire": "2019-08-02 17:21:59.365257",
|
|
23968
|
+
"last_update": "2019-12-27 16:17:55.214719",
|
|
23969
|
+
"created": "<function <lambda> at 0x7f8894ce1aa0>",
|
|
22536
23970
|
"active": true,
|
|
22537
|
-
"last_push": "2019-
|
|
22538
|
-
"next_try": "2019-
|
|
22539
|
-
}
|
|
22540
|
-
},
|
|
22541
|
-
"Certificate": {
|
|
22542
|
-
"required": [
|
|
22543
|
-
"id",
|
|
22544
|
-
"id_public_key_file",
|
|
22545
|
-
"id_private_key_file",
|
|
22546
|
-
"type",
|
|
22547
|
-
"created"
|
|
22548
|
-
],
|
|
22549
|
-
"type": "object",
|
|
22550
|
-
"properties": {
|
|
22551
|
-
"id": {
|
|
22552
|
-
"type": "integer"
|
|
22553
|
-
},
|
|
22554
|
-
"id_public_key_file": {
|
|
22555
|
-
"type": "integer"
|
|
22556
|
-
},
|
|
22557
|
-
"id_private_key_file": {
|
|
22558
|
-
"type": "integer"
|
|
22559
|
-
},
|
|
22560
|
-
"type": {
|
|
22561
|
-
"type": "string"
|
|
22562
|
-
},
|
|
22563
|
-
"created": {
|
|
22564
|
-
"type": "string",
|
|
22565
|
-
"format": "date-time"
|
|
22566
|
-
}
|
|
22567
|
-
},
|
|
22568
|
-
"example": {
|
|
22569
|
-
"id": 0,
|
|
22570
|
-
"id_public_key_file": 0,
|
|
22571
|
-
"id_private_key_file": 0,
|
|
22572
|
-
"type": "",
|
|
22573
|
-
"created": "2019-08-02 17:21:59.372311"
|
|
23971
|
+
"last_push": "2019-12-27 16:17:55.214905",
|
|
23972
|
+
"next_try": "2019-12-27 16:17:55.214963"
|
|
22574
23973
|
}
|
|
22575
23974
|
},
|
|
22576
23975
|
"ConnectionLog": {
|
|
@@ -22597,6 +23996,10 @@
|
|
|
22597
23996
|
"type": "integer",
|
|
22598
23997
|
"description": "ID of the connector"
|
|
22599
23998
|
},
|
|
23999
|
+
"id_source": {
|
|
24000
|
+
"type": "integer",
|
|
24001
|
+
"description": "ID of the related connection source"
|
|
24002
|
+
},
|
|
22600
24003
|
"login": {
|
|
22601
24004
|
"type": "string",
|
|
22602
24005
|
"description": "bcrypt hash of the login"
|
|
@@ -22651,44 +24054,22 @@
|
|
|
22651
24054
|
}
|
|
22652
24055
|
},
|
|
22653
24056
|
"example": {
|
|
22654
|
-
"id": 0,
|
|
22655
|
-
"id_user": 0,
|
|
22656
|
-
"id_connection": 0,
|
|
22657
|
-
"id_connector": 0,
|
|
22658
|
-
"
|
|
22659
|
-
"
|
|
22660
|
-
"
|
|
22661
|
-
"
|
|
22662
|
-
"
|
|
22663
|
-
"
|
|
22664
|
-
"
|
|
22665
|
-
"
|
|
22666
|
-
"
|
|
22667
|
-
"
|
|
22668
|
-
"
|
|
22669
|
-
|
|
22670
|
-
},
|
|
22671
|
-
"ProjectType": {
|
|
22672
|
-
"required": [
|
|
22673
|
-
"id",
|
|
22674
|
-
"name"
|
|
22675
|
-
],
|
|
22676
|
-
"type": "object",
|
|
22677
|
-
"properties": {
|
|
22678
|
-
"id": {
|
|
22679
|
-
"type": "integer"
|
|
22680
|
-
},
|
|
22681
|
-
"name": {
|
|
22682
|
-
"type": "string"
|
|
22683
|
-
},
|
|
22684
|
-
"icon_url": {
|
|
22685
|
-
"type": "string"
|
|
22686
|
-
}
|
|
22687
|
-
},
|
|
22688
|
-
"example": {
|
|
22689
|
-
"id": 0,
|
|
22690
|
-
"name": "",
|
|
22691
|
-
"icon_url": ""
|
|
24057
|
+
"id": 0,
|
|
24058
|
+
"id_user": 0,
|
|
24059
|
+
"id_connection": 0,
|
|
24060
|
+
"id_connector": 0,
|
|
24061
|
+
"id_source": 0,
|
|
24062
|
+
"login": "",
|
|
24063
|
+
"error_uid": "",
|
|
24064
|
+
"timestamp": "CURRENT_TIMESTAMP",
|
|
24065
|
+
"next_try": "2019-12-27 16:17:55.216094",
|
|
24066
|
+
"error": "",
|
|
24067
|
+
"error_message": "",
|
|
24068
|
+
"statut": 0,
|
|
24069
|
+
"nb_accounts": 0,
|
|
24070
|
+
"start": "2019-12-27 16:17:55.216370",
|
|
24071
|
+
"worker": "",
|
|
24072
|
+
"session_folder_id": ""
|
|
22692
24073
|
}
|
|
22693
24074
|
},
|
|
22694
24075
|
"Transfer": {
|
|
@@ -22698,7 +24079,8 @@
|
|
|
22698
24079
|
"exec_date",
|
|
22699
24080
|
"register_date",
|
|
22700
24081
|
"amount",
|
|
22701
|
-
"state"
|
|
24082
|
+
"state",
|
|
24083
|
+
"beneficiary_type"
|
|
22702
24084
|
],
|
|
22703
24085
|
"type": "object",
|
|
22704
24086
|
"properties": {
|
|
@@ -22752,7 +24134,7 @@
|
|
|
22752
24134
|
},
|
|
22753
24135
|
"state": {
|
|
22754
24136
|
"type": "string",
|
|
22755
|
-
"description": "State of the transfer (created, scheduled, validating, pending, coming, done, canceled,
|
|
24137
|
+
"description": "State of the transfer (created, scheduled, validating, pending, coming, done, canceled, transactionNotFound, deleted, error, bug)"
|
|
22756
24138
|
},
|
|
22757
24139
|
"error": {
|
|
22758
24140
|
"type": "string",
|
|
@@ -22771,6 +24153,23 @@
|
|
|
22771
24153
|
"type": "integer",
|
|
22772
24154
|
"description": "If found, ID of the related transaction"
|
|
22773
24155
|
},
|
|
24156
|
+
"beneficiary_type": {
|
|
24157
|
+
"default": "recipient",
|
|
24158
|
+
"type": "string",
|
|
24159
|
+
"description": "Type of beneficiary number, for example: 'recipient' (in bank recipient list), 'iban' or 'phone_number'"
|
|
24160
|
+
},
|
|
24161
|
+
"beneficiary_number": {
|
|
24162
|
+
"type": "string",
|
|
24163
|
+
"description": "Beneficiary bank identifier value like recipient webid, iban: EX6713281847025300290000062 or phone_number: 06XXXXXX"
|
|
24164
|
+
},
|
|
24165
|
+
"beneficiary_label": {
|
|
24166
|
+
"type": "string",
|
|
24167
|
+
"description": "Label of the beneficiary (needed for transfer to other beneficiary type than 'recipient')"
|
|
24168
|
+
},
|
|
24169
|
+
"validate_mechanism": {
|
|
24170
|
+
"type": "string",
|
|
24171
|
+
"description": "Authentication method used to validate transfer (credentials or webauth)"
|
|
24172
|
+
},
|
|
22774
24173
|
"currency": {
|
|
22775
24174
|
"type": "object",
|
|
22776
24175
|
"description": "Currency of the object"
|
|
@@ -22783,8 +24182,8 @@
|
|
|
22783
24182
|
"id_recipient": 0,
|
|
22784
24183
|
"account_iban": "",
|
|
22785
24184
|
"recipient_iban": "",
|
|
22786
|
-
"exec_date": "2019-
|
|
22787
|
-
"register_date": "2019-
|
|
24185
|
+
"exec_date": "2019-12-27",
|
|
24186
|
+
"register_date": "2019-12-27 16:17:55.220954",
|
|
22788
24187
|
"amount": 0,
|
|
22789
24188
|
"fees": 0,
|
|
22790
24189
|
"webid": "",
|
|
@@ -22793,9 +24192,119 @@
|
|
|
22793
24192
|
"label": "",
|
|
22794
24193
|
"account_balance": 0,
|
|
22795
24194
|
"id_transaction": 0,
|
|
24195
|
+
"beneficiary_type": "recipient",
|
|
24196
|
+
"beneficiary_number": "",
|
|
24197
|
+
"beneficiary_label": "",
|
|
24198
|
+
"validate_mechanism": "",
|
|
22796
24199
|
"currency": ""
|
|
22797
24200
|
}
|
|
22798
24201
|
},
|
|
24202
|
+
"Order": {
|
|
24203
|
+
"required": [
|
|
24204
|
+
"id",
|
|
24205
|
+
"id_merchant",
|
|
24206
|
+
"id_transfer"
|
|
24207
|
+
],
|
|
24208
|
+
"type": "object",
|
|
24209
|
+
"properties": {
|
|
24210
|
+
"id": {
|
|
24211
|
+
"type": "integer",
|
|
24212
|
+
"description": "ID of the order"
|
|
24213
|
+
},
|
|
24214
|
+
"id_merchant": {
|
|
24215
|
+
"type": "integer",
|
|
24216
|
+
"description": "id of the merchant who initiated the order"
|
|
24217
|
+
},
|
|
24218
|
+
"id_transfer": {
|
|
24219
|
+
"type": "integer",
|
|
24220
|
+
"description": "id of the transfer used to pay this the order"
|
|
24221
|
+
},
|
|
24222
|
+
"state": {
|
|
24223
|
+
"type": "string",
|
|
24224
|
+
"description": "State of the order (result of the recipient adding and the transfer execution)"
|
|
24225
|
+
},
|
|
24226
|
+
"error_message": {
|
|
24227
|
+
"type": "string",
|
|
24228
|
+
"description": "more information on the state if something went wrong during the order"
|
|
24229
|
+
},
|
|
24230
|
+
"opt_out_cause": {
|
|
24231
|
+
"type": "string",
|
|
24232
|
+
"description": "set by the webview, indicates at which step of the payment the user has left the order"
|
|
24233
|
+
},
|
|
24234
|
+
"refund_value": {
|
|
24235
|
+
"type": "number",
|
|
24236
|
+
"description": "Amount refunded",
|
|
24237
|
+
"format": "float"
|
|
24238
|
+
}
|
|
24239
|
+
},
|
|
24240
|
+
"example": {
|
|
24241
|
+
"id": 0,
|
|
24242
|
+
"id_merchant": 0,
|
|
24243
|
+
"id_transfer": 0,
|
|
24244
|
+
"state": "",
|
|
24245
|
+
"error_message": "",
|
|
24246
|
+
"opt_out_cause": "",
|
|
24247
|
+
"refund_value": 0
|
|
24248
|
+
}
|
|
24249
|
+
},
|
|
24250
|
+
"Certificate": {
|
|
24251
|
+
"required": [
|
|
24252
|
+
"id",
|
|
24253
|
+
"id_public_key_file",
|
|
24254
|
+
"id_private_key_file",
|
|
24255
|
+
"type",
|
|
24256
|
+
"created"
|
|
24257
|
+
],
|
|
24258
|
+
"type": "object",
|
|
24259
|
+
"properties": {
|
|
24260
|
+
"id": {
|
|
24261
|
+
"type": "integer"
|
|
24262
|
+
},
|
|
24263
|
+
"id_public_key_file": {
|
|
24264
|
+
"type": "integer"
|
|
24265
|
+
},
|
|
24266
|
+
"id_private_key_file": {
|
|
24267
|
+
"type": "integer"
|
|
24268
|
+
},
|
|
24269
|
+
"type": {
|
|
24270
|
+
"type": "string"
|
|
24271
|
+
},
|
|
24272
|
+
"created": {
|
|
24273
|
+
"type": "string",
|
|
24274
|
+
"format": "date-time"
|
|
24275
|
+
}
|
|
24276
|
+
},
|
|
24277
|
+
"example": {
|
|
24278
|
+
"id": 0,
|
|
24279
|
+
"id_public_key_file": 0,
|
|
24280
|
+
"id_private_key_file": 0,
|
|
24281
|
+
"type": "",
|
|
24282
|
+
"created": "2019-12-27 16:17:55.226500"
|
|
24283
|
+
}
|
|
24284
|
+
},
|
|
24285
|
+
"ProjectType": {
|
|
24286
|
+
"required": [
|
|
24287
|
+
"id",
|
|
24288
|
+
"name"
|
|
24289
|
+
],
|
|
24290
|
+
"type": "object",
|
|
24291
|
+
"properties": {
|
|
24292
|
+
"id": {
|
|
24293
|
+
"type": "integer"
|
|
24294
|
+
},
|
|
24295
|
+
"name": {
|
|
24296
|
+
"type": "string"
|
|
24297
|
+
},
|
|
24298
|
+
"icon_url": {
|
|
24299
|
+
"type": "string"
|
|
24300
|
+
}
|
|
24301
|
+
},
|
|
24302
|
+
"example": {
|
|
24303
|
+
"id": 0,
|
|
24304
|
+
"name": "",
|
|
24305
|
+
"icon_url": ""
|
|
24306
|
+
}
|
|
24307
|
+
},
|
|
22799
24308
|
"Access": {
|
|
22800
24309
|
"required": [
|
|
22801
24310
|
"id",
|
|
@@ -22927,7 +24436,7 @@
|
|
|
22927
24436
|
"mean_amount": 0,
|
|
22928
24437
|
"median_increment": 0,
|
|
22929
24438
|
"enabled": true,
|
|
22930
|
-
"next_date": "2019-
|
|
24439
|
+
"next_date": "2019-12-27",
|
|
22931
24440
|
"wording": "",
|
|
22932
24441
|
"id_category": 0,
|
|
22933
24442
|
"created_by": ""
|
|
@@ -23094,6 +24603,10 @@
|
|
|
23094
24603
|
"type": "integer",
|
|
23095
24604
|
"description": "ID of related user"
|
|
23096
24605
|
},
|
|
24606
|
+
"id_source": {
|
|
24607
|
+
"type": "integer",
|
|
24608
|
+
"description": "ID of the related connection source"
|
|
24609
|
+
},
|
|
23097
24610
|
"number": {
|
|
23098
24611
|
"type": "string",
|
|
23099
24612
|
"description": "Subscription's number"
|
|
@@ -23140,14 +24653,15 @@
|
|
|
23140
24653
|
"id": 0,
|
|
23141
24654
|
"id_connection": 0,
|
|
23142
24655
|
"id_user": 0,
|
|
24656
|
+
"id_source": 0,
|
|
23143
24657
|
"number": "",
|
|
23144
24658
|
"label": "",
|
|
23145
24659
|
"subscriber": "",
|
|
23146
|
-
"validity": "2019-
|
|
23147
|
-
"renewdate": "2019-
|
|
23148
|
-
"last_update": "2019-
|
|
23149
|
-
"deleted": "2019-
|
|
23150
|
-
"disabled": "2019-
|
|
24660
|
+
"validity": "2019-12-27",
|
|
24661
|
+
"renewdate": "2019-12-27",
|
|
24662
|
+
"last_update": "2019-12-27 16:17:55.250146",
|
|
24663
|
+
"deleted": "2019-12-27 16:17:55.250214",
|
|
24664
|
+
"disabled": "2019-12-27 16:17:55.250273",
|
|
23151
24665
|
"error": ""
|
|
23152
24666
|
}
|
|
23153
24667
|
},
|
|
@@ -23282,6 +24796,11 @@
|
|
|
23282
24796
|
"description": "Value in the original currency",
|
|
23283
24797
|
"format": "float"
|
|
23284
24798
|
},
|
|
24799
|
+
"original_gross_value": {
|
|
24800
|
+
"type": "number",
|
|
24801
|
+
"description": "Gross value in the original currency",
|
|
24802
|
+
"format": "float"
|
|
24803
|
+
},
|
|
23285
24804
|
"original_currency": {
|
|
23286
24805
|
"type": "object",
|
|
23287
24806
|
"description": "Original currency"
|
|
@@ -23312,25 +24831,26 @@
|
|
|
23312
24831
|
"id": 0,
|
|
23313
24832
|
"id_account": 0,
|
|
23314
24833
|
"webid": "",
|
|
23315
|
-
"application_date": "2019-
|
|
23316
|
-
"date": "2019-
|
|
24834
|
+
"application_date": "2019-12-27",
|
|
24835
|
+
"date": "2019-12-27",
|
|
23317
24836
|
"value": 0,
|
|
23318
24837
|
"gross_value": 0,
|
|
23319
24838
|
"nature": "inconnu",
|
|
23320
24839
|
"wording": "",
|
|
23321
24840
|
"id_category": 0,
|
|
23322
24841
|
"state": "new",
|
|
23323
|
-
"date_scraped": "2019-
|
|
23324
|
-
"rdate": "2019-
|
|
23325
|
-
"vdate": "2019-
|
|
23326
|
-
"bdate": "2019-
|
|
24842
|
+
"date_scraped": "2019-12-27 16:17:55.252832",
|
|
24843
|
+
"rdate": "2019-12-27",
|
|
24844
|
+
"vdate": "2019-12-27",
|
|
24845
|
+
"bdate": "2019-12-27",
|
|
23327
24846
|
"coming": false,
|
|
23328
24847
|
"active": true,
|
|
23329
24848
|
"id_cluster": 0,
|
|
23330
24849
|
"comment": "",
|
|
23331
|
-
"last_update": "2019-
|
|
23332
|
-
"deleted": "2019-
|
|
24850
|
+
"last_update": "2019-12-27 16:17:55.253360",
|
|
24851
|
+
"deleted": "2019-12-27 16:17:55.253424",
|
|
23333
24852
|
"original_value": 0,
|
|
24853
|
+
"original_gross_value": 0,
|
|
23334
24854
|
"original_currency": "",
|
|
23335
24855
|
"commission": 0,
|
|
23336
24856
|
"commission_currency": "",
|
|
@@ -23486,16 +25006,16 @@
|
|
|
23486
25006
|
"diff_percent": 0,
|
|
23487
25007
|
"prev_diff": 0,
|
|
23488
25008
|
"portfolio_share": 0,
|
|
23489
|
-
"vdate": "2019-
|
|
23490
|
-
"prev_vdate": "2019-
|
|
25009
|
+
"vdate": "2019-12-27",
|
|
25010
|
+
"prev_vdate": "2019-12-27",
|
|
23491
25011
|
"id_security": 0,
|
|
23492
25012
|
"original_currency": "",
|
|
23493
25013
|
"original_valuation": 0,
|
|
23494
25014
|
"original_unitvalue": 0,
|
|
23495
25015
|
"original_unitprice": 0,
|
|
23496
25016
|
"original_diff": 0,
|
|
23497
|
-
"last_update": "2019-
|
|
23498
|
-
"deleted": "2019-
|
|
25017
|
+
"last_update": "2019-12-27 16:17:55.257343",
|
|
25018
|
+
"deleted": "2019-12-27 16:17:55.257402"
|
|
23499
25019
|
}
|
|
23500
25020
|
},
|
|
23501
25021
|
"Recipient": {
|
|
@@ -23594,11 +25114,11 @@
|
|
|
23594
25114
|
"iban": "",
|
|
23595
25115
|
"webid": "",
|
|
23596
25116
|
"category": "",
|
|
23597
|
-
"last_update": "2019-
|
|
23598
|
-
"time_scraped": "2019-
|
|
23599
|
-
"deleted": "2019-
|
|
23600
|
-
"expire": "2019-
|
|
23601
|
-
"enabled_at": "2019-
|
|
25117
|
+
"last_update": "2019-12-27 16:17:55.258763",
|
|
25118
|
+
"time_scraped": "2019-12-27 16:17:55.258823",
|
|
25119
|
+
"deleted": "2019-12-27 16:17:55.258879",
|
|
25120
|
+
"expire": "2019-12-27 16:17:55.258940",
|
|
25121
|
+
"enabled_at": "2019-12-27 16:17:55.259115",
|
|
23602
25122
|
"add_verified": false,
|
|
23603
25123
|
"state": "",
|
|
23604
25124
|
"error": "",
|
|
@@ -23703,8 +25223,8 @@
|
|
|
23703
25223
|
"id_thumbnail": 0,
|
|
23704
25224
|
"name": "",
|
|
23705
25225
|
"timestamp": "CURRENT_TIMESTAMP",
|
|
23706
|
-
"date": "2019-
|
|
23707
|
-
"duedate": "2019-
|
|
25226
|
+
"date": "2019-12-27 16:17:55.260543",
|
|
25227
|
+
"duedate": "2019-12-27",
|
|
23708
25228
|
"total_amount": 0,
|
|
23709
25229
|
"untaxed_amount": 0,
|
|
23710
25230
|
"vat": 0,
|
|
@@ -23712,7 +25232,7 @@
|
|
|
23712
25232
|
"readonly": true,
|
|
23713
25233
|
"number": "",
|
|
23714
25234
|
"issuer": "",
|
|
23715
|
-
"last_update": "2019-
|
|
25235
|
+
"last_update": "2019-12-27 16:17:55.261123",
|
|
23716
25236
|
"has_file_on_website": true,
|
|
23717
25237
|
"currency": ""
|
|
23718
25238
|
}
|
|
@@ -23739,6 +25259,10 @@
|
|
|
23739
25259
|
"type": "integer",
|
|
23740
25260
|
"description": "ID of the related user"
|
|
23741
25261
|
},
|
|
25262
|
+
"id_source": {
|
|
25263
|
+
"type": "integer",
|
|
25264
|
+
"description": "ID of the related connection source"
|
|
25265
|
+
},
|
|
23742
25266
|
"id_parent": {
|
|
23743
25267
|
"type": "integer",
|
|
23744
25268
|
"description": "Id of the parent account"
|
|
@@ -23813,17 +25337,22 @@
|
|
|
23813
25337
|
},
|
|
23814
25338
|
"usage": {
|
|
23815
25339
|
"type": "string",
|
|
23816
|
-
"description": "Account usage"
|
|
25340
|
+
"description": "Account usage (if not set by the user, displays the value of original_usage)"
|
|
23817
25341
|
},
|
|
23818
25342
|
"ownership": {
|
|
23819
25343
|
"type": "string",
|
|
23820
25344
|
"description": "Relationship between the credentials owner and the account"
|
|
25345
|
+
},
|
|
25346
|
+
"company_name": {
|
|
25347
|
+
"type": "string",
|
|
25348
|
+
"description": "Name of the company holding the employee savings of the account"
|
|
23821
25349
|
}
|
|
23822
25350
|
},
|
|
23823
25351
|
"example": {
|
|
23824
25352
|
"id": 0,
|
|
23825
25353
|
"id_connection": 0,
|
|
23826
25354
|
"id_user": 0,
|
|
25355
|
+
"id_source": 0,
|
|
23827
25356
|
"id_parent": 0,
|
|
23828
25357
|
"number": "",
|
|
23829
25358
|
"webid": "",
|
|
@@ -23831,9 +25360,9 @@
|
|
|
23831
25360
|
"balance": 0,
|
|
23832
25361
|
"coming": 0,
|
|
23833
25362
|
"display": true,
|
|
23834
|
-
"last_update": "2019-
|
|
23835
|
-
"deleted": "2019-
|
|
23836
|
-
"disabled": "2019-
|
|
25363
|
+
"last_update": "2019-12-27 16:17:55.263959",
|
|
25364
|
+
"deleted": "2019-12-27 16:17:55.264019",
|
|
25365
|
+
"disabled": "2019-12-27 16:17:55.264077",
|
|
23837
25366
|
"iban": "",
|
|
23838
25367
|
"currency": "",
|
|
23839
25368
|
"id_type": 0,
|
|
@@ -23841,7 +25370,8 @@
|
|
|
23841
25370
|
"name": "",
|
|
23842
25371
|
"error": "",
|
|
23843
25372
|
"usage": "",
|
|
23844
|
-
"ownership": ""
|
|
25373
|
+
"ownership": "",
|
|
25374
|
+
"company_name": ""
|
|
23845
25375
|
}
|
|
23846
25376
|
},
|
|
23847
25377
|
"Project": {
|
|
@@ -24016,46 +25546,10 @@
|
|
|
24016
25546
|
"label": "",
|
|
24017
25547
|
"value": 0,
|
|
24018
25548
|
"quantity": 0,
|
|
24019
|
-
"availability_date": "2019-
|
|
25549
|
+
"availability_date": "2019-12-27",
|
|
24020
25550
|
"condition": "inconnu",
|
|
24021
|
-
"last_update": "2019-
|
|
24022
|
-
"deleted": "2019-
|
|
24023
|
-
}
|
|
24024
|
-
},
|
|
24025
|
-
"Invite": {
|
|
24026
|
-
"required": [
|
|
24027
|
-
"id",
|
|
24028
|
-
"id_user_inviting"
|
|
24029
|
-
],
|
|
24030
|
-
"type": "object",
|
|
24031
|
-
"properties": {
|
|
24032
|
-
"id": {
|
|
24033
|
-
"type": "integer"
|
|
24034
|
-
},
|
|
24035
|
-
"id_unsubscribe": {
|
|
24036
|
-
"type": "integer"
|
|
24037
|
-
},
|
|
24038
|
-
"id_user_inviting": {
|
|
24039
|
-
"type": "integer"
|
|
24040
|
-
},
|
|
24041
|
-
"id_user_invited": {
|
|
24042
|
-
"type": "integer"
|
|
24043
|
-
},
|
|
24044
|
-
"email_invited": {
|
|
24045
|
-
"type": "string"
|
|
24046
|
-
},
|
|
24047
|
-
"timestamp": {
|
|
24048
|
-
"type": "string",
|
|
24049
|
-
"format": "date-time"
|
|
24050
|
-
}
|
|
24051
|
-
},
|
|
24052
|
-
"example": {
|
|
24053
|
-
"id": 0,
|
|
24054
|
-
"id_unsubscribe": 0,
|
|
24055
|
-
"id_user_inviting": 0,
|
|
24056
|
-
"id_user_invited": 0,
|
|
24057
|
-
"email_invited": "",
|
|
24058
|
-
"timestamp": "2019-08-02 17:21:59.449495"
|
|
25551
|
+
"last_update": "2019-12-27 16:17:55.268919",
|
|
25552
|
+
"deleted": "2019-12-27 16:17:55.268982"
|
|
24059
25553
|
}
|
|
24060
25554
|
},
|
|
24061
25555
|
"Alert": {
|
|
@@ -24280,7 +25774,7 @@
|
|
|
24280
25774
|
"example": {
|
|
24281
25775
|
"id": 0,
|
|
24282
25776
|
"id_investment": 0,
|
|
24283
|
-
"vdate": "2019-
|
|
25777
|
+
"vdate": "2019-12-27",
|
|
24284
25778
|
"unitvalue": 0,
|
|
24285
25779
|
"original_currency": "",
|
|
24286
25780
|
"original_unitvalue": 0
|
|
@@ -24338,14 +25832,149 @@
|
|
|
24338
25832
|
"timestamp": "CURRENT_TIMESTAMP"
|
|
24339
25833
|
}
|
|
24340
25834
|
},
|
|
25835
|
+
"SubscriptionLog": {
|
|
25836
|
+
"required": [
|
|
25837
|
+
"id",
|
|
25838
|
+
"id_subscription",
|
|
25839
|
+
"timestamp"
|
|
25840
|
+
],
|
|
25841
|
+
"type": "object",
|
|
25842
|
+
"properties": {
|
|
25843
|
+
"id": {
|
|
25844
|
+
"type": "integer",
|
|
25845
|
+
"description": "ID of the log"
|
|
25846
|
+
},
|
|
25847
|
+
"id_subscription": {
|
|
25848
|
+
"type": "integer",
|
|
25849
|
+
"description": "ID of the related subscription"
|
|
25850
|
+
},
|
|
25851
|
+
"timestamp": {
|
|
25852
|
+
"default": "CURRENT_TIMESTAMP",
|
|
25853
|
+
"type": "string",
|
|
25854
|
+
"description": "Timestamp of log",
|
|
25855
|
+
"format": "date-time"
|
|
25856
|
+
},
|
|
25857
|
+
"nb_docs": {
|
|
25858
|
+
"type": "integer",
|
|
25859
|
+
"description": "Number of docs on the subscription"
|
|
25860
|
+
},
|
|
25861
|
+
"id_connection_log": {
|
|
25862
|
+
"type": "integer",
|
|
25863
|
+
"description": "ID of the related connection log"
|
|
25864
|
+
},
|
|
25865
|
+
"error": {
|
|
25866
|
+
"type": "string",
|
|
25867
|
+
"description": "If fail, contains the error code"
|
|
25868
|
+
},
|
|
25869
|
+
"error_message": {
|
|
25870
|
+
"type": "string",
|
|
25871
|
+
"description": "If fail, error message received from provider"
|
|
25872
|
+
},
|
|
25873
|
+
"id_source": {
|
|
25874
|
+
"type": "integer",
|
|
25875
|
+
"description": "ID of the related connection source"
|
|
25876
|
+
}
|
|
25877
|
+
},
|
|
25878
|
+
"example": {
|
|
25879
|
+
"id": 0,
|
|
25880
|
+
"id_subscription": 0,
|
|
25881
|
+
"timestamp": "CURRENT_TIMESTAMP",
|
|
25882
|
+
"nb_docs": 0,
|
|
25883
|
+
"id_connection_log": 0,
|
|
25884
|
+
"error": "",
|
|
25885
|
+
"error_message": "",
|
|
25886
|
+
"id_source": 0
|
|
25887
|
+
}
|
|
25888
|
+
},
|
|
25889
|
+
"ConnectionSource": {
|
|
25890
|
+
"required": [
|
|
25891
|
+
"id",
|
|
25892
|
+
"id_connection",
|
|
25893
|
+
"id_connector_source",
|
|
25894
|
+
"name",
|
|
25895
|
+
"created"
|
|
25896
|
+
],
|
|
25897
|
+
"type": "object",
|
|
25898
|
+
"properties": {
|
|
25899
|
+
"id": {
|
|
25900
|
+
"type": "integer",
|
|
25901
|
+
"description": "ID of connection"
|
|
25902
|
+
},
|
|
25903
|
+
"id_connection": {
|
|
25904
|
+
"type": "integer",
|
|
25905
|
+
"description": "ID of the related connection"
|
|
25906
|
+
},
|
|
25907
|
+
"id_connector_source": {
|
|
25908
|
+
"type": "integer",
|
|
25909
|
+
"description": "ID of the related connector source"
|
|
25910
|
+
},
|
|
25911
|
+
"name": {
|
|
25912
|
+
"type": "string",
|
|
25913
|
+
"description": "Name of the connection source"
|
|
25914
|
+
},
|
|
25915
|
+
"last_update": {
|
|
25916
|
+
"type": "string",
|
|
25917
|
+
"description": "Last successful update",
|
|
25918
|
+
"format": "date-time"
|
|
25919
|
+
},
|
|
25920
|
+
"disabled": {
|
|
25921
|
+
"type": "string",
|
|
25922
|
+
"description": "This source is not used to synchronize the connection",
|
|
25923
|
+
"format": "date-time"
|
|
25924
|
+
},
|
|
25925
|
+
"created": {
|
|
25926
|
+
"default": "<function <lambda> at 0x7f8894cfe7d0>",
|
|
25927
|
+
"type": "string",
|
|
25928
|
+
"description": "Creation date of the connection source",
|
|
25929
|
+
"format": "date-time"
|
|
25930
|
+
},
|
|
25931
|
+
"state": {
|
|
25932
|
+
"type": "string",
|
|
25933
|
+
"description": "If the last update has failed, the state code"
|
|
25934
|
+
},
|
|
25935
|
+
"access_expire": {
|
|
25936
|
+
"type": "string",
|
|
25937
|
+
"description": "Expiration date of the access",
|
|
25938
|
+
"format": "date-time"
|
|
25939
|
+
},
|
|
25940
|
+
"expire": {
|
|
25941
|
+
"type": "string",
|
|
25942
|
+
"description": "Expiration of the connection source. Used to purge the connection in case completion was not finished",
|
|
25943
|
+
"format": "date-time"
|
|
25944
|
+
},
|
|
25945
|
+
"next_try": {
|
|
25946
|
+
"type": "string",
|
|
25947
|
+
"description": "Date of next synchronization",
|
|
25948
|
+
"format": "date-time"
|
|
25949
|
+
}
|
|
25950
|
+
},
|
|
25951
|
+
"example": {
|
|
25952
|
+
"id": 0,
|
|
25953
|
+
"id_connection": 0,
|
|
25954
|
+
"id_connector_source": 0,
|
|
25955
|
+
"name": "",
|
|
25956
|
+
"last_update": "2019-12-27 16:17:55.317583",
|
|
25957
|
+
"disabled": "2019-12-27 16:17:55.317658",
|
|
25958
|
+
"created": "<function <lambda> at 0x7f8894cfe7d0>",
|
|
25959
|
+
"state": "",
|
|
25960
|
+
"access_expire": "2019-12-27 16:17:55.317849",
|
|
25961
|
+
"expire": "2019-12-27 16:17:55.317911",
|
|
25962
|
+
"next_try": "2019-12-27 16:17:55.318118"
|
|
25963
|
+
}
|
|
25964
|
+
},
|
|
24341
25965
|
"AccountLog": {
|
|
24342
25966
|
"required": [
|
|
25967
|
+
"id",
|
|
24343
25968
|
"id_account",
|
|
24344
25969
|
"balance",
|
|
24345
25970
|
"timestamp"
|
|
24346
25971
|
],
|
|
24347
25972
|
"type": "object",
|
|
24348
25973
|
"properties": {
|
|
25974
|
+
"id": {
|
|
25975
|
+
"type": "integer",
|
|
25976
|
+
"description": "ID of the log"
|
|
25977
|
+
},
|
|
24349
25978
|
"id_account": {
|
|
24350
25979
|
"type": "integer",
|
|
24351
25980
|
"description": "ID of the related account"
|
|
@@ -24385,6 +26014,7 @@
|
|
|
24385
26014
|
}
|
|
24386
26015
|
},
|
|
24387
26016
|
"example": {
|
|
26017
|
+
"id": 0,
|
|
24388
26018
|
"id_account": 0,
|
|
24389
26019
|
"id_connector": 0,
|
|
24390
26020
|
"balance": 0,
|
|
@@ -24444,7 +26074,7 @@
|
|
|
24444
26074
|
"crypto": false,
|
|
24445
26075
|
"precision": 2,
|
|
24446
26076
|
"marketcap": 0,
|
|
24447
|
-
"datetime": "2019-
|
|
26077
|
+
"datetime": "2019-12-27 16:17:55.397255"
|
|
24448
26078
|
}
|
|
24449
26079
|
},
|
|
24450
26080
|
"ConnectorCategory": {
|
|
@@ -24528,7 +26158,6 @@
|
|
|
24528
26158
|
},
|
|
24529
26159
|
"example": {
|
|
24530
26160
|
"id": 0,
|
|
24531
|
-
"key": "",
|
|
24532
26161
|
"previous_value": "",
|
|
24533
26162
|
"new_value": "",
|
|
24534
26163
|
"type": "",
|
|
@@ -24578,9 +26207,6 @@
|
|
|
24578
26207
|
{
|
|
24579
26208
|
"name": "Documents"
|
|
24580
26209
|
},
|
|
24581
|
-
{
|
|
24582
|
-
"name": "HUB"
|
|
24583
|
-
},
|
|
24584
26210
|
{
|
|
24585
26211
|
"name": "OCR"
|
|
24586
26212
|
},
|
|
@@ -24602,6 +26228,9 @@
|
|
|
24602
26228
|
{
|
|
24603
26229
|
"name": "Terms"
|
|
24604
26230
|
},
|
|
26231
|
+
{
|
|
26232
|
+
"name": "Transfer"
|
|
26233
|
+
},
|
|
24605
26234
|
{
|
|
24606
26235
|
"name": "Transfers"
|
|
24607
26236
|
},
|