forked from XeroAPI/Xero-OpenAPI
-
Notifications
You must be signed in to change notification settings - Fork 0
/
xero_bankfeeds.yaml
1258 lines (1258 loc) · 38.4 KB
/
xero_bankfeeds.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:
version: "2.3.7"
title: Bank Feeds API
description: This specifing endpoints Xero Bank feeds API
termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
contact:
name: "Xero Platform Team"
email: "[email protected]"
url: "https://developer.xero.com"
license:
name: MIT
url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
servers:
- description: Xero Bank Feeds API base url
url: https://api.xero.com/bankfeeds.xro/1.0
paths:
/FeedConnections:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [bankfeeds]
tags:
- BankFeeds
summary: searches feed connections
operationId: getFeedConnections
description: By passing in the appropriate options, you can search for available feed connections in the system.
parameters:
- name: page
in: query
description: Page number which specifies the set of records to retrieve. By default the number of the records per set is 10. Example - https://api.xero.com/bankfeeds.xro/1.0/FeedConnections?page=1 to get the second set of the records. When page value is not a number or a negative number, by default, the first set of records is returned.
schema:
type: integer
example: 1
- name: pageSize
in: query
description: Page size which specifies how many records per page will be returned (default 10). Example - https://api.xero.com/bankfeeds.xro/1.0/FeedConnections?pageSize=100 to specify page size of 100.
schema:
type: integer
example: 100
responses:
'201':
description: search results matching criteria returned with pagination and items array
content:
application/json:
schema:
$ref: '#/components/schemas/FeedConnections'
example:
{
"pagination":{
"page":1,
"pageCount":1,
"pageSize":87654321,
"itemCount":39
},
"items":[
{
"id":"c0eb97b5-4f97-465a-8268-276513c14396",
"accountToken":"foobar31306",
"accountType":"BANK",
"accountNumber":"123496842",
"accountName":"SDK Bank 95921",
"accountId":"aefbf6be-4285-4ca5-bf39-0f486c8515c7",
"currency":"GBP",
"country":"GB"
},
{
"id":"3b44b539-4e39-4d53-9334-d8ba01674752",
"accountToken":"foobar74770",
"accountType":"BANK",
"accountNumber":"123481122",
"accountName":"SDK Bank 11272",
"accountId":"fc2f3cc2-126e-40d7-9fc1-12e52d0a71f1",
"currency":"GBP",
"country":"GB"
}
]
}
'400':
description: validation error response
post:
security:
- OAuth2: [bankfeeds]
tags:
- BankFeeds
summary: create one or more new feed connection
operationId: createFeedConnections
x-hasBankFeedsValidationError: true
description: By passing in the FeedConnections array object in the body, you can create one or more new feed connections
requestBody:
required: true
description: Feed Connection(s) array object in the body
content:
application/json:
schema:
$ref: '#/components/schemas/FeedConnections'
example:
{
"items":[
{
"accountToken":"foobar71760",
"accountNumber":"123458637",
"accountName":"SDK Bank 90861",
"accountType":"BANK",
"currency":"GBP"
}
]
}
responses:
'201':
description: success new feed connection(s)response
content:
application/json:
schema:
$ref: '#/components/schemas/FeedConnections'
example:
{
"items":[
{
"id":"2a19d46c-2a92-4e50-9401-dcf2cb895be7",
"accountToken":"foobar71760",
"status":"PENDING"
}
]
}
'400':
description: 'invalid input, object invalid'
'409':
description: failed to create new feed connection(s)response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/FeedConnections/{id}:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [bankfeeds]
tags:
- BankFeeds
summary: Retrive single feed connection based on unique id provided
operationId: getFeedConnection
description: By passing in a FeedConnection Id options, you can search for matching feed connections
parameters:
- required: true
in: path
name: id
description: Unique identifier for retrieving single object
schema:
type: string
format: uuid
responses:
'200':
description: success returns a FeedConnection object matching the id in response
content:
application/json:
schema:
$ref: '#/components/schemas/FeedConnection'
example:
{
"id":"b58b685a-1bee-4904-91f1-fee30bb6ea52",
"accountToken":"foobar84778",
"accountType":"BANK",
"accountNumber":"123434859",
"accountName":"SDK Bank 5517",
"accountId":"f4c4d595-da94-493b-999a-19d1ae1f508a",
"currency":"GBP",
"country":"GB"
}
'400':
description: bad input parameter
/FeedConnections/DeleteRequests:
parameters:
- $ref: '#/components/parameters/requiredHeader'
post:
security:
- OAuth2: [bankfeeds]
tags:
- BankFeeds
summary: Delete an exsiting feed connection
operationId: deleteFeedConnections
description: By passing in FeedConnections array object in the body, you can delete a feed connection.
requestBody:
required: true
description: Feed Connections array object in the body
content:
application/json:
schema:
$ref: '#/components/schemas/FeedConnections'
example:
{
"items":[
{
"id":"b4cc693b-24d9-42ec-a6d4-2943d253ff63"
}
]
}
responses:
'202':
description: Success response for deleted feed connection
content:
application/json:
schema:
$ref: '#/components/schemas/FeedConnections'
example:
{
"items":[
{
"id":"b4cc693b-24d9-42ec-a6d4-2943d253ff63",
"status":"PENDING"
},
{
"accountToken": "10000125",
"status": "REJECTED",
"error": {
"type": "feed-connected-in-different-organisation",
"title": "Feed connected in different organisation",
"detail": "The AccountToken is connected to another Xero Bank Account associated with this bank. This Xero Bank Account belongs to a different Xero Organisation."
}
}
]
}
'400':
description: bad input parameter
/Statements:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [bankfeeds]
tags:
- BankFeeds
summary: Retrive all statements based on unique search criteria
operationId: getStatements
description: By passing in parameters, you can search for matching statements
parameters:
- in: query
name: page
description: unique id for single object
required: false
schema:
type: integer
format: int32
- in: query
name: pageSize
description: Page size which specifies how many records per page will be returned (default 10). Example - https://api.xero.com/bankfeeds.xro/1.0/Statements?pageSize=100 to specify page size of 100.
required: false
schema:
type: integer
format: int32
- name: Xero-Application-Id
in: header
required: false
schema:
type: string
default: 00000000-0000-0000-0000-0000000010000
- name: Xero-User-Id
in: header
required: false
schema:
type: string
default: 00000000-0000-0000-0000-0000030000000
responses:
'200':
description: success returns Statements array of objects response
content:
application/json:
schema:
$ref: '#/components/schemas/Statements'
example:
{
"pagination":{
"page":1,
"pageCount":210,
"pageSize":3,
"itemCount":3
},
"items":[
{
"id":"9817e4b8-82b3-4526-91f7-040bd278053f",
"feedConnectionId":"6a4b9ff5-3a5f-4321-936b-4796163550f6",
"status":"REJECTED",
"startDate":"2019-08-01",
"endDate":"2019-08-15",
"startBalance":{
"amount":"100.0000",
"creditDebitIndicator":"CREDIT"
},
"endBalance":{
"amount":"150.0000",
"creditDebitIndicator":"CREDIT"
},
"statementLineCount":"1",
"errors":[
{
"type":"duplicate-statement",
"title":"Duplicate Statement Received",
"status":409,
"detail":"The received statement was marked as a duplicate."
}
]
},
{
"id":"2fc57bac-7aa7-4981-a5cd-8aee83fe698c",
"feedConnectionId":"6a4b9ff5-3a5f-4321-936b-4796163550f6",
"status":"DELIVERED",
"startDate":"2019-08-01",
"endDate":"2019-08-15",
"startBalance":{
"amount":"100.0000",
"creditDebitIndicator":"CREDIT"
},
"endBalance":{
"amount":"150.0000",
"creditDebitIndicator":"CREDIT"
},
"statementLineCount":"1"
}
]
}
'400':
description: bad input parameter
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Statements'
example: {
"type": "invalid-request",
"title": "Invalid Request",
"status": 400,
"detail": "For the request field missing parameter."
}
post:
security:
- OAuth2: [bankfeeds]
tags:
- BankFeeds
operationId: createStatements
x-hasBankFeedsValidationError: true
responses:
'202':
description: Success returns Statements array of objects in response
content:
application/json:
schema:
$ref: '#/components/schemas/Statements'
example:
{
"items":[
{
"id":"d69b02b7-a30c-464a-99cf-ba9770373c61",
"feedConnectionId":"6a4b9ff5-3a5f-4321-936b-4796163550f6",
"status":"PENDING"
},
{
"id":"598f255c-015b-4138-93df-2e06c64565b3",
"feedConnectionId":"2ebe6393-f3bb-48ab-9a0e-b04fa8585a70",
"status":"PENDING"
}
]
}
'400':
description: Statement failed validation
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Statements'
example: {
"type": "invalid-request",
"title": "Invalid Request",
"status": 400,
"detail": "For the request field 'StatementLine.ChequeNumber' exceeded the maximum length of 20."
}
'403':
description: Invalid application or feed connection
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example: {
"type": "invalid-application",
"title": "Invalid Application",
"status": 403,
"detail": "The application has not been configured to use these API endpoints."
}
'409':
description: Duplicate statement received
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Statements'
example:
{
"items":[
{
"id":"29fefeb6-f449-470d-9179-f1d8900930d6",
"feedConnectionId":"6a4b9ff5-3a5f-4321-936b-4796163550f6",
"status":"REJECTED",
"errors":[
{
"type":"duplicate-statement",
"title":"Duplicate Statement Received",
"status":409,
"detail":"The received statement was marked as a duplicate."
}
]
}
]
}
'413':
description: Statement exceeds size limit
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Statements'
example: {
"type": "invalid-request",
"title": "Request too large",
"status": 413,
"detail": "Request size of 3500000 bytes exceeds the limit of 3000000 bytes."
}
'422':
description: Unprocessable Entity
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Statements'
example: {
"type": "invalid-end-balance",
"title": "Invalid End Balance",
"status": 422,
"detail": "End balance does not match start balance +/- statement line amounts."
}
'500':
description: Intermittent Xero Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Statements'
example: {
"type": "internal-error",
"title": "Intermittent Internal Xero Error",
"status": 500,
"detail": "The request should be retried. If the error persists, a Xero support issue should be raised."
}
requestBody:
description: Statements array of objects in the body
content:
application/json:
schema:
$ref: '#/components/schemas/Statements'
example:
{
"items":[
{
"feedConnectionId":"6a4b9ff5-3a5f-4321-936b-4796163550f6",
"startDate":"2019-08-11",
"endDate":"2019-08-11",
"startBalance":{
"amount":"100",
"creditDebitIndicator":"CREDIT"
},
"endBalance":{
"amount":"150",
"creditDebitIndicator":"CREDIT"
},
"statementLines":[
{
"postedDate":"2019-08-11",
"description":"My new line",
"amount":"50",
"creditDebitIndicator":"CREDIT",
"transactionId":"123446422",
"payeeName":"StarLord90315",
"reference":"Foobar95578",
"chequeNumber":"12379009"
}
]
},
{
"feedConnectionId":"2ebe6393-f3bb-48ab-9a0e-b04fa8585a70",
"startDate":"2019-08-11",
"endDate":"2019-08-11",
"startBalance":{
"amount":"100",
"creditDebitIndicator":"CREDIT"
},
"endBalance":{
"amount":"150",
"creditDebitIndicator":"CREDIT"
},
"statementLines":[
{
"postedDate":"2019-08-11",
"description":"My new line",
"amount":"50",
"creditDebitIndicator":"CREDIT",
"transactionId":"123449402",
"payeeName":"StarLord56705",
"reference":"Foobar67355",
"chequeNumber":"12379350"
}
]
}
]
}
/Statements/{statementId}:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [bankfeeds]
tags:
- BankFeeds
summary: Retrive single statement based on unique id provided
operationId: getStatement
description: By passing in a statement id, you can search for matching statements
parameters:
- name: statementId
description: statement id for single object
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: search results matching id for single statement
content:
application/json:
schema:
$ref: '#/components/schemas/Statement'
example:
{
"id":"97aca24a-dd10-4cda-98c7-1084a048257b",
"feedConnectionId":"6a4b9ff5-3a5f-4321-936b-4796163550f6",
"status":"DELIVERED",
"startDate":"2019-08-11",
"endDate":"2019-10-11",
"startBalance":{
"amount":"100.0000",
"creditDebitIndicator":"CREDIT"
},
"endBalance":{
"amount":"150.0000",
"creditDebitIndicator":"CREDIT"
},
"statementLineCount":"1"
}
'404':
description: Statement not found
components:
securitySchemes:
OAuth2:
type: oauth2
description: For more information visit https://developer.xero.com/documentation/oauth2/overview
flows:
authorizationCode:
authorizationUrl: 'https://login.xero.com/identity/connect/authorize'
tokenUrl: 'https://identity.xero.com/connect/token'
scopes:
email: Grant read-only access to your email
openid: Grant read-only access to your open id
profile: your profile information
accounting.transactions: Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read: Grant read-only access to invoices
accounting.reports.read: Grant read-only access to accounting reports
accounting.journals.read: Grant read-only access to journals
accounting.settings: Grant read-write access to organisation and account settings
accounting.settings.read: Grant read-only access to organisation and account settings
accounting.contacts: Grant read-write access to contacts and contact groups
accounting.contacts.read: Grant read-only access to contacts and contact groups
accounting.attachments: Grant read-write access to attachments
accounting.attachments.read: Grant read-only access to attachments
assets assets.read: Grant read-only access to fixed assets
bankfeeds: Grant read-write access to bankfeeds
files: Grant read-write access to files and folders
files.read: Grant read-only access to files and folders
payroll: Grant read-write access to payroll
payroll.read: Grant read-only access to payroll
payroll.employees: Grant read-write access to payroll employees
payroll.employees.read: Grant read-only access to payroll employees
payroll.leaveapplications: Grant read-write access to payroll leaveapplications
payroll.leaveapplications.read: Grant read-only access to payroll leaveapplications
payroll.payitems: Grant read-write access to payroll payitems
payroll.payitems.read: Grant read-only access to payroll payitems
payroll.payrollcalendars: Grant read-write access to payroll calendars
payroll.payrollcalendars.read: Grant read-only access to payroll calendars
payroll.payruns: Grant read-write access to payroll payruns
payroll.payruns.read: Grant read-only access to payroll payruns
payroll.payslip: Grant read-write access to payroll payslips
payroll.payslip.read: Grant read-only access to payroll payslips
payroll.settings.read: Grant read-only access to payroll settings
payroll.superfunds: Grant read-write access to payroll superfunds
payroll.superfunds.read: Grant read-only access to payroll superfunds
payroll.superfundproducts.read: Grant read-only access to payroll superfundproducts
payroll.timesheets: Grant read-write access to payroll timesheets
payroll.timesheets.read: Grant read-only access to payroll timesheets
paymentservices: Grant read-write access to payment services
projects: Grant read-write access to projects
projects.read: Grant read-only access to projects
parameters:
requiredHeader:
in: header
name: Xero-Tenant-Id
description: Xero identifier for Tenant
schema:
type: string
required: true
schemas:
FeedConnections:
externalDocs:
url: 'https://developer.xero.com/documentation/bank-feeds-api/feed-connections'
type: object
properties:
pagination:
$ref: '#/components/schemas/Pagination'
items:
type: array
items:
$ref: '#/components/schemas/FeedConnection'
FeedConnection:
externalDocs:
url: 'https://developer.xero.com/documentation/bank-feeds-api/feed-connections'
type: object
properties:
id:
type: string
format: uuid
example: "0d3cf8d-95dc-4466-8dc0-47e6d1197e28"
description: GUID used to identify the Account.
accountToken:
type: string
example: "10000123"
maximum: 50
description: This account identifier is generated by the financial institute (FI). This must be unique for your financial institute.
accountNumber:
type: string
example: "3809087654321500"
maximum: 40
description: String(40) when AccountType is BANK String(4) when AccountType is CREDITCARD The Account Number is used to match the feed to a Xero Bank Account. The API will create a new Xero Bank Account if a match to an existing Xero Bank Account is not found. Only the last 4 digits must be supplied for Credit Card numbers. Must be included if AccountId is not specified.
accountName:
type: string
example: "Joe's Savings Account"
maximum: 30
description: The Account Name will be used for the creation of a new Xero Bank Account if a matching Xero Bank Account is not found.
accountId:
type: string
format: uuid
example: "079a88ea-276d-41fb-a1f1-366ef3e22921"
description: Xero identifier for a bank account in Xero. Must be included if AccountNumber is not specified.
accountType:
enum: [BANK,CREDITCARD]
example: "BANK"
description: High level bank account type - BANK CREDITCARD BANK encompasses all bank account types other than credit cards.
currency:
$ref: '#/components/schemas/CurrencyCode'
country:
$ref: '#/components/schemas/CountryCode'
status:
type: string
enum: [PENDING,REJECTED]
example: "REJECTED"
description: the current status of the feed connection
error:
$ref: '#/components/schemas/Error'
Statements:
externalDocs:
url: 'https://developer.xero.com/documentation/bank-feeds-api/statements'
type: object
properties:
pagination:
$ref: '#/components/schemas/Pagination'
items:
type: array
items:
$ref: '#/components/schemas/Statement'
Pagination:
type: object
properties:
page:
type: integer
example: 1
description: Page number which specifies the set of records to retrieve. Example - https://api.xero.com/bankfeeds.xro/1.0/Statements?page=2 to get the second set of the records. When page value is not a number or a negative number, by default, the first set of records is returned.
pageSize:
type: integer
example: 10
description: Page size which specifies how many records per page will be returned (default 50). Example - https://api.xero.com/bankfeeds.xro/1.0/Statements?pageSize=100 to specify page size of 100.
pageCount:
type: integer
example: 1
description: Number of pages available
itemCount:
type: integer
example: 2
description: Number of items returned
Statement:
type: object
properties:
id:
type: string
format: uuid
example: "ba4f3127-5e46-427d-80ea-dea2fcd26afe"
description: GUID used to identify the Statement.
feedConnectionId:
type: string
format: uuid
example: "87cb0dc8-fa32-409c-b622-19f8de8dcc83"
description: The Xero generated feed connection Id that identifies the Xero Bank Account Container into which the statement should be delivered. This is obtained by calling GET FeedConnections.
status:
enum: ["PENDING","REJECTED","DELIVERED"]
example: "PENDING"
description: Current status of statements
startDate:
type: string
format: date
example: "2018-07-27"
description: Opening balance date (can be no older than one year from the current date) ISO-8601 YYYY-MM-DD
endDate:
type: string
format: date
example: "2018-07-27"
description: Closing balance date ISO-8601 YYYY-MM-DD
startBalance:
$ref: '#/components/schemas/StartBalance'
endBalance:
$ref: '#/components/schemas/EndBalance'
statementLines:
$ref: '#/components/schemas/StatementLines'
errors:
type: array
items:
$ref: '#/components/schemas/Error'
statementLineCount:
type: integer
example: 1
StartBalance:
description: The starting balance of the statement
type: object
properties:
amount:
type: number
format: double
x-is-money: true
example: "9.0000"
description: decimal(19,4) unsigned Opening/closing balance amount.
creditDebitIndicator:
$ref: '#/components/schemas/CreditDebitIndicator'
EndBalance:
description: The StartBalance plus all the Statement Line Amounts should be equal to the EndBalance Amount.
type: object
properties:
amount:
type: number
format: double
x-is-money: true
example: "10.1340"
creditDebitIndicator:
$ref: '#/components/schemas/CreditDebitIndicator'
StatementLines:
type: array
items:
$ref: '#/components/schemas/StatementLine'
StatementLine:
type: object
description: the lines details for a statement
properties:
postedDate:
type: string
format: date
example: "2018-06-10"
description: The date that the transaction was processed or cleared as seen in internet banking ISO-8601 YYYY-MM-DD
description:
type: string
example: "Description for statement line 2"
maximum: 2000
description: Transaction description
amount:
type: number
format: double
x-is-money: true
example: "5.00"
description: Transaction amount
creditDebitIndicator:
$ref: '#/components/schemas/CreditDebitIndicator'
transactionId:
type: string
example: "transaction-id-2"
description: Financial institute's internal transaction identifier. If provided this field is factored into duplicate detection.
payeeName:
type: string
example: "Payee name for statement line 2"
description: Typically the merchant or payee name
maximum: 255
reference:
type: string
example: "Reference for statement line 2"
description: Optional field to enhance the Description
maximum: 255
chequeNumber:
type: string
example: "021"
description: The cheque/check number
maximum: 20
Error:
type: object
description: On error, the API consumer will receive an HTTP response with a HTTP Status Code of 4xx or 5xx and a Content-Type of application/problem+json.
properties:
title:
type: string
maximum: 255
description: Human readable high level error description.
example: "Invalid Application"
status:
type: integer
description: The numeric HTTP Status Code, e.g. 404
example: 403
detail:
type: string
maximum: 255
description: Human readable detailed error description.
example: "The application has not been configured to use these API endpoints."
type:
type: string
description: Identifies the type of error.
enum:
- "invalid-request"
- "invalid-application"
- "invalid-feed-connection"
- "duplicate-statement"
- "invalid-end-balance"
- "invalid-start-and-end-date"
- "invalid-start-date"
- "internal-error"
- "feed-already-connected-in-current-organisation"
example: "invalid-application"
CreditDebitIndicator:
type: string
description: If the statement balances are credit or debit, the CreditDebitIndicator should be specified from the perspective of the Customer.
enum:
- CREDIT
- DEBIT
CurrencyCode:
description: 3 letter alpha code for the ISO-4217 currency code, e.g. USD, AUD.
example: "AUD"
type: string
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GGP
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- IMP
- INR
- IQD
- IRR
- ISK
- JEP
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRU
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SPL
- SRD
- STN
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TVD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND