-
Notifications
You must be signed in to change notification settings - Fork 2
/
cds.yaml
2887 lines (2887 loc) · 90.4 KB
/
cds.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: Consumer Data Standards
description: >-
API sets created by the Australian Consumer Data Standards to meet the needs
of the Consumer Data Right
version: "1-oas3"
license:
name: MIT Licence
url: 'https://opensource.org/licenses/MIT'
paths:
/banking/accounts:
get:
summary: Get Accounts
description: Obtain a list of accounts
security:
- OAuth2:
- accounts
operationId: listAccounts
x-scopes:
- bank_basic_accounts
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/ParamAccountOpenStatus'
- $ref: '#/components/parameters/ParamAccountIsOwned'
- $ref: '#/components/parameters/ParamProductCategory'
- $ref: '#/components/parameters/ParamPage'
- $ref: '#/components/parameters/ParamPageSize'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingAccounts'
x-version: '1'
'/banking/accounts/{accountId}':
get:
summary: Get Account Detail
description: Obtain detailed information on a single account
security:
- OAuth2:
- accounts
operationId: getAccountDetail
x-scopes:
- bank_detailed_accounts
tags:
- Accounts
parameters:
- name: accountId
in: path
description: >-
A tokenised identifier for the account which is unique but not
shareable
required: true
schema:
type: string
format: ASCIIString
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingAccount'
x-version: '1'
/banking/accounts/balances:
get:
summary: Get Bulk Balances
description: 'Obtain balances for multiple, filtered accounts'
security:
- OAuth2:
- accounts
operationId: listBalancesBulk
x-scopes:
- bank_basic_accounts
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/ParamAccountOpenStatus'
- $ref: '#/components/parameters/ParamAccountIsOwned'
- $ref: '#/components/parameters/ParamProductCategory'
- $ref: '#/components/parameters/ParamPage'
- $ref: '#/components/parameters/ParamPageSize'
responses:
'200':
description: resource listing the financial balances for the account
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingAccountsBalances'
x-version: '1'
post:
summary: Get Balances For Specific Accounts
description: Obtain balances for a specified list of accounts
security:
- OAuth2:
- accounts
operationId: listBalancesSpecificAccounts
x-scopes:
- bank_basic_accounts
tags:
- Accounts
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingAccountsBalances'
'422':
description: >-
The request was well formed but was unable to be processed due to
business logic specific to the request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorList'
x-version: '1'
requestBody:
$ref: '#/components/requestBodies/RequestAccountIds'
'/banking/accounts/{accountId}/transactions':
get:
summary: Get Transactions For Account
description: Obtain transactions for a specific account
security:
- OAuth2:
- accounts
operationId: getTransactions
x-scopes:
- bank_transactions
tags:
- Accounts
parameters:
- name: accountId
in: path
description: >-
ID of the account to get transactions for. Must have previously
been returned by one of the account list end points.
required: true
schema:
type: string
format: ASCIIString
- $ref: '#/components/parameters/ParamStartTime'
- $ref: '#/components/parameters/ParamEndTime'
- $ref: '#/components/parameters/ParamTransactionMinAmount'
- $ref: '#/components/parameters/ParamTransactionMaxAmount'
- $ref: '#/components/parameters/ParamTransactionText'
- $ref: '#/components/parameters/ParamPage'
- $ref: '#/components/parameters/ParamPageSize'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingTransactions'
x-version: '1'
'/banking/accounts/{accountId}/transactions/{transactionId}':
get:
summary: Get Transaction Detail
description: Obtain detailed information on a transaction for a specific account
security:
- OAuth2:
- accounts
operationId: getTransactionDetail
x-scopes:
- bank_transactions
tags:
- Accounts
parameters:
- name: accountId
in: path
description: The account id token that is used to uniquely represent the account
required: true
schema:
type: string
format: ASCIIString
- name: transactionId
in: path
description: >-
The unique identifier for the specific transaction for which details
are being requested
required: true
schema:
type: string
format: ASCIIString
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingTransactionDetail'
x-version: '1'
/banking/accounts/transactions:
get:
summary: Get Transactions For Multiple Accounts
description: 'Obtain transactions for multiple, filtered accounts'
security:
- OAuth2:
- accounts
operationId: listTransactionsBulk
x-scopes:
- bank_transactions
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/ParamAccountOpenStatus'
- $ref: '#/components/parameters/ParamAccountIsOwned'
- $ref: '#/components/parameters/ParamProductCategory'
- $ref: '#/components/parameters/ParamStartTime'
- $ref: '#/components/parameters/ParamEndTime'
- $ref: '#/components/parameters/ParamTransactionMinAmount'
- $ref: '#/components/parameters/ParamTransactionMaxAmount'
- $ref: '#/components/parameters/ParamTransactionText'
- $ref: '#/components/parameters/ParamPage'
- $ref: '#/components/parameters/ParamPageSize'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingTransactions'
x-version: '1'
post:
summary: Get Transactions For Specific Accounts
description: Obtain transactions for a specified list of transactions.
security:
- OAuth2:
- accounts
operationId: listTransactionsSpecificAccounts
x-scopes:
- bank_transactions
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/ParamStartTime'
- $ref: '#/components/parameters/ParamEndTime'
- $ref: '#/components/parameters/ParamTransactionMinAmount'
- $ref: '#/components/parameters/ParamTransactionMaxAmount'
- $ref: '#/components/parameters/ParamTransactionText'
- $ref: '#/components/parameters/ParamPage'
- $ref: '#/components/parameters/ParamPageSize'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingTransactions'
'422':
description: >-
The request was well formed but was unable to be processed due to
business logic specific to the request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorList'
x-version: '1'
requestBody:
$ref: '#/components/requestBodies/RequestAccountIds'
'/banking/accounts/{accountId}/direct-debits':
get:
summary: Get Direct Debits For Account
description: Obtain direct debit authorisations for a specific account
security:
- OAuth2:
- direct-debits
operationId: listDirectDebits
x-scopes:
- bank_detailed_accounts
tags:
- Direct Debits
parameters:
- name: accountId
in: path
description: >-
ID of the account to get direct debit authorisations for. Must have
previously been returned by one of the account list end points.
required: true
schema:
type: string
format: ASCIIString
- $ref: '#/components/parameters/ParamPage'
- $ref: '#/components/parameters/ParamPageSize'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingDirectDebits'
x-version: '1'
/banking/accounts/direct-debits:
get:
summary: Get Bulk Direct Debits
description: 'Obtain direct debit authorisations for multiple, filtered accounts'
security:
- OAuth2:
- direct-debits
operationId: listDirectDebitsBulk
x-scopes:
- bank_detailed_accounts
tags:
- Direct Debits
parameters:
- $ref: '#/components/parameters/ParamAccountIsOwned'
- $ref: '#/components/parameters/ParamProductCategory'
- $ref: '#/components/parameters/ParamPage'
- $ref: '#/components/parameters/ParamPageSize'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingDirectDebits'
x-version: '1'
post:
summary: Get Direct Debits For Specific Accounts
description: Obtain direct debit authorisations for a specified list of accounts
security:
- OAuth2:
- direct-debits
operationId: listDirectDebitsSpecificAccounts
x-scopes:
- bank_detailed_accounts
tags:
- Direct Debits
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingDirectDebits'
'422':
description: >-
The request was well formed but was unable to be processed due to
business logic specific to the request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorList'
x-version: '1'
requestBody:
$ref: '#/components/requestBodies/RequestAccountIds'
/banking/payees:
get:
summary: Get Payees
description: Obtain a list of pre-registered payees
security:
- OAuth2:
- payees
operationId: listPayees
x-scopes:
- bank_basic_accounts
tags:
- Payees
parameters:
- name: type
in: query
description: >-
Filter on the payee type field. In addition to normal type field
values, ALL can be specified to retrieve all payees. If absent the
assumed value is ALL
required: false
schema:
type: string
enum:
- DOMESTIC
- INTERNATIONAL
- BILLER
default: ALL
- $ref: '#/components/parameters/ParamPage'
- $ref: '#/components/parameters/ParamPageSize'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingPayees'
x-version: '1'
'/banking/payees/{payeeId}':
get:
summary: Get Payee Detail
description: Obtain detailed information on a single payee
security:
- OAuth2:
- payees
operationId: getPayeeDetail
x-scopes:
- bank_payees
tags:
- Payees
parameters:
- name: payeeId
in: path
description: The ID used to locate the details of a particular payee
required: true
schema:
type: string
format: ASCIIString
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingPayeeDetails'
x-version: '1'
/banking/products:
get:
summary: Get Products
description: >-
Obtain a list of products that are currently openly offered to the
market
security:
- OAuth2:
- products
operationId: listProducts
x-scopes: []
tags:
- Products
parameters:
- name: effective
in: query
description: >-
Allows for the filtering of products based on whether the current
time is within the period of time defined as effective by the
effectiveFrom and effectiveTo fields. If absent defaults to
'CURRENT'
required: false
schema:
type: string
enum:
- CURRENT
- FUTURE
- ALL
default: CURRENT
- name: updated-since
in: query
description: >-
Only include products that have been updated after the specified
date and time. If absent defaults to include all products
required: false
schema:
type: string
format: DateTimeString
- name: brand
in: query
description: Filter results based on a specific brand
required: false
schema:
type: string
- $ref: '#/components/parameters/ParamProductCategory'
- $ref: '#/components/parameters/ParamPage'
- $ref: '#/components/parameters/ParamPageSize'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingProducts'
x-version: '1'
'/banking/products/{productId}':
get:
summary: Get Product Detail
description: >-
Obtain detailed information on a single product offered openly to the
market
security:
- OAuth2:
- products
operationId: getProductDetail
x-scopes: []
tags:
- Products
parameters:
- name: productId
in: path
description: ID of the specific product requested
required: true
schema:
type: string
format: ASCIIString
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingProduct'
x-version: '1'
/common/customer:
get:
summary: Get Customer
description: >-
Obtain basic information on the customer that has authorised the current
session
security:
- OAuth2:
- customer
operationId: getCustomer
x-scopes:
- common_basic_customer
tags:
- Customer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseCommonCustomer'
x-version: '1'
/common/customer/detail:
get:
summary: Get Customer Detail
description: >-
Obtain detailed information on the authorised customer within the
current session.
security:
- OAuth2:
- customer
operationId: getCustomerDetail
x-scopes:
- common_detailed_customer
tags:
- Customer
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseCommonCustomerDetailed'
x-version: '1'
servers:
- url: 'https://data.provider.com.au/cds-au/v1'
components:
parameters:
ParamAccountOpenStatus:
name: open-status
in: query
description: >-
Used to filter results according to open/closed status. Values can be
OPEN, CLOSED or ALL. If absent then ALL is assumed
required: false
schema:
type: string
enum:
- OPEN
- CLOSED
- ALL
default: ALL
ParamProductCategory:
name: product-category
in: query
description: >-
Used to filter results on the productCategory field applicable to
accounts. Any one of the valid values for this field can be supplied. If
absent then all accounts returned.
required: false
schema:
type: string
enum:
- PERS_AT_CALL_DEPOSITS
- BUS_AT_CALL_DEPOSITS
- TERM_DEPOSITS
- RESIDENTIAL_MORTGAGES
- PERS_CRED_AND_CHRG_CARDS
- BUS_CRED_AND_CHRG_CARDS
- PERS_LOANS
- PERS_LEASING
- BUS_LEASING
- TRADE_FINANCE
- PERS_OVERDRAFT
- BUS_OVERDRAFT
- BUS_LOANS
- FOREIGN_CURR_AT_CALL_DEPOSITS
- FOREIGN_CURR_TERM_DEPOSITS
- FOREIGN_CURR_LOAN
- FOREIGN_CURRRENCT_OVERDRAFT
- TRAVEL_CARD
ParamAccountIsOwned:
name: is-owned
in: query
description: >-
Filters accounts based on whether they are owned by the authorised
customer
required: false
schema:
type: string
enum:
- OWNED
- NOT_OWNED
- ALL
default: ALL
ParamPage:
name: page
in: query
description: Page of results to request (standard pagination)
required: false
schema:
type: integer
default: '1'
ParamPageSize:
name: page-size
in: query
description: Page size to request. Default is 25 (standard pagination)
required: false
schema:
type: integer
default: '25'
ParamStartTime:
name: start-time
in: query
description: >-
Constrain the transaction history request to transactions with effective
time at or after this date/time. If absent defaults to current time.
Format is aligned to DateTimeString common type
required: false
schema:
type: string
format: DateTimeString
ParamEndTime:
name: end-time
in: query
description: >-
Constrain the transaction history request to transactions with effective
time at or before this date/time. If absent defaults to start-time plus
100 days. Format is aligned to DateTimeString common type
required: false
schema:
type: string
format: DateTimeString
ParamTransactionMinAmount:
name: min-amount
in: query
description: >-
Filter transactions to only transactions with amounts higher or equal to
than this amount
required: false
schema:
type: string
format: AmountString
ParamTransactionMaxAmount:
name: max-amount
in: query
description: >-
Filter transactions to only transactions with amounts less than or equal
to than this amount
required: false
schema:
type: string
format: AmountString
ParamTransactionText:
name: text
in: query
description: >-
Filter transactions to only transactions where this string value is
found as a substring of either the reference or description fields.
Format is arbitrary ASCII string
required: false
schema:
type: string
requestBodies:
RequestAccountIds:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestAccountIds'
description: The list of account IDs to obtain information for
required: true
schemas:
RequestAccountIds:
type: object
required:
- data
- meta
properties:
data:
type: object
required:
- accountIds
properties:
accountIds:
type: array
items:
type: string
description: A valid account ID previously obtained from another end point
format: ASCIIString
meta:
$ref: '#/components/schemas/Meta'
ResponseBankingProducts:
type: object
required:
- data
- links
- meta
properties:
data:
type: object
required:
- products
properties:
products:
type: array
items:
$ref: '#/components/schemas/Product'
links:
$ref: '#/components/schemas/LinksPaginated'
meta:
$ref: '#/components/schemas/MetaPaginated'
Product:
type: object
required:
- productId
- lastUpdated
- productCategory
- name
- description
- brand
- isTailored
properties:
productId:
type: string
description: >-
A provider specific unique identifier for this product. This
identifier must be unique to a product but does not otherwise need
to adhere to ID permanence guidelines.
format: ASCIIString
effectiveFrom:
type: string
description: >-
The date and time from which this product is effective (ie. is
available for origination). Used to enable the articulation of
products to the regime before they are available for customers to
originate
format: DateTimeString
effectiveTo:
type: string
description: >-
The date and time at which this product will be retired and will no
longer be offered. Used to enable the managed deprecation of
products
format: DateTimeString
lastUpdated:
type: string
description: >-
The last date and time that the information for this product was
changed (or the creation date for the product if it has never been
altered)
format: DateTimeString
productCategory:
$ref: '#/components/schemas/EnumProductCategory'
name:
type: string
description: The display name of the product
description:
type: string
description: A description of the product
brand:
type: string
description: >-
A label of the brand for the product. Able to be used for filtering.
For data providers with single brands this value is still required
brandName:
type: string
description: An optional display name of the brand
applicationUri:
type: string
description: >-
A link to the an application web page where this product can be
applied for.
format: URIString
isTailored:
type: boolean
description: >-
Indicates whether the product is specifically tailored to a
circumstance. In this case fees and prices are significantly
negotiated depending on context. While all products are open to a
degree of tailoring this flag indicates that tailoring is expected
and thus that the provision of specific fees and rates is not
applicable
additionalInformation:
type: object
properties:
overviewUri:
type: string
description: General overview of the product
format: URIString
termsUri:
type: string
description: Terms and conditions for the product
format: URIString
eligibilityUri:
type: string
description: Eligibility rules and criteria for the product
format: URIString
feesAndPricingUri:
type: string
description: >-
Description of fees, pricing, discounts, exemptions and bonuses
for the product
format: URIString
bundleUri:
type: string
description: Description of a bundle that this product can be part of
format: URIString
ResponseBankingProduct:
type: object
required:
- data
- links
- meta
properties:
data:
$ref: '#/components/schemas/ProductDetail'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
ProductDetail:
allOf:
- $ref: '#/components/schemas/Product'
- type: object
properties:
bundles:
type: array
items:
$ref: '#/components/schemas/ProductBundles'
features:
type: array
items:
$ref: '#/components/schemas/ProductFeatures'
constraints:
type: array
items:
$ref: '#/components/schemas/ProductConstraints'
eligibility:
type: array
items:
$ref: '#/components/schemas/ProductEligibility'
fees:
type: array
items:
$ref: '#/components/schemas/ProductFees'
depositRates:
type: array
items:
$ref: '#/components/schemas/ProductDepositRates'
lendingRates:
type: array
items:
$ref: '#/components/schemas/ProductLendingRates'
ProductBundles:
type: object
required:
- name
- description
- productIds
properties:
name:
type: string
description: Name of the bundle
description:
type: string
description: Description of the bundle
additionalInfoUri:
type: string
description: >-
Link to a web page with more information on the bundle criteria and
benefits
format: URIString
productIds:
type: array
description: Array of product IDs for products included in the bundle
items:
type: string
format: ASCIIString
ProductFeatures:
type: object
required:
- featureType
x-conditional:
- additionalValue
properties:
featureType:
type: string
description: The type of feature described
enum:
- CARD_ACCESS
- ADDITIONAL_CARDS
- UNLIMITED_TXNS
- FREE_TXNS
- FREE_TXNS_ALLOWANCE
- LOYALTY_PROGRAM
- OFFSET
- OVERDRAFT
- REDRAW
- INSURANCE
- BALANCE_TRANSFERS
- INTEREST_FREE
- INTEREST_FREE_TRANSFERS
- DIGITAL_WALLET
- DIGITAL_BANKING
- NPP_PAYID
- NPP_ENABLED
- DONATE_INTEREST
- BILL_PAYMENT
additionalValue:
type: string
description: >-
Generic field containing additional information relevant to the
featureType specified. Whether mandatory or not is dependent on the
value of featureType
ProductConstraints:
type: object
required:
- constraintType
x-conditional:
- additionalValue
properties:
constraintType:
type: string
description: >-
The type of constraint described. See the next section for an
overview of valid values and their meaning
enum:
- MIN_BALANCE
- OPENING_BALANCE
- MAX_LIMIT
- MIN_LIMIT
additionalValue:
type: string
description: >-
Generic field containing additional information relevant to the
constraintType specified. Whether mandatory or not is dependent on
the value of constraintType
ProductEligibility:
type: object
required:
- eligibilityType
x-conditional:
- additionalValue
- additionalInfo
properties:
eligibilityType:
type: string
description: >-
The type of eligibility criteria described. See the next section
for an overview of valid values and their meaning
enum:
- BUSINESS
- PENSION_RECIPIENT
- MIN_AGE
- MAX_AGE
- MIN_INCOME
- MIN_TURNOVER
- STAFF
- STUDENT
- EMPLOYMENT_STATUS
- RESIDENCY_STATUS
- OTHER
additionalValue:
type: string
description: >-
Generic field containing additional information relevant to the
eligibilityType specified. Whether mandatory or not is dependent on
the value of eligibilityType
additionalInfo:
type: string
description: >-
Display text providing more information on the eligibility criteria.
Mandatory if the eligibilityType field is set to OTHER
additionalInfoUri:
type: string
description: >-
Link to a web page with more information on this eligibility
criteria
format: URIString
ProductFees:
type: object
required:
- name
- feeType
x-conditional:
- additionalValue
- amount
- balanceRate
- transactionRate
properties:
name: