-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
6240 lines (6214 loc) · 237 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Payment Order API
description: Initiates payment orders.
version: v1.44.15
x-api-status-urls: false
x-konfig-ignore:
object-with-no-properties: true
servers:
- url: https://TENANT_NAME.mambu.com/api/v1
tags:
- description: >
These endpoints are used for making and receiving SEPA credit transfers
through the Mambu Payment Gateway.
For more information on supported messages, flows and technical
information, including examples of generated XML messages and how the
fields map to these API requests, please refer to the [SEPA Credit
Transfer](https://support.mambu.com/docs/sepa-credit-transfers) section of
our User Guide.
name: SEPA Credit Transfers
- description: >
SEPA Direct Debit Payments are one time or recurring payments made using
the Single European Payment Area scheme for transactions made in Euros
between accounts at banks within the SEPA area, which includes all EU
countries as well as other territories such as Liechtenstein, Switzerland,
the United Kingdom, Andorra and Nordic countries.
Mambu supports both the Core SEPA rulebook for individuals and the B2B
scheme for companies. For more information on supported messages, flows
and technical information, please refer to the [SEPA Direct
Debit](https://support.mambu.com/docs/sepa-direct-debit) section of our
user guide.
name: SEPA Direct Debit
- description: >
These APIs allow you to submit inquiries for SEPA payments including for
cases where the customer claims to have not received the funds, the value
date was not correctly recorded or to request a status update for payments
which have been cancelled.
For more information on the types of inquiry supported and how to submit
and respond to inquiries via the Mambu Payment Gateway UI, please refer to
the relevant section of our User Guide, such as the [SEPA credit transfer
inquiries](https://support.mambu.com/docs/sct-inquiries) article for SEPA
credit transfers.
name: SEPA Credit Transfer Inquiries
- description: >-
The External Account Representation (EAR) endpoints are used to associate
IBANs with Mambu account IDs so that payments made using the Mambu Payment
Gateway are routed to the correct accounts.
An IBAN can be mapped to multiple accounts but can only be associated to
one account per currency, so, for example, the same IBAN can be mapped to
one underlying Mambu account using EUR, another using GBP and another
using CHF, but not to two accounts both in EUR denomination.
<aside class='notice'><strong>Please Note</strong><br>There is a short
delay for newly created accounts to be synced with the Mambu Payment
Gateway. This means that requests to the EAR endpoints may fail with an
<code>ACCOUNT_NOT_FOUND</code> error if made immediately following account
creation in Mambu. We recommend implementing a retry mechanism with
exponential backoff and low value for maximum number of retries if such an
error is received for an account which has just been created.</aside>
name: External Account Representation
- name: Standing Order
- description: >
If you are using an external service to check payments as part of your
Anti Money Laundering obligations, these endpoints receive responses which
will lead to unblocking funds and transferring them to the recipient
account in the case of an all clear or returning funds to the payer in
cases where there a compliance issue has been identified.
For more general information on AML flows, including how the necessary
suspense accounting should be set up in Mambu, please refer to the [AML
and Suspense
Accounts](https://support.mambu.com/docs/aml-suspense-accounting) section
of our User Guide.
name: AML
- description: >
This endpoint is the main entry point to the Mambu Payment Gateway for
external systems.
For more information on the types of messages accepted by this endpoint,
please refer to the [supported
flows](https://support.mambu.com/docs/payment-gateway-introduction#supported-flows)
section of the introduction to the Mambu Payment Gateway article in our
User Guide.
<aside class="note">
<strong>Please note</strong>
<p>
As this endpoint may be exposed to external systems, we strongly recommend
using a separate API key for each service calling this API. This is an
industry best practice and makes debugging easier, it also allows you to
rotate or invalidate keys for a particular service in cases of system
error or during security incidents.
</p>
</aside>
name: Incoming Messages
- description: >
Use this endpoint to search for SEPA Credit Transfer and Direct Debit
messages received by the Mambu Payment Gateway.
name: Search Messages
- name: CreditTransfer
- description: >
These endpoints allow you to configure settings for the Mambu Payment
Gateway such as setting callback URLs which will be notified on certain
actions.
name: Settings
paths:
/accounts/{accountId}/blocking-rules:
post:
tags:
- SEPA Direct Debit
operationId: SepaDirectDebit_addBlockingRule
description: >-
Request a blocking rule to be added to a specific Mambu account. When a
blocking rule has been added for a specific mandate ID, collection
requests for that mandate will be rejected and a pacs.002 message sent
as response with reason code MS02. If no specific mandate ID is
provided, all direct debit collection requests for the given account
will be rejected. For more information on blocking SEPA Direct Debits,
consult the [Blocking SEPA Direct
Debits](https://support.mambu.com/docs/blocking-sepa-direct-debits)
article in our user guide.
parameters:
- name: accountId
in: path
required: true
schema:
description: ID of the Mambu Deposit account.
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBlockingRule'
examples:
createProductBlockingRule:
summary: >-
Request blocking all SEPA Direct Debits for the specified
account.
description: createProductBlockingRule
value:
product: SEPA_DIRECT_DEBIT
createCeditorMandateBlockingRule:
summary: >-
Request blocking SEPA Direct Debits for a specific mandate for
the specified account.
description: createCeditorMandateBlockingRule
value:
product: SEPA_DIRECT_DEBIT
creditorMandate:
mandateRelatedInformation:
mandateIdentification: '578798984'
creditorSchemeIdentification:
identification:
privateIdentification: ID777444887
responses:
'202':
description: Accepted - The Blocking Rule has been prepared for processing.
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
productCannotBeBlocked:
summary: Specified payment product cannot be blocked.
description: productCannotBeBlocked
value:
tppMessages:
- category: ERROR
code: PARAMETER_NOT_SUPPORTED
path: product
text: SEPA_CREDIT_TRANSFER cannot be blocked
'405':
description: >-
Method Not Allowed - This code is only sent when the HTTP method
(PUT, POST, DELETE, GET etc.) is not supported by a specific
endpoint. It has nothing to do with the content, payment or account
information data model.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
unsupportedHttpMethod:
summary: The request was submitted with an unsupported HTTP method.
description: unsupportedHttpMethod
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'415':
description: >-
Unsupported Media Type - A media type which the serves does not
support has been supplied.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
unsupportedContentType:
summary: >-
The request was submitted with an unsupported content type.
For example "application/xml" instead of "application/json".
description: unsupportedContentType
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
delete:
tags:
- SEPA Direct Debit
operationId: SepaDirectDebit_removeBlockingRules
description: >-
Request deletion of blocking rules for the specified Mambu account. If
no request body is provided, all rules for the account will be removed,
if you provide a JSON body with a specific mandate ID, only the rule for
that mandate will be removed. For more information on blocking SEPA
Direct Debits, consult the [Blocking SEPA Direct
Debits](https://support.mambu.com/docs/blocking-sepa-direct-debits)
article in our user guide.
parameters:
- name: accountId
in: path
required: true
schema:
description: ID of the Mambu Deposit account.
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteBlockingRule'
examples:
deleteAllBlockingRules:
summary: Delete all blocking rules for the specified account.
description: deleteAllBlockingRules
value: null
deleteProductBlockingRule:
summary: Delete product blocking rule for the specified account.
description: deleteProductBlockingRule
value:
product: SEPA_DIRECT_DEBIT
deleteCreditorMandateBlockingRule:
summary: >-
Delete creditor mandate blocking rule for the specified
account.
description: deleteCreditorMandateBlockingRule
value:
product: SEPA_DIRECT_DEBIT
creditorMandate:
mandateRelatedInformation:
mandateIdentification: '578798984'
creditorSchemeIdentification:
identification:
privateIdentification: ID777444887
responses:
'202':
description: >-
Accepted - Blocking rules for the specified account have been
submitted for deletion.
'405':
description: >-
Method Not Allowed - This code is only sent when the HTTP method
(PUT, POST, DELETE, GET etc.) is not supported by a specific
endpoint. It has nothing to do with the consent, payment or account
information data model.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
unsupportedHttpMethod:
summary: The request was submitted with an unsupported HTTP method.
description: unsupportedHttpMethod
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'415':
description: >-
Unsupported Media Type - A media type which the serves does not
support has been supplied.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
unsupportedContentType:
summary: >-
The request was submitted with an unsupported content type.
For example "application/xml" instead of "application/json".
description: unsupportedContentType
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/accounts/{accountId}/identifications:
get:
tags:
- External Account Representation
operationId: ExternalAccountRepresentation_getIdentifications
description: >-
Gets associations of an external account identification (IBAN or
proprietary) to a Mambu Account.
parameters:
- name: accountId
in: path
required: true
schema:
type: string
- name: limit
in: query
schema:
description: >-
Limit the number of identifications retrieved. The default limit
is 50, can be specified up to 1000.
maximum: 1000
minimum: 1
type: integer
format: int32
default: 50
- name: offset
in: query
schema:
description: >-
Offset determines how many records will be skipped before being
included in the returned results. The default offset value is 0.
minimum: 0
type: integer
format: int64
default: 0
responses:
'200':
description: OK - List existing external identifications.
headers:
Items-Offset:
description: The index of the first returned item.
required: true
style: simple
schema:
type: integer
Items-Limit:
description: The requested page size.
required: true
style: simple
schema:
type: integer
Items-Total:
description: The total count of available items.
required: true
style: simple
schema:
type: integer
content:
application/json:
schema:
$ref: >-
#/components/schemas/ExternalAccountRepresentationGetIdentificationsResponse
examples:
Identification:
summary: List of identifications
description: Identification
value:
- iban: DE46606951125202071272
- currency: USD
- other:
identification: ABCDE1234F
scheme: PAN
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
post:
tags:
- External Account Representation
operationId: ExternalAccountRepresentation_addIdentificationAssociation
description: >-
Adds association of an external account identification (IBAN or
proprietary) to a Mambu Account. The currency of the association will be
the one of the underlining Mambu account. If an IBAN is supposed to be a
multi-currency one, this API needs to be invoked multiple times with
different Mambu accounts (for the different currencies).
parameters:
- name: accountId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAccountMapping'
examples:
createMambuAccountMapping:
summary: >-
Create mapping between a proprietary identification and a
Mambu Account
description: createMambuAccountMapping
value:
identification:
other:
identification: ABCDE1234F
scheme: PAN
iban: DE46606951125202071272
currency: USD
responses:
'201':
description: Created - Association successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/AccountMappingResponse'
examples:
accountMappingResponse:
summary: Successful account identification request.
description: accountMappingResponse
value: {}
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
invalidIdentification:
summary: IBAN is not valid.
description: invalidIdentification
value:
tppMessages:
- category: ERROR
code: FORMAT_ERROR
path: iban
text: iban size must be between 15 and 34
- category: ERROR
code: FORMAT_ERROR
path: iban
text: iban invalid IBAN value
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/accounts/identifications:
put:
tags:
- External Account Representation
operationId: ExternalAccountRepresentation_associateIban
description: >-
Create or replace associations of an external account identification
(IBAN or proprietary) to one of Mambu Accounts. The currency of the
association will be the one of the underlining Mambu account.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAccountMappings'
examples:
createMambuAccountMappings:
summary: >-
Create mapping between a proprietary identification and
multiple Mambu Accounts with different currencies
description: createMambuAccountMappings
value: |-
{
"identification": {
"iban": "DE46606951125202071272"
},
"accountIds": [
"123",
]
}
responses:
'201':
description: Created - Association successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/AccountMappingResponse'
examples:
accountMappingResponse:
summary: Successful account identification request.
description: accountMappingResponse
value: {}
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
invalidIdentification:
summary: IBAN is not valid.
description: invalidIdentification
value:
tppMessages:
- category: ERROR
code: FORMAT_ERROR
path: iban
text: iban size must be between 15 and 34
- category: ERROR
code: FORMAT_ERROR
path: iban
text: iban invalid IBAN value
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/accounts/identifications:search:
post:
tags:
- External Account Representation
operationId: ExternalAccountRepresentation_searchIdentifications
description: >-
Searches identifications (with MambuID included) based on provided
filter criteria
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountIdentificationsSearchRequestDTO'
responses:
'200':
description: OK - List of found identifications with accountId
content:
application/json:
schema:
$ref: >-
#/components/schemas/ExternalAccountRepresentationSearchIdentificationsResponse
examples:
AccountIdentificationsSearchResponse:
summary: Successful account identification search response.
description: AccountIdentificationsSearchResponse
value:
- accountId: test123
currency: EUR
type: DEPOSIT
identification:
iban: DE46606951125202071272
identification: ABCDE1234F
scheme: PAN
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
invalidSearchFilter:
summary: Search filter is not valid
description: invalidSearchFilter
value:
tppMessages:
- category: ERROR
code: FORMAT_ERROR
path: >-
searchAccountIdentifications.arg0.filterCriteria[0].field
text: >-
filterCriteria[0].field Should be one of: schema,
iban, currency, identification
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/TppMessagesResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/collections:
post:
tags:
- SEPA Direct Debit
operationId: SepaDirectDebit_createCollectionInitiationRequest
description: >-
Creates a collection initiation request. This covers the flows as
described in the [SEPA Direct
Debit](https://support.mambu.com/docs/sepa-direct-debit-creditor-flow)
section of our user guide.
parameters:
- name: X-Request-ID
in: header
required: true
schema:
description: >-
ID of the request, unique to the call, as determined by the
initiating party.
type: string
- name: Idempotency-Key
in: header
schema:
description: >-
Prevents retried requests to be executed multiple times.
Subsequent requests with the same Idempotency Key will not be
processed and will return a cached result.
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionDTO'
examples:
initiateCollectionRequest:
summary: >-
Initiate collection request for accounts identified by IBAN
and creditor agent identified by BIC.
description: initiateCollectionRequest
value:
debtorAccount:
identification:
iban: DE46606951125202071272
currency: EUR
debtorName: John Doe
serviceLevel: SEPA
instructedAmount:
currency: EUR
amount: '500'
creditorAccount:
identification:
iban: DE16195554277485442959
currency: EUR
creditorName: Merchant123
paymentIdentification:
transactionIdentification: 113T9bs6ad48ga1216d772430401s01sd2
requestedExecutionDate: '2020-09-01'
mandateRelatedInformation:
mandateIdentification: 16ead91c975c4881a60c
dateOfSignature: '2020-01-31'
paymentTypeInformation:
sequenceType: FRST
creditorSchemeIdentification:
identification:
privateIdentification: I48799148795
responses:
'201':
description: >-
Created - Collection Initiation request was correctly performed (but
not yet accepted) nor executed.
headers:
Location:
description: >-
Location of the created collection order request resource, for
future reference or status polling.
required: true
style: simple
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionResponse'
examples:
initiateCollectionResponse:
summary: Successful collection initiation response.
description: initiateCollectionResponse
value:
transactionStatus: RCVD
collectionId: e38458a4-d955-4a39-8e21-9608e9600b3d
'400':
description: >-
Bad Request - Validation error occurred. This code will cover
malformed syntax in request or incorrect data in payload.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
missingMandatoryField:
summary: Identification for debtor account was not provided.
description: missingMandatoryField
value:
tppMessages:
- category: ERROR
code: FORMAT_ERROR
path: debtorAccount.identification
text: debtorAccount.identification may not be null
'405':
description: >-
Method Not Allowed - This code is only sent when the HTTP method
(PUT, POST, DELETE, GET etc.) is not supported on a specific
endpoint. It has nothing to do with the content, payment or account
information data model.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
unsupportedHttpMethod:
summary: The request was submitted with an unsupported HTTP method.
description: unsupportedHttpMethod
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'415':
description: >-
Unsupported Media Type - A media type which the serves does not
support has been supplied.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
unsupportedContentType:
summary: >-
The request was submitted with an unsupported content type.
For example "application/xml" instead of "application/json".
description: unsupportedContentType
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'500':
description: Internal Server Error - Internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/FailedPaymentResponse'
examples:
internalServerError:
summary: The request failed due to an internal server error.
description: internalServerError
value:
tppMessages:
- category: ERROR
code: SERVICE_INVALID
text: >-
There was an error processing your request. It has
been logged (ID a449ea6319107e42).
'503':
description: >-
Service Unavailable - The server is currently unavailable.
Generally, this is a temporary state.
/log:
post:
tags:
- External Account Representation
operationId: ExternalAccountRepresentation_createOrUpdateLog
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogRequest'
required: true
responses:
default:
description: default response
content:
application/json:
schema:
$ref: >-
#/components/schemas/ExternalAccountRepresentationCreateOrUpdateLogResponse
/payments/financial-institution-credit-transfers:
post:
tags:
- CreditTransfer
operationId: CreditTransfer_submitPaymentRequest
parameters:
- name: X-Request-ID
in: header
required: true
schema:
description: >-
ID of the request, unique to the call, as determined by the
initiating party.
type: string
- name: Idempotency-Key
in: header
schema:
description: >-
Prevents retried requests to be executed multiple times.
Subsequent requests with the same Idempotency Key will not be
processed and will return a cached result.
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FinancialInstitutionPaymentDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: >-
#/components/schemas/CreditTransferSubmitPaymentRequestResponse
/payments/credit-transfers:
post:
tags:
- SEPA Credit Transfers
operationId: SepaCreditTransfers_createRequest
parameters:
- name: X-Request-ID
in: header
required: true
schema:
description: >-
ID of the request, unique to the call, as determined by the
initiating party.
type: string
- name: Idempotency-Key
in: header
schema:
description: >-
Prevents retried requests to be executed multiple times.
Subsequent requests with the same Idempotency Key will not be
processed and will return a cached result.
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Iso20022PaymentDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/SepaCreditTransfersCreateRequestResponse'
/payments:
post:
tags:
- SEPA Credit Transfers
operationId: SepaCreditTransfers_createPaymentRequest
description: >-
Creates a payment initiation request. Payments using the SEPA Credit
Transfer scheme can only be created for the current date. A pacs.008
message will be generated from the data provided in this request. For
more information on how these fields map to SEPA XML messages, refer to
the [SEPA Credit Transfer Techincal
Information](https://support.mambu.com/docs/sepa-credit-transfer-technical-information#pacs00800102)
article in our user guide.
parameters:
- name: X-Request-ID
in: header
required: true
schema:
description: >-
ID of the request, unique to the call, as determined by the
initiating party.
type: string
- name: Idempotency-Key
in: header
schema:
description: >-
Prevents retried requests to be executed multiple times.
Subsequent requests with the same Idempotency Key will not be
processed and will return a cached result.