-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.ts
9213 lines (9208 loc) · 394 KB
/
index.ts
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
/* eslint-disable @typescript-eslint/no-explicit-any */
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
'/account-auth-requests': {
/**
* Update Account Pre-authorisation
* @description Used to continue the authorisation process and for any `Institution` that contains the `INITIATE_PRE_AUTHORISATION` feature and direct user to the login screen of their financial institution in order to give consent to access account data. <br><br>See [Redirect Account Flows](https://docs.yapily.com/pages/key-concepts/account-data/account-authorisation/redirect-account-flows/) for more information about this flow. <br><br>Features: <ul><li>`INITIATE_ACCOUNT_REQUEST`</li><li>`INITIATE_PRE_AUTHORISATION`</li></ul>
*/
put: operations['updatePreAuthoriseAccountConsent']
/**
* Create Account Authorisation
* @description Used to initiate the authorisation process and direct users to the login screen of their financial institution in order to give consent to access account data.<br><br>See [Redirect Account Flows](https://docs.yapily.com/pages/key-concepts/account-data/account-authorisation/redirect-account-flows/) for more information about this flow.<br><br>Feature: `INITIATE_ACCOUNT_REQUEST`
*/
post: operations['initiateAccountRequest']
/**
* Re-authorise Account Consent
* @description Used to prompt the account holder for continued access to their financial data. This endpoint should be used when a `Consent` that was previously `AUTHORIZED` can no longer be used to retrieve data.<br><br>See [Re-Authorisation](https://docs.yapily.com/pages/key-concepts/account-data/account-consents/#re-authorisation) for more information.
*/
patch: operations['reAuthoriseAccount']
}
'/accounts': {
/**
* Get Accounts
* @description Returns all accounts and balances for the end user associated with the presented consent token.<br><br>Feature: `ACCOUNTS`
*/
get: operations['getAccounts']
}
'/accounts/{accountId}': {
/**
* Get Account
* @description Returns the account and balance information for a user's specified account.<br><br>Feature: `ACCOUNT`
*/
get: operations['getAccount']
}
'/accounts/{accountId}/balances': {
/**
* Get Account Balances
* @description Returns the balance for the end user associated with the presented consent token.<br><br>Feature: `ACCOUNT_BALANCES`
*/
get: operations['getAccountBalances']
}
'/accounts/{accountId}/beneficiaries': {
/**
* Get Account Beneficiaries
* @description Returns all the beneficiaries of a user's account.<br><br>Feature: `ACCOUNT_BENEFICIARIES`
*/
get: operations['getBeneficiaries']
}
'/accounts/{accountId}/direct-debits': {
/**
* Get Account Direct Debits
* @description Returns the list of direct debits for an account.<br><br>Feature: `ACCOUNT_DIRECT_DEBITS`
*/
get: operations['getAccountDirectDebits']
}
'/accounts/{accountId}/periodic-payments': {
/**
* Get Account Periodic Payments
* @description Returns the list of periodic payments (standing orders in the UK) for an account.<br><br>Feature: `ACCOUNT_PERIODIC_PAYMENTS`
*/
get: operations['getAccountPeriodicPayments']
}
'/accounts/{accountId}/scheduled-payments': {
/**
* Get Account Scheduled Payments
* @description Returns the list of scheduled payments for an account.<br><br>Feature: `ACCOUNT_SCHEDULED_PAYMENTS`
*/
get: operations['getAccountScheduledPayments']
}
'/accounts/{accountId}/statements': {
/**
* Get Account Statements
* @description Returns the list of statements for an account.<br><br>Feature: `ACCOUNT_STATEMENTS`
*/
get: operations['getStatements']
}
'/accounts/{accountId}/statements/{statementId}': {
/**
* Get Account Statement
* @description Returns a statement for an account.<br><br>Feature: `ACCOUNT_STATEMENT`
*/
get: operations['getStatement']
}
'/accounts/{accountId}/statements/{statementId}/file': {
/**
* Get Account Statement File
* @description Returns a PDF file of a statement for an account.<br><br>Feature: `ACCOUNT_STATEMENT_FILE`
*/
get: operations['getStatementFile']
}
'/accounts/{accountId}/transactions': {
/**
* Get Account Transactions
* @description Returns the account transactions for an account.<br><br>Feature: `ACCOUNT_TRANSACTIONS`
*/
get: operations['getTransactions']
}
'/bulk-payment-auth-requests': {
/**
* Create Bulk Payment Authorisation
* @description Used to initiate the authorisation process and direct users to the login screen of their financial Institution in order to give their consent for a bulk payment. See [Bulk Payments](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/bulk-payments/) for more information. <br><br>See [Redirect Payment Flows](https://docs.yapily.com/pages/key-concepts/payments/payment-authorisation/redirect-payment-flows/) for more information about this flow.<br><br>Feature: `INITIATE_BULK_PAYMENT`
*/
post: operations['createBulkPaymentAuthorisation']
}
'/bulk-payments': {
/**
* Create Bulk Payment
* @description Creates a bulk payment after obtaining the user's authorisation. <br><br>Feature: `CREATE_BULK_PAYMENT`
*/
post: operations['createBulkPayment']
}
'/categories/{country}': {
/**
* Get Categories
* @description Used to retrieve the list of categories returned by the Yapily Categorisation engine for a given locale. <br><br>See [Data Enrichment](https://docs.yapily.com/pages/key-concepts/account-data/data-enrichment/intro-to-data-enrichment/) for more information.
*/
get: operations['getCategories']
}
'/consent-auth-code': {
/**
* Exchange OAuth2 Code
* @description Used to obtain a Yapily Consent object containing the `consentToken` once the user has authenticated and you have an OAuth2 authorisation code `auth-code` and state `auth-state`.
*/
post: operations['createConsentWithCode']
}
'/consent-one-time-token': {
/**
* Exchange One Time Token
* @description Exchange a One-time-token for the consent token
*/
post: operations['getConsentBySingleAccessConsent']
}
'/consents': {
/**
* Get Consents
* @description Used to retrieve all the consents created for each user within an application
*/
get: operations['getConsents']
}
'/consents/{consentId}': {
/**
* Get Consent
* @description Get consent using the consent Id
*/
get: operations['getConsentById']
/**
* Delete Consent
* @description Delete a consent using the consent Id
*/
delete: operations['delete']
}
'/consents/{consentId}/extend': {
/**
* Extend Consent
* @description Used to indicate to Yapily that reconfirmation has occurred for a given Consent, and to update lastUpdatedAt and reconfirmBy for that Consent. Returns the Consent.
*/
post: operations['extendConsent']
}
'/embedded-account-auth-requests': {
/**
* Create Embedded Account Authorisation
* @description Used to initiate the embedded authorisation process for an `Institution` that contains the `INITIATE_EMBEDDED_ACCOUNT_REQUEST` feature in order to obtain the the user's authorisation to access their account information. <br><br>See [Embedded Account Flows](https://docs.yapily.com/pages/key-concepts/account-data/account-authorisation/embedded-account-flows/) for more information about this flow.<br><br>Feature: `INITIATE_EMBEDDED_ACCOUNT_REQUEST`
*/
post: operations['initiateEmbeddedAccountRequest']
}
'/embedded-account-auth-requests/{consentId}': {
/**
* Update Embedded Account Authorisation
* @description Used to pass the SCA Code received from the `Institution` (and the SCA method selected by the user where multiple SCA methods are supported by the `Institution`) in order to complete the embedded authorisation to access the user's financial data. <br><br>See [Embedded Account Flows](https://docs.yapily.com/pages/key-concepts/account-data/account-authorisation/embedded-account-flows/) for more information about this flow.<br><br>Feature: `INITIATE_EMBEDDED_ACCOUNT_REQUEST`
*/
put: operations['updateEmbeddedAccountRequest']
}
'/embedded-bulk-payment-auth-requests': {
/**
* Create Embedded Bulk Payment Authorisation
* @description Used to initiate the embedded authorisation process for an `Institution` that contains the `INITIATE_EMBEDDED_BULK_PAYMENT` feature in order to obtain the the user's authorisation for a bulk payment. See [Bulk Payments](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/bulk-payments/) for more information. <br><br> See [Embedded Payment Flows](https://docs.yapily.com/pages/key-concepts/payments/payment-authorisation/embedded-payment-flows/) for more information about this flow.<br><br>Feature: `INITIATE_EMBEDDED_BULK_PAYMENT`
*/
post: operations['createEmbeddedBulkPaymentAuthorisation']
}
'/embedded-bulk-payment-auth-requests/{consentId}': {
/**
* Update Embedded Bulk Payment Authorisation
* @description Used to pass the SCA Code received from the `Institution` (and the SCA method selected by the user where multiple SCA methods are supported by the `Institution`) in order to complete the embedded authorisation to initiate a bulk payment. See [Bulk Payments](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/bulk-payments/) for more information. <br><br>See [Embedded Payment Flows](https://docs.yapily.com/pages/key-concepts/payments/payment-authorisation/embedded-payment-flows/) for more information about this flow.<br><br>Feature: `INITIATE_EMBEDDED_BULK_PAYMENT`
*/
put: operations['updateEmbeddedBulkPaymentAuthorisation']
}
'/embedded-payment-auth-requests': {
/**
* Create Embedded Payment Authorisation
* @description Used to initiate the embedded authorisation process for an `Institution` that contains the `INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT` feature in order to obtain the the user's authorisation for a payment.<br><br> See [Embedded Payment Flows](https://docs.yapily.com/pages/key-concepts/payments/payment-authorisation/embedded-payment-flows/) for more information about this flow.<br><br>Feature: `INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT`
*/
post: operations['createEmbeddedPaymentAuthorisation']
}
'/embedded-payment-auth-requests/{consentId}': {
/**
* Update Embedded Payment Authorisation
* @description Used to pass the SCA Code received from the `Institution` (and the SCA method selected by the user where multiple SCA methods are supported by the `Institution`) in order to complete the embedded authorisation to initiate a payment. <br><br> See [Embedded Payment Flows](https://docs.yapily.com/guides/payments/payment-authorisation-flows/embedded/) for more information about this flow.<br><br>Feature: `INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT`
*/
put: operations['updateEmbeddedPaymentAuthorisation']
}
'/features': {
/**
* Get Features
* @description Used to retrieve all features available from Yapily. Each `Institution` supports a one, many or all of these features and can be seen in the features field of the `Institution` object.<br><br>Note: Every `Institution` does not necessarily support every feature. To see which features are available for a particular Institution, use either the [Get Institutions](https://docs.yapily.com/api/reference/#operation/getInstitutions) or [Get Institution](https://docs.yapily.com/api/reference/#operation/getInstitution) endpoint and check the features array within the `Institution` payload.
*/
get: operations['getFeatureDetails']
}
'/identity': {
/**
* Get Identity
* @description Returns the identity information for an account.<br><br>Feature: `IDENTITY`
*/
get: operations['getIdentity']
}
'/institutions': {
/**
* Get Institutions
* @description Used to retrieve all `Institutions` within an application
*/
get: operations['getInstitutions']
}
'/institutions/{institutionId}': {
/**
* Get Institution
* @description Used to retrieves details of a specific `Institution` within an application
*/
get: operations['getInstitution']
}
'/me': {
/**
* Get Application Self
* @description Get the information about the institutions configured in your application
*/
get: operations['getApplicationMe']
}
'/payment-auth-requests': {
/**
* Update Payment Pre-authorisation
* @description Used to continue the authorisation process and for any `Institution` that contains the `INITIATE_PRE_AUTHORISATION` feature and direct user to the login screen of their financial institution in order to give consent to initiate a payment. <br><br>See [Redirect Payment Flows](https://docs.yapily.com/pages/key-concepts/payments/payment-authorisation/redirect-payment-flows/) for more information about this flow. <br><br>Feature: `INITIATE_PRE_AUTHORISATION`
*/
put: operations['updatePaymentAuthorisation']
/**
* Create Payment Authorisation
* @description Used to initiate the authorisation process and direct users to the login screen of their financial Institution in order to give their consent for a payment. This endpoint is used to initiate all the different payment listed below. Based on the type of payment you wish to make, you may be required to provide specific properties in [PaymentRequest](https://docs.yapily.com/api/reference/#operation/createPaymentAuthorisation!path=paymentRequest&t=request). First make sure that the payment feature you wish to execute is supported by the bank by checking the features array in [GET Institution](https://docs.yapily.com/api/reference/#operation/getInstitution). <br><br>See [Redirect Payment Flows](https://docs.yapily.com/pages/key-concepts/payments/payment-authorisation/redirect-payment-flows/) for more information about this flow.<br><br>Features:<ul><li>`INITIATE_DOMESTIC_PERIODIC_PAYMENT`</li><li>`INITIATE_DOMESTIC_SCHEDULED_PAYMENT`</li><li>`INITIATE_DOMESTIC_SINGLE_INSTANT_PAYMENT`</li><li>`INITIATE_DOMESTIC_SINGLE_PAYMENT`</li><li>`INITIATE_INTERNATIONAL_PERIODIC_PAYMENT`</li><li>`INITIATE_INTERNATIONAL_SCHEDULED_PAYMENT`</li><li>`INITIATE_INTERNATIONAL_SINGLE_PAYMENT`</li></ul>
*/
post: operations['createPaymentAuthorisation']
}
'/payments': {
/**
* Create Payment
* @description Creates a payment after obtaining the user's authorisation. <br><br>Features:<ul><li>`CREATE_DOMESTIC_PERIODIC_PAYMENT`</li><li>`CREATE_DOMESTIC_SCHEDULED_PAYMENT`</li><li>`CREATE_DOMESTIC_SINGLE_INSTANT_PAYMENT`</li><li>`CREATE_DOMESTIC_SINGLE_PAYMENT`</li><li>`CREATE_INTERNATIONAL_PERIODIC_PAYMENT`</li><li>`CREATE_INTERNATIONAL_SCHEDULED_PAYMENT`</li><li>`CREATE_INTERNATIONAL_SINGLE_PAYMENT`</li></ul>
*/
post: operations['createPayment']
}
'/payments/{paymentId}/details': {
/**
* Get Payment Details
* @description Returns the details of a payment. <br><br>Most commonly used to check for payment status updates. <br><br>Feature: `EXISTING_PAYMENTS_DETAILS`
*/
get: operations['getPayments']
}
'/pre-auth-requests': {
/**
* Create Pre-authorisation
* @description Used to initiate the pre-authorisation process for any `Institution` that contains the `INITIATE_PRE_AUTHORISATION` feature to authenticate the user. <br><br>Feature: `INITIATE_PRE_AUTHORISATION`
*/
post: operations['createPreAuthorisationRequest']
}
'/payment-pre-auth-requests': {
/**
* Create Payment Pre-authorisation
* @description Used to initiate the pre-authorisation process for payments for CBI Globe institutions that contain the `INITIATE_ONETIME_PRE_AUTHORISATION_PAYMENTS` feature to authenticate the user. <br><br>Feature: `INITIATE_ONETIME_PRE_AUTHORISATION_PAYMENTS`
*/
post: operations['createPaymentPreAuthorisationRequest']
}
'/users': {
/**
* Get Users
* @description Get all the users configured in your application
*/
get: operations['getUsers']
/**
* Create User
* @description Create a new user in your application
*/
post: operations['addUser']
}
'/users/{userUuid}': {
/**
* Get User
* @description Get a specific user using the user UUID
*/
get: operations['getUser']
/**
* Delete User
* @description Delete a user from your application along with any sub-resources (including consent resources on institution APIs if they exist)
*/
delete: operations['deleteUser']
}
'/users/{userUuid}/profile/consents': {
/**
* Create Profile Consent
* @description Used to add a consent to a `Financial Profile` for a `User`. The response is asynchronous, returned with pending status, while retrieval of financial data is commenced. There is a limit of 10,000 transactions for enrichment.
*/
post: operations['createProfileConsent']
}
'/users/{userUuid}/profile/consents/{profileConsentId}': {
/**
* Get Profile Consent
* @description Used to retrieve a specific ProfileConsent for a User.
*/
get: operations['getProfileConsent']
/**
* Delete Profile Consent
* @description Used to delete a `ProfileConsent` for a `User`. This will remove the consent and all associated financial data from the 'Financial Profile'.
*/
delete: operations['deleteProfileConsent']
}
'/users/{userUuid}/profile/transaction-groups': {
/**
* Get Transaction Groups
* @description Used to retrieve a `TransactionGroups` for a `User`. Status will be `PENDING` until all ProfileConsents are `COMPLETED`.
*/
get: operations['getUserProfile']
}
'/users/{userUuid}/profile/predicted-balances': {
/**
* Get Predicted Balances
* @description Used to retrieve a `Balance Prediction Profile` for a `User`. Status will be `PENDING` until all ProfileConsents are `COMPLETED`.
*/
get: operations['getBalancePrediction']
}
'/notifications/event-subscriptions': {
/**
* Get Event Subscriptions
* @description Get all event subscriptions that your application is subscribed to
*/
get: operations['getEventSubscriptions']
/**
* Create Event Subscription
* @description Used to subscribe to notifications relating to a specified event type.
*/
post: operations['createEventSubscription']
}
'/notifications/event-subscriptions/{eventTypeId}': {
/**
* Get Event Subscription
* @description Used to get details of your subscription to a specified event type.
*/
get: operations['getEventSubscriptionById']
/**
* Delete Event Subscription
* @description Used to unsubscribe to notifications relating to a specified event type.
*/
delete: operations['deleteEventSubscriptionById']
}
'/virtual-accounts/beneficiaries': {
/**
* Get List Of Beneficiaries
* @description Gets the list of beneficiaries (individual or business account) to which a Pay Out can be made.
*/
get: operations['getVirtualAccountBeneficiaries']
/**
* Create Beneficiary
* @description Create a new beneficiary (individual or business account) to which a Pay Out can be made. The beneficiary can be used from any virtual account that is held
*/
post: operations['createVirtualAccountBeneficiary']
}
'/virtual-accounts/beneficiaries/{beneficiaryId}': {
/**
* Get Beneficiary
* @description Get the details of a specific beneficiary (individual or business account) to which a Pay Out can be made from its id.
*/
get: operations['getVirtualAccountBeneficiary']
/**
* Delete Beneficiary
* @description Delete a specific beneficiary (individual or business account)
*/
delete: operations['deleteVirtualAccountBeneficiary']
}
'/virtual-accounts/accounts': {
/**
* Get Accounts
* @description Retrieve a list of all virtual accounts held
*/
get: operations['getVirtualAccounts']
/**
* Create Account
* @description Create a new virtual account
*/
post: operations['createVirtualAccount']
}
'/virtual-accounts/payments/pay-outs': {
/**
* Create Pay Out
* @description Initiate a payment from a specified virtual account to a previously added beneficiary using any of the schemes that it supports <br> When subscribed to virtualAccount.payOut.status notifications, further updates on payment processing status will be delivered asynchronously
*/
post: operations['createVirtualAccountPayOut']
}
'/virtual-accounts/accounts/{accountId}': {
/**
* Get Account
* @description Get the details of a specific account using its Id
*/
get: operations['getVirtualAccountById']
/**
* Update Account
* @description Update the details of a specific account using its Id
*/
patch: operations['updateVirtualAccountById']
}
'/virtual-accounts/payments': {
/**
* Get Payments
* @description Retrieve a list of virtual account payments
*/
get: operations['getVirtualAccountPayments']
}
'/virtual-accounts/payments/{id}': {
/**
* Get Payment
* @description Get the details of a specific payment using its Id
*/
get: operations['getPaymentsById']
}
'/virtual-accounts/payments/transfers': {
/**
* Create Virtual Account Transfer
* @description Create a transfer between two virtual accounts
*/
post: operations['createVirtualAccountTransfer']
}
'/virtual-accounts/payments/{paymentId}/pay-in-details': {
/**
* Get Pay-In Details
* @description Get the details of a pay-in transaction
*/
get: operations['getPayInDetails']
}
'/virtual-accounts/clients': {
/**
* Get List of Virtual Account Clients
* @description Get Virtual Account Clients (individual or business client).
*/
get: operations['getVirtualAccountClients']
/**
* Create Virtual Account Client
* @description Create a new virtual account client (individual or business client). Available for clients who have direct onboarding permissions only. Please contact your CSM to enquire about access
*/
post: operations['createVirtualAccountClient']
}
'/virtual-accounts/refunds': {
/**
* Get list of refunds
* @description Retrieve a list of refunds
*/
get: operations['getVirtualAccountRefunds']
/**
* Create Refund
* @description Create a refund for a payment received into a virtual account. Funds are returned to the source account. When subscribed to `virtualAccount.refund.status` notifications, updates on the refund status are delivered asynchronously.
*/
post: operations['createVirtualAccountRefund']
}
'/virtual-accounts/refunds/{id}': {
/**
* Get Refund By Id
* @description Get the details of a refund by its ID
*/
get: operations['getVirtualAccountRefundById']
}
'/virtual-accounts/clients/{clientId}': {
/**
* Get a Virtual Account Client by ID
* @description Get a Virtual Account Client using its ID. Restricted to applications with direct onboarding permissions only
*/
get: operations['getVirtualAccountClientById']
}
'/variable-recurring-payments/sweeping/consents': {
/**
* Create Sweeping Variable Recurring Payment Authorisation
* @description Used to initiate the authorisation process and direct users to the login screen of their financial Institution in order to give their consent for Sweeping Variable Recurring Payments. The request would return an Authorization URL and an Identifier for the consent created at the Institution. First make sure that the payment feature you wish to execute is supported by the bank by checking the features array in [GET Institution](https://docs.yapily.com/api/#get-institution). <br><br>See [Redirect Payment Flows](https://docs.yapily.com/guides/payments/payment-authorisation-flows/redirect/) for more information about this flow.<br><br>Features:<ul><li>`INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING`</li></ul>
*/
post: operations['createSweepingAuthorisation']
}
'/variable-recurring-payments/non-sweeping/consents': {
/**
* Create Non-Sweeping Variable Recurring Payment Authorisation
* @description Used to initiate the authorisation process and direct users to the login screen of their financial Institution in order to give their consent for Non-Sweeping Variable Recurring Payments. The request would return an Authorization URL and an Identifier for the consent created at the Institution. First make sure that the payment feature you wish to execute is supported by the bank by checking the features array in [GET Institution](https://docs.yapily.com/api/#get-institution). <br><br>See [Redirect Payment Flows](https://docs.yapily.com/guides/payments/payment-authorisation-flows/redirect/) for more information about this flow.<br><br>Features:<ul><li>`INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_NONSWEEPING`</li></ul>
*/
post: operations['createNonSweepingAuthorisation']
}
'/variable-recurring-payments/payments': {
/**
* Create Variable Recurring Payment
* @description Creates a Variable Recurring Payment transaction after obtaining the user's authorisation.<br><br>Features:<ul><li>`CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING`</li><li>`CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_NONSWEEPING`</li></ul>
*/
post: operations['createVrpPayment']
}
'/variable-recurring-payments/sweeping/consents/{consentId}': {
/**
* Get Sweeping Variable Recurring Payment Consent Details
* @description Get Sweeping Variable Recurring Payments consent details using the consent Id
*/
get: operations['getSweepingVrpConsentById']
}
'/variable-recurring-payments/non-sweeping/consents/{consentId}': {
/**
* Get Non-Sweeping Variable Recurring Payment Consent Details
* @description Get Non-Sweeping Variable Recurring Payments consent details using the consent Id
*/
get: operations['getNonSweepingVrpConsentById']
}
'/variable-recurring-payments/funds-confirmation': {
/**
* Confirm Funds for Variable Recurring Payment
* @description Confirms whether there are available funds on the Payer account to execute a Variable Recurring Payment after obtaining the user's authorisation. <br><br>Features:<ul><li>`VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION`</li></ul>
*/
post: operations['createVrpFundsConfirmation']
}
'/variable-recurring-payments/payments/{paymentId}/details': {
/**
* Get Variable Recurring Payment Details
* @description Get Variable Recurring Payment details using the Payment Id
*/
get: operations['getVrpPaymentDetails']
}
'/accounts/{accountId}/real-time/transactions': {
/**
* Get Real Time Account Transactions
* @description Used to get the account transactions for an account in real time with cursor pagination<br><br>Feature: `ACCOUNT_TRANSACTIONS`
*/
get: operations['getRealTimeTransactions']
}
'/hosted/payment-requests': {
/**
* Create Hosted payment request
* @description Used to initiate a payment request using Yapily Hosted Pages.
*/
post: operations['createHostedPaymentRequest']
}
'/hosted/payment-requests/links': {
/**
* Create Pay By Link
* @description Used to created a long lived payment request for Pay By Link
*/
post: operations['createHostedPaymentRequestLink']
}
'/hosted/payment-requests/{paymentRequestId}': {
/**
* Get Hosted payment request
* @description Used to get details of a payment request
*/
get: operations['getHostedPaymentRequest']
}
'/institutions/constraints/payments': {
/**
* Get Payment Constraints Rules
* @description Retrieve institution specific constraints for payment authorisation and submission requests
*/
get: operations['getPaymentConstraintsRulesByInstitution']
}
'/institutions/constraints/data': {
/**
* Get Data Constraints Rules
* @description Get Data Constraints Rules against an Institution for Account Authorisation requests
*/
get: operations['getAccountConstraintsRulesByInstitution']
}
}
export type webhooks = Record<string, never>
export interface components {
schemas: {
Account: {
/** @description Unique identifier of the account. */
id?: string
/** @description Specifies the type of account e.g. (BUSINESS_CURRENT). */
type?: string
/** @description Product name as defined by the financial institution for this account */
description?: string
/** @description Main / headline balance for the account. <br><br> Use of this field is recommended as fallback only. Instead, use of the typed balances (accountBalances) is recommended. */
balance?: number
/** @description Currency the bank account balance is denoted in. <br><br> Specified as a 3-letter ISO 4217 currency code */
currency?: string
usageType?: components['schemas']['UsageType']
accountType?: components['schemas']['AccountType']
/** @description Nickname of the account that was provided by the account owner. <br><br> May be used to aid identification of the account. */
nickname?: string
/** @description Supplementary specifications that might be provided by the Bank. These provide further characteristics about the account. */
details?: string
accountNames?: components['schemas']['AccountName'][]
accountIdentifications?: components['schemas']['AccountIdentification'][]
accountBalances?: components['schemas']['AccountBalance'][]
consolidatedAccountInformation?: components['schemas']['ConsolidatedAccountInformation']
}
AccountApiListResponse: {
meta?: components['schemas']['ResponseListMeta']
data?: components['schemas']['Account'][]
links?: {
[key: string]: string | undefined
}
forwardedData?: components['schemas']['ResponseForwardedData'][]
raw?: components['schemas']['RawResponse'][]
paging?: components['schemas']['FilteredClientPayloadListAccount']
tracingId?: string
}
ApiResponseOfAccount: {
meta?: components['schemas']['ResponseMeta']
data?: components['schemas']['Account']
links?: {
[key: string]: string | undefined
}
forwardedData?: components['schemas']['ResponseForwardedData'][]
raw?: components['schemas']['RawResponse'][]
tracingId?: string
}
AccountAuthorisationRequest: {
/**
* Format: uuid
* @description `User` for which the authorisation request was created.
*/
userUuid?: string
/**
* @description __Conditional__. User-friendly identifier of the `User` that provides authorisation. If a `User` with the specified `applicationUserId` exists, it will be used otherwise, a new `User` with the specified `applicationUserId` will be created and used. Either the `userUuid` or `applicationUserId` must be provided.
* @example user-234562290
*/
applicationUserId?: string
/** @description Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect. */
forwardParameters?: string[]
/**
* @description __Mandatory__. The reference to the `Institution` which identifies which institution the authorisation request is sent to.
* @example yapily-mock
*/
institutionId: string
/**
* @description __Optional__. The server to redirect the user to after the user completes the authorisation at the `Institution`. <br><br>See [Using a callback (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-optional) for more information.
* @example https://display-parameters.com
*/
callback?: string
redirect?: components['schemas']['RedirectRequest']
/**
* @description __Conditional__. Used to receive a `oneTimeToken` rather than a `consentToken` at the `callback` for additional security. This can only be used when the `callback` is set. <br><br>See [Using a callback with an OTT (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-with-an-ott-optional) for more information.
* @example false
*/
oneTimeToken?: boolean
accountRequest?: components['schemas']['AccountRequest']
}
AccountBalance: {
type?: components['schemas']['AccountBalanceType']
/**
* Format: date-time
* @description Date and time of the reported balance.
*/
dateTime?: string
balanceAmount?: components['schemas']['Amount']
/** @description _Optional_. Indicates whether any credit lines are included in the balance. */
creditLineIncluded?: boolean
/** @description _Optional_. Specifies the type of balance. */
creditLines?: components['schemas']['CreditLine'][]
}
ExtendConsentRequest: {
/**
* Format: date-time
* @description __Mandatory__. The time that the user confirmed access to their account information
* @example 2022-08-16T10:59:53.288Z
*/
lastConfirmedAt: string
}
EmbeddedAccountAuthorisationRequest: {
/**
* Format: uuid
* @description `User` for which the authorisation request was created.
*/
userUuid?: string
/**
* @description __Conditional__. The user-friendly reference to the `User` that will authorise the authorisation request. If a `User` with the specified `applicationUserId` exists, it will be used otherwise, a new `User` with the specified `applicationUserId` will be created and used. Either the `userUuid` or `applicationUserId` must be provided.
* @example user-234562290
*/
applicationUserId?: string
/** @description Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect. */
forwardParameters?: string[]
/**
* @description __Mandatory__. The reference to the `Institution` which identifies which institution the authorisation request is sent to.
* @example yapily-mock
*/
institutionId: string
/**
* @description __Optional__. The server to redirect the user to after the user complete the authorisation at the `Institution`. <br><br>See [Using a callback (Optional)](https://docs.yapily.com/) for more information.
* @example https://display-parameters.com
*/
callback?: string
redirect?: components['schemas']['RedirectRequest']
/**
* @description __Conditional__. Used to receive a `oneTimeToken` rather than a `consentToken` at the `callback` for additional security. This can only be used when the `callback` is set. <br><br>See [Using a callback with an OTT (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-with-an-ott-optional) for more information.
* @example false
*/
oneTimeToken?: boolean
userCredentials?: components['schemas']['UserCredentials']
selectedScaMethod?: components['schemas']['ScaMethod']
/**
* @description __Conditional__. Used to update the authorisation with the sca code received by the user from the `Institution` using the embedded account authorisation flow.<br><br>This is the penultimate step required in the embedded account authorisation flow to authorise the `Consent`. After sending the sca code, to obtain an authorised consent, the last step is to poll [Get Consent](https://docs.yapily.com/api/reference/#operation/getConsentById) until the `Institution` authorises the request and the `Consent` `status` transitions to `AUTHORIZED`.
* @example 325614
*/
scaCode?: string
accountRequest?: components['schemas']['AccountRequest']
}
/** Account Identifications */
AccountIdentification: {
type: components['schemas']['AccountIdentificationType']
/**
* Account Identification
* @description __Mandatory__. The value associated with the account identification type.<br><br> See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/intro-to-payment-execution/#account-identifications-combinations) for more information on the format of the values.
* @example 401016
*/
identification: string
}
/** Account Identifications */
AccountIdentificationResponse: {
type?: components['schemas']['AccountIdentificationTypeResponse']
/**
* Account Identification
* @description The value associated with the account identification type.<br><br> See [Account Identification Combinations](https://docs.yapily.com/pages/payments/payments-resources/intro-to-payment-execution/#account-identifications-combinations) for more information on the format of the values.
* @example 401016
*/
identification?: string
}
/** @description __Conditional__. Used to create a request for the balance of the account specified. Once the user authorises the request, only the balance can be obtained by executing [GET Account Balances](./#get-account-balances).<br><br> This can be specified in conjunction with `accountIdentifiersForTransaction` to generate a `Consent` that can both access the accounts balance and transactions. */
AccountInfo: {
/**
* @description __Conditional__. Unique identifier of the account.
* @example 500000000000000000000001
*/
accountId?: string
accountIdentification: components['schemas']['AccountIdentification']
}
AccountName: {
/** @description The bank account holder's name given by the account owner. */
name?: string
}
/** @description __Conditional__. Used to further specify details of the `Consent` to request <br><br>Conditions:<ol><li>Mandatory to specify the individual scopes to request from the user at the `Institution` for an account authorisation</li><li>Mandatory to specify an expiry time on the created `Consent` at which time will render it unusable</li><li>Mandatory to specify the date range that the created `Consent` will be able to access transactions for (given the range is support for the `Institution`)</li></ol> */
AccountRequest: {
/**
* Format: date-time
* @description __Optional__. Specifies the earliest date of the transaction records to be returned.<br><br> You must supply this field to retrieve transactions older than 90 days for banks accessed via the the [CBI Globe Gateway](https://docs.yapily.com/pages/data/financial-data-resources/data-restrictions/#cbi-globe-gateway).
* @example 2020-01-01T00:00:00Z
*/
transactionFrom?: string
/**
* Format: date-time
* @description __Optional__. Specifies the latest date of the transaction records to be returned.
* @example 2021-01-01T00:00:00Z
*/
transactionTo?: string
/**
* Format: date-time
* @description __Optional__. Used to set a hard date for when the user's associated `Consent` will expire.<br><br>**Note**: If this supported by the bank, specifying this is property is opting out of having a long-lived consent that can be perpetually re-authorised by the user. This will add an `expiresAt` field on the `Consent` object which will render it unusable after this date.<br><br>**Note**: This is not supported by every `Institution`. In such case, the request will not fail but the property will be ignored and the created `Consent` will not have an expiry date.
* @example 2025-01-01T00:00:00Z
*/
expiresAt?: string
accountIdentifiers?: components['schemas']['AccountInfo']
/** @description __Conditional__. Used to create a request for the transactions of the account specified. Once the user authorises the request, only the transactions can be obtained by executing [GET Account Transactions](./#get-account-transactions). <br><br>This can be specified in conjunction with `accountIdentifiersForBalance` to generate a `Consent` that can both access the accounts balance and transactions. */
accountIdentifiersForTransaction?: components['schemas']['AccountInfo'][]
/** @description __Conditional__. Used to create a request for the balance of the account specified. Once the user authorises the request, only the balance can be obtained by executing [GET Account Balances](./#get-account-balances).<br><br> This can be specified in conjunction with `accountIdentifiersForTransaction` to generate a `Consent` that can both access the accounts balance and transactions. */
accountIdentifiersForBalance?: components['schemas']['AccountInfo'][]
/** @description __Optional__. Used to granularly specify the set of features that the user will give their consent for when requesting access to their account information. Depending on the `Institution`, this may also populate a consent screen which list these scopes before the user authorises.<br><br>This endpoint accepts allow all [Financial Data Features](/guides/financial-data/features/#feature-list) that the `Institution` supports.To find out which scopes an `Institution` supports, check [GET Institution](./#get-institution). */
featureScope?: components['schemas']['FeatureEnum'][]
}
/** @description Statement information belonging to the account. */
AccountStatement: {
/** @description Unique identifier for the statement. */
id?: string
/**
* Format: date-time
* @description Date and time of when the statement period starts.
*/
startDateTime?: string
/**
* Format: date-time
* @description Date and time of when the statement period ends.
*/
endDateTime?: string
/**
* Format: date-time
* @description Date and time of when the statement was created.
*/
creationDateTime?: string
}
/**
* @description Specifies the type of the stated account balance.
* @enum {string}
*/
AccountBalanceType:
| 'CLOSING_AVAILABLE'
| 'CLOSING_BOOKED'
| 'CLOSING_CLEARED'
| 'EXPECTED'
| 'FORWARD_AVAILABLE'
| 'INFORMATION'
| 'INTERIM_AVAILABLE'
| 'INTERIM_BOOKED'
| 'INTERIM_CLEARED'
| 'OPENING_AVAILABLE'
| 'OPENING_BOOKED'
| 'OPENING_CLEARED'
| 'PREVIOUSLY_CLOSED_BOOKED'
| 'AUTHORISED'
| 'OTHER'
| 'UNKNOWN'
/**
* Account Identification Type
* @description __Mandatory__. Used to describe the format of the account.<br><br> See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/intro-to-payment-execution/#account-identifications-combinations) for more information on when to specify each type.
* @example SORT_CODE
* @enum {string}
*/
AccountIdentificationType:
| 'SORT_CODE'
| 'ACCOUNT_NUMBER'
| 'IBAN'
| 'BBAN'
| 'BIC'
| 'PAN'
| 'MASKED_PAN'
| 'MSISDN'
| 'BSB'
| 'NCC'
| 'ABA'
| 'ABA_WIRE'
| 'ABA_ACH'
| 'EMAIL'
| 'ROLL_NUMBER'
| 'BLZ'
| 'IFS'
| 'CLABE'
| 'CTN'
| 'BRANCH_CODE'
| 'VIRTUAL_ACCOUNT_ID'
/**
* Account Identification Type
* @description Used to describe the format of the account.<br><br> See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/intro-to-payment-execution/#account-identifications-combinations) for more information.
* @example SORT_CODE
* @enum {string}
*/
AccountIdentificationTypeResponse:
| 'SORT_CODE'
| 'ACCOUNT_NUMBER'
| 'IBAN'
| 'BBAN'
| 'BIC'
| 'PAN'
| 'MASKED_PAN'
| 'MSISDN'
| 'BSB'
| 'NCC'
| 'ABA'
| 'ABA_WIRE'
| 'ABA_ACH'
| 'EMAIL'
| 'ROLL_NUMBER'
| 'BLZ'
| 'IFS'
| 'CLABE'
| 'CTN'
| 'BRANCH_CODE'
| 'VIRTUAL_ACCOUNT_ID'
ApiResponseOfAccountStatement: {
meta?: components['schemas']['ResponseMeta']
data?: components['schemas']['AccountStatement']
links?: {
[key: string]: string | undefined
}
forwardedData?: components['schemas']['ResponseForwardedData'][]
raw?: components['schemas']['RawResponse'][]
tracingId?: string
}
ApiListResponseOfAccountStatement: {
meta?: components['schemas']['ResponseListMeta']
data?: components['schemas']['AccountStatement'][]
links?: {
[key: string]: string | undefined
}
forwardedData?: components['schemas']['ResponseForwardedData'][]
raw?: components['schemas']['RawResponse'][]
paging?: components['schemas']['FilteredClientPayloadListAccountStatement']
tracingId?: string
}
/**
* @description The type of account e.g. (Credit Card, Savings).
* @enum {string}
*/
AccountType:
| 'CASH_TRADING'
| 'CASH_INCOME'
| 'CASH_PAYMENT'
| 'CHARGE_CARD'
| 'CHARGES'
| 'COMMISSION'
| 'CREDIT_CARD'
| 'CURRENT'
| 'E_MONEY'
| 'LIMITED_LIQUIDITY_SAVINGS_ACCOUNT'
| 'LOAN'
| 'MARGINAL_LENDING'
| 'MONEY_MARKET'
| 'MORTGAGE'
| 'NON_RESIDENT_EXTERNAL'
| 'OTHER'
| 'OVERDRAFT'
| 'OVERNIGHT_DEPOSIT'
| 'PREPAID_CARD'
| 'SALARY'
| 'SAVINGS'
| 'SETTLEMENT'
| 'TAX'
| 'UNKNOWN'
/**
* Address Details
* @description __Conditional__. The address of the `Payee` or `Payer`.<ul><li>`payee.address` is mandatory when the `paymentType` is an `INTERNATIONAL` payment</li><li>An `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment.</li></ul>
* @example {
* "country": "GB"
* }
*/
Address: {
/**
* Address Lines
* @description __Optional__. The address line of the address
* @example [
* "Ardenham Court"
* ]
*/
addressLines?: string[]
/**
* Street
* @description __Optional__. The street name of the address
* @example Oxford Road
*/
streetName?: string
/**
* Building Number
* @description __Optional__. The building number of the address
* @example 45
*/
buildingNumber?: string
/**
* Post Code
* @description __Optional__. The post code of the address
* @example HP19 3EQ
*/
postCode?: string
/**
* Town
* @description __Optional__. The town name of the address
* @example Aylesbury
*/
townName?: string
/**
* County
* @description __Optional__. The list of counties for the address
* @example [
* "Buckinghamshire"
* ]
*/
county?: string[]
/**
* Country
* @description __Conditional__. The 2-letter country code for the address. <br><br>An `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment
* @example GB
*/
country?: string
/**
* Department
* @description __Optional__. The department for the address
* @example Unit 2
*/
department?: string
/**
* Sub-Department
* @description __Optional__. The sub-department for the address
* @example Floor 3
*/
subDepartment?: string
addressType?: components['schemas']['AddressTypeEnum']
}
/**
* Address Details
* @description The address of the `Payee` or `Payer`.
* @example {
* "country": "GB"
* }
*/
AddressResponse: {
/**
* Address Lines
* @description The address line of the address
* @example [
* "Ardenham Court"