budgea_client 5.3.8 → 5.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +14 -13
- data/README.md +15 -4
- data/budgea_openapi.json +356 -28
- data/config.json +1 -1
- data/docs/AuthenticationApi.md +62 -0
- data/docs/Connector.md +1 -0
- data/docs/ConnectorSource.md +7 -0
- data/docs/Field.md +2 -1
- data/docs/InlineResponse2005.md +1 -3
- data/docs/PFMApi.md +9 -12
- data/docs/Payment.md +15 -0
- data/docs/PaymentBeneficiary.md +13 -0
- data/docs/PaymentBeneficiaryRequest.md +12 -0
- data/docs/PaymentData.md +13 -0
- data/docs/PaymentErrorCode.md +7 -0
- data/docs/PaymentInstruction.md +12 -0
- data/docs/PaymentInstructionRequest.md +13 -0
- data/docs/PaymentRequest.md +13 -0
- data/docs/PaymentState.md +7 -0
- data/docs/PaymentsApi.md +114 -0
- data/lib/budgea_client/api/authentication_api.rb +60 -0
- data/lib/budgea_client/api/payments_api.rb +127 -0
- data/lib/budgea_client/api/pfm_api.rb +14 -26
- data/lib/budgea_client/models/connection.rb +2 -2
- data/lib/budgea_client/models/connector.rb +15 -4
- data/lib/budgea_client/models/connector_source.rb +79 -4
- data/lib/budgea_client/models/field.rb +18 -5
- data/lib/budgea_client/models/inline_response_200_5.rb +7 -37
- data/lib/budgea_client/models/payment.rb +255 -0
- data/lib/budgea_client/models/payment_beneficiary.rb +235 -0
- data/lib/budgea_client/models/payment_beneficiary_request.rb +240 -0
- data/lib/budgea_client/models/payment_data.rb +246 -0
- data/lib/budgea_client/models/payment_error_code.rb +44 -0
- data/lib/budgea_client/models/payment_instruction.rb +224 -0
- data/lib/budgea_client/models/payment_instruction_request.rb +254 -0
- data/lib/budgea_client/models/payment_request.rb +246 -0
- data/lib/budgea_client/models/payment_state.rb +35 -0
- data/lib/budgea_client/version.rb +1 -1
- data/lib/budgea_client.rb +9 -0
- data/patches/01_allow_enum_nil.patch +4 -4
- data/spec/api/payments_api_spec.rb +46 -0
- data/spec/models/payment_beneficiary_request_spec.rb +65 -0
- data/spec/models/payment_beneficiary_spec.rb +35 -0
- data/spec/models/payment_data_spec.rb +71 -0
- data/spec/models/payment_error_code_spec.rb +35 -0
- data/spec/models/payment_instruction_request_spec.rb +35 -0
- data/spec/models/payment_instruction_spec.rb +35 -0
- data/spec/models/payment_request_spec.rb +71 -0
- data/spec/models/payment_spec.rb +35 -0
- data/spec/models/payment_state_spec.rb +35 -0
- data/tags +129 -2
- metadata +42 -3
- data/pkg/budgea_client-5.3.7.gem +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3405835ae770437364f52a4b4c01f85944bc028af9183a0fcc7216a7f3cedf0e
|
4
|
+
data.tar.gz: 1aa21134d1b97c054735adbfd6313d8034214dddd5a032edf3b5e1139edbbe30
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a9c2ad0db9179d9724f7255601406c370954084b0d47b290d45b4def7cb1e745b05576205e3c4e9c837ca9505984d5e807ed10e76bd85ea4462fe9dae189499f
|
7
|
+
data.tar.gz: 33b583def4737334e9e59a05333c24d485bc1fcbd1226fc7c5667f0d85f335bde036582c69926786f5ed7f046de7aa3867f0e402433f7d634d7c7672a2f6d836
|
data/Gemfile.lock
CHANGED
@@ -1,31 +1,32 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
budgea_client (5.
|
4
|
+
budgea_client (5.6.0)
|
5
|
+
addressable (~> 2.3, >= 2.3.0)
|
5
6
|
json (~> 2.1, >= 2.1.0)
|
6
7
|
typhoeus (~> 1.0, >= 1.0.1)
|
7
8
|
|
8
9
|
GEM
|
9
10
|
remote: https://rubygems.org/
|
10
11
|
specs:
|
11
|
-
ZenTest (4.
|
12
|
-
addressable (2.
|
13
|
-
public_suffix (>= 2.0.2, <
|
12
|
+
ZenTest (4.12.0)
|
13
|
+
addressable (2.8.0)
|
14
|
+
public_suffix (>= 2.0.2, < 5.0)
|
14
15
|
autotest (4.4.6)
|
15
16
|
ZenTest (>= 4.4.1)
|
16
|
-
autotest-fsevent (0.2.
|
17
|
+
autotest-fsevent (0.2.18)
|
17
18
|
sys-uname
|
18
19
|
autotest-growl (0.2.16)
|
19
20
|
autotest-rails-pure (4.1.2)
|
20
21
|
crack (0.4.3)
|
21
22
|
safe_yaml (~> 1.0.0)
|
22
23
|
diff-lcs (1.3)
|
23
|
-
ethon (0.
|
24
|
-
ffi (>= 1.
|
25
|
-
ffi (1.
|
24
|
+
ethon (0.15.0)
|
25
|
+
ffi (>= 1.15.0)
|
26
|
+
ffi (1.15.3)
|
26
27
|
hashdiff (0.3.7)
|
27
|
-
json (2.
|
28
|
-
public_suffix (
|
28
|
+
json (2.6.2)
|
29
|
+
public_suffix (4.0.6)
|
29
30
|
rake (12.3.3)
|
30
31
|
rspec (3.8.0)
|
31
32
|
rspec-core (~> 3.8.0)
|
@@ -41,8 +42,8 @@ GEM
|
|
41
42
|
rspec-support (~> 3.8.0)
|
42
43
|
rspec-support (3.8.0)
|
43
44
|
safe_yaml (1.0.4)
|
44
|
-
sys-uname (1.
|
45
|
-
ffi (
|
45
|
+
sys-uname (1.2.2)
|
46
|
+
ffi (~> 1.1)
|
46
47
|
typhoeus (1.4.0)
|
47
48
|
ethon (>= 0.9.0)
|
48
49
|
vcr (3.0.3)
|
@@ -66,4 +67,4 @@ DEPENDENCIES
|
|
66
67
|
webmock (~> 1.24, >= 1.24.3)
|
67
68
|
|
68
69
|
BUNDLED WITH
|
69
|
-
1.
|
70
|
+
1.17.3
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ No description provided (generated by Swagger Codegen https://github.com/swagger
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0
|
10
|
-
- Package version: 5.
|
10
|
+
- Package version: 5.6.0
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build budgea_client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./budgea_client-5.
|
26
|
+
gem install ./budgea_client-5.6.0.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./budgea_client-5.
|
28
|
+
(for development, run `gem install --dev ./budgea_client-5.6.0.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'budgea_client', '~> 5.
|
34
|
+
gem 'budgea_client', '~> 5.6.0'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -126,6 +126,7 @@ Class | Method | HTTP request | Description
|
|
126
126
|
*BudgeaClient::AuthenticationApi* | [**auth_token_access_post**](docs/AuthenticationApi.md#auth_token_access_post) | **POST** /auth/token/access | Transform a temporary code to a access_token
|
127
127
|
*BudgeaClient::AuthenticationApi* | [**auth_token_code_get**](docs/AuthenticationApi.md#auth_token_code_get) | **GET** /auth/token/code | Generate a user temporary token
|
128
128
|
*BudgeaClient::AuthenticationApi* | [**auth_token_delete**](docs/AuthenticationApi.md#auth_token_delete) | **DELETE** /auth/token | Remove user access
|
129
|
+
*BudgeaClient::AuthenticationApi* | [**auth_token_post**](docs/AuthenticationApi.md#auth_token_post) | **POST** /auth/token | Login to API with credentials
|
129
130
|
*BudgeaClient::AuthenticationApi* | [**certificate_type_get**](docs/AuthenticationApi.md#certificate_type_get) | **GET** /certificate/{type} | Get the latest certificate of a type
|
130
131
|
*BudgeaClient::AuthenticationApi* | [**hash_delete**](docs/AuthenticationApi.md#hash_delete) | **DELETE** /hash | Delete the user's connections
|
131
132
|
*BudgeaClient::AuthenticationApi* | [**users_id_user_delete**](docs/AuthenticationApi.md#users_id_user_delete) | **DELETE** /users/{id_user} | Delete the user
|
@@ -421,6 +422,8 @@ Class | Method | HTTP request | Description
|
|
421
422
|
*BudgeaClient::PFMApi* | [**users_id_user_profiles_me_put**](docs/PFMApi.md#users_id_user_profiles_me_put) | **PUT** /users/{id_user}/profiles/me | Change settings of the profile.
|
422
423
|
*BudgeaClient::PFMApi* | [**users_id_user_resume_get**](docs/PFMApi.md#users_id_user_resume_get) | **GET** /users/{id_user}/resume | Get synthesis configuration of a specific user
|
423
424
|
*BudgeaClient::PFMApi* | [**users_id_user_resume_post**](docs/PFMApi.md#users_id_user_resume_post) | **POST** /users/{id_user}/resume | Update synthesis configuration
|
425
|
+
*BudgeaClient::PaymentsApi* | [**payments_id_payment_get**](docs/PaymentsApi.md#payments_id_payment_get) | **GET** /payments/{id_payment} | Retrieve a payment request
|
426
|
+
*BudgeaClient::PaymentsApi* | [**payments_post**](docs/PaymentsApi.md#payments_post) | **POST** /payments | Create and validate a payment request
|
424
427
|
*BudgeaClient::ProvidersApi* | [**banks_get**](docs/ProvidersApi.md#banks_get) | **GET** /banks | Get list of connectors
|
425
428
|
*BudgeaClient::ProvidersApi* | [**banks_id_connector_logos_get**](docs/ProvidersApi.md#banks_id_connector_logos_get) | **GET** /banks/{id_connector}/logos | Get all links to the files associated with this connector.
|
426
429
|
*BudgeaClient::ProvidersApi* | [**banks_id_connector_logos_main_get**](docs/ProvidersApi.md#banks_id_connector_logos_main_get) | **GET** /banks/{id_connector}/logos/main | Get all links to the files associated with this connector.
|
@@ -710,6 +713,14 @@ Class | Method | HTTP request | Description
|
|
710
713
|
- [BudgeaClient::LockedUser](docs/LockedUser.md)
|
711
714
|
- [BudgeaClient::OidcWhitelist](docs/OidcWhitelist.md)
|
712
715
|
- [BudgeaClient::Order](docs/Order.md)
|
716
|
+
- [BudgeaClient::Payment](docs/Payment.md)
|
717
|
+
- [BudgeaClient::PaymentBeneficiary](docs/PaymentBeneficiary.md)
|
718
|
+
- [BudgeaClient::PaymentBeneficiaryRequest](docs/PaymentBeneficiaryRequest.md)
|
719
|
+
- [BudgeaClient::PaymentErrorCode](docs/PaymentErrorCode.md)
|
720
|
+
- [BudgeaClient::PaymentInstruction](docs/PaymentInstruction.md)
|
721
|
+
- [BudgeaClient::PaymentInstructionRequest](docs/PaymentInstructionRequest.md)
|
722
|
+
- [BudgeaClient::PaymentRequest](docs/PaymentRequest.md)
|
723
|
+
- [BudgeaClient::PaymentState](docs/PaymentState.md)
|
713
724
|
- [BudgeaClient::Pocket](docs/Pocket.md)
|
714
725
|
- [BudgeaClient::Profile](docs/Profile.md)
|
715
726
|
- [BudgeaClient::Project](docs/Project.md)
|
data/budgea_openapi.json
CHANGED
@@ -493,16 +493,10 @@
|
|
493
493
|
"schema": {
|
494
494
|
"required": [
|
495
495
|
"token",
|
496
|
-
"scope"
|
497
|
-
"user",
|
498
|
-
"profile"
|
496
|
+
"scope"
|
499
497
|
],
|
500
498
|
"type": "object",
|
501
499
|
"properties": {
|
502
|
-
"profile": {
|
503
|
-
"type": "object",
|
504
|
-
"description": "the user profile data object"
|
505
|
-
},
|
506
500
|
"scope": {
|
507
501
|
"type": "string",
|
508
502
|
"description": "the token scope"
|
@@ -511,53 +505,42 @@
|
|
511
505
|
"type": "string",
|
512
506
|
"description": "the requested token"
|
513
507
|
},
|
514
|
-
"
|
508
|
+
"expire_in": {
|
515
509
|
"type": "integer",
|
516
510
|
"description": "duration in seconds of the token validity"
|
517
|
-
},
|
518
|
-
"user": {
|
519
|
-
"type": "object",
|
520
|
-
"description": "the user data object"
|
521
511
|
}
|
522
512
|
}
|
523
513
|
},
|
524
514
|
"description": "",
|
525
515
|
"examples": {
|
526
|
-
"profile": {},
|
527
516
|
"scope": "",
|
528
|
-
"token": "A37mwXNCblbWX0LrvpRq60sZ6NBft/t5tsHhADie56/TJscwSi8NSjVmUIf6iLqpDwPe6lyFXM3z7E/zKf9eRHUWzx4QryEgmCtwZ0XgQb9SE+HwaenwqwTuv1gHZD+n"
|
529
|
-
"user": {}
|
517
|
+
"token": "A37mwXNCblbWX0LrvpRq60sZ6NBft/t5tsHhADie56/TJscwSi8NSjVmUIf6iLqpDwPe6lyFXM3z7E/zKf9eRHUWzx4QryEgmCtwZ0XgQb9SE+HwaenwqwTuv1gHZD+n"
|
530
518
|
}
|
531
519
|
}
|
532
520
|
},
|
533
521
|
"tags": [
|
522
|
+
"Authentication",
|
534
523
|
"PFM"
|
535
524
|
],
|
536
|
-
"description": "Request a new
|
525
|
+
"description": "Request a new token by giving the client_id and client_secret",
|
537
526
|
"parameters": [
|
538
527
|
{
|
539
|
-
"required": true,
|
540
528
|
"in": "formData",
|
541
529
|
"type": "string",
|
542
|
-
"name": "
|
543
|
-
"description": "username"
|
530
|
+
"name": "client_id"
|
544
531
|
},
|
545
532
|
{
|
546
|
-
"required": true,
|
547
533
|
"in": "formData",
|
548
534
|
"type": "string",
|
549
|
-
"name": "
|
550
|
-
"description": "password"
|
535
|
+
"name": "client_secret"
|
551
536
|
},
|
552
537
|
{
|
553
|
-
"required": true,
|
554
538
|
"in": "formData",
|
555
539
|
"type": "string",
|
556
|
-
"name": "
|
557
|
-
"description": "
|
540
|
+
"name": "grant_type",
|
541
|
+
"description": "grant type"
|
558
542
|
},
|
559
543
|
{
|
560
|
-
"required": false,
|
561
544
|
"in": "formData",
|
562
545
|
"type": "string",
|
563
546
|
"name": "scope",
|
@@ -3458,6 +3441,59 @@
|
|
3458
3441
|
"summary": "Delete the supplied authorized redirect uri"
|
3459
3442
|
}
|
3460
3443
|
},
|
3444
|
+
"/payments": {
|
3445
|
+
"post": {
|
3446
|
+
"responses": {
|
3447
|
+
"200": {
|
3448
|
+
"description": "Successful POST on Payment resource",
|
3449
|
+
"schema": {
|
3450
|
+
"$ref": "#/definitions/Payment"
|
3451
|
+
}
|
3452
|
+
}
|
3453
|
+
},
|
3454
|
+
"parameters": [
|
3455
|
+
{
|
3456
|
+
"in": "body",
|
3457
|
+
"name": "payment_data",
|
3458
|
+
"required": true,
|
3459
|
+
"schema": {
|
3460
|
+
"$ref": "#/definitions/PaymentRequest"
|
3461
|
+
}
|
3462
|
+
}
|
3463
|
+
],
|
3464
|
+
"tags": [
|
3465
|
+
"Payments"
|
3466
|
+
],
|
3467
|
+
"summary": "Create and validate a payment request",
|
3468
|
+
"consumes": [
|
3469
|
+
"application/json"
|
3470
|
+
]
|
3471
|
+
}
|
3472
|
+
},
|
3473
|
+
"/payments/{id_payment}": {
|
3474
|
+
"get": {
|
3475
|
+
"responses": {
|
3476
|
+
"200": {
|
3477
|
+
"description": "Successful GET on Payment resource",
|
3478
|
+
"schema": {
|
3479
|
+
"$ref": "#/definitions/Payment"
|
3480
|
+
}
|
3481
|
+
}
|
3482
|
+
},
|
3483
|
+
"tags": [
|
3484
|
+
"Payments"
|
3485
|
+
],
|
3486
|
+
"summary": "Retrieve a payment request",
|
3487
|
+
"parameters": [
|
3488
|
+
{
|
3489
|
+
"required": true,
|
3490
|
+
"type": "integer",
|
3491
|
+
"name": "id_payment",
|
3492
|
+
"in": "path"
|
3493
|
+
}
|
3494
|
+
]
|
3495
|
+
}
|
3496
|
+
},
|
3461
3497
|
"/providers": {
|
3462
3498
|
"get": {
|
3463
3499
|
"responses": {
|
@@ -23487,6 +23523,12 @@
|
|
23487
23523
|
"items": {
|
23488
23524
|
"type": "string"
|
23489
23525
|
}
|
23526
|
+
},
|
23527
|
+
"sources": {
|
23528
|
+
"type": "array",
|
23529
|
+
"items": {
|
23530
|
+
"$ref": "#/definitions/ConnectorSource"
|
23531
|
+
}
|
23490
23532
|
}
|
23491
23533
|
},
|
23492
23534
|
"example": {
|
@@ -23577,6 +23619,45 @@
|
|
23577
23619
|
"priority": {
|
23578
23620
|
"type": "integer",
|
23579
23621
|
"description": "The source priority order for the synchronization"
|
23622
|
+
},
|
23623
|
+
"capabilities": {
|
23624
|
+
"type": "array",
|
23625
|
+
"items": {
|
23626
|
+
"type": "string"
|
23627
|
+
}
|
23628
|
+
},
|
23629
|
+
"available_auth_mechanisms": {
|
23630
|
+
"type": "array",
|
23631
|
+
"items": {
|
23632
|
+
"type": "string"
|
23633
|
+
}
|
23634
|
+
},
|
23635
|
+
"urls": {
|
23636
|
+
"type": "array",
|
23637
|
+
"items": {
|
23638
|
+
"type": "string"
|
23639
|
+
}
|
23640
|
+
},
|
23641
|
+
"available_transfer_mechanisms": {
|
23642
|
+
"type": "array",
|
23643
|
+
"items": {
|
23644
|
+
"type": "string"
|
23645
|
+
}
|
23646
|
+
},
|
23647
|
+
"transfer_validate_mechanism": {
|
23648
|
+
"type": "string"
|
23649
|
+
},
|
23650
|
+
"transfer_execution_date_types": {
|
23651
|
+
"type": "array",
|
23652
|
+
"items": {
|
23653
|
+
"type": "string"
|
23654
|
+
}
|
23655
|
+
},
|
23656
|
+
"transfer_execution_frequencies": {
|
23657
|
+
"type": "array",
|
23658
|
+
"items": {
|
23659
|
+
"type": "string"
|
23660
|
+
}
|
23580
23661
|
}
|
23581
23662
|
},
|
23582
23663
|
"example": {
|
@@ -23645,8 +23726,17 @@
|
|
23645
23726
|
"description": "If true, field has to be set to synchronize the connection"
|
23646
23727
|
},
|
23647
23728
|
"auth_mechanisms": {
|
23648
|
-
"type": "
|
23729
|
+
"type": "array",
|
23730
|
+
"items": {
|
23731
|
+
"type": "string"
|
23732
|
+
},
|
23649
23733
|
"description": "Authentication mechanisms this field is used for"
|
23734
|
+
},
|
23735
|
+
"connector_sources": {
|
23736
|
+
"type": "array",
|
23737
|
+
"items": {
|
23738
|
+
"type": "string"
|
23739
|
+
}
|
23650
23740
|
}
|
23651
23741
|
},
|
23652
23742
|
"example": {
|
@@ -23840,7 +23930,9 @@
|
|
23840
23930
|
"passwordExpired",
|
23841
23931
|
"webauthRequired",
|
23842
23932
|
"rateLimiting",
|
23843
|
-
"bug"
|
23933
|
+
"bug",
|
23934
|
+
"validating",
|
23935
|
+
"notSupported"
|
23844
23936
|
],
|
23845
23937
|
"description": "State of Connection"
|
23846
23938
|
},
|
@@ -26584,6 +26676,242 @@
|
|
26584
26676
|
"name": "",
|
26585
26677
|
"attacheable": true
|
26586
26678
|
}
|
26679
|
+
},
|
26680
|
+
"PaymentRequest": {
|
26681
|
+
"type": "object",
|
26682
|
+
"required": ["client_redirect_uri", "instructions"],
|
26683
|
+
"properties": {
|
26684
|
+
"id_connector": {
|
26685
|
+
"type": "integer",
|
26686
|
+
"description": "ID of the bank connector to use to initiate the payment. The bank connector must be eligible to payments creation. The id_connector can be submitted later on if validated is false when you initiate the payment request."
|
26687
|
+
},
|
26688
|
+
"client_redirect_uri": {
|
26689
|
+
"type": "string",
|
26690
|
+
"description": "The redirect URL to use when building the validation URL. The provided URL must not contain any query parameter, rely on the client_state parameter for state management."
|
26691
|
+
},
|
26692
|
+
"client_state": {
|
26693
|
+
"type": "string",
|
26694
|
+
"description": "Optional value that will be added as a state query parameter to the redirect URL after validation."
|
26695
|
+
},
|
26696
|
+
"beneficiary": {
|
26697
|
+
"$ref": "#/definitions/PaymentBeneficiaryRequest"
|
26698
|
+
},
|
26699
|
+
"instructions": {
|
26700
|
+
"type": "array",
|
26701
|
+
"items": {
|
26702
|
+
"$ref": "#/definitions/PaymentInstructionRequest"
|
26703
|
+
},
|
26704
|
+
"description": "The payment information."
|
26705
|
+
},
|
26706
|
+
"validated": {
|
26707
|
+
"type": "boolean",
|
26708
|
+
"description": "Provide true to acknowledge payment validation at once. Otherwise, validation is deferred."
|
26709
|
+
}
|
26710
|
+
},
|
26711
|
+
"additionalProperties": {}
|
26712
|
+
},
|
26713
|
+
"PaymentBeneficiaryRequest": {
|
26714
|
+
"type": "object",
|
26715
|
+
"required": ["scheme_name", "identification", "label"],
|
26716
|
+
"properties": {
|
26717
|
+
"scheme_name": {
|
26718
|
+
"type": "string",
|
26719
|
+
"description": "The beneficiary number type: iban for IBAN, bban for BBAN (please note that BBAN is not supported by any connector yet)."
|
26720
|
+
},
|
26721
|
+
"identification": {
|
26722
|
+
"type": "string",
|
26723
|
+
"description": "The beneficiary account number, of type matching the scheme_name."
|
26724
|
+
},
|
26725
|
+
"label": {
|
26726
|
+
"type": "string",
|
26727
|
+
"description": "Display name of the beneficiary."
|
26728
|
+
},
|
26729
|
+
"merchant_scheme_name": {
|
26730
|
+
"type": "string",
|
26731
|
+
"description": "For merchant beneficiaries, the type of identifier: siret, siren, rcs, rna."
|
26732
|
+
},
|
26733
|
+
"merchant_identification": {
|
26734
|
+
"type": "string",
|
26735
|
+
"description": "For merchant beneficiaries, the identifier, of type matching the merchant_scheme_name."
|
26736
|
+
}
|
26737
|
+
}
|
26738
|
+
},
|
26739
|
+
"PaymentInstructionRequest": {
|
26740
|
+
"type": "object",
|
26741
|
+
"required": ["amount", "currency", "label", "execution_date_type"],
|
26742
|
+
"properties": {
|
26743
|
+
"reference_id": {
|
26744
|
+
"type": "string",
|
26745
|
+
"description": "An identifier for the transaction, set by the emitter client. If not provided, a random UUID value will be generated."
|
26746
|
+
},
|
26747
|
+
"amount": {
|
26748
|
+
"type": "integer",
|
26749
|
+
"description": "The amount of the payment."
|
26750
|
+
},
|
26751
|
+
"currency": {
|
26752
|
+
"type": "string",
|
26753
|
+
"description": "The currency code of the payment amount, a per ISO 4217."
|
26754
|
+
},
|
26755
|
+
"label": {
|
26756
|
+
"type": "string",
|
26757
|
+
"description": "Label of the payment."
|
26758
|
+
},
|
26759
|
+
"execution_date_type": {
|
26760
|
+
"type": "string",
|
26761
|
+
"description": "The execution date type of the payment: first_open_day for a standard banking transfer, deferred for a scheduled transfer, instant for instant payment. Other values might be supported later."
|
26762
|
+
},
|
26763
|
+
"execution_date": {
|
26764
|
+
"type": "date",
|
26765
|
+
"description": "The execution date for the transfer, only for deferred transfers."
|
26766
|
+
},
|
26767
|
+
"beneficiary": {
|
26768
|
+
"$ref": "#/definitions/PaymentBeneficiaryRequest"
|
26769
|
+
}
|
26770
|
+
}
|
26771
|
+
},
|
26772
|
+
"Payment": {
|
26773
|
+
"type": "object",
|
26774
|
+
"properties": {
|
26775
|
+
"id": {
|
26776
|
+
"type": "integer",
|
26777
|
+
"description": "The ID of the created payment request."
|
26778
|
+
},
|
26779
|
+
"state": {
|
26780
|
+
"type": "string"
|
26781
|
+
},
|
26782
|
+
"error_code": {
|
26783
|
+
"type": "string"
|
26784
|
+
},
|
26785
|
+
"error_description": {
|
26786
|
+
"type": "string",
|
26787
|
+
"nullable": true,
|
26788
|
+
"description": "Error message in case of an error."
|
26789
|
+
},
|
26790
|
+
"id_connector": {
|
26791
|
+
"type": "integer",
|
26792
|
+
"nullable": true,
|
26793
|
+
"description": "ID of the bank connector to use to initiate the payment."
|
26794
|
+
},
|
26795
|
+
"register_date": {
|
26796
|
+
"type": "datetime",
|
26797
|
+
"description": "Creation date of the transfer request."
|
26798
|
+
},
|
26799
|
+
"validate_uri": {
|
26800
|
+
"type": "string",
|
26801
|
+
"nullable": true,
|
26802
|
+
"description": "The URL that must be presented to the PSU to validate the payment request. The URL is only available after the transfer has been validated."
|
26803
|
+
},
|
26804
|
+
"client_redirect_uri": {
|
26805
|
+
"type": "string",
|
26806
|
+
"nullable": true,
|
26807
|
+
"description": "The validate_uri callback URL that was provided when configuring the transfer request."
|
26808
|
+
},
|
26809
|
+
"instructions": {
|
26810
|
+
"type": "array",
|
26811
|
+
"items": {
|
26812
|
+
"$ref": "#/definitions/PaymentInstruction"
|
26813
|
+
},
|
26814
|
+
"description": "The list of payment instructions."
|
26815
|
+
}
|
26816
|
+
}
|
26817
|
+
},
|
26818
|
+
"PaymentBeneficiary": {
|
26819
|
+
"type": "object",
|
26820
|
+
"properties": {
|
26821
|
+
"scheme_name": {
|
26822
|
+
"type": "string",
|
26823
|
+
"description": "The beneficiary number type: iban for IBAN, bban for BBAN."
|
26824
|
+
},
|
26825
|
+
"identification": {
|
26826
|
+
"type": "string",
|
26827
|
+
"description": "The beneficiary account number, of type matching the scheme_name."
|
26828
|
+
},
|
26829
|
+
"label": {
|
26830
|
+
"type": "string",
|
26831
|
+
"description": "Display name of the beneficiary."
|
26832
|
+
},
|
26833
|
+
"merchant_scheme_name": {
|
26834
|
+
"type": "string",
|
26835
|
+
"description": "For merchant beneficiaries, the type of identifier: siret, siren, rcs, rna."
|
26836
|
+
},
|
26837
|
+
"merchant_identification": {
|
26838
|
+
"type": "string",
|
26839
|
+
"description": "For merchant beneficiaries, the identifier, of type matching the merchant_scheme_name."
|
26840
|
+
},
|
26841
|
+
"bic": {
|
26842
|
+
"type": "string",
|
26843
|
+
"nullable": true,
|
26844
|
+
"description": "The BIC of the beneficiary if it could be determined from the IBAN, null otherwise."
|
26845
|
+
}
|
26846
|
+
}
|
26847
|
+
},
|
26848
|
+
"PaymentInstruction": {
|
26849
|
+
"type": "object",
|
26850
|
+
"properties": {
|
26851
|
+
"reference_id": {
|
26852
|
+
"type": "string",
|
26853
|
+
"description": "An identifier for the transaction."
|
26854
|
+
},
|
26855
|
+
"amount": {
|
26856
|
+
"type": "float",
|
26857
|
+
"description": "The amount of the payment."
|
26858
|
+
},
|
26859
|
+
"currency": {
|
26860
|
+
"type": "string",
|
26861
|
+
"description": "The currency of the payment amount."
|
26862
|
+
},
|
26863
|
+
"label": {
|
26864
|
+
"type": "string",
|
26865
|
+
"description": "Label of the payment."
|
26866
|
+
},
|
26867
|
+
"execution_date_type": {
|
26868
|
+
"type": "string",
|
26869
|
+
"description": "The execution date type of the payment: first_open_day for a standard banking transfer, deferred for a scheduled transfer, instant for instant payment. Other values might be supported later."
|
26870
|
+
},
|
26871
|
+
"execution_date": {
|
26872
|
+
"type": "date",
|
26873
|
+
"nullable": true,
|
26874
|
+
"description": "The execution date of the payment (available when the payment is deferred or has been validated)"
|
26875
|
+
},
|
26876
|
+
"beneficiary": {
|
26877
|
+
"$ref": "#/definitions/PaymentBeneficiary"
|
26878
|
+
}
|
26879
|
+
}
|
26880
|
+
},
|
26881
|
+
"PaymentState": {
|
26882
|
+
"type": "string",
|
26883
|
+
"description": "created\tThe payment request was registered, but not yet validated.\nvalidating\tThe payment request was validated and initialized with the bank. The validate_uri is available.\nerror\tAn error occurred while initializing the request with the bank. The error_code is available.\npending\tThe payment request has been validated on the bank website, but execution has not been confirmed yet.\nrejected\tThe payment request has been rejected by the bank or the user. The error_code is available.\ndone\tThe payment has been executed and confirmed by the bank.\nexpired\tThe payment has automatically expired because it did not have a definitive status (ie done or rejected) N days after its execution. N value is configurable with the payment.manual_expire_time_days configuration key.",
|
26884
|
+
"enum": [
|
26885
|
+
"created",
|
26886
|
+
"validating",
|
26887
|
+
"error",
|
26888
|
+
"pending",
|
26889
|
+
"rejected",
|
26890
|
+
"done",
|
26891
|
+
"expired"
|
26892
|
+
]
|
26893
|
+
},
|
26894
|
+
"PaymentErrorCode": {
|
26895
|
+
"type": "string",
|
26896
|
+
"description": "invalidEmitter\tIdentification of the emitter account is invalid, or transfer emission is not possible.\ninsufficientFunds\tThe balance of the emitter account is too low.\ninvalidAmount\tThe amount of the payment request is invalid or out of the authorized bounds.\ninvalidCurrency\tThe currency of the payment request is invalid or unsupported.\ninvalidDate\tThe execution date of the payment request is invalid or out of the supported bounds.\ninvalidBeneficiary\tThe beneficiary identification is invalid or unsupported.\ninvalidLabel\tThe label of the payment request does not match the constraints enforced by the bank.\nregulatoryReason\tThe request was aborted by the bank for regulatory reason (e.g. fraud detection).\nauthenticationFailed\tThe request was aborted because the end-user failed to identify with the bank.\nnoAnswerFromCustomer\tThe payment request expired without any interaction with the end-user.\nnoSpecifiedReason\tThe payment request was rejected by the bank without any reason.\nCancelledByUser\tThe payment was explicitly cancelled by the end-user.\nbankMessage\tThe bank sent an error message to the user.\ninvalidValue\tThe request contains invalid data.\nactionNeeded\tAn action is needed on the website by the user.\nbug\tA bug has occurred during the request validation.",
|
26897
|
+
"enum": [
|
26898
|
+
"invalidEmitter",
|
26899
|
+
"insufficientFunds",
|
26900
|
+
"invalidAmount",
|
26901
|
+
"invalidCurrency",
|
26902
|
+
"invalidDate",
|
26903
|
+
"invalidBeneficiary",
|
26904
|
+
"invalidLabel",
|
26905
|
+
"regulatoryReason",
|
26906
|
+
"authenticationFailed",
|
26907
|
+
"noAnswerFromCustomer",
|
26908
|
+
"noSpecifiedReason",
|
26909
|
+
"CancelledByUser",
|
26910
|
+
"bankMessage",
|
26911
|
+
"invalidValue",
|
26912
|
+
"actionNeeded",
|
26913
|
+
"bug"
|
26914
|
+
]
|
26587
26915
|
}
|
26588
26916
|
},
|
26589
26917
|
"basePath": "/2.0/",
|
data/config.json
CHANGED