-
Notifications
You must be signed in to change notification settings - Fork 5
/
swagger.yml
1712 lines (1697 loc) · 54.2 KB
/
swagger.yml
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
swagger: '2.0'
info:
description: Twikey API
version: 1.0.0
title: Twikey API
contact:
name: "Twikey Support"
url: "https://www.twikey.com"
email: "[email protected]"
host: api.twikey.com
basePath: /
tags:
- name: General
- name: Mandates
description: Mandate related endpoints
- name: Transactions
description: Transaction related endpoints
- name: Collections
description: Collection related endpoints
- name: Credit Transfer
description: Credit Transfer related endpoints
- name: Identification
description: Identity related endpoints
produces:
- application/xml
- application/json
schemes:
- https
securityDefinitions:
session_key:
type: apiKey
name: Authorization
in: header
description:
Using the "API Token" to retrieve a session based "AuthorizationToken"
paths:
/creditor:
post:
tags:
- General
summary: Login
description:
>
Requires an **API Token** which can be found in the Twikey Creditor Dashboard under Settings/Api Integration.
When using the API the login call will provide you with an AuthorizationToken, which is to be send upon every subsequent call (via the authorization header) in order to use the api.
This AuthorizationToken acts as a session token and has a validity of 24h.
If the creditor opted for enhanced security, the private key allows the generation of a Time-based One-time password.
See <a href="/r/admin/doc/api#appendix-c-calculation-of-the-otp-by-the-swp">Appendix C of the Creditor API documentation</a> for a more detailed explanation or sample code on how to calculate this OTP (samples in various languages are available).
operationId: postCreditor
consumes:
- application/x-www-form-urlencoded
parameters:
- name: apiToken
in: formData
description: ERP API Token
required: true
type: string
x-example: 5845FD1A3D1A9915EA9C879BAF6D1DDE5B457143
- name: otp
in: formData
description: Value calculated based on salt and private key (if enhanced security)
required: false
type: integer
format: int64
responses:
'200':
description: >
For security reasons, the http status is ** always ** 200, however for returning error codes specific to the call
2 additional response headers were added "ApiError" and "ApiErrorCode" which are added on every response that contains errors.
Notible exceptions are authentication errors and authorisation errors that don't have these 2 headers.
examples:
Valid token:
{
"Authorization":"mysessiontoken"
}
get:
tags:
- General
summary: Logout
description: Invalidates the AuthorizationToken by making a GET request to /creditor
operationId: getCreditor
security:
- session_key : []
responses:
'204':
description: Logged out succesfully
/creditor/mandate:
get:
summary: Update Feed
description: >
Returns a List of all updated mandates (new, changed or cancelled) **since the last call. **
From the moment there are changes (eg. a new contract/mandate or an update of an existing contract)
this call provides all related information to the creditor. The service is initiated by the creditor
and provides all MRI information (and extra metadata) to the creditor. This call can either be triggered by a callback
once a change was made or periodically when no callback can be made.
This information can serve multiple purposes:
* Updating a CRM system to take appropriate actions (eg. call the customer on cancel..)
* Integrate the info in an ERP system to create the correct SDD files (in case of mandates)
In order too avoid polling, a hook can be setup to notify the client when new information is available.
This hook can be configured in the settings > erp section.
operationId: getCreditorMandate
tags:
- Mandates
security:
- session_key : []
consumes:
- application/x-www-form-urlencoded
parameters:
- name: chunkSize
in: query
description: Amount of mandates to return per call (max 100)
required: false
type: integer
format: int64
default: 100
responses:
'200':
description: The request has succeeded
schema:
$ref: '#/definitions/MandateResponse'
examples:
Example stream:
{
"GrpHdr": {
"CreDtTm": "2015-08-20T13:02:03Z"
},
"Messages": [
{
"EvtTime": "2015-06-23T11:31:51Z",
"Mndt": {
"Cdtr": {
"CtctDtls": {
"EmailAdr": "[email protected]"
},
"CtryOfRes": "BE",
"Id": "BE0533800797",
"Nm": "Twikey N.V.",
"PstlAdr": {
"AdrLine": "Veldstraat 11",
"Ctry": "BE",
"PstCd": "9000",
"TwnNm": "Gent"
}
},
"CdtrSchmeId": "BE54ZZZ0533800797",
"Dbtr": {
"CtctDtls": {
"EmailAdr": "[email protected]"
},
"CtryOfRes": "BE",
"Id": "BE123456789",
"Nm": "debtorCompany Inc.",
"PstlAdr": {
"AdrLine": "Street 52",
"Ctry": "BE",
"PstCd": "1000",
"TwnNm": "Brussels"
}
},
"DbtrAcct": "BE493104522",
"DbtrAgt": {
"FinInstnId": {
"BICFI": "BBRUBEBB",
"Nm": "ING BELGIUM NV/SA"
}
},
"LclInstrm": "CORE",
"MaxAmt": "0",
"MndtId": "1600650622",
"Ocrncs": {
"Drtn": {
"FrDt": "2015-06-13"
},
"Frqcy": "ADHO",
"SeqTp": "RCUR"
},
"RfrdDoc": "1000",
"SplmtryData": [
{
"Key": "SignerPlace#0",
"Value": "Brussels"
},
{
"Key": "SignerDate#0",
"Value": "2015-06-22T21:00:00Z"
}
]
}
}
]
}
post:
tags:
- Mandates
summary: Import
description: Import existing mandates (or updates)
operationId: postCreditorMandate
security:
- session_key : []
consumes:
- application/xml
- application/json
parameters:
- name: Mandates
in: body
description: All mandate updates like in fetch (json)
required: true
schema:
$ref: '#/definitions/MandateResponse'
responses:
'204':
description: Batch import of mandates was fully done or not at all
delete:
tags:
- Mandates
summary: Cancel
description: >
A contract can be cancelled by either debtor or creditor, this can be
done via the website or the api. However, there may be circumstances in
which the creditor receives the cancel **not** through Twikey. In order to avoid extra costs & stale
information, Twikey requires the update of its systems. The creditor, the
creditor bank or the debtor bank, can initiate this
request. Afterwards the update is distributed to all parties.
operationId: deleteCreditorMandate
security:
- session_key : []
consumes:
- application/x-www-form-urlencoded
parameters:
- name: mndtId
in: query
description: Mandate Reference
required: true
type: string
- name: rsn
in: query
description: Reason of cancellation
required: true
type: string
responses:
200:
description: The request has succeeded
400:
description: >
User error, error code can be found in ApiError response header, translated value can be found in the body
eg.
* No contract was selected or invalid mndtId supplied
* Contract had wrong status (eg. already cancelled) or not authorised
* No contract was selected or mandate not found
* Please provide reason
/creditor/mandate/detail:
get:
tags:
- Mandates
summary: Mandate Details
description: Retrieve details of a specific mandate
operationId: getCreditorMandateDetails
security:
- session_key : []
consumes:
- application/x-www-form-urlencoded
parameters:
- name: mndtId
in: query
description: Mandate Reference
required: true
type: string
- name: force
in: query
description: Also include non-signed states
required: false
type: boolean
responses:
'200':
description: Details of the mandate (see /creditor/mandate)
/creditor/customeraccess:
post:
tags:
- Mandates
summary: Customer access
description: Allow debtor access to a specific mandate
operationId: CustomerAccess
security:
- session_key : []
consumes:
- application/x-www-form-urlencoded
parameters:
- name: mndtId
in: query
description: Mandate Reference
required: true
type: string
responses:
'200':
description: Link valid for 2min. allowing debtor access to the mandate
/creditor/mandate/update:
post:
tags:
- Mandates
summary: Update
description: >
Sometimes sending in the complete mandate is overkill and sending just
the updated information is a lot easier by just passing the updated information. This endpoint allows to update
account, address, email, phone information and plan.
operationId: postCreditorMandateUpdate
security:
- session_key : []
consumes:
- application/x-www-form-urlencoded
parameters:
- name: mndtId
in: query
description: Mandate Reference
required: true
type: string
- name: iban
in: query
required: false
type: string
- name: bic
in: query
required: false
type: string
- name: address
in: query
description: Street (street + number)
required: false
type: string
- name: zip
in: query
required: false
type: string
- name: city
in: query
required: false
type: string
- name: country
in: query
description: Country (ISO 2 letters)
required: false
type: string
- name: mobile
in: query
description: International format +32499123445
required: false
type: string
- name: email
in: query
required: false
type: string
responses:
204:
description: 'The server has fulfilled the request but does not need to return an entity-body, and might want to return updated meta-information'
400:
description: >
User error, error code can be found in ApiError response header, translated value can be found in the body
eg.
* No contract was selected or invalid mndtId supplied
* Mandates are editable only when in Prepared/Print state or CORE or not authorised
* No contract was selected or mandate not found
/creditor/mandate/plan:
post:
tags:
- Mandates
summary: Update a plan
description: >
Sometimes a plan on an existing mandate needs to be updated.
This endpoint allows to update a plan, just by passing the data for the new plan.
operationId: postCreditorMandatePlan
security:
- session_key : []
consumes:
- application/x-www-form-urlencoded
parameters:
- name: mndtId
in: query
description: Mandate Reference
required: true
type: string
- name: plan
in: query
description: Name of the plan
required: true
type: string
- name: _pls
in: query
required: false
type: string
description: Startdate of the plan
- name: _pli
in: query
required: false
type: string
description: Possible values are 1w, 2w, 1m, 2m, 3m, 4m, 6m, 12m
- name: _plo
in: query
required: false
type: string
description: Day of the interval on which the plan must be executed
- name: _plt
in: query
required: false
type: string
description: Number of times the plan must be executed
- name: _pla
in: query
required: false
type: string
description: Amount associated to the plan
- name: _pld
in: query
required: false
type: string
description: Message associated to the plan
responses:
204:
description: 'The server has fulfilled the request but does not need to return an entity-body, and might want to return updated meta-information'
400:
description: >
User error, error code can be found in ApiError response header, translated value can be found in the body
eg.
* The plan parameter was not provided or an invalid planparameter supplied
* Mandates are editable only when in Prepared/Print state or CORE or not authorised
* No contract was selected or mandate not found
/creditor/mandate/pdf:
get:
tags:
- Mandates
summary: Retrieve pdf
description: Retrieve pdf of a mandate
operationId: getCreditorMandatePdf
security:
- session_key : []
consumes:
- application/x-www-form-urlencoded
produces:
- application/pdf
parameters:
- name: mndtId
in: query
description: Mandate Reference
required: true
type: string
responses:
'200':
description: PDF is available in the body of the response
post:
tags:
- Mandates
summary: Upload pdf
description: Import existing mandate pdf (eg. scan of a printed document)
operationId: postCreditorMandatePdf
security:
- session_key : []
consumes:
- application/pdf
parameters:
- name: mndtId
in: query
description: Mandate Reference
required: true
type: string
responses:
'200':
description: Import of the pdf was done
/creditor/invite:
post:
tags:
- Mandates
summary: Invite
description: Necessary to start with an eMandate. The end-result is a signed or protected shortlink that will allow the end-customer to sign a mandate. The (short)link can be embedded in your website or in an email or in a paper letter. We advise to use the shortlink as the data is not exposed in the URL's. The parameters are as described in
<a href="/r/admin/doc/api#6-prepare-contract-or-url">Prepare Contracts</a>.
operationId: postCreditorPrepare
security:
- session_key : []
consumes:
- application/x-www-form-urlencoded
parameters:
- name: ct
in: formData
description: Contract template to use
required: true
type: integer
- name: l
in: formData
description: Language (en/fr/nl/de/pt/es/it)
required: false
type: string
- name: iban
in: formData
required: false
type: string
- name: bic
in: formData
required: false
type: string
- name: mandateNumber
in: formData
description: Mandate Identification number (if not generated)
required: false
type: string
- name: email
in: formData
required: true
type: string
- name: lastname
in: formData
required: false
type: string
- name: firstname
in: formData
required: false
type: string
- name: mobile
in: formData
description: mobile number required for sms (International format +32499123445)
required: false
type: string
- name: address
in: formData
description: Address (street + number)
required: false
type: string
- name: city
in: formData
required: false
type: string
- name: zip
in: formData
required: false
type: string
- name: country
in: formData
required: false
description: ISO format (2 letters)
type: string
- name: companyName
in: formData
description: the company name (if debtor is company)
required: false
type: string
- name: vatno
in: formData
description: the enterprise number (if debtor is company)
required: false
type: string
- name: form
in: formData
description: the legal form of the company (if debtor is company)
required: false
type: string
- name: contractNumber
in: formData
description: the contract number which can override the one defined in the template.
required: false
type: string
- name: campaign
in: formData
description: Campaign to include this url in
required: false
type: string
- name: prefix
in: formData
description: Optional prefix to use in the url (default companyname)
required: false
type: string
- name: check
in: formData
description: If an existing mandate exists, don't prepare a new (based on email + template(=ct))
required: false
type: boolean
- name: amount
in: formData
description: Amount of the transaction to put on the mandate after it's signed
required: false
type: number
- name: sendInvite
in: formData
description: Send out invite email directly
required: false
type: boolean
- name: reminderDays
in: formData
description: Send a reminder if contract was not signed after number of days
required: false
type: number
responses:
'200':
description: >
If the check option is provided and an existing mandate is available it will be returned.
Otherwise an url and key will be returned.
examples:
New agreement:
{
"url": "http://twikey.to/mycompany/xlBF",
"key": "xlBF",
"mndtId": "Comp71"
}
Existing (Valid) with check enabled:
{
"mndtId": "Comp71"
}
/creditor/ident:
get:
tags:
- Identification
summary: Bank Retrieval
description: Allow retrieving possible banks for a certain mechanisms
operationId: identFetch
security:
- session_key : []
consumes:
- application/x-www-form-urlencoded
parameters:
- name: ct
in: formData
description: Contract template to use
required: true
type: integer
- name: method
in: formData
description: Mechanism to be used
required: false
type: string
responses:
'200':
description: >
examples:
{
"Options": [
{
"Bic": "ABNANL2A",
"Name": "ABNAmro"
},
{
"Bic": "RABONL2U",
"Name": "RABOBANK"
},
{
"Bic": "INGBNL2A",
"Name": "ING"
}
]
}
post:
tags:
- Identification
summary: Identification
description: Allow retrieving authentication url's for different mechanisms
operationId: identPrepare
security:
- session_key : []
consumes:
- application/x-www-form-urlencoded
parameters:
- name: ct
in: formData
description: Contract template to use
required: true
type: integer
- name: method
in: formData
description: Mechanism to be used
required: false
type: string
- name: bic
in: formData
required: false
type: string
- name: token
in: formData
description: Optional token to be returned when the user is redirected to the exit url
required: false
type: string
responses:
'200':
description: >
Url to redirect to for authenticating the user
examples:
{
"url": "https://www.bank.nl/some_parameters"
}
/creditor/sign:
post:
tags:
- Mandates
summary: Create and sign
description: >
Create a contract with an invitation/signature directly via API. Note that this call can require different parameters depending on the method of signature.
All parameters are described in <a href="/r/admin/doc/api#12-direct-signature-of-a-core-mandate">Create contracts</a>
When enabled for your contract it is possible to negiotiate mandates with their signature directly via API. Depending on
the method the set of required parameters and/or handling may differ.
Methods currently supported :
* sms: require the mobile parameter
* digisign a base64 encoded png should be provided as payload. (max 150 k)
* Challenge/Response
operationId: postCreditorSign
security:
- session_key : []
consumes:
- application/x-www-form-urlencoded
parameters:
- name: signDate
in: formData
description: 'Date of signature (xsd:dateTime / yyyy-mm-dd), sms uses date of reply '
required: false
type: string
- name: method
in: formData
description: Method to sign (sms or digisign)
required: false
type: string
- name: l
in: formData
description: Language (en/fr/nl/de/pt/es/it)
required: false
type: string
- name: place
in: formData
description: Place of signature
required: false
type: string
- name: ct
in: formData
description: Contract template to use
required: false
type: number
- name: iban
in: formData
required: true
type: string
- name: bic
in: formData
required: true
type: string
- name: mandateNumber
in: formData
description: Mandate Identification number (if not generated)
required: false
type: string
- name: email
in: formData
required: false
type: string
- name: lastname
in: formData
required: false
type: string
- name: firstname
in: formData
required: false
type: string
- name: mobile
in: formData
description: mobile number required for sms (International format +32499123445)
required: false
type: string
- name: address
in: formData
description: Address (street + number)
required: false
type: string
- name: city
in: formData
required: false
type: string
- name: zip
in: formData
required: false
type: string
- name: country
in: formData
required: false
description: ISO format (2 letters)
type: string
- name: companyName
in: formData
description: the company name (if debtor is company)
required: false
type: string
- name: vatno
in: formData
description: the enterprise number (if debtor is company)
required: false
type: string
- name: form
in: formData
description: the legal form of the company (if debtor is company)
required: false
type: string
- name: contractNumber
in: formData
description: the contract number which can override the one defined in the template.
required: false
type: string
responses:
'200':
description: The request has succeeded
examples:
New valid agreement:
{
"Msg": "OK",
"MndtId": "MyMandateId"
}
/creditor/legal:
get:
tags:
- Mandates
summary: Retrieve legal terms
description: Retrieve legal terms
operationId: getCreditorLegal
security:
- session_key : []
consumes:
- application/x-www-form-urlencoded
parameters:
- name: locale
in: query
description: eg. nl, nl_NL, nl_BE, de, fr, fr_LU
required: false
type: string
responses:
'200':
description: The request has succeeded
examples:
Legal terms:
{
"bySigning": "By signing this mandate ....",
"rightsCore": "As part of your rights, ....",
"rightsB2b": "This mandate is only intended...",
"infoCorrect": "By signing this document ..."
}
/creditor/transaction:
post:
tags:
- Transactions
summary: New transaction
description: Add transaction to an existing mandate
operationId: postCreditorBilling
security:
- session_key : []
consumes:
- application/x-www-form-urlencoded
parameters:
- name: mndtId
in: formData
description: Mandate Reference
required: true
type: string
- name: date
in: formData
description: Date of the billable event or now when empty
required: false
type: string
x-example: 'Date of purchase (xsd:dateTime / yyyy-mm-dd)'
- name: reqcolldt
in: formData
description: Requested date of the billable event
required: false
type: string
x-example: 'Date of purchase (xsd:dateTime / yyyy-mm-dd)'
- name: message
in: formData
description: Message to the customer (if only 1 entry)
required: true
type: string
- name: ref
in: formData
description: Your reference
required: false
type: string
- name: amount
in: formData
description: Amount to be billed
required: true
type: string
- name: place
in: formData
description: Optional place
required: false
type: string
responses:
'200':
description: The request has succeeded
examples:
Newly added transaction:
{
"Entries": [
{
"id": 86860,
"contractId": 52152,
"mndtId": "TWIKEYCORE71",
"contract": "Contractnumber Twikey",
"amount": 10.0,
"msg": "test",
"place": null,
"reqcolldt": "2016-02-03",
"date": "2016-02-03T07:11:43Z"
}
]
}
put:
tags:
- Transactions
summary: Update a transaction
description: Update parameters for an existing transaction.
operationId: updateTransaction
security:
- session_key : []
consumes:
- application/x-www-form-urlencoded
parameters:
- name: id
in: formData
description: Transaction id
required: true
type: string
- name: amount
in: formData
description: Amount to be billed
required: false
type: string
- name: reqcolldt
in: formData
description: Requested date of the billable event
required: false
type: string
x-example: 'Date of purchase (xsd:dateTime / yyyy-mm-dd)'
- name: message
in: formData
description: Message to the customer (if only 1 entry)
required: false
type: string
- name: place
in: formData
description: Optional place
required: false
type: string
- name: ref
in: formData
description: Your reference
required: false
type: string
responses:
'200':
description: The request has succeeded
'400':
description: User error if parameter is given but not valid
delete:
tags:
- Transactions
summary: Remove a transaction
description: Remove a transaction that wasn't collected yet
operationId: deleteCreditorTransactions
consumes:
- application/x-www-form-urlencoded
security:
- session_key : []
parameters:
- name: id
in: query
description: a transactionId as returned in the post
required: false
type: string
- name: mndtId
in: query
description: all open transactions linked to the mandateReference
required: false
type: string
- name: ref
in: query
description: transactionReference as provided in the post to be removed
required: false
type: string
responses:
'204':
description: The request has succeeded
get:
tags:
- Transactions
summary: Transaction feed
description: Retrieve feed of updated transactions.
operationId: getCreditorTransactions
consumes:
- application/x-www-form-urlencoded