-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
3554 lines (3554 loc) · 119 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.0
info:
title: Nuapay TPP API Specification
description: >-
Swagger Spec for the Nuapay TPP OpenBanking/PSD2. Provides PISP and Banks
Endpoints
version: 1.16.1
contact:
name: Nuapay
email: api.support@nuapay.com
license:
name: Nuapay
url: https://sentenial.com
x-logo:
backgroundColor: '#FFFFFF'
url: https://www.nuapay.com/wp-content/uploads/2018/04/nuapay.svg
servers:
- url: https://api.nuapay.com/tpp
tags:
- description: |-
Payment initiation endpoints allow a merchant to,
- Initiate payment requests in Open Banking
- Retrieve the status of a previously initiated payment request
name: PISP Service
- description: |-
Bank endpoints allow a merchant to,
- Retrieve a list of banks that support the Open Banking scheme
- View details of a specific bank that supports the Open Banking scheme
name: Bank Service
paths:
/bankfamilies:
get:
tags:
- Bank Service
summary: View Bank Families
operationId: BankService_viewBankFamilies
security:
- MerchantOAuth2:
- openbanking_aisp
- openbanking_pisp
- MerchantApiKey: []
- PartnerOAuth2:
- openbanking_aisp
- openbanking_pisp
- PartnerApiKey: []
description: Get list of Bank Families
parameters:
- description: Page number
name: pagenumber
in: query
required: false
schema:
type: integer
format: int32
default: 1
- description: Page size
name: pagesize
in: query
required: false
schema:
type: integer
format: int32
default: 20
- name: supportedcurrencies
in: query
required: false
explode: true
schema:
type: array
items:
type: string
enum:
- EUR
- GBP
- PLN
- BGN
- HRK
- CZK
- DKK
- HUF
- RON
- SEK
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedListBankFamiliesResponseEnvelope'
examples:
response:
value:
uri: /bankFamilies
data:
- id: 8ww64y0phx
uri: /bankFamilies/8ww64y0phx
name: Nuapay France
logo: >-
https://www.nuapay.com/wp-content/uploads/2018/04/nuapay.svg
supportedCurrencies:
- EUR
- id: 1xf48y2zds
uri: /bankFamilies/1xf48y2zds
name: Nuapay UK
logo: >-
https://www.nuapay.com/wp-content/uploads/2018/04/nuapay.svg
supportedCurrencies:
- GBP
page:
pageNumber: 1
pageSize: 10
totalElements: 2
totalPages: 1
sort: []
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: T0000
returnDescription: Validation errors occurred. Please see details.
details:
description: Page is invalid
code: T0001
field: page
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'429':
description: Too Many Requests
x-sentenial:
enriched: 'true'
headers:
Retry-After:
description: Number in seconds to wait
schema:
type: integer
format: int32
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
/bankfamilies/{bankfamilyId}:
get:
tags:
- Bank Service
summary: View Bank Family
operationId: BankService_getBankFamily
security:
- MerchantOAuth2:
- openbanking_aisp
- openbanking_pisp
- MerchantApiKey: []
- PartnerOAuth2:
- openbanking_aisp
- openbanking_pisp
- PartnerApiKey: []
description: View Bank Family Details
parameters:
- description: Bank Family id returned by Get Bank Families endpoint.
name: bankfamilyId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BankFamilyResponseEnvelope'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: T0000
returnDescription: Validation errors occurred. Please see details.
details:
description: Page is invalid
code: T0001
field: page
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'429':
description: Too Many Requests
x-sentenial:
enriched: 'true'
headers:
Retry-After:
description: Number in seconds to wait
schema:
type: integer
format: int32
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
/banks:
get:
tags:
- Bank Service
summary: Retrieve Banks
operationId: BankService_getSupportedBanks
security:
- MerchantOAuth2:
- openbanking_aisp
- openbanking_pisp
- MerchantApiKey: []
- PartnerOAuth2:
- openbanking_aisp
- openbanking_pisp
- PartnerApiKey: []
description: Get Supported Banks On This TPP
parameters:
- description: >-
CountryCode - ISO country code - indicates where bank is domiciled
(ISO 3166 Alpha-2)
name: country
in: query
required: false
explode: true
schema:
type: array
items:
type: string
- description: >-
Allows to filter the banks that requires debtor account to be
provided when initiating payment.
name: debtoraccountrequired
in: query
required: false
schema:
type: boolean
- description: Page number
name: pagenumber
in: query
required: false
schema:
type: integer
format: int32
default: 1
- description: Page size
name: pagesize
in: query
required: false
schema:
type: integer
format: int32
default: 20
- name: supportedcurrencies
in: query
required: false
explode: true
schema:
type: array
items:
type: string
enum:
- EUR
- GBP
- PLN
- BGN
- HRK
- CZK
- DKK
- HUF
- RON
- SEK
- description: Allows filtering by Bank Family via the Bank Family Id.
name: bankfamilyid
in: query
required: false
schema:
type: string
- description: Allows filtering by Banks without an associated Bank Family.
name: excludebankfamily
in: query
required: false
schema:
type: boolean
- description: >-
Filter the bank list by service provided returns both AISPs and
PISPs, 'AISP' returns only AISPs and 'PISP' returns only PISPs. When
not provided returns all banks regardless of service.
name: services
in: query
required: false
explode: true
schema:
type: array
items:
type: string
enum:
- AISP
- PISP
- description: >-
Filter the bank list by payment method. When not provided or false,
returns the full list of banks. When true, the only banks that
supports SEPA Instant Payments are returned.
name: sepainstantreachability
in: query
required: false
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BanksResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: T0000
returnDescription: Validation errors occurred. Please see details.
details:
description: Page is invalid
code: T0001
field: page
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'429':
description: Too Many Requests
x-sentenial:
enriched: 'true'
headers:
Retry-After:
description: Number in seconds to wait
schema:
type: integer
format: int32
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
/payments:
post:
tags:
- PISP Service
summary: Create Payment
operationId: PispService_makePayment
security:
- MerchantOAuth2:
- openbanking_pisp
- MerchantApiKey: []
description: Create a payment request POST endpoint
parameters:
- description: >-
Every request will be processed only once per Idempotency-Key. The
Idempotency Key will be valid for 24 hours.
name: Idempotency-Key
in: header
x-sentenial:
enriched: 'true'
required: false
schema:
type: string
maxLength: 50
- description: Client ID of the PSU in the ASPSP client interface.
name: PSU-ID
in: header
required: false
schema:
type: string
- description: The PSU's IP address if the PSU is currently logged in with the TPP.
name: Customer-IP-Address
in: header
required: false
schema:
type: string
maxLength: 50
requestBody:
description: Create a Payment Request
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponseEnvelope'
examples:
response:
value:
uri: /payments/re27gry2dw
data:
id: re27gry2dw
uri: /payments/re27gry2dw
endToEndIdentification: endToEndIdentification123
debtorAccount:
identification: 60161331926819
name: null
schemeName: SortCodeAccountNumber
secondaryIdentification: null
risk:
paymentContextCode: Other
merchantCategoryCode: null
merchantCustomerIdentification: null
deliveryAddress: null
remittanceInformation:
reference: reference123
unstructured: null
status: PENDING_APPROVAL
amount: 99.99
currency: GBP
countryCode: GB
language: en
email: client@example.com
orderDetails:
items:
- description: Dublin(DUB) to London(LCY) - Adult Fare
name: Flights Outbound
quantity: 2
amount: 50
- description: Dublin(DUB) to London(LCY) - Adult Fare
name: Flights Return
quantity: 2
amount: 50
- description: Dublin(DUB) to London(LCY) - Adult Fare
name: Flights Return
quantity: 2
amount: 30
- description: null
name: Discounts
quantity: null
amount: -5
- description: null
name: Total
quantity: null
amount: 125
integrationType: SELF_HOSTED
merchantPostAuthUrl: https://merchant.openbanking.com/result
bankId: lyboxy9bqp
aspspAuthUrl: >-
https://any-aspsp.com/openbanking/authorize?response_type=code+id_token&scope=openid+payments&client_id=377aaa6a-70bf-4e95-ac19-2bac5270bacd&redirect_uri=https%3A%2F%2Fapi.nuapay.com%2Ftpp%2Fpayment-requests%2Foauth&state=df78b5f6-12c0-4646-b47c-4362217acb0a&nonce=bea92693-19da-4609-858e-86c79e908a08&request=eyJraWQiOiI2QlJZamgtc0VRUTNmNWlzc0lxWU9WNGNXdVUiLCJ0eXAiOiJKV1QiLCJhbGciOiJQUzI1NiJ9.eyJpc3MiOiIzNzdhYWE2YS03MGJmLTRlOTUtYWMxOS0yYmFjNTI3MGJhY2QiLCJyZXNwb25zZV90eXBlIjoiY29kZSBpZF90b2tlbiIsIm5vbmNlIjoiYmVhOTI2OTMtMTlkYS00NjA5LTg1OGUtODZjNzllOTA4YTA4IiwiY2xpZW50X2lkIjoiMzc3YWFhNmEtNzBiZi00ZTk1LWFjMTktMmJhYzUyNzBiYWNkIiwibWF4X2FnZSI6ODY0MDAsImF1ZCI6Imh0dHBzOlwvXC9hdXRob3Jpc2UtYXBpLmxsb3lkc2JhbmsuY28udWtcL3Byb2QwMVwvY2hhbm5lbFwvbHlkcyIsInNjb3BlIjoib3BlbmlkIHBheW1lbnRzIiwiY2xhaW1zIjp7InVzZXJpbmZvIjp7Im9wZW5iYW5raW5nX2ludGVudF9pZCI6eyJ2YWx1ZSI6IjY0YWQ5NWEwLWUzMWYtNGNiOC04NjM3LTdjOGRmOTc3MTJmOSIsImVzc2VudGlhbCI6dHJ1ZX19LCJpZF90b2tlbiI6eyJvcGVuYmFua2luZ19pbnRlbnRfaWQiOnsidmFsdWUiOiI2NGFkOTVhMC1lMzFmLTRjYjgtODYzNy03YzhkZjk3NzEyZjkiLCJlc3NlbnRpYWwiOnRydWV9LCJhY3IiOnsiZXNzZW50aWFsIjp0cnVlLCJ2YWx1ZXMiOlsidXJuOm9wZW5iYW5raW5nOnBzZDI6c2NhIiwidXJuOm9wZW5iYW5raW5nOnBzZDI6Y2EiXX19fSwicmVkaXJlY3RfdXJpIjoiaHR0cHM6XC9cL2FwaS5udWFwYXkuY29tXC90cHBcL3BheW1lbnQtcmVxdWVzdHNcL29hdXRoIiwic3RhdGUiOiJkZjc4YjVmNi0xMmMwLTQ2NDYtYjQ3Yy00MzYyMjE3YWNiMGEiLCJleHAiOjE1NzU0NTg3MTYsImlhdCI6MTU3NTQ1ODQxNiwianRpIjoiNDQyYmY4N2YtYzIxNC00NjgxLTk3ODYtZjIwZGM1YjIzOWYxIn0.IyeHKQQeU6x32CdUllkskLFWEjkJZKzvp8D4ZOwtlN3v32qmbh4hkGtwNilqZetqqq1ESB1InzfyAlb5S3GyZ_1pTV5UmFqsY60w4jIvSVQXmxKyCYIDrdgTvfa3IYOtA3vStpRpnHyXZfke7mBLGM0nn3YLEmujQ88T1kzq8v9rKTUKwgAE-NYLsYnXNg8dNlrl_lvXVou-J26keS5EaYMVSwHRXcZ8Vp51Hro5L3Py5KyG270RL-7AfJCrEOcvwKbHWOYthoZj1FcuuJWoCT80H1rtkw80vI8QpaQHhp8xYOGft4n6uf2WBhUVb9eBrl9B0GtWe3opBeFXzOtKyg
cutOffDateTime: null
expectedExecutionDateTime: null
expectedSettlementDateTime: null
merchantId: gabxwwv2l5
creationDateTime: '2020-05-01T08:25:29.291Z'
debtorBankName: Bank Name
multiAuthorisation:
status: null
numberRequired: null
numberReceived: null
lastUpdateDateTime: null
expirationDateTime: null
links:
- id: re27gry2dwX
resourceType: refunds
uri: /payments/re27gry2dw/refunds
- id: re27gry2dwX
resourceType: history
uri: /payments/re27gry2dw/history
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: T0000
returnDescription: Validation errors occurred. Please see details.
details:
description: Field is invalid
code: T0004
field: email
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'415':
description: Unsupported Media Type
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: T0000
returnDescription: Validation errors occurred. Please see details.
details:
description: Amount has to be greater than 0.
code: T0016
field: amount
'429':
description: Too Many Requests
x-sentenial:
enriched: 'true'
headers:
Retry-After:
description: Number in seconds to wait
schema:
type: integer
format: int32
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
get:
tags:
- PISP Service
summary: List payments
operationId: PispService_listPayments
security:
- MerchantOAuth2:
- openbanking_pisp
- MerchantApiKey: []
- PartnerOAuth2:
- openbanking_pisp
- PartnerApiKey: []
description: GET payments list endpoint
parameters:
- description: >-
Submission from date time in the format, 'yyyy-MM-dd'T'HH:mm:ss',
maximum date from/to date range is 30 days. If neither from/to date
is provided returns results for the last 30 days.
name: fromdatetime
in: query
required: false
schema:
type: string
- description: >-
Submission to date time in the format, 'yyyy-MM-dd'T'HH:mm:ss',
maximum date from/to date range is 30 days. If neither from/to date
is provided returns results for the last 30 days.
name: todatetime
in: query
required: false
schema:
type: string
- description: >-
When provided only payments with amount equal or higher than
provided amount will be returned
name: fromamount
in: query
required: false
schema:
type: number
minimum: 0
maximum: 999999999.99
- description: >-
When provided only payments with amount equal or smaller than
provided amount will be returned
name: toamount
in: query
required: false
schema:
type: number
minimum: 0
maximum: 999999999.99
- description: >-
This is used in UI flows to get payment details. Applicable for
payments created with REDIRECT, CHECKOUT integration type.
name: userinterfacepaymentid
in: query
required: false
schema:
type: string
- description: >-
A number of statuses can be queried within a single request by
providing multiple occurences of the parameter. If not provided all
statuses will be returned
name: paymentstatus
in: query
required: false
explode: true
schema:
type: array
items:
type: string
enum:
- PENDING
- PENDING_APPROVAL
- OAUTH_CALLBACK_COMPLETE
- AUTHORISED
- DECLINED
- SETTLEMENT_REJECTED
- SETTLEMENT_PENDING
- SETTLEMENT_IN_PROGRESS
- SETTLEMENT_COMPLETE
- CONSENT_API_REJECTED
- TIMEOUT
- CONSENT_TIMEOUT
- UNEXPECTED_ERROR
- UNKNOWN
- PAYMENT_RECEIVED
- description: Payer name. This parameter supports searching with wildcards
name: payername
in: query
required: false
schema:
type: string
- description: Payer e-mail. This parameter supports searching with wildcards
name: payeremail
in: query
required: false
schema:
type: string
- description: >-
Payment reference will attempt to match endToEndIdentification,
remittanceInformation.reference and
remittanceInformation.unstructured. Will return all matches and
partial matches if using wildcard searches. This parameter supports
searching with wildcards
name: reference
in: query
required: false
schema:
type: string
- description: Currency
name: currency
in: query
required: false
schema:
type: string
enum:
- EUR
- GBP
- PLN
- BGN
- HRK
- CZK
- DKK
- HUF
- RON
- SEK
- description: Page number
name: pagenumber
in: query
required: false
schema:
type: integer
format: int32
default: 1
- description: Page size
name: pagesize
in: query
required: false
schema:
type: integer
format: int32
default: 20
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedListPaymentResponseEnvelope'
examples:
response:
value:
uri: /payments
data:
- id: ybo8zayk2q
uri: /payments/ybo8zayk2q
merchantId: b0zaq1klpt
creationDateTime: '2019-02-28T10:43:07.00Z'
amount: 99.99
countryCode: GB
currency: GBP
email: client@example.com
language: en
remittanceInformation:
unstructured: The Remittance Information
endToEndIdentification: endToEndIdentification
orderDetails:
items:
- description: Dublin(DUB) to London(LCY) - Adult Fare
name: Flights Outbound
quantity: 2
amount: 50
- description: Dublin(DUB) to London(LCY) - Adult Fare
name: Flights Return
quantity: 2
amount: 50
- description: Dublin(DUB) to London(LCY) - Adult Fare
name: Flights Return
quantity: 2
amount: 30
- description: null
name: Discounts
quantity: null
amount: -5
- description: null
name: Total
quantity: null
amount: 125
integrationType: CHECKOUT
merchantPostAuthUrl: null
bankId: null
bankName: null
aspspAuthUrl: null
status: PENDING_APPROVAL
debtorBankName: Test Bank Name
debtorAccount:
identification: GB29NWBK60161331926819
schemeName: IBAN
links:
- id: null
resourceType: refunds
uri: /payments/ybo8zayk2q/refunds
- id: null
resourceType: history
uri: /payment/{paymentId}/history
page:
pageNumber: 1
pageSize: 10
totalElements: 1
totalPages: 1
sort: []
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: T0000
returnDescription: Validation errors occurred. Please see details.
details:
description: Field is invalid
code: T0002
field: fromdatetime
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
'429':
description: Too Many Requests
x-sentenial:
enriched: 'true'
headers:
Retry-After:
description: Number in seconds to wait
schema:
type: integer
format: int32
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
returnCode: null
returnDescription: null
details: null
/payments/callback:
post:
tags:
- PISP Service
summary: Forward Payment Callback
operationId: PispService_forwardPaymentCallback
security:
- MerchantOAuth2:
- openbanking_callback
- PartnerOAuth2:
- openbanking_callback
description: Forward Payment Callback POST endpoint