-
Notifications
You must be signed in to change notification settings - Fork 147
/
CurrentAccount.yaml
3507 lines (3507 loc) · 194 KB
/
CurrentAccount.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.1
info:
title: Current Account
description: 'This service domain orchestrates a consumer checking/demand deposit account. The typical range of services and fees covers payments and deposits, standing orders, sweeps, liens, check and debit card access.'
contact:
name: BIAN
url: https://bian.org
version: 12.0.0
servers:
- url: https://virtserver.swaggerhub.com/B154/BIAN/CurrentAccount/12.0.0
paths:
/CurrentAccount/Initiate:
post:
tags:
- CR - CurrentAccountFacility
summary: InCR Initiate A new Current Account
description: InCR Initiate A new Current Account
operationId: Initiate
requestBody:
$ref: '#/components/requestBodies/CurrentAccountFacility'
responses:
'200':
$ref: '#/components/responses/CurrentAccountFacility'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/Update':
put:
tags:
- CR - CurrentAccountFacility
summary: UpCR Update details of a current account
description: UpCR Update details of a current account
operationId: Update
parameters:
- $ref: '#/components/parameters/currentaccountid'
requestBody:
$ref: '#/components/requestBodies/CurrentAccountFacility'
responses:
'200':
$ref: '#/components/responses/CurrentAccountFacility'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/Control':
put:
tags:
- CR - CurrentAccountFacility
summary: CoCR Control the processing of an current account
description: CoCR Control the processing of an current account
operationId: Control
parameters:
- $ref: '#/components/parameters/currentaccountid'
requestBody:
$ref: '#/components/requestBodies/CurrentAccountFacility'
responses:
'200':
$ref: '#/components/responses/CurrentAccountFacility'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/Retrieve':
get:
tags:
- CR - CurrentAccountFacility
summary: ReCR Retrieve information about a current account - either standard canned reports or selected instance attribute values
description: ReCR Retrieve information about a current account - either standard canned reports or selected instance attribute values
operationId: Retrieve
parameters:
- $ref: '#/components/parameters/currentaccountid'
responses:
'200':
$ref: '#/components/responses/CurrentAccountFacility'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/Interest/{interestid}/Retrieve':
get:
tags:
- BQ - Interest
summary: ReBQ Retrieve details of an interest transaction applied internally to the account
description: ReBQ Retrieve details of an interest transaction applied internally to the account
operationId: RetrieveInterest
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/interestid'
responses:
'200':
$ref: '#/components/responses/Interest'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/ServiceFee/Initiate':
post:
tags:
- BQ - ServiceFee
summary: InBQ Initiate service fees against an account
description: InBQ Initiate service fees against an account
operationId: InitiateServiceFee
parameters:
- $ref: '#/components/parameters/currentaccountid'
requestBody:
$ref: '#/components/requestBodies/ServiceFee'
responses:
'200':
$ref: '#/components/responses/ServiceFee'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/ServiceFee/{servicefeeid}/Execute':
put:
tags:
- BQ - ServiceFee
summary: ExBQ Apply a service fee to the account
description: ExBQ Apply a service fee to the account
operationId: ExecuteServiceFee
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/servicefeeid'
requestBody:
$ref: '#/components/requestBodies/ServiceFee'
responses:
'200':
$ref: '#/components/responses/ServiceFee'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/ServiceFee/{servicefeeid}/Retrieve':
get:
tags:
- BQ - ServiceFee
summary: ReBQ Retrieve information about a service fee applied to the account
description: ReBQ Retrieve information about a service fee applied to the account
operationId: RetrieveServiceFee
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/servicefeeid'
responses:
'200':
$ref: '#/components/responses/ServiceFee'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/AccountLien/Initiate':
post:
tags:
- BQ - AccountLien
summary: InBQ Set up an account lien
description: InBQ Set up an account lien
operationId: InitiateAccountLien
parameters:
- $ref: '#/components/parameters/currentaccountid'
requestBody:
$ref: '#/components/requestBodies/AccountLien'
responses:
'200':
$ref: '#/components/responses/AccountLien'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/AccountLien/{accountlienid}/Update':
put:
tags:
- BQ - AccountLien
summary: UpBQ Update details of an existing account lien
description: UpBQ Update details of an existing account lien
operationId: UpdateAccountLien
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/accountlienid'
requestBody:
$ref: '#/components/requestBodies/AccountLien'
responses:
'200':
$ref: '#/components/responses/AccountLien'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/AccountLien/{accountlienid}/Exchange':
put:
tags:
- BQ - AccountLien
summary: EcBQ Exchange
description: EcBQ Exchange
operationId: ExchangeAccountLien
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/accountlienid'
requestBody:
$ref: '#/components/requestBodies/AccountLien'
responses:
'200':
$ref: '#/components/responses/AccountLien'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/AccountLien/{accountlienid}/Retrieve':
get:
tags:
- BQ - AccountLien
summary: ReBQ Retrieve details about an account lien
description: ReBQ Retrieve details about an account lien
operationId: RetrieveAccountLien
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/accountlienid'
responses:
'200':
$ref: '#/components/responses/AccountLien'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/AccountSweep/Initiate':
post:
tags:
- BQ - AccountSweep
summary: InBQ Set up an account sweep
description: InBQ Set up an account sweep
operationId: InitiateAccountSweep
parameters:
- $ref: '#/components/parameters/currentaccountid'
requestBody:
$ref: '#/components/requestBodies/AccountSweep'
responses:
'200':
$ref: '#/components/responses/AccountSweep'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/AccountSweep/{accountsweepid}/Update':
put:
tags:
- BQ - AccountSweep
summary: UpBQ Update details of an existing account sweep
description: UpBQ Update details of an existing account sweep
operationId: UpdateAccountSweep
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/accountsweepid'
requestBody:
$ref: '#/components/requestBodies/AccountSweep'
responses:
'200':
$ref: '#/components/responses/AccountSweep'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/AccountSweep/{accountsweepid}/Execute':
put:
tags:
- BQ - AccountSweep
summary: ExBQ Trigger an account sweep transaction
description: ExBQ Trigger an account sweep transaction
operationId: ExecuteAccountSweep
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/accountsweepid'
requestBody:
$ref: '#/components/requestBodies/AccountSweep'
responses:
'200':
$ref: '#/components/responses/AccountSweep'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/AccountSweep/{accountsweepid}/Retrieve':
get:
tags:
- BQ - AccountSweep
summary: ReBQ Retrieve details about a sweep facility or specific sweep transaction
description: ReBQ Retrieve details about a sweep facility or specific sweep transaction
operationId: RetrieveAccountSweep
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/accountsweepid'
responses:
'200':
$ref: '#/components/responses/AccountSweep'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/DepositsandWithdrawals/Initiate':
post:
tags:
- BQ - DepositsandWithdrawals
summary: InBQ Initialize deposit or withdrawal transaction
description: InBQ Initialize deposit or withdrawal transaction
operationId: InitiateDepositsandWithdrawals
parameters:
- $ref: '#/components/parameters/currentaccountid'
requestBody:
$ref: '#/components/requestBodies/DepositsandWithdrawals'
responses:
'200':
$ref: '#/components/responses/DepositsandWithdrawals'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/DepositsandWithdrawals/{depositsandwithdrawalsid}/Update':
put:
tags:
- BQ - DepositsandWithdrawals
summary: UpBQ Update/correct a deposit or withdrawal transaction
description: UpBQ Update/correct a deposit or withdrawal transaction
operationId: UpdateDepositsandWithdrawals
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/depositsandwithdrawalsid'
requestBody:
$ref: '#/components/requestBodies/DepositsandWithdrawals'
responses:
'200':
$ref: '#/components/responses/DepositsandWithdrawals'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/DepositsandWithdrawals/{depositsandwithdrawalsid}/Execute':
put:
tags:
- BQ - DepositsandWithdrawals
summary: ExBQ Execute a deposit or withdrawal transaction
description: ExBQ Execute a deposit or withdrawal transaction
operationId: ExecuteDepositsandWithdrawals
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/depositsandwithdrawalsid'
requestBody:
$ref: '#/components/requestBodies/DepositsandWithdrawals'
responses:
'200':
$ref: '#/components/responses/DepositsandWithdrawals'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/DepositsandWithdrawals/{depositsandwithdrawalsid}/Retrieve':
get:
tags:
- BQ - DepositsandWithdrawals
summary: ReBQ Retrieve details about a deposit or withdrawal transaction
description: ReBQ Retrieve details about a deposit or withdrawal transaction
operationId: RetrieveDepositsandWithdrawals
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/depositsandwithdrawalsid'
responses:
'200':
$ref: '#/components/responses/DepositsandWithdrawals'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/Payment/Initiate':
post:
tags:
- BQ - Payment
summary: InBQ Initialize a payment transaction
description: InBQ Initialize a payment transaction
operationId: InitiatePayment
parameters:
- $ref: '#/components/parameters/currentaccountid'
requestBody:
$ref: '#/components/requestBodies/Payment'
responses:
'200':
$ref: '#/components/responses/Payment'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/Payment/{paymentid}/Update':
put:
tags:
- BQ - Payment
summary: UpBQ Update a payment transaction configuration or specific transaction
description: UpBQ Update a payment transaction configuration or specific transaction
operationId: UpdatePayment
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/paymentid'
requestBody:
$ref: '#/components/requestBodies/Payment'
responses:
'200':
$ref: '#/components/responses/Payment'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/Payment/{paymentid}/Exchange':
put:
tags:
- BQ - Payment
summary: EcBQ Verify/approve a scheduled repeating payment
description: EcBQ Verify/approve a scheduled repeating payment
operationId: ExchangePayment
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/paymentid'
requestBody:
$ref: '#/components/requestBodies/Payment'
responses:
'200':
$ref: '#/components/responses/Payment'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/Payment/{paymentid}/Execute':
put:
tags:
- BQ - Payment
summary: ExBQ Trigger a payment for a repeating payment set up
description: ExBQ Trigger a payment for a repeating payment set up
operationId: ExecutePayment
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/paymentid'
requestBody:
$ref: '#/components/requestBodies/Payment'
responses:
'200':
$ref: '#/components/responses/Payment'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/Payment/{paymentid}/Retrieve':
get:
tags:
- BQ - Payment
summary: ReBQ Retrieve details about a payment transaction or arrangement
description: ReBQ Retrieve details about a payment transaction or arrangement
operationId: RetrievePayment
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/paymentid'
responses:
'200':
$ref: '#/components/responses/Payment'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/IssuedDevice/Initiate':
post:
tags:
- BQ - IssuedDevice
summary: Initiate Provision of Issued Device
description: Initiate Provision of Issued Device
operationId: InitiateIssuedDevice
parameters:
- $ref: '#/components/parameters/currentaccountid'
requestBody:
$ref: '#/components/requestBodies/IssuedDevice'
responses:
'200':
$ref: '#/components/responses/IssuedDevice'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/IssuedDevice/{issueddeviceid}/Update':
put:
tags:
- BQ - IssuedDevice
summary: Update Details of Issued Device Allocated to This Account
description: Update Details of Issued Device Allocated to This Account
operationId: UpdateIssuedDevice
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/issueddeviceid'
requestBody:
$ref: '#/components/requestBodies/IssuedDevice'
responses:
'200':
$ref: '#/components/responses/IssuedDevice'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/IssuedDevice/{issueddeviceid}/Retrieve':
get:
tags:
- BQ - IssuedDevice
summary: Retrieve Details about Issued Device
description: Retrieve Details about Issued Device
operationId: RetrieveIssuedDevice
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/issueddeviceid'
responses:
'200':
$ref: '#/components/responses/IssuedDevice'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/Interest/{interestid}/Execute':
put:
tags:
- BQ - Interest
summary: ExBQ Execute Apply Interest
description: ExBQ Execute Apply Interest
operationId: ExecuteInterest
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/interestid'
requestBody:
$ref: '#/components/requestBodies/Interest'
responses:
'200':
$ref: '#/components/responses/Interest'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/ServiceFee/{servicefeeid}/Update':
put:
tags:
- BQ - ServiceFee
summary: Update details about an applied service fee
description: Update details about an applied service fee
operationId: UpdateServiceFee
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/servicefeeid'
requestBody:
$ref: '#/components/requestBodies/ServiceFee'
responses:
'200':
$ref: '#/components/responses/ServiceFee'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'/CurrentAccount/{currentaccountid}/BookingAuthorization/{bookingauthorizationid}/Execute':
put:
tags:
- BQ - BookingAuthorization
summary: Execute Authorization of Booking
description: Execute Authorization of Booking
operationId: ExecuteBookingAuthorization
parameters:
- $ref: '#/components/parameters/currentaccountid'
- $ref: '#/components/parameters/bookingauthorizationid'
requestBody:
$ref: '#/components/requestBodies/BookingAuthorization'
responses:
'200':
$ref: '#/components/responses/BookingAuthorization'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
components:
schemas:
HTTPError:
type: object
properties:
status_code:
type: string
format: string
status:
type: string
format: string
message:
type: string
format: string
description: Status Attributes
accountidentificationtypevalues:
enum:
- BBAN
- IBAN
- UPIC
- AccountNumber
- PAN
- Paym
- Wallet
type: string
description: ">\r\n* `BBAN` - Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. (ISO20022)\n\n.\r\n* `IBAN` - International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions. (ISO20022)\n\nAn identifier used internationally by financial institutions to uniquely identify the account of a customer at a financial institution, as described in the latest edition of the international standard ISO 13616. \"Banking and related financial services - International Bank Account Number (IBAN)\". (OBExternalAccountIdentification4Code)\r\n* `UPIC` - Universal Payment Identification Code (UPIC) - identifier used by the New York Clearing House to mask confidential data, such as bank accounts and bank routing numbers. UPIC numbers remain with business customers, regardless of banking relationship changes. (ISO20022)\r\n* `AccountNumber` - String of characters (mainly numbers) used to identify an account.(ISO20022)\n\nSort Code and Account Number - identifier scheme used in the UK by financial institutions to identify the account of a customer. The identifier is the concatenation of the 6 digit UK sort code and 8 digit account number. (OBExternalAccountIdentification4Code)\nThe regular expression for this identifier is: ^[0-9]{6}[0-9]{8}$\r\n* `PAN` - Primary Account Number - identifier scheme used to identify a card account. (OBExternalAccountIdentification4Code)\r\n* `Paym` - Paym Scheme to make payments via mobile (OBExternalAccountIdentification4Code)\r\n* `Wallet` - A primary and unique account identifier used to identify a wallet.\nAn ASPSP must document on their developer portal, the payment methods that supports this account identifier.(OBExternalAccountIdentification4Code)\r\n"
value:
type: object
properties:
Value:
type: string
description: "Data or set of data \n\n- A value is the concept of worth in general that is assigned or is determined by measurement, assessment or calculation. (UN/CEFACT)"
format: datatype
description: "The current calculated position ||\r\n|"
name:
type: object
properties:
Name:
type: string
description: 'A name is a word or phrase that constitutes the distinctive designation of a person, place, thing or concept. (UN/CEFAT)'
format: datatype
description: The name of the CA product used for marketing purposes from a customer perspective. I.e. what the customer would recognise. Name|Name (https://www.iso20022.org/standardsrepository/type/Name)|Standard|ISO20022 ()
partytypevalues:
enum:
- Person
- Organisation
type: string
description: ">\r\n* `Person` - Human entity, as distinguished from a corporate entity (which is sometimes referred to as an 'artificial person'). ISO20022\r\n* `Organisation` - Organised structure that is set up for a particular purpose. For example, a business, government body, department, charity, or financial institution. ISO20022\r\n"
datetime:
type: object
properties:
DateTimeContent:
type: string
description: ''
format: string
TimeZoneCode:
type: string
description: ''
format: string
DaylightSavingIndicator:
type: string
description: ''
format: string
description: Key dates associated with the account ISODateTime|ISODateTime (https://www.iso20022.org/standardsrepository/type/ISODateTime)|Standard|ISO20022 BM ()
partyidentificationtypevalues:
enum:
- Taxidentificationnumber
- Nationalregistrationnumber
- Registrationauthorityidentification
- LEI(LegalEntityIdentifier)
- Alienregistrationnumber
- Passportnumber
- Taxexemptidentificationnumber
- Corporateidentification
- Driverlicensenumber
- Foreigninvestmentidentitynumber
- Socialsecuritynumber
- Identitycardnumber
- Concat
- Nationalregistrationidentificationnumber
type: string
description: ">\r\n* `Taxidentificationnumber` - Number assigned by a tax authority to an entity.\r\n* `Nationalregistrationnumber` - Number assigned by a national registration authority to an entity. In Singapore this is known as the NRIC. (ISO20022)\r\n* `Registrationauthorityidentification` - An identifier for the Legal Entity in a business registry in the jurisdiction of legal registration, or in the appropriate registration authority. (ISO20022)\r\n* `LEI(LegalEntityIdentifier)` - \r\n* `Alienregistrationnumber` - Number assigned by a government agency to identify foreign nationals.\r\n* `Passportnumber` - Number assigned by a passport authority.\r\n* `Taxexemptidentificationnumber` - Number assigned to a tax exempt entity.\r\n* `Corporateidentification` - Number assigned to a corporate entity.\r\n* `Driverlicensenumber` - Number assigned to a driver's license.\r\n* `Foreigninvestmentidentitynumber` - Number assigned to a foreign investor (other than the alien number).\r\n* `Socialsecuritynumber` - Number assigned by a social security agency.\r\n* `Identitycardnumber` - Number assigned by a national authority to an identity card.\r\n* `Concat` - Number assigned by an issuer to identify a customer via the concatenation of the birthdate and characters of the first name and surname.\r\n* `Nationalregistrationidentificationnumber` - National registration identification number. In Singapore this is known as the NRIC.\r\n"
partyidentification:
type: object
properties:
PartyIdentificationType:
$ref: '#/components/schemas/partyidentificationtypevalues'
PartyIdentification:
$ref: '#/components/schemas/identifier'
description: ''
partylegalstructuretypevalues:
enum:
- Individual
- CommunityInterestCompany
- CharitableIncorporatedOrganisation
- Co-Operative
- Charity
- GeneralPartnership
- LimitedLiabilityPartnership
- ScottishLimitedPartnership
- LimitedPartnership
- PrivateLimitedCompany
- PublicLimitedCompany
- Sole(SoleTrader)
type: string
description: ">\r\n* `Individual` - \r\n* `CommunityInterestCompany` - \r\n* `CharitableIncorporatedOrganisation` - \r\n* `Co-Operative` - \r\n* `Charity` - \r\n* `GeneralPartnership` - \r\n* `LimitedLiabilityPartnership` - \r\n* `ScottishLimitedPartnership` - \r\n* `LimitedPartnership` - \r\n* `PrivateLimitedCompany` - \r\n* `PublicLimitedCompany` - \r\n* `Sole(SoleTrader)` - \r\n"
party:
type: object
properties:
PartyName:
$ref: '#/components/schemas/name'
PartyType:
$ref: '#/components/schemas/partytypevalues'
PartyDateTime:
$ref: '#/components/schemas/datetime'
PartyIdentification:
$ref: '#/components/schemas/partyidentification'
PartyLegalStructureType:
$ref: '#/components/schemas/partylegalstructuretypevalues'
description: Reference to the associated party Party|Party (https://www.iso20022.org/standardsrepository/type/Party)|Standard|ISO20022BM ()
text:
type: object
properties:
Text:
type: string
description: Text is a character string such as a finite set of characters generally in the form of words of a language. (UN/CEFACT)
format: datatype
description: ''
datetimeperiod:
type: object
properties:
FromDateTime:
$ref: '#/components/schemas/datetime'
ToDateTime:
$ref: '#/components/schemas/datetime'
description: ''
partyinvolvementtypevalues:
enum:
- Agreementinvolvement
- Partyinvolvement
- Arrangementinvolvement
- Designspecificationinvolvement
- Relationshipinvolvement
- Locationinvolvement
- Bankguaranteeinvolvement
type: string
description: ">\r\n* `Agreementinvolvement` - \r\n* `Partyinvolvement` - \r\n* `Arrangementinvolvement` - \r\n* `Designspecificationinvolvement` - \r\n* `Relationshipinvolvement` - \r\n* `Locationinvolvement` - \r\n* `Bankguaranteeinvolvement` - \r\n"
partyrole:
type: object
properties:
PartyRoleType:
$ref: '#/components/schemas/text'
PartyRoleName:
$ref: '#/components/schemas/name'
PartyRoleValidityPeriod:
$ref: '#/components/schemas/datetimeperiod'
PartyInvolvementType:
$ref: '#/components/schemas/partyinvolvementtypevalues'
description: ''
involvedparty:
type: object
properties:
PartyReference:
$ref: '#/components/schemas/party'
PartyInvolvement:
$ref: '#/components/schemas/partyrole'
description: "Reference to the account primary party/owner ||\r\n|"
identifier:
type: object
properties:
IdentifierValue:
$ref: '#/components/schemas/value'
IdentifierIssuingAuthority:
$ref: '#/components/schemas/involvedparty'
IdentifierStartDate:
$ref: '#/components/schemas/datetime'
IdentifierEndDate:
$ref: '#/components/schemas/datetime'
description: Identifier within the parent organisation for the product. Must be unique in the organisation. GenericIdentification|GenericIdentification (https://www.iso20022.org/standardsrepository/type/GenericIdentification)|Standard|ISO20022 BM ()
accountidentification: