pcp-server-ruby-sdk 1.7.0 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/api-definition.yaml +685 -667
- data/lib/PCP-server-Ruby-SDK/endpoints/checkout_api_client.rb +3 -1
- data/lib/PCP-server-Ruby-SDK/endpoints/commerce_case_api_client.rb +5 -4
- data/lib/PCP-server-Ruby-SDK/endpoints/order_management_checkout_actions_api_client.rb +25 -0
- data/lib/PCP-server-Ruby-SDK/models/cancel_payment_request.rb +8 -0
- data/lib/PCP-server-Ruby-SDK/models/cart_item_supplier_references.rb +2 -0
- data/lib/PCP-server-Ruby-SDK/models/commerce_cases_response.rb +18 -0
- data/lib/PCP-server-Ruby-SDK/models/complete_order_request.rb +187 -0
- data/lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb +2 -1
- data/lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb +11 -1
- data/lib/PCP-server-Ruby-SDK/models/order_line_details_result.rb +11 -1
- data/lib/PCP-server-Ruby-SDK/models/payment_event.rb +34 -4
- data/lib/PCP-server-Ruby-SDK/models/payment_references_for_refund.rb +198 -0
- data/lib/PCP-server-Ruby-SDK/models/redirect_payment_method_specific_input.rb +4 -14
- data/lib/PCP-server-Ruby-SDK/models/redirect_payment_method_specific_output.rb +4 -14
- data/lib/PCP-server-Ruby-SDK/models/refund_request.rb +1 -1
- data/lib/PCP-server-Ruby-SDK/models/required_field_validation.rb +108 -0
- data/lib/PCP-server-Ruby-SDK/version.rb +1 -1
- data/lib/PCP-server-Ruby-SDK.rb +6 -0
- data/package-lock.json +16 -2
- data/package.json +1 -1
- data/spec/endpoints/checkout_api_client_spec.rb +22 -0
- data/spec/endpoints/order_management_checkout_actions_api_client_spec.rb +51 -0
- data/spec/models/required_field_validation_spec.rb +551 -0
- metadata +14 -8
data/api-definition.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
openapi: "3.0.3"
|
|
2
2
|
|
|
3
3
|
info:
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.50.0
|
|
5
5
|
title: "Commerce Platform API"
|
|
6
6
|
description: |
|
|
7
7
|
RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments.
|
|
@@ -25,7 +25,7 @@ tags:
|
|
|
25
25
|
description: Resource for operations on Payment Information.
|
|
26
26
|
|
|
27
27
|
paths:
|
|
28
|
-
|
|
28
|
+
'/v1/{merchantId}/commerce-cases':
|
|
29
29
|
post:
|
|
30
30
|
summary: Create a Commerce Case
|
|
31
31
|
description: |-
|
|
@@ -37,15 +37,15 @@ paths:
|
|
|
37
37
|
- CommerceCase
|
|
38
38
|
operationId: createCommerceCase
|
|
39
39
|
parameters:
|
|
40
|
-
- $ref:
|
|
40
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
41
41
|
requestBody:
|
|
42
42
|
required: true
|
|
43
43
|
content:
|
|
44
44
|
application/json:
|
|
45
45
|
schema:
|
|
46
|
-
$ref:
|
|
46
|
+
$ref: '#/components/schemas/CreateCommerceCaseRequest'
|
|
47
47
|
responses:
|
|
48
|
-
|
|
48
|
+
'201':
|
|
49
49
|
x-nullable: true
|
|
50
50
|
description: |-
|
|
51
51
|
The response contains the references to the Commerce Case and the Checkout and if autoExecuteOrder was set
|
|
@@ -53,8 +53,8 @@ paths:
|
|
|
53
53
|
content:
|
|
54
54
|
application/json:
|
|
55
55
|
schema:
|
|
56
|
-
$ref:
|
|
57
|
-
|
|
56
|
+
$ref: '#/components/schemas/CreateCommerceCaseResponse'
|
|
57
|
+
'202':
|
|
58
58
|
x-nullable: true
|
|
59
59
|
description: |-
|
|
60
60
|
The response contains the references to the Commerce case and the Checkout. Status code 202 will be returned
|
|
@@ -62,14 +62,14 @@ paths:
|
|
|
62
62
|
content:
|
|
63
63
|
application/json:
|
|
64
64
|
schema:
|
|
65
|
-
$ref:
|
|
66
|
-
|
|
65
|
+
$ref: '#/components/schemas/CreateCommerceCaseResponse'
|
|
66
|
+
'400':
|
|
67
67
|
x-nullable: true
|
|
68
68
|
description: Commerce Case not found.
|
|
69
69
|
content:
|
|
70
70
|
application/json:
|
|
71
71
|
schema:
|
|
72
|
-
$ref:
|
|
72
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
73
73
|
get:
|
|
74
74
|
summary: Get a list of Commerce Cases based on Search Parameters
|
|
75
75
|
description: |
|
|
@@ -80,18 +80,18 @@ paths:
|
|
|
80
80
|
- CommerceCase
|
|
81
81
|
operationId: getCommerceCases
|
|
82
82
|
parameters:
|
|
83
|
-
- $ref:
|
|
84
|
-
- $ref:
|
|
85
|
-
- $ref:
|
|
86
|
-
- $ref:
|
|
87
|
-
- $ref:
|
|
88
|
-
- $ref:
|
|
89
|
-
- $ref:
|
|
90
|
-
- $ref:
|
|
91
|
-
- $ref:
|
|
92
|
-
- $ref:
|
|
83
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
84
|
+
- $ref: '#/components/parameters/offset'
|
|
85
|
+
- $ref: '#/components/parameters/size'
|
|
86
|
+
- $ref: '#/components/parameters/fromDate'
|
|
87
|
+
- $ref: '#/components/parameters/toDate'
|
|
88
|
+
- $ref: '#/components/parameters/commerceCaseIdQuery'
|
|
89
|
+
- $ref: '#/components/parameters/merchantReference'
|
|
90
|
+
- $ref: '#/components/parameters/merchantCustomerId'
|
|
91
|
+
- $ref: '#/components/parameters/includeCheckoutStatus'
|
|
92
|
+
- $ref: '#/components/parameters/includePaymentChannel'
|
|
93
93
|
responses:
|
|
94
|
-
|
|
94
|
+
'200':
|
|
95
95
|
x-nullable: true
|
|
96
96
|
description: |
|
|
97
97
|
The response contains all Commerce Cases and Checkouts that match with the provided criteria.
|
|
@@ -99,15 +99,15 @@ paths:
|
|
|
99
99
|
content:
|
|
100
100
|
application/json:
|
|
101
101
|
schema:
|
|
102
|
-
$ref:
|
|
103
|
-
|
|
102
|
+
$ref: '#/components/schemas/CommerceCasesResponse'
|
|
103
|
+
'400':
|
|
104
104
|
x-nullable: true
|
|
105
105
|
description: Exception when requesting Checkouts with unknown parameters.
|
|
106
106
|
content:
|
|
107
107
|
application/json:
|
|
108
108
|
schema:
|
|
109
|
-
$ref:
|
|
110
|
-
|
|
109
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
110
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}':
|
|
111
111
|
get:
|
|
112
112
|
summary: Get Commerce Case Details
|
|
113
113
|
description: This endpoint can be used to get a specific Commerce Case and all linked Checkouts.
|
|
@@ -115,23 +115,23 @@ paths:
|
|
|
115
115
|
- CommerceCase
|
|
116
116
|
operationId: getCommerceCase
|
|
117
117
|
parameters:
|
|
118
|
-
- $ref:
|
|
119
|
-
- $ref:
|
|
118
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
119
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
120
120
|
responses:
|
|
121
|
-
|
|
121
|
+
'200':
|
|
122
122
|
x-nullable: true
|
|
123
123
|
description: The response contains the Commerce Case and all linked Checkout.
|
|
124
124
|
content:
|
|
125
125
|
application/json:
|
|
126
126
|
schema:
|
|
127
|
-
$ref:
|
|
128
|
-
|
|
127
|
+
$ref: '#/components/schemas/CommerceCaseResponse'
|
|
128
|
+
'404':
|
|
129
129
|
x-nullable: true
|
|
130
130
|
description: Checkout not found.
|
|
131
131
|
content:
|
|
132
132
|
application/json:
|
|
133
133
|
schema:
|
|
134
|
-
$ref:
|
|
134
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
135
135
|
patch:
|
|
136
136
|
summary: Modify an existing Commerce Case.
|
|
137
137
|
description: This endpoint can be used to update or modify the customer object of a Commerce Case.
|
|
@@ -139,19 +139,19 @@ paths:
|
|
|
139
139
|
- CommerceCase
|
|
140
140
|
operationId: updateCommerceCase
|
|
141
141
|
parameters:
|
|
142
|
-
- $ref:
|
|
143
|
-
- $ref:
|
|
142
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
143
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
144
144
|
requestBody:
|
|
145
145
|
required: true
|
|
146
146
|
content:
|
|
147
147
|
application/json:
|
|
148
148
|
schema:
|
|
149
|
-
$ref:
|
|
149
|
+
$ref: '#/components/schemas/PatchCommerceCaseRequest'
|
|
150
150
|
responses:
|
|
151
|
-
|
|
151
|
+
'204':
|
|
152
152
|
x-nullable: true
|
|
153
153
|
description: The Commerce Case was updated successfully.
|
|
154
|
-
|
|
154
|
+
'400':
|
|
155
155
|
x-nullable: true
|
|
156
156
|
description: |-
|
|
157
157
|
The request was malformed or was missing required data. When a required property was missing the error
|
|
@@ -159,22 +159,22 @@ paths:
|
|
|
159
159
|
content:
|
|
160
160
|
application/json:
|
|
161
161
|
schema:
|
|
162
|
-
$ref:
|
|
163
|
-
|
|
162
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
163
|
+
'404':
|
|
164
164
|
x-nullable: true
|
|
165
165
|
description: Commerce Case not found.
|
|
166
166
|
content:
|
|
167
167
|
application/json:
|
|
168
168
|
schema:
|
|
169
|
-
$ref:
|
|
170
|
-
|
|
169
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
170
|
+
'503':
|
|
171
171
|
x-nullable: true
|
|
172
172
|
description: Service unavailable.
|
|
173
173
|
content:
|
|
174
174
|
application/json:
|
|
175
175
|
schema:
|
|
176
|
-
$ref:
|
|
177
|
-
|
|
176
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
177
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/order':
|
|
178
178
|
post:
|
|
179
179
|
summary: Creates an Order that will automatially execute a Payment
|
|
180
180
|
description: |
|
|
@@ -185,24 +185,24 @@ paths:
|
|
|
185
185
|
- OrderManagementCheckoutActions
|
|
186
186
|
operationId: createOrder
|
|
187
187
|
parameters:
|
|
188
|
-
- $ref:
|
|
189
|
-
- $ref:
|
|
190
|
-
- $ref:
|
|
188
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
189
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
190
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
191
191
|
requestBody:
|
|
192
192
|
required: true
|
|
193
193
|
content:
|
|
194
194
|
application/json:
|
|
195
195
|
schema:
|
|
196
|
-
$ref:
|
|
196
|
+
$ref: '#/components/schemas/OrderRequest'
|
|
197
197
|
responses:
|
|
198
|
-
|
|
198
|
+
'201':
|
|
199
199
|
x-nullable: true
|
|
200
200
|
description: The order request was successfully processed and a payment object was created.
|
|
201
201
|
content:
|
|
202
202
|
application/json:
|
|
203
203
|
schema:
|
|
204
|
-
$ref:
|
|
205
|
-
|
|
204
|
+
$ref: '#/components/schemas/OrderResponse'
|
|
205
|
+
'400':
|
|
206
206
|
x-nullable: true
|
|
207
207
|
description: |-
|
|
208
208
|
The request was malformed or was missing required data. When a required property was missing the error
|
|
@@ -210,36 +210,36 @@ paths:
|
|
|
210
210
|
content:
|
|
211
211
|
application/json:
|
|
212
212
|
schema:
|
|
213
|
-
$ref:
|
|
214
|
-
|
|
213
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
214
|
+
'402':
|
|
215
215
|
x-nullable: true
|
|
216
216
|
description: The payment was declined by a 3rd party (acquirer, payment processor, etc.)
|
|
217
217
|
content:
|
|
218
218
|
application/json:
|
|
219
219
|
schema:
|
|
220
|
-
$ref:
|
|
221
|
-
|
|
220
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
221
|
+
'403':
|
|
222
222
|
x-nullable: true
|
|
223
223
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
224
224
|
content:
|
|
225
225
|
application/json:
|
|
226
226
|
schema:
|
|
227
|
-
$ref:
|
|
228
|
-
|
|
227
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
228
|
+
'404':
|
|
229
229
|
x-nullable: true
|
|
230
230
|
description: Payment not found
|
|
231
231
|
content:
|
|
232
232
|
application/json:
|
|
233
233
|
schema:
|
|
234
|
-
$ref:
|
|
235
|
-
|
|
234
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
235
|
+
'409':
|
|
236
236
|
x-nullable: true
|
|
237
237
|
description: Conflict
|
|
238
238
|
content:
|
|
239
239
|
application/json:
|
|
240
240
|
schema:
|
|
241
|
-
$ref:
|
|
242
|
-
|
|
241
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
242
|
+
'502':
|
|
243
243
|
x-nullable: true
|
|
244
244
|
description: |-
|
|
245
245
|
Any 5XX response points to something that went wrong on our end. This could also be that the system was
|
|
@@ -248,15 +248,15 @@ paths:
|
|
|
248
248
|
content:
|
|
249
249
|
application/json:
|
|
250
250
|
schema:
|
|
251
|
-
$ref:
|
|
252
|
-
|
|
251
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
252
|
+
'503':
|
|
253
253
|
x-nullable: true
|
|
254
254
|
description: Service unavailable
|
|
255
255
|
content:
|
|
256
256
|
application/json:
|
|
257
257
|
schema:
|
|
258
|
-
$ref:
|
|
259
|
-
|
|
258
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
259
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/complete-order':
|
|
260
260
|
post:
|
|
261
261
|
summary: Complete an Order
|
|
262
262
|
description: |-
|
|
@@ -269,14 +269,14 @@ paths:
|
|
|
269
269
|
- OrderManagementCheckoutActions
|
|
270
270
|
operationId: completeOrder
|
|
271
271
|
parameters:
|
|
272
|
-
- $ref:
|
|
273
|
-
- $ref:
|
|
274
|
-
- $ref:
|
|
272
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
273
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
274
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
275
275
|
requestBody:
|
|
276
276
|
content:
|
|
277
277
|
application/json:
|
|
278
278
|
schema:
|
|
279
|
-
$ref:
|
|
279
|
+
$ref: '#/components/schemas/CompleteOrderRequest'
|
|
280
280
|
required: true
|
|
281
281
|
responses:
|
|
282
282
|
200:
|
|
@@ -284,60 +284,59 @@ paths:
|
|
|
284
284
|
content:
|
|
285
285
|
application/json:
|
|
286
286
|
schema:
|
|
287
|
-
$ref:
|
|
287
|
+
$ref: '#/components/schemas/CompletePaymentResponse'
|
|
288
288
|
400:
|
|
289
289
|
description: Incorrect input data
|
|
290
290
|
content:
|
|
291
291
|
application/json:
|
|
292
292
|
schema:
|
|
293
|
-
$ref:
|
|
293
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
294
294
|
402:
|
|
295
295
|
description: The payment was declined by a 3rd party (acquirer, payment processor, etc.)
|
|
296
296
|
content:
|
|
297
297
|
application/json:
|
|
298
298
|
schema:
|
|
299
|
-
$ref:
|
|
299
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
300
300
|
403:
|
|
301
301
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
302
302
|
content:
|
|
303
303
|
application/json:
|
|
304
304
|
schema:
|
|
305
|
-
$ref:
|
|
305
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
306
306
|
409:
|
|
307
307
|
description: Complete is not allowed
|
|
308
308
|
content:
|
|
309
309
|
application/json:
|
|
310
310
|
schema:
|
|
311
|
-
$ref:
|
|
311
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
312
312
|
422:
|
|
313
313
|
description: The request was well-formed but was unable to be processed due to semantic errors
|
|
314
314
|
content:
|
|
315
315
|
application/json:
|
|
316
316
|
schema:
|
|
317
|
-
$ref:
|
|
317
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
318
318
|
500:
|
|
319
319
|
description: Internal server exception
|
|
320
320
|
content:
|
|
321
321
|
application/json:
|
|
322
322
|
schema:
|
|
323
|
-
$ref:
|
|
323
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
324
324
|
502:
|
|
325
|
-
description:
|
|
326
|
-
Any 5XX response points to something that went wrong on our
|
|
325
|
+
description: Any 5XX response points to something that went wrong on our
|
|
327
326
|
end. This could also be that the system was unable to route the transaction
|
|
328
327
|
to an appropriate acquirer/3rd party. Another reason for such a response
|
|
329
328
|
is when the 3rd party's response could not be understood.
|
|
330
329
|
content:
|
|
331
330
|
application/json:
|
|
332
331
|
schema:
|
|
333
|
-
$ref:
|
|
332
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
334
333
|
503:
|
|
335
334
|
description: Service unavailable
|
|
336
335
|
content:
|
|
337
336
|
application/json:
|
|
338
337
|
schema:
|
|
339
|
-
$ref:
|
|
340
|
-
|
|
338
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
339
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/deliver':
|
|
341
340
|
post:
|
|
342
341
|
summary: Mark items of a Checkout as delivered and automatically capture the payment for the items
|
|
343
342
|
description: |
|
|
@@ -351,24 +350,24 @@ paths:
|
|
|
351
350
|
- OrderManagementCheckoutActions
|
|
352
351
|
operationId: deliverOrder
|
|
353
352
|
parameters:
|
|
354
|
-
- $ref:
|
|
355
|
-
- $ref:
|
|
356
|
-
- $ref:
|
|
353
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
354
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
355
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
357
356
|
requestBody:
|
|
358
357
|
required: true
|
|
359
358
|
content:
|
|
360
359
|
application/json:
|
|
361
360
|
schema:
|
|
362
|
-
$ref:
|
|
361
|
+
$ref: '#/components/schemas/DeliverRequest'
|
|
363
362
|
responses:
|
|
364
|
-
|
|
363
|
+
'201':
|
|
365
364
|
x-nullable: true
|
|
366
365
|
description: The deliver was successfully created.
|
|
367
366
|
content:
|
|
368
367
|
application/json:
|
|
369
368
|
schema:
|
|
370
|
-
$ref:
|
|
371
|
-
|
|
369
|
+
$ref: '#/components/schemas/DeliverResponse'
|
|
370
|
+
'400':
|
|
372
371
|
x-nullable: true
|
|
373
372
|
description: |-
|
|
374
373
|
The request was malformed or was missing required data. When a required property was missing the error
|
|
@@ -376,15 +375,15 @@ paths:
|
|
|
376
375
|
content:
|
|
377
376
|
application/json:
|
|
378
377
|
schema:
|
|
379
|
-
$ref:
|
|
380
|
-
|
|
378
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
379
|
+
'403':
|
|
381
380
|
x-nullable: true
|
|
382
381
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
383
382
|
content:
|
|
384
383
|
application/json:
|
|
385
384
|
schema:
|
|
386
|
-
$ref:
|
|
387
|
-
|
|
385
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
386
|
+
'404':
|
|
388
387
|
x-nullable: true
|
|
389
388
|
description: |-
|
|
390
389
|
The most common cause for this response is that the Checkout status was not PENDING_COMPLETION, BILLED or
|
|
@@ -392,8 +391,8 @@ paths:
|
|
|
392
391
|
content:
|
|
393
392
|
application/json:
|
|
394
393
|
schema:
|
|
395
|
-
$ref:
|
|
396
|
-
|
|
394
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
395
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/return':
|
|
397
396
|
post:
|
|
398
397
|
summary: Mark items of a Checkout as returned and automatically refund the payment for the items
|
|
399
398
|
description: |
|
|
@@ -405,24 +404,24 @@ paths:
|
|
|
405
404
|
- OrderManagementCheckoutActions
|
|
406
405
|
operationId: returnOrder
|
|
407
406
|
parameters:
|
|
408
|
-
- $ref:
|
|
409
|
-
- $ref:
|
|
410
|
-
- $ref:
|
|
407
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
408
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
409
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
411
410
|
requestBody:
|
|
412
411
|
required: false
|
|
413
412
|
content:
|
|
414
413
|
application/json:
|
|
415
414
|
schema:
|
|
416
|
-
$ref:
|
|
415
|
+
$ref: '#/components/schemas/ReturnRequest'
|
|
417
416
|
responses:
|
|
418
|
-
|
|
417
|
+
'201':
|
|
419
418
|
x-nullable: true
|
|
420
419
|
description: The return was successfully executed.
|
|
421
420
|
content:
|
|
422
421
|
application/json:
|
|
423
422
|
schema:
|
|
424
|
-
$ref:
|
|
425
|
-
|
|
423
|
+
$ref: '#/components/schemas/ReturnResponse'
|
|
424
|
+
'400':
|
|
426
425
|
x-nullable: true
|
|
427
426
|
description: |-
|
|
428
427
|
The request was malformed or was missing required data. When a required property was missing the error
|
|
@@ -430,15 +429,15 @@ paths:
|
|
|
430
429
|
content:
|
|
431
430
|
application/json:
|
|
432
431
|
schema:
|
|
433
|
-
$ref:
|
|
434
|
-
|
|
432
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
433
|
+
'403':
|
|
435
434
|
x-nullable: true
|
|
436
435
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
437
436
|
content:
|
|
438
437
|
application/json:
|
|
439
438
|
schema:
|
|
440
|
-
$ref:
|
|
441
|
-
|
|
439
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
440
|
+
'404':
|
|
442
441
|
x-nullable: true
|
|
443
442
|
description: |-
|
|
444
443
|
The most common cause for this response is that the Checkout status was not PENDING_COMPLETION, BILLED or
|
|
@@ -446,8 +445,8 @@ paths:
|
|
|
446
445
|
content:
|
|
447
446
|
application/json:
|
|
448
447
|
schema:
|
|
449
|
-
$ref:
|
|
450
|
-
|
|
448
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
449
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/cancel':
|
|
451
450
|
post:
|
|
452
451
|
summary: Mark items of a Checkout as cancelled and automatically cancel the payment for the items
|
|
453
452
|
description: |-
|
|
@@ -456,7 +455,7 @@ paths:
|
|
|
456
455
|
The Cancel endpoint can be used to cancel a full or partial order.
|
|
457
456
|
The Cancel request will mark all or (for cancelType PARTIAL) the provided items as CANCELLED, and – in case of
|
|
458
457
|
an existing authorization – will reverse the payment.
|
|
459
|
-
|
|
458
|
+
|
|
460
459
|
In the light of card payments, reversing an authorization that is not needed will prevent you from having to pay
|
|
461
460
|
a fee/penalty for unused authorization requests.
|
|
462
461
|
Whilst scheme regulations require that acquirers and PSPs support authorization reversals, there are no rules
|
|
@@ -472,17 +471,17 @@ paths:
|
|
|
472
471
|
- OrderManagementCheckoutActions
|
|
473
472
|
operationId: cancelOrder
|
|
474
473
|
parameters:
|
|
475
|
-
- $ref:
|
|
476
|
-
- $ref:
|
|
477
|
-
- $ref:
|
|
474
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
475
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
476
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
478
477
|
requestBody:
|
|
479
478
|
required: false
|
|
480
479
|
content:
|
|
481
480
|
application/json:
|
|
482
481
|
schema:
|
|
483
|
-
$ref:
|
|
482
|
+
$ref: '#/components/schemas/CancelRequest'
|
|
484
483
|
responses:
|
|
485
|
-
|
|
484
|
+
'200':
|
|
486
485
|
x-nullable: true
|
|
487
486
|
description: |-
|
|
488
487
|
The payment has been cancelled. Some acquirers/issuers will provide some feedback in case a reversal of the
|
|
@@ -490,50 +489,50 @@ paths:
|
|
|
490
489
|
content:
|
|
491
490
|
application/json:
|
|
492
491
|
schema:
|
|
493
|
-
$ref:
|
|
494
|
-
|
|
492
|
+
$ref: '#/components/schemas/CancelResponse'
|
|
493
|
+
'400':
|
|
495
494
|
x-nullable: true
|
|
496
495
|
description: Incorrect input data
|
|
497
496
|
content:
|
|
498
497
|
application/json:
|
|
499
498
|
schema:
|
|
500
|
-
$ref:
|
|
501
|
-
|
|
499
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
500
|
+
'402':
|
|
502
501
|
x-nullable: true
|
|
503
502
|
description: Payment required
|
|
504
503
|
content:
|
|
505
504
|
application/json:
|
|
506
505
|
schema:
|
|
507
|
-
$ref:
|
|
508
|
-
|
|
506
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
507
|
+
'403':
|
|
509
508
|
x-nullable: true
|
|
510
509
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
511
510
|
content:
|
|
512
511
|
application/json:
|
|
513
512
|
schema:
|
|
514
|
-
$ref:
|
|
515
|
-
|
|
513
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
514
|
+
'404':
|
|
516
515
|
x-nullable: true
|
|
517
516
|
description: Payment was not found
|
|
518
517
|
content:
|
|
519
518
|
application/json:
|
|
520
519
|
schema:
|
|
521
|
-
$ref:
|
|
522
|
-
|
|
520
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
521
|
+
'409':
|
|
523
522
|
x-nullable: true
|
|
524
523
|
description: Cancellation is not allowed because payment is closed
|
|
525
524
|
content:
|
|
526
525
|
application/json:
|
|
527
526
|
schema:
|
|
528
|
-
$ref:
|
|
529
|
-
|
|
527
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
528
|
+
'500':
|
|
530
529
|
x-nullable: true
|
|
531
530
|
description: Internal server exception
|
|
532
531
|
content:
|
|
533
532
|
application/json:
|
|
534
533
|
schema:
|
|
535
|
-
$ref:
|
|
536
|
-
|
|
534
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
535
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts':
|
|
537
536
|
post:
|
|
538
537
|
summary: Add a Checkout to an existing Commerce Case
|
|
539
538
|
description: |-
|
|
@@ -544,38 +543,38 @@ paths:
|
|
|
544
543
|
- Checkout
|
|
545
544
|
operationId: createCheckout
|
|
546
545
|
parameters:
|
|
547
|
-
- $ref:
|
|
548
|
-
- $ref:
|
|
546
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
547
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
549
548
|
requestBody:
|
|
550
549
|
required: true
|
|
551
550
|
content:
|
|
552
551
|
application/json:
|
|
553
552
|
schema:
|
|
554
|
-
$ref:
|
|
553
|
+
$ref: '#/components/schemas/CreateCheckoutRequest'
|
|
555
554
|
responses:
|
|
556
|
-
|
|
555
|
+
'201':
|
|
557
556
|
x-nullable: true
|
|
558
557
|
description: The response contains the reference of the Checkout and possible the response for the payment.
|
|
559
558
|
content:
|
|
560
559
|
application/json:
|
|
561
560
|
schema:
|
|
562
|
-
$ref:
|
|
563
|
-
|
|
561
|
+
$ref: '#/components/schemas/CreateCheckoutResponse'
|
|
562
|
+
'202':
|
|
564
563
|
x-nullable: true
|
|
565
564
|
description: |-
|
|
566
565
|
The response contains the reference of the Checkout. But the Payment Execution was not successful.
|
|
567
566
|
content:
|
|
568
567
|
application/json:
|
|
569
568
|
schema:
|
|
570
|
-
$ref:
|
|
571
|
-
|
|
569
|
+
$ref: '#/components/schemas/CreateCheckoutResponse'
|
|
570
|
+
'400':
|
|
572
571
|
x-nullable: true
|
|
573
572
|
description: Payment not found.
|
|
574
573
|
content:
|
|
575
574
|
application/json:
|
|
576
575
|
schema:
|
|
577
|
-
$ref:
|
|
578
|
-
|
|
576
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
577
|
+
'/v1/{merchantId}/checkouts':
|
|
579
578
|
get:
|
|
580
579
|
summary: Get a list of Checkouts based on Search Parameters
|
|
581
580
|
description: |
|
|
@@ -587,57 +586,57 @@ paths:
|
|
|
587
586
|
- Checkout
|
|
588
587
|
operationId: getCheckouts
|
|
589
588
|
parameters:
|
|
590
|
-
- $ref:
|
|
591
|
-
- $ref:
|
|
592
|
-
- $ref:
|
|
593
|
-
- $ref:
|
|
594
|
-
- $ref:
|
|
595
|
-
- $ref:
|
|
596
|
-
- $ref:
|
|
597
|
-
- $ref:
|
|
598
|
-
- $ref:
|
|
599
|
-
- $ref:
|
|
600
|
-
- $ref:
|
|
601
|
-
- $ref:
|
|
602
|
-
- $ref:
|
|
603
|
-
- $ref:
|
|
604
|
-
- $ref:
|
|
605
|
-
- $ref:
|
|
606
|
-
- $ref:
|
|
607
|
-
- $ref:
|
|
608
|
-
- $ref:
|
|
609
|
-
- $ref:
|
|
610
|
-
- $ref:
|
|
611
|
-
- $ref:
|
|
612
|
-
- $ref:
|
|
613
|
-
- $ref:
|
|
614
|
-
- $ref:
|
|
615
|
-
- $ref:
|
|
616
|
-
- $ref:
|
|
617
|
-
- $ref:
|
|
618
|
-
- $ref:
|
|
619
|
-
- $ref:
|
|
620
|
-
- $ref:
|
|
621
|
-
- $ref:
|
|
622
|
-
- $ref:
|
|
623
|
-
- $ref:
|
|
589
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
590
|
+
- $ref: '#/components/parameters/offset'
|
|
591
|
+
- $ref: '#/components/parameters/size'
|
|
592
|
+
- $ref: '#/components/parameters/fromDate'
|
|
593
|
+
- $ref: '#/components/parameters/toDate'
|
|
594
|
+
- $ref: '#/components/parameters/fromCheckoutAmount'
|
|
595
|
+
- $ref: '#/components/parameters/toCheckoutAmount'
|
|
596
|
+
- $ref: '#/components/parameters/fromOpenAmount'
|
|
597
|
+
- $ref: '#/components/parameters/toOpenAmount'
|
|
598
|
+
- $ref: '#/components/parameters/fromCollectedAmount'
|
|
599
|
+
- $ref: '#/components/parameters/toCollectedAmount'
|
|
600
|
+
- $ref: '#/components/parameters/fromCancelledAmount'
|
|
601
|
+
- $ref: '#/components/parameters/toCancelledAmount'
|
|
602
|
+
- $ref: '#/components/parameters/fromRefundAmount'
|
|
603
|
+
- $ref: '#/components/parameters/toRefundAmount'
|
|
604
|
+
- $ref: '#/components/parameters/fromChargebackAmount'
|
|
605
|
+
- $ref: '#/components/parameters/toChargebackAmount'
|
|
606
|
+
- $ref: '#/components/parameters/checkoutIdQuery'
|
|
607
|
+
- $ref: '#/components/parameters/merchantReference'
|
|
608
|
+
- $ref: '#/components/parameters/merchantCustomerId'
|
|
609
|
+
- $ref: '#/components/parameters/includePaymentProductId'
|
|
610
|
+
- $ref: '#/components/parameters/includeCheckoutStatus'
|
|
611
|
+
- $ref: '#/components/parameters/includeExtendedCheckoutStatus'
|
|
612
|
+
- $ref: '#/components/parameters/includePaymentChannel'
|
|
613
|
+
- $ref: '#/components/parameters/paymentReference'
|
|
614
|
+
- $ref: '#/components/parameters/paymentId'
|
|
615
|
+
- $ref: '#/components/parameters/firstName'
|
|
616
|
+
- $ref: '#/components/parameters/surname'
|
|
617
|
+
- $ref: '#/components/parameters/email'
|
|
618
|
+
- $ref: '#/components/parameters/phoneNumber'
|
|
619
|
+
- $ref: '#/components/parameters/dateOfBirth'
|
|
620
|
+
- $ref: '#/components/parameters/companyInformation'
|
|
621
|
+
- $ref: '#/components/parameters/terminalId'
|
|
622
|
+
- $ref: '#/components/parameters/reportingToken'
|
|
624
623
|
responses:
|
|
625
|
-
|
|
624
|
+
'200':
|
|
626
625
|
x-nullable: true
|
|
627
626
|
description: |
|
|
628
627
|
The response containing all found Checkouts for the provided criteria.
|
|
629
628
|
content:
|
|
630
629
|
application/json:
|
|
631
630
|
schema:
|
|
632
|
-
$ref:
|
|
633
|
-
|
|
631
|
+
$ref: '#/components/schemas/CheckoutsResponse'
|
|
632
|
+
'400':
|
|
634
633
|
x-nullable: true
|
|
635
634
|
description: Exception when requesting Checkouts with given parameters.
|
|
636
635
|
content:
|
|
637
636
|
application/json:
|
|
638
637
|
schema:
|
|
639
|
-
$ref:
|
|
640
|
-
|
|
638
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
639
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}':
|
|
641
640
|
get:
|
|
642
641
|
summary: Get Checkout Details
|
|
643
642
|
description: This endpoint can be used to get a Checkout.
|
|
@@ -645,24 +644,24 @@ paths:
|
|
|
645
644
|
- Checkout
|
|
646
645
|
operationId: getCheckout
|
|
647
646
|
parameters:
|
|
648
|
-
- $ref:
|
|
649
|
-
- $ref:
|
|
650
|
-
- $ref:
|
|
647
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
648
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
649
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
651
650
|
responses:
|
|
652
|
-
|
|
651
|
+
'200':
|
|
653
652
|
x-nullable: true
|
|
654
653
|
description: The response contains the Checkout.
|
|
655
654
|
content:
|
|
656
655
|
application/json:
|
|
657
656
|
schema:
|
|
658
|
-
$ref:
|
|
659
|
-
|
|
657
|
+
$ref: '#/components/schemas/CheckoutResponse'
|
|
658
|
+
'404':
|
|
660
659
|
x-nullable: true
|
|
661
660
|
description: Checkout not found
|
|
662
661
|
content:
|
|
663
662
|
application/json:
|
|
664
663
|
schema:
|
|
665
|
-
$ref:
|
|
664
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
666
665
|
patch:
|
|
667
666
|
summary: Modify a Checkout
|
|
668
667
|
description: This endpoint can be used to update or modify the data of a Checkout.
|
|
@@ -670,33 +669,33 @@ paths:
|
|
|
670
669
|
- Checkout
|
|
671
670
|
operationId: updateCheckout
|
|
672
671
|
parameters:
|
|
673
|
-
- $ref:
|
|
674
|
-
- $ref:
|
|
675
|
-
- $ref:
|
|
672
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
673
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
674
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
676
675
|
requestBody:
|
|
677
676
|
required: true
|
|
678
677
|
content:
|
|
679
678
|
application/json:
|
|
680
679
|
schema:
|
|
681
|
-
$ref:
|
|
680
|
+
$ref: '#/components/schemas/PatchCheckoutRequest'
|
|
682
681
|
responses:
|
|
683
|
-
|
|
682
|
+
'204':
|
|
684
683
|
x-nullable: true
|
|
685
684
|
description: The Checkout is updated successfully.
|
|
686
|
-
|
|
685
|
+
'400':
|
|
687
686
|
x-nullable: true
|
|
688
687
|
description: Payment not found.
|
|
689
688
|
content:
|
|
690
689
|
application/json:
|
|
691
690
|
schema:
|
|
692
|
-
$ref:
|
|
693
|
-
|
|
691
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
692
|
+
'409':
|
|
694
693
|
x-nullable: true
|
|
695
694
|
description: Conflict
|
|
696
695
|
content:
|
|
697
696
|
application/json:
|
|
698
697
|
schema:
|
|
699
|
-
$ref:
|
|
698
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
700
699
|
delete:
|
|
701
700
|
summary: Delete a Checkout
|
|
702
701
|
description: This endpoint can be used to delete an unused Checkout.
|
|
@@ -704,28 +703,28 @@ paths:
|
|
|
704
703
|
- Checkout
|
|
705
704
|
operationId: deleteCheckout
|
|
706
705
|
parameters:
|
|
707
|
-
- $ref:
|
|
708
|
-
- $ref:
|
|
709
|
-
- $ref:
|
|
706
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
707
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
708
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
710
709
|
responses:
|
|
711
|
-
|
|
710
|
+
'204':
|
|
712
711
|
x-nullable: true
|
|
713
712
|
description: The Checkout was successfully deleted.
|
|
714
|
-
|
|
713
|
+
'403':
|
|
715
714
|
x-nullable: true
|
|
716
715
|
description: You are not allowed to delete the Checkout
|
|
717
716
|
content:
|
|
718
717
|
application/json:
|
|
719
718
|
schema:
|
|
720
|
-
$ref:
|
|
721
|
-
|
|
719
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
720
|
+
'404':
|
|
722
721
|
x-nullable: true
|
|
723
722
|
description: The Checkout could not be found
|
|
724
723
|
content:
|
|
725
724
|
application/json:
|
|
726
725
|
schema:
|
|
727
|
-
$ref:
|
|
728
|
-
|
|
726
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
727
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-executions':
|
|
729
728
|
post:
|
|
730
729
|
summary: Create a Payment
|
|
731
730
|
description: |-
|
|
@@ -736,24 +735,24 @@ paths:
|
|
|
736
735
|
- PaymentExecution
|
|
737
736
|
operationId: createPayment
|
|
738
737
|
parameters:
|
|
739
|
-
- $ref:
|
|
740
|
-
- $ref:
|
|
741
|
-
- $ref:
|
|
738
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
739
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
740
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
742
741
|
requestBody:
|
|
743
742
|
required: true
|
|
744
743
|
content:
|
|
745
744
|
application/json:
|
|
746
745
|
schema:
|
|
747
|
-
$ref:
|
|
746
|
+
$ref: '#/components/schemas/PaymentExecutionRequest'
|
|
748
747
|
responses:
|
|
749
|
-
|
|
748
|
+
'201':
|
|
750
749
|
x-nullable: true
|
|
751
750
|
description: The payment request was successfully processed and a payment object was created.
|
|
752
751
|
content:
|
|
753
752
|
application/json:
|
|
754
753
|
schema:
|
|
755
|
-
$ref:
|
|
756
|
-
|
|
754
|
+
$ref: '#/components/schemas/CreatePaymentResponse'
|
|
755
|
+
'400':
|
|
757
756
|
x-nullable: true
|
|
758
757
|
description: |-
|
|
759
758
|
The request was malformed or was missing required data. When a required property was missing the error
|
|
@@ -761,36 +760,36 @@ paths:
|
|
|
761
760
|
content:
|
|
762
761
|
application/json:
|
|
763
762
|
schema:
|
|
764
|
-
$ref:
|
|
765
|
-
|
|
763
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
764
|
+
'402':
|
|
766
765
|
x-nullable: true
|
|
767
766
|
description: The payment was declined by a 3rd party (acquirer, payment processor, etc.)
|
|
768
767
|
content:
|
|
769
768
|
application/json:
|
|
770
769
|
schema:
|
|
771
|
-
$ref:
|
|
772
|
-
|
|
770
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
771
|
+
'403':
|
|
773
772
|
x-nullable: true
|
|
774
773
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
775
774
|
content:
|
|
776
775
|
application/json:
|
|
777
776
|
schema:
|
|
778
|
-
$ref:
|
|
779
|
-
|
|
777
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
778
|
+
'404':
|
|
780
779
|
x-nullable: true
|
|
781
780
|
description: Payment not found
|
|
782
781
|
content:
|
|
783
782
|
application/json:
|
|
784
783
|
schema:
|
|
785
|
-
$ref:
|
|
786
|
-
|
|
784
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
785
|
+
'409':
|
|
787
786
|
x-nullable: true
|
|
788
787
|
description: Conflict
|
|
789
788
|
content:
|
|
790
789
|
application/json:
|
|
791
790
|
schema:
|
|
792
|
-
$ref:
|
|
793
|
-
|
|
791
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
792
|
+
'502':
|
|
794
793
|
x-nullable: true
|
|
795
794
|
description: |-
|
|
796
795
|
Any 5XX response points to something that went wrong on our end. This could also be that the system was
|
|
@@ -799,15 +798,15 @@ paths:
|
|
|
799
798
|
content:
|
|
800
799
|
application/json:
|
|
801
800
|
schema:
|
|
802
|
-
$ref:
|
|
803
|
-
|
|
801
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
802
|
+
'503':
|
|
804
803
|
x-nullable: true
|
|
805
804
|
description: Service unavailable
|
|
806
805
|
content:
|
|
807
806
|
application/json:
|
|
808
807
|
schema:
|
|
809
|
-
$ref:
|
|
810
|
-
|
|
808
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
809
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-executions/{paymentExecutionId}/capture':
|
|
811
810
|
post:
|
|
812
811
|
summary: Capture a Payment
|
|
813
812
|
description: |-
|
|
@@ -816,7 +815,7 @@ paths:
|
|
|
816
815
|
OrderManagementActions will be impossible after using a PaymentExecution endpoint.
|
|
817
816
|
It is possible to perform multiple partial captures by providing an amount that is lower than the total
|
|
818
817
|
authorized amount.
|
|
819
|
-
|
|
818
|
+
|
|
820
819
|
The cancellationReason is mandatory for BNPL payment methods (paymentProductId 3390, 3391 and 3392) if isFinal
|
|
821
820
|
is set to true and the amount of the Capture is lower than the authorized amount.
|
|
822
821
|
For other payment methods the cancellationReason is not mandatory in this case but can be used for reporting and
|
|
@@ -825,25 +824,25 @@ paths:
|
|
|
825
824
|
- PaymentExecution
|
|
826
825
|
operationId: capturePaymentExecution
|
|
827
826
|
parameters:
|
|
828
|
-
- $ref:
|
|
829
|
-
- $ref:
|
|
830
|
-
- $ref:
|
|
831
|
-
- $ref:
|
|
827
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
828
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
829
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
830
|
+
- $ref: '#/components/parameters/paymentExecutionId'
|
|
832
831
|
requestBody:
|
|
833
832
|
required: true
|
|
834
833
|
content:
|
|
835
834
|
application/json:
|
|
836
835
|
schema:
|
|
837
|
-
$ref:
|
|
836
|
+
$ref: '#/components/schemas/CapturePaymentRequest'
|
|
838
837
|
responses:
|
|
839
|
-
|
|
838
|
+
'201':
|
|
840
839
|
x-nullable: true
|
|
841
840
|
description: The Capture was successfully created.
|
|
842
841
|
content:
|
|
843
842
|
application/json:
|
|
844
843
|
schema:
|
|
845
|
-
$ref:
|
|
846
|
-
|
|
844
|
+
$ref: '#/components/schemas/CapturePaymentResponse'
|
|
845
|
+
'400':
|
|
847
846
|
x-nullable: true
|
|
848
847
|
description: |-
|
|
849
848
|
The request was malformed or was missing required data. When a required property was missing the error
|
|
@@ -851,15 +850,15 @@ paths:
|
|
|
851
850
|
content:
|
|
852
851
|
application/json:
|
|
853
852
|
schema:
|
|
854
|
-
$ref:
|
|
855
|
-
|
|
853
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
854
|
+
'403':
|
|
856
855
|
x-nullable: true
|
|
857
856
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
858
857
|
content:
|
|
859
858
|
application/json:
|
|
860
859
|
schema:
|
|
861
|
-
$ref:
|
|
862
|
-
|
|
860
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
861
|
+
'404':
|
|
863
862
|
x-nullable: true
|
|
864
863
|
description: |-
|
|
865
864
|
The most common cause for this response is that the Checkout status was not PENDING_COMPLETION, BILLED or
|
|
@@ -867,15 +866,15 @@ paths:
|
|
|
867
866
|
content:
|
|
868
867
|
application/json:
|
|
869
868
|
schema:
|
|
870
|
-
$ref:
|
|
871
|
-
|
|
869
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
870
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-executions/{paymentExecutionId}/cancel':
|
|
872
871
|
post:
|
|
873
872
|
summary: Cancel a Payment
|
|
874
873
|
description: |-
|
|
875
874
|
This endpoint can be used to reverse the payment associated with this Checkout. The Cancel is only possible for
|
|
876
875
|
the entire amount of the payment and not partial payments.
|
|
877
876
|
OrderManagementActions will be impossible after using a PaymentExecution endpoint.
|
|
878
|
-
|
|
877
|
+
|
|
879
878
|
In the light of card payments, reversing an authorization that is not needed will prevent you from having to pay
|
|
880
879
|
a fee/penalty for unused authorization requests.
|
|
881
880
|
Whilst scheme regulations require that acquirers and PSPs support authorization reversals, there are no rules
|
|
@@ -891,18 +890,18 @@ paths:
|
|
|
891
890
|
- PaymentExecution
|
|
892
891
|
operationId: cancelPaymentExecution
|
|
893
892
|
parameters:
|
|
894
|
-
- $ref:
|
|
895
|
-
- $ref:
|
|
896
|
-
- $ref:
|
|
897
|
-
- $ref:
|
|
893
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
894
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
895
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
896
|
+
- $ref: '#/components/parameters/paymentExecutionId'
|
|
898
897
|
requestBody:
|
|
899
898
|
required: true
|
|
900
899
|
content:
|
|
901
900
|
application/json:
|
|
902
901
|
schema:
|
|
903
|
-
$ref:
|
|
902
|
+
$ref: '#/components/schemas/CancelPaymentRequest'
|
|
904
903
|
responses:
|
|
905
|
-
|
|
904
|
+
'200':
|
|
906
905
|
x-nullable: true
|
|
907
906
|
description: |-
|
|
908
907
|
The payment has been cancelled. Some acquirers/issuers will provide some feedback in case a reversal of the
|
|
@@ -910,50 +909,50 @@ paths:
|
|
|
910
909
|
content:
|
|
911
910
|
application/json:
|
|
912
911
|
schema:
|
|
913
|
-
$ref:
|
|
914
|
-
|
|
912
|
+
$ref: '#/components/schemas/CancelPaymentResponse'
|
|
913
|
+
'400':
|
|
915
914
|
x-nullable: true
|
|
916
915
|
description: Incorrect input data
|
|
917
916
|
content:
|
|
918
917
|
application/json:
|
|
919
918
|
schema:
|
|
920
|
-
$ref:
|
|
921
|
-
|
|
919
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
920
|
+
'402':
|
|
922
921
|
x-nullable: true
|
|
923
922
|
description: Payment required
|
|
924
923
|
content:
|
|
925
924
|
application/json:
|
|
926
925
|
schema:
|
|
927
|
-
$ref:
|
|
928
|
-
|
|
926
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
927
|
+
'403':
|
|
929
928
|
x-nullable: true
|
|
930
929
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
931
930
|
content:
|
|
932
931
|
application/json:
|
|
933
932
|
schema:
|
|
934
|
-
$ref:
|
|
935
|
-
|
|
933
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
934
|
+
'404':
|
|
936
935
|
x-nullable: true
|
|
937
936
|
description: Payment was not found
|
|
938
937
|
content:
|
|
939
938
|
application/json:
|
|
940
939
|
schema:
|
|
941
|
-
$ref:
|
|
942
|
-
|
|
940
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
941
|
+
'409':
|
|
943
942
|
x-nullable: true
|
|
944
943
|
description: Cancellation is not allowed because payment is closed
|
|
945
944
|
content:
|
|
946
945
|
application/json:
|
|
947
946
|
schema:
|
|
948
|
-
$ref:
|
|
949
|
-
|
|
947
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
948
|
+
'500':
|
|
950
949
|
x-nullable: true
|
|
951
950
|
description: Internal server exception
|
|
952
951
|
content:
|
|
953
952
|
application/json:
|
|
954
953
|
schema:
|
|
955
|
-
$ref:
|
|
956
|
-
|
|
954
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
955
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-executions/{paymentExecutionId}/refund':
|
|
957
956
|
post:
|
|
958
957
|
summary: Refund a Payment
|
|
959
958
|
description: |-
|
|
@@ -964,25 +963,25 @@ paths:
|
|
|
964
963
|
- PaymentExecution
|
|
965
964
|
operationId: refundPaymentExecution
|
|
966
965
|
parameters:
|
|
967
|
-
- $ref:
|
|
968
|
-
- $ref:
|
|
969
|
-
- $ref:
|
|
970
|
-
- $ref:
|
|
966
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
967
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
968
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
969
|
+
- $ref: '#/components/parameters/paymentExecutionId'
|
|
971
970
|
requestBody:
|
|
972
971
|
required: true
|
|
973
972
|
content:
|
|
974
973
|
application/json:
|
|
975
974
|
schema:
|
|
976
|
-
$ref:
|
|
975
|
+
$ref: '#/components/schemas/RefundRequest'
|
|
977
976
|
responses:
|
|
978
|
-
|
|
977
|
+
'201':
|
|
979
978
|
x-nullable: true
|
|
980
979
|
description: The Refund was successfully created.
|
|
981
980
|
content:
|
|
982
981
|
application/json:
|
|
983
982
|
schema:
|
|
984
|
-
$ref:
|
|
985
|
-
|
|
983
|
+
$ref: '#/components/schemas/RefundPaymentResponse'
|
|
984
|
+
'400':
|
|
986
985
|
x-nullable: true
|
|
987
986
|
description: |-
|
|
988
987
|
The request was malformed or was missing required data. When a required property was missing the error
|
|
@@ -990,22 +989,22 @@ paths:
|
|
|
990
989
|
content:
|
|
991
990
|
application/json:
|
|
992
991
|
schema:
|
|
993
|
-
$ref:
|
|
994
|
-
|
|
992
|
+
$ref: '#/components/schemas/RefundErrorResponse'
|
|
993
|
+
'403':
|
|
995
994
|
x-nullable: true
|
|
996
995
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
997
996
|
content:
|
|
998
997
|
application/json:
|
|
999
998
|
schema:
|
|
1000
|
-
$ref:
|
|
1001
|
-
|
|
999
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1000
|
+
'404':
|
|
1002
1001
|
x-nullable: true
|
|
1003
1002
|
description: The most common cause for this response id that the payment was not in a cancelable state.
|
|
1004
1003
|
content:
|
|
1005
1004
|
application/json:
|
|
1006
1005
|
schema:
|
|
1007
|
-
$ref:
|
|
1008
|
-
|
|
1006
|
+
$ref: '#/components/schemas/RefundErrorResponse'
|
|
1007
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-executions/{paymentExecutionId}/complete':
|
|
1009
1008
|
post:
|
|
1010
1009
|
summary: Complete a Payment
|
|
1011
1010
|
description: |-
|
|
@@ -1019,15 +1018,15 @@ paths:
|
|
|
1019
1018
|
- PaymentExecution
|
|
1020
1019
|
operationId: completePayment
|
|
1021
1020
|
parameters:
|
|
1022
|
-
- $ref:
|
|
1023
|
-
- $ref:
|
|
1024
|
-
- $ref:
|
|
1025
|
-
- $ref:
|
|
1021
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
1022
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
1023
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
1024
|
+
- $ref: '#/components/parameters/paymentExecutionId'
|
|
1026
1025
|
requestBody:
|
|
1027
1026
|
content:
|
|
1028
1027
|
application/json:
|
|
1029
1028
|
schema:
|
|
1030
|
-
$ref:
|
|
1029
|
+
$ref: '#/components/schemas/CompletePaymentRequest'
|
|
1031
1030
|
required: true
|
|
1032
1031
|
responses:
|
|
1033
1032
|
200:
|
|
@@ -1035,67 +1034,66 @@ paths:
|
|
|
1035
1034
|
content:
|
|
1036
1035
|
application/json:
|
|
1037
1036
|
schema:
|
|
1038
|
-
$ref:
|
|
1037
|
+
$ref: '#/components/schemas/CompletePaymentResponse'
|
|
1039
1038
|
400:
|
|
1040
1039
|
description: Incorrect input data
|
|
1041
1040
|
content:
|
|
1042
1041
|
application/json:
|
|
1043
1042
|
schema:
|
|
1044
|
-
$ref:
|
|
1043
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1045
1044
|
402:
|
|
1046
1045
|
description: The payment was declined by a 3rd party (acquirer, payment processor, etc.)
|
|
1047
1046
|
content:
|
|
1048
1047
|
application/json:
|
|
1049
1048
|
schema:
|
|
1050
|
-
$ref:
|
|
1049
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1051
1050
|
403:
|
|
1052
1051
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
1053
1052
|
content:
|
|
1054
1053
|
application/json:
|
|
1055
1054
|
schema:
|
|
1056
|
-
$ref:
|
|
1055
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1057
1056
|
409:
|
|
1058
1057
|
description: Complete is not allowed
|
|
1059
1058
|
content:
|
|
1060
1059
|
application/json:
|
|
1061
1060
|
schema:
|
|
1062
|
-
$ref:
|
|
1061
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1063
1062
|
422:
|
|
1064
1063
|
description: The request was well-formed but was unable to be processed due to semantic errors
|
|
1065
1064
|
content:
|
|
1066
1065
|
application/json:
|
|
1067
1066
|
schema:
|
|
1068
|
-
$ref:
|
|
1067
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1069
1068
|
500:
|
|
1070
1069
|
description: Internal server exception
|
|
1071
1070
|
content:
|
|
1072
1071
|
application/json:
|
|
1073
1072
|
schema:
|
|
1074
|
-
$ref:
|
|
1073
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1075
1074
|
502:
|
|
1076
|
-
description:
|
|
1077
|
-
Any 5XX response points to something that went wrong on our
|
|
1075
|
+
description: Any 5XX response points to something that went wrong on our
|
|
1078
1076
|
end. This could also be that the system was unable to route the transaction
|
|
1079
1077
|
to an appropriate acquirer/3rd party. Another reason for such a response
|
|
1080
1078
|
is when the 3rd party's response could not be understood.
|
|
1081
1079
|
content:
|
|
1082
1080
|
application/json:
|
|
1083
1081
|
schema:
|
|
1084
|
-
$ref:
|
|
1082
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1085
1083
|
503:
|
|
1086
1084
|
description: Service unavailable
|
|
1087
1085
|
content:
|
|
1088
1086
|
application/json:
|
|
1089
1087
|
schema:
|
|
1090
|
-
$ref:
|
|
1091
|
-
|
|
1088
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1089
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-executions/{paymentExecutionId}/pause':
|
|
1092
1090
|
post:
|
|
1093
1091
|
summary: Pause a Payment for selected payment methods
|
|
1094
1092
|
description: |-
|
|
1095
1093
|
Defers next dunning step-up after a consumer has announced to send
|
|
1096
1094
|
back a shipped order. Merchant intends to do a REFUND call soon.
|
|
1097
1095
|
OrderManagementActions will be impossible after using a PaymentExecution endpoint.
|
|
1098
|
-
|
|
1096
|
+
|
|
1099
1097
|
Currently only applicable for PAYONE Buy Now, Pay Later (BNPL).
|
|
1100
1098
|
|
|
1101
1099
|
* 3390 - PAYONE Secured Invoice
|
|
@@ -1105,86 +1103,82 @@ paths:
|
|
|
1105
1103
|
- PaymentExecution
|
|
1106
1104
|
operationId: pausePayment
|
|
1107
1105
|
parameters:
|
|
1108
|
-
- $ref:
|
|
1109
|
-
- $ref:
|
|
1110
|
-
- $ref:
|
|
1111
|
-
- $ref:
|
|
1106
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
1107
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
1108
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
1109
|
+
- $ref: '#/components/parameters/paymentExecutionId'
|
|
1112
1110
|
requestBody:
|
|
1113
1111
|
content:
|
|
1114
1112
|
application/json:
|
|
1115
1113
|
schema:
|
|
1116
|
-
$ref:
|
|
1114
|
+
$ref: '#/components/schemas/PausePaymentRequest'
|
|
1117
1115
|
responses:
|
|
1118
1116
|
200:
|
|
1119
1117
|
description: The pause was successful.
|
|
1120
1118
|
content:
|
|
1121
1119
|
application/json:
|
|
1122
1120
|
schema:
|
|
1123
|
-
$ref:
|
|
1121
|
+
$ref: '#/components/schemas/PausePaymentResponse'
|
|
1124
1122
|
400:
|
|
1125
1123
|
description: Incorrect input data
|
|
1126
1124
|
content:
|
|
1127
1125
|
application/json:
|
|
1128
1126
|
schema:
|
|
1129
|
-
$ref:
|
|
1127
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1130
1128
|
402:
|
|
1131
|
-
description:
|
|
1132
|
-
The payment was declined by a 3rd party (acquirer, payment
|
|
1129
|
+
description: The payment was declined by a 3rd party (acquirer, payment
|
|
1133
1130
|
processor, etc.)
|
|
1134
1131
|
content:
|
|
1135
1132
|
application/json:
|
|
1136
1133
|
schema:
|
|
1137
|
-
$ref:
|
|
1134
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1138
1135
|
403:
|
|
1139
|
-
description:
|
|
1140
|
-
You are not allowed to access the service or account or your
|
|
1136
|
+
description: You are not allowed to access the service or account or your
|
|
1141
1137
|
API authentication failed.
|
|
1142
1138
|
content:
|
|
1143
1139
|
application/json:
|
|
1144
1140
|
schema:
|
|
1145
|
-
$ref:
|
|
1141
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1146
1142
|
409:
|
|
1147
1143
|
description: Pause is not allowed
|
|
1148
1144
|
content:
|
|
1149
1145
|
application/json:
|
|
1150
1146
|
schema:
|
|
1151
|
-
$ref:
|
|
1147
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1152
1148
|
422:
|
|
1153
|
-
description:
|
|
1154
|
-
The request was well-formed but was unable to be processed
|
|
1149
|
+
description: The request was well-formed but was unable to be processed
|
|
1155
1150
|
due to semantic errors
|
|
1156
1151
|
content:
|
|
1157
1152
|
application/json:
|
|
1158
1153
|
schema:
|
|
1159
|
-
$ref:
|
|
1154
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1160
1155
|
500:
|
|
1161
1156
|
description: Internal server exception
|
|
1162
1157
|
content:
|
|
1163
1158
|
application/json:
|
|
1164
1159
|
schema:
|
|
1165
|
-
$ref:
|
|
1160
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1166
1161
|
502:
|
|
1167
|
-
description:
|
|
1168
|
-
Any 5XX response points to something that went wrong on our
|
|
1162
|
+
description: Any 5XX response points to something that went wrong on our
|
|
1169
1163
|
end. This could also be that the system was unable to route the transaction
|
|
1170
1164
|
to an appropriate acquirer/3rd party. Another reason for such a response
|
|
1171
1165
|
is when the 3rd party's response could not be understood.
|
|
1172
1166
|
content:
|
|
1173
1167
|
application/json:
|
|
1174
1168
|
schema:
|
|
1175
|
-
$ref:
|
|
1169
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1176
1170
|
503:
|
|
1177
1171
|
description: Service unavailable
|
|
1178
1172
|
content:
|
|
1179
1173
|
application/json:
|
|
1180
1174
|
schema:
|
|
1181
|
-
$ref:
|
|
1182
|
-
|
|
1175
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1176
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-executions/{paymentExecutionId}/refresh':
|
|
1183
1177
|
post:
|
|
1184
1178
|
summary: Refresh information of a Payment Execution
|
|
1185
1179
|
description: |-
|
|
1186
1180
|
This endpoint can be used to refresh the information of a Payment Execution.
|
|
1187
|
-
|
|
1181
|
+
|
|
1188
1182
|
This endpoint can be used to refresh a Payment Execution in two different modes:
|
|
1189
1183
|
* PAYMENT_EVENTS = Refresh all events that belong to a payment. It can be used for a synchronisation with
|
|
1190
1184
|
the payment gateway e.g. in case of possible inconsistencies between the Commerce Platform and the payment gateway.
|
|
@@ -1192,7 +1186,7 @@ paths:
|
|
|
1192
1186
|
* PAYMENT_PROVIDER_DETAILS = Refresh the payment status of the payment and return the payment provider details.
|
|
1193
1187
|
It can be used for a synchronisation of the payment with the external payment provider. At the moment this call
|
|
1194
1188
|
will update the customer payment status of a transaction for PAYONE Buy Now, Pay Later (BNPL).
|
|
1195
|
-
|
|
1189
|
+
|
|
1196
1190
|
ATTENTION: This Refresh endpoint includes a rate limit of one request per Payment Execution every twelve hours.
|
|
1197
1191
|
The reason for this rate limit that for the currently supported use case a change in payment provider details is
|
|
1198
1192
|
not expected to change more frequently.
|
|
@@ -1200,60 +1194,58 @@ paths:
|
|
|
1200
1194
|
- PaymentExecution
|
|
1201
1195
|
operationId: refreshPayment
|
|
1202
1196
|
parameters:
|
|
1203
|
-
- $ref:
|
|
1204
|
-
- $ref:
|
|
1205
|
-
- $ref:
|
|
1206
|
-
- $ref:
|
|
1197
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
1198
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
1199
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
1200
|
+
- $ref: '#/components/parameters/paymentExecutionId'
|
|
1207
1201
|
requestBody:
|
|
1208
1202
|
content:
|
|
1209
1203
|
application/json:
|
|
1210
1204
|
schema:
|
|
1211
|
-
$ref:
|
|
1205
|
+
$ref: '#/components/schemas/RefreshPaymentRequest'
|
|
1212
1206
|
responses:
|
|
1213
1207
|
200:
|
|
1214
1208
|
description: The refresh was successful.
|
|
1215
1209
|
content:
|
|
1216
1210
|
application/json:
|
|
1217
1211
|
schema:
|
|
1218
|
-
$ref:
|
|
1212
|
+
$ref: '#/components/schemas/PaymentExecution'
|
|
1219
1213
|
400:
|
|
1220
1214
|
description: Incorrect input data
|
|
1221
1215
|
content:
|
|
1222
1216
|
application/json:
|
|
1223
1217
|
schema:
|
|
1224
|
-
$ref:
|
|
1218
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1225
1219
|
403:
|
|
1226
|
-
description:
|
|
1227
|
-
You are not allowed to access the service or account or your
|
|
1220
|
+
description: You are not allowed to access the service or account or your
|
|
1228
1221
|
API authentication failed.
|
|
1229
1222
|
content:
|
|
1230
1223
|
application/json:
|
|
1231
1224
|
schema:
|
|
1232
|
-
$ref:
|
|
1225
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1233
1226
|
500:
|
|
1234
1227
|
description: Internal server exception
|
|
1235
1228
|
content:
|
|
1236
1229
|
application/json:
|
|
1237
1230
|
schema:
|
|
1238
|
-
$ref:
|
|
1231
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1239
1232
|
502:
|
|
1240
|
-
description:
|
|
1241
|
-
Any 5XX response points to something that went wrong on our
|
|
1233
|
+
description: Any 5XX response points to something that went wrong on our
|
|
1242
1234
|
end. This could also be that the system was unable to route the transaction
|
|
1243
1235
|
to an appropriate acquirer/3rd party. Another reason for such a response
|
|
1244
1236
|
is when the 3rd party's response could not be understood.
|
|
1245
1237
|
content:
|
|
1246
1238
|
application/json:
|
|
1247
1239
|
schema:
|
|
1248
|
-
$ref:
|
|
1240
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1249
1241
|
503:
|
|
1250
1242
|
description: Service unavailable
|
|
1251
1243
|
content:
|
|
1252
1244
|
application/json:
|
|
1253
1245
|
schema:
|
|
1254
|
-
$ref:
|
|
1246
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1255
1247
|
|
|
1256
|
-
|
|
1248
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-information':
|
|
1257
1249
|
post:
|
|
1258
1250
|
summary: Create a Payment Information
|
|
1259
1251
|
description: |-
|
|
@@ -1262,52 +1254,52 @@ paths:
|
|
|
1262
1254
|
- PaymentInformation
|
|
1263
1255
|
operationId: createPaymentInformation
|
|
1264
1256
|
parameters:
|
|
1265
|
-
- $ref:
|
|
1266
|
-
- $ref:
|
|
1267
|
-
- $ref:
|
|
1257
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
1258
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
1259
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
1268
1260
|
requestBody:
|
|
1269
1261
|
required: true
|
|
1270
1262
|
content:
|
|
1271
1263
|
application/json:
|
|
1272
1264
|
schema:
|
|
1273
|
-
$ref:
|
|
1265
|
+
$ref: '#/components/schemas/PaymentInformationRequest'
|
|
1274
1266
|
responses:
|
|
1275
|
-
|
|
1267
|
+
'201':
|
|
1276
1268
|
x-nullable: true
|
|
1277
1269
|
description: The response contains the reference of the created Payment Information.
|
|
1278
1270
|
content:
|
|
1279
1271
|
application/json:
|
|
1280
1272
|
schema:
|
|
1281
|
-
$ref:
|
|
1282
|
-
|
|
1273
|
+
$ref: '#/components/schemas/PaymentInformationResponse'
|
|
1274
|
+
'400':
|
|
1283
1275
|
x-nullable: true
|
|
1284
1276
|
description: Incorrect input data
|
|
1285
1277
|
content:
|
|
1286
1278
|
application/json:
|
|
1287
1279
|
schema:
|
|
1288
|
-
$ref:
|
|
1289
|
-
|
|
1280
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1281
|
+
'404':
|
|
1290
1282
|
x-nullable: true
|
|
1291
1283
|
description: Payment not found
|
|
1292
1284
|
content:
|
|
1293
1285
|
application/json:
|
|
1294
1286
|
schema:
|
|
1295
|
-
$ref:
|
|
1296
|
-
|
|
1287
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1288
|
+
'409':
|
|
1297
1289
|
x-nullable: true
|
|
1298
1290
|
description: Creation of Payment Information is not allowed
|
|
1299
1291
|
content:
|
|
1300
1292
|
application/json:
|
|
1301
1293
|
schema:
|
|
1302
|
-
$ref:
|
|
1303
|
-
|
|
1294
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1295
|
+
'500':
|
|
1304
1296
|
x-nullable: true
|
|
1305
1297
|
description: Internal server exception
|
|
1306
1298
|
content:
|
|
1307
1299
|
application/json:
|
|
1308
1300
|
schema:
|
|
1309
|
-
$ref:
|
|
1310
|
-
|
|
1301
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1302
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-information/{paymentInformationId}':
|
|
1311
1303
|
get:
|
|
1312
1304
|
summary: Get a Payment Information
|
|
1313
1305
|
description: |-
|
|
@@ -1316,26 +1308,26 @@ paths:
|
|
|
1316
1308
|
- PaymentInformation
|
|
1317
1309
|
operationId: getPaymentInformation
|
|
1318
1310
|
parameters:
|
|
1319
|
-
- $ref:
|
|
1320
|
-
- $ref:
|
|
1321
|
-
- $ref:
|
|
1322
|
-
- $ref:
|
|
1311
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
1312
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
1313
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
1314
|
+
- $ref: '#/components/parameters/paymentInformationId'
|
|
1323
1315
|
responses:
|
|
1324
|
-
|
|
1316
|
+
'200':
|
|
1325
1317
|
x-nullable: true
|
|
1326
1318
|
description: The response contains the reference of the created Payment Information.
|
|
1327
1319
|
content:
|
|
1328
1320
|
application/json:
|
|
1329
1321
|
schema:
|
|
1330
|
-
$ref:
|
|
1331
|
-
|
|
1322
|
+
$ref: '#/components/schemas/PaymentInformationResponse'
|
|
1323
|
+
'404':
|
|
1332
1324
|
x-nullable: true
|
|
1333
1325
|
description: Payment not found
|
|
1334
1326
|
content:
|
|
1335
1327
|
application/json:
|
|
1336
1328
|
schema:
|
|
1337
|
-
$ref:
|
|
1338
|
-
|
|
1329
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1330
|
+
'/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-information/{paymentInformationId}/refund':
|
|
1339
1331
|
post:
|
|
1340
1332
|
summary: Refund a Payment Information
|
|
1341
1333
|
description: |-
|
|
@@ -1345,25 +1337,25 @@ paths:
|
|
|
1345
1337
|
- PaymentInformation
|
|
1346
1338
|
operationId: refundPaymentInformation
|
|
1347
1339
|
parameters:
|
|
1348
|
-
- $ref:
|
|
1349
|
-
- $ref:
|
|
1350
|
-
- $ref:
|
|
1351
|
-
- $ref:
|
|
1340
|
+
- $ref: '#/components/parameters/merchantIdPath'
|
|
1341
|
+
- $ref: '#/components/parameters/commerceCaseIdPath'
|
|
1342
|
+
- $ref: '#/components/parameters/checkoutIdPath'
|
|
1343
|
+
- $ref: '#/components/parameters/paymentInformationId'
|
|
1352
1344
|
requestBody:
|
|
1353
1345
|
required: true
|
|
1354
1346
|
content:
|
|
1355
1347
|
application/json:
|
|
1356
1348
|
schema:
|
|
1357
|
-
$ref:
|
|
1349
|
+
$ref: '#/components/schemas/PaymentInformationRefundRequest'
|
|
1358
1350
|
responses:
|
|
1359
|
-
|
|
1351
|
+
'201':
|
|
1360
1352
|
x-nullable: true
|
|
1361
1353
|
description: The Refund was successfully created.
|
|
1362
1354
|
content:
|
|
1363
1355
|
application/json:
|
|
1364
1356
|
schema:
|
|
1365
|
-
$ref:
|
|
1366
|
-
|
|
1357
|
+
$ref: '#/components/schemas/PaymentInformationRefundResponse'
|
|
1358
|
+
'400':
|
|
1367
1359
|
x-nullable: true
|
|
1368
1360
|
description: |-
|
|
1369
1361
|
The request was malformed or was missing required data. When a required property was missing the error
|
|
@@ -1371,21 +1363,21 @@ paths:
|
|
|
1371
1363
|
content:
|
|
1372
1364
|
application/json:
|
|
1373
1365
|
schema:
|
|
1374
|
-
$ref:
|
|
1375
|
-
|
|
1366
|
+
$ref: '#/components/schemas/RefundErrorResponse'
|
|
1367
|
+
'403':
|
|
1376
1368
|
x-nullable: true
|
|
1377
1369
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
1378
1370
|
content:
|
|
1379
1371
|
application/json:
|
|
1380
1372
|
schema:
|
|
1381
|
-
$ref:
|
|
1382
|
-
|
|
1373
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
1374
|
+
'404':
|
|
1383
1375
|
x-nullable: true
|
|
1384
1376
|
description: The most common cause for this response id that the payment was not in a cancelable state.
|
|
1385
1377
|
content:
|
|
1386
1378
|
application/json:
|
|
1387
1379
|
schema:
|
|
1388
|
-
$ref:
|
|
1380
|
+
$ref: '#/components/schemas/RefundErrorResponse'
|
|
1389
1381
|
|
|
1390
1382
|
components:
|
|
1391
1383
|
parameters:
|
|
@@ -1560,7 +1552,7 @@ components:
|
|
|
1560
1552
|
schema:
|
|
1561
1553
|
type: array
|
|
1562
1554
|
items:
|
|
1563
|
-
$ref:
|
|
1555
|
+
$ref: '#/components/schemas/StatusCheckout'
|
|
1564
1556
|
includeExtendedCheckoutStatus:
|
|
1565
1557
|
in: query
|
|
1566
1558
|
name: includeExtendedCheckoutStatus
|
|
@@ -1569,7 +1561,7 @@ components:
|
|
|
1569
1561
|
schema:
|
|
1570
1562
|
type: array
|
|
1571
1563
|
items:
|
|
1572
|
-
$ref:
|
|
1564
|
+
$ref: '#/components/schemas/ExtendedCheckoutStatus'
|
|
1573
1565
|
includePaymentChannel:
|
|
1574
1566
|
in: query
|
|
1575
1567
|
name: includePaymentChannel
|
|
@@ -1579,7 +1571,7 @@ components:
|
|
|
1579
1571
|
schema:
|
|
1580
1572
|
type: array
|
|
1581
1573
|
items:
|
|
1582
|
-
$ref:
|
|
1574
|
+
$ref: '#/components/schemas/PaymentChannel'
|
|
1583
1575
|
includePaymentProductId:
|
|
1584
1576
|
in: query
|
|
1585
1577
|
name: includePaymentProductId
|
|
@@ -1667,7 +1659,7 @@ components:
|
|
|
1667
1659
|
schema:
|
|
1668
1660
|
type: string
|
|
1669
1661
|
x-trim-at: 20
|
|
1670
|
-
example:
|
|
1662
|
+
example: '+1234567890'
|
|
1671
1663
|
reportingToken:
|
|
1672
1664
|
in: query
|
|
1673
1665
|
name: reportingToken
|
|
@@ -1889,7 +1881,7 @@ components:
|
|
|
1889
1881
|
minLength: 2
|
|
1890
1882
|
maxLength: 10
|
|
1891
1883
|
name:
|
|
1892
|
-
$ref:
|
|
1884
|
+
$ref: '#/components/schemas/PersonalName'
|
|
1893
1885
|
AllowedPaymentActions:
|
|
1894
1886
|
type: string
|
|
1895
1887
|
enum:
|
|
@@ -2008,7 +2000,7 @@ components:
|
|
|
2008
2000
|
signature includes the signing certificate, its intermediate CA certificate, and information about the
|
|
2009
2001
|
signing algorithm.
|
|
2010
2002
|
header:
|
|
2011
|
-
$ref:
|
|
2003
|
+
$ref: '#/components/schemas/ApplePaymentDataTokenHeaderInformation'
|
|
2012
2004
|
required:
|
|
2013
2005
|
- version
|
|
2014
2006
|
- signature
|
|
@@ -2025,7 +2017,7 @@ components:
|
|
|
2025
2017
|
authortizations can be reversed and can be captured within 30 days. The capture amount can be lower than the
|
|
2026
2018
|
authorized amount.
|
|
2027
2019
|
* SALE - The payment creation results in an authorization that is already captured at the moment of approval.
|
|
2028
|
-
|
|
2020
|
+
|
|
2029
2021
|
If the parameter is not provided in the request, the default value will be PRE_AUTHORIZATION
|
|
2030
2022
|
BankAccountInformation:
|
|
2031
2023
|
type: object
|
|
@@ -2067,7 +2059,7 @@ components:
|
|
|
2067
2059
|
Payment product identifier - please check product documentation for a full overview of possible values.
|
|
2068
2060
|
example: 772
|
|
2069
2061
|
paymentProduct772SpecificInput:
|
|
2070
|
-
$ref:
|
|
2062
|
+
$ref: '#/components/schemas/SepaTransferPaymentProduct772SpecificInput'
|
|
2071
2063
|
CancelItem:
|
|
2072
2064
|
type: object
|
|
2073
2065
|
properties:
|
|
@@ -2117,13 +2109,13 @@ components:
|
|
|
2117
2109
|
type: object
|
|
2118
2110
|
properties:
|
|
2119
2111
|
cancellationReason:
|
|
2120
|
-
$ref:
|
|
2112
|
+
$ref: '#/components/schemas/CancellationReason'
|
|
2121
2113
|
CancelPaymentResponse:
|
|
2122
2114
|
type: object
|
|
2123
2115
|
additionalProperties: false
|
|
2124
2116
|
properties:
|
|
2125
2117
|
payment:
|
|
2126
|
-
$ref:
|
|
2118
|
+
$ref: '#/components/schemas/PaymentResponse'
|
|
2127
2119
|
CancelRequest:
|
|
2128
2120
|
type: object
|
|
2129
2121
|
description: |
|
|
@@ -2132,26 +2124,26 @@ components:
|
|
|
2132
2124
|
A Cancel can be created for a full or the partial ShoppingCart of the Checkout.
|
|
2133
2125
|
The platform will automatically calculate the respective amount to trigger the Cancel. For a partial Cancel a
|
|
2134
2126
|
list of items must be provided.
|
|
2135
|
-
|
|
2127
|
+
|
|
2136
2128
|
The cancellationReason is mandatory for BNPL payment methods (paymentProductId 3390, 3391 and 3392).
|
|
2137
2129
|
For other payment methods the cancellationReason is not mandatory but can be used for reporting and
|
|
2138
2130
|
reconciliation purposes.
|
|
2139
2131
|
properties:
|
|
2140
2132
|
cancelType:
|
|
2141
|
-
$ref:
|
|
2133
|
+
$ref: '#/components/schemas/CancelType'
|
|
2142
2134
|
cancellationReason:
|
|
2143
|
-
$ref:
|
|
2135
|
+
$ref: '#/components/schemas/CancellationReason'
|
|
2144
2136
|
cancelItems:
|
|
2145
2137
|
type: array
|
|
2146
2138
|
items:
|
|
2147
|
-
$ref:
|
|
2139
|
+
$ref: '#/components/schemas/CancelItem'
|
|
2148
2140
|
CancelResponse:
|
|
2149
2141
|
type: object
|
|
2150
2142
|
properties:
|
|
2151
2143
|
cancelPaymentResponse:
|
|
2152
|
-
$ref:
|
|
2144
|
+
$ref: '#/components/schemas/CancelPaymentResponse'
|
|
2153
2145
|
shoppingCart:
|
|
2154
|
-
$ref:
|
|
2146
|
+
$ref: '#/components/schemas/ShoppingCartResult'
|
|
2155
2147
|
CancelType:
|
|
2156
2148
|
type: string
|
|
2157
2149
|
description: |
|
|
@@ -2162,7 +2154,7 @@ components:
|
|
|
2162
2154
|
should not be made for the entire ShoppingCart. For this type the list of items has to be provided.
|
|
2163
2155
|
Please note that a reversal for a partial payment will not reverse the respective amount from the authorization
|
|
2164
2156
|
but only reduces the openAmount that is ready for collecting.
|
|
2165
|
-
|
|
2157
|
+
|
|
2166
2158
|
Following conditions apply to the Cancel request:
|
|
2167
2159
|
* items must be in status ORDERED
|
|
2168
2160
|
* there was no Capture, Refund or Cancel triggered over the Payment Execution resource
|
|
@@ -2178,7 +2170,7 @@ components:
|
|
|
2178
2170
|
additionalProperties: false
|
|
2179
2171
|
properties:
|
|
2180
2172
|
amountOfMoney:
|
|
2181
|
-
$ref:
|
|
2173
|
+
$ref: '#/components/schemas/AmountOfMoney'
|
|
2182
2174
|
merchantParameters:
|
|
2183
2175
|
type: string
|
|
2184
2176
|
description: |-
|
|
@@ -2187,12 +2179,12 @@ components:
|
|
|
2187
2179
|
maxLength: 1000
|
|
2188
2180
|
example: "{'SessionID':'126548354','ShopperID':'7354131'}"
|
|
2189
2181
|
references:
|
|
2190
|
-
$ref:
|
|
2182
|
+
$ref: '#/components/schemas/PaymentReferences'
|
|
2191
2183
|
paymentMethod:
|
|
2192
2184
|
type: string
|
|
2193
2185
|
description: Payment method identifier used by our payment engine.
|
|
2194
2186
|
paymentInstructions:
|
|
2195
|
-
$ref:
|
|
2187
|
+
$ref: '#/components/schemas/PaymentInstructions'
|
|
2196
2188
|
CapturePaymentRequest:
|
|
2197
2189
|
type: object
|
|
2198
2190
|
additionalProperties: false
|
|
@@ -2217,29 +2209,29 @@ components:
|
|
|
2217
2209
|
This property indicates whether this will be the final operation.
|
|
2218
2210
|
If the full amount should not captured but the property is set to true, the remaining amount will automatically be cancelled.
|
|
2219
2211
|
cancellationReason:
|
|
2220
|
-
$ref:
|
|
2212
|
+
$ref: '#/components/schemas/CancellationReason'
|
|
2221
2213
|
references:
|
|
2222
|
-
$ref:
|
|
2214
|
+
$ref: '#/components/schemas/PaymentReferences'
|
|
2223
2215
|
delivery:
|
|
2224
|
-
$ref:
|
|
2216
|
+
$ref: '#/components/schemas/DeliveryInformation'
|
|
2225
2217
|
fundSplit:
|
|
2226
|
-
$ref:
|
|
2218
|
+
$ref: '#/components/schemas/FundSplit'
|
|
2227
2219
|
CapturePaymentResponse:
|
|
2228
2220
|
type: object
|
|
2229
2221
|
additionalProperties: false
|
|
2230
2222
|
properties:
|
|
2231
2223
|
captureOutput:
|
|
2232
|
-
$ref:
|
|
2224
|
+
$ref: '#/components/schemas/CaptureOutput'
|
|
2233
2225
|
status:
|
|
2234
|
-
$ref:
|
|
2226
|
+
$ref: '#/components/schemas/StatusValue'
|
|
2235
2227
|
statusOutput:
|
|
2236
|
-
$ref:
|
|
2228
|
+
$ref: '#/components/schemas/PaymentStatusOutput'
|
|
2237
2229
|
fundSplit:
|
|
2238
|
-
$ref:
|
|
2230
|
+
$ref: '#/components/schemas/FundSplit'
|
|
2239
2231
|
id:
|
|
2240
2232
|
type: string
|
|
2241
2233
|
description: Unique payment transaction identifier of the payment gateway.
|
|
2242
|
-
example:
|
|
2234
|
+
example: '3066019730_1'
|
|
2243
2235
|
CardFraudResults:
|
|
2244
2236
|
type: object
|
|
2245
2237
|
description: |
|
|
@@ -2343,7 +2335,7 @@ components:
|
|
|
2343
2335
|
description: Detailed information regarding an occurred payment event.
|
|
2344
2336
|
properties:
|
|
2345
2337
|
cartItemStatus:
|
|
2346
|
-
$ref:
|
|
2338
|
+
$ref: '#/components/schemas/CartItemStatus'
|
|
2347
2339
|
quantity:
|
|
2348
2340
|
type: integer
|
|
2349
2341
|
description: |-
|
|
@@ -2359,9 +2351,9 @@ components:
|
|
|
2359
2351
|
additionalProperties: false
|
|
2360
2352
|
properties:
|
|
2361
2353
|
authorizationMode:
|
|
2362
|
-
$ref:
|
|
2354
|
+
$ref: '#/components/schemas/AuthorizationMode'
|
|
2363
2355
|
recurring:
|
|
2364
|
-
$ref:
|
|
2356
|
+
$ref: '#/components/schemas/CardRecurrenceDetails'
|
|
2365
2357
|
paymentProcessingToken:
|
|
2366
2358
|
type: string
|
|
2367
2359
|
description: ID of the token to use to create the payment.
|
|
@@ -2374,15 +2366,15 @@ components:
|
|
|
2374
2366
|
example: 12a037cc-833d-8b45-8f6f-11c34171f4e1
|
|
2375
2367
|
maxLength: 40
|
|
2376
2368
|
transactionChannel:
|
|
2377
|
-
$ref:
|
|
2369
|
+
$ref: '#/components/schemas/TransactionChannel'
|
|
2378
2370
|
unscheduledCardOnFileRequestor:
|
|
2379
|
-
$ref:
|
|
2371
|
+
$ref: '#/components/schemas/UnscheduledCardOnFileRequestor'
|
|
2380
2372
|
unscheduledCardOnFileSequenceIndicator:
|
|
2381
|
-
$ref:
|
|
2373
|
+
$ref: '#/components/schemas/UnscheduledCardOnFileSequenceIndicator'
|
|
2382
2374
|
paymentProductId:
|
|
2383
|
-
$ref:
|
|
2375
|
+
$ref: '#/components/schemas/PaymentProductId'
|
|
2384
2376
|
card:
|
|
2385
|
-
$ref:
|
|
2377
|
+
$ref: '#/components/schemas/CardInfo'
|
|
2386
2378
|
returnUrl:
|
|
2387
2379
|
type: string
|
|
2388
2380
|
description: |-
|
|
@@ -2403,7 +2395,7 @@ components:
|
|
|
2403
2395
|
* Yearly
|
|
2404
2396
|
* Quarterly
|
|
2405
2397
|
* Monthly
|
|
2406
|
-
|
|
2398
|
+
|
|
2407
2399
|
* Weekly
|
|
2408
2400
|
* Daily
|
|
2409
2401
|
Supported soon
|
|
@@ -2427,14 +2419,14 @@ components:
|
|
|
2427
2419
|
additionalProperties: false
|
|
2428
2420
|
properties:
|
|
2429
2421
|
paymentProductId:
|
|
2430
|
-
$ref:
|
|
2422
|
+
$ref: '#/components/schemas/PaymentProductId'
|
|
2431
2423
|
authorisationCode:
|
|
2432
2424
|
description: Card Authorization code as returned by the acquirer
|
|
2433
2425
|
type: string
|
|
2434
2426
|
fraudResults:
|
|
2435
|
-
$ref:
|
|
2427
|
+
$ref: '#/components/schemas/CardFraudResults'
|
|
2436
2428
|
threeDSecureResults:
|
|
2437
|
-
$ref:
|
|
2429
|
+
$ref: '#/components/schemas/ThreeDSecureResults'
|
|
2438
2430
|
CardRecurrenceDetails:
|
|
2439
2431
|
type: object
|
|
2440
2432
|
description: Object containing data related to recurring.
|
|
@@ -2461,11 +2453,11 @@ components:
|
|
|
2461
2453
|
additionalProperties: false
|
|
2462
2454
|
properties:
|
|
2463
2455
|
invoiceData:
|
|
2464
|
-
$ref:
|
|
2456
|
+
$ref: '#/components/schemas/CartItemInvoiceData'
|
|
2465
2457
|
orderLineDetails:
|
|
2466
|
-
$ref:
|
|
2458
|
+
$ref: '#/components/schemas/OrderLineDetailsInput'
|
|
2467
2459
|
supplierReferences:
|
|
2468
|
-
$ref:
|
|
2460
|
+
$ref: '#/components/schemas/CartItemSupplierReferences'
|
|
2469
2461
|
CartItemInvoiceData:
|
|
2470
2462
|
type: object
|
|
2471
2463
|
description: Object containing the line items of the invoice or shopping cart.
|
|
@@ -2484,11 +2476,11 @@ components:
|
|
|
2484
2476
|
additionalProperties: false
|
|
2485
2477
|
properties:
|
|
2486
2478
|
invoiceData:
|
|
2487
|
-
$ref:
|
|
2479
|
+
$ref: '#/components/schemas/CartItemInvoiceData'
|
|
2488
2480
|
orderLineDetails:
|
|
2489
|
-
$ref:
|
|
2481
|
+
$ref: '#/components/schemas/OrderLineDetailsPatch'
|
|
2490
2482
|
supplierReferences:
|
|
2491
|
-
$ref:
|
|
2483
|
+
$ref: '#/components/schemas/CartItemSupplierReferences'
|
|
2492
2484
|
CartItemResult:
|
|
2493
2485
|
type: object
|
|
2494
2486
|
description: This object contains information of all items in the cart.
|
|
@@ -2496,11 +2488,11 @@ components:
|
|
|
2496
2488
|
additionalProperties: false
|
|
2497
2489
|
properties:
|
|
2498
2490
|
invoiceData:
|
|
2499
|
-
$ref:
|
|
2491
|
+
$ref: '#/components/schemas/CartItemInvoiceData'
|
|
2500
2492
|
orderLineDetails:
|
|
2501
|
-
$ref:
|
|
2493
|
+
$ref: '#/components/schemas/OrderLineDetailsResult'
|
|
2502
2494
|
supplierReferences:
|
|
2503
|
-
$ref:
|
|
2495
|
+
$ref: '#/components/schemas/CartItemSupplierReferences'
|
|
2504
2496
|
CartItemStatus:
|
|
2505
2497
|
type: string
|
|
2506
2498
|
enum:
|
|
@@ -2518,7 +2510,9 @@ components:
|
|
|
2518
2510
|
properties:
|
|
2519
2511
|
supplierId:
|
|
2520
2512
|
type: string
|
|
2521
|
-
description:
|
|
2513
|
+
description: |
|
|
2514
|
+
Unique identifier for the supplier. Used for reporting to identify to which supplier the item belongs.
|
|
2515
|
+
Only allowed for marketplace merchants or if feature to ignore Marketplace fields is enabled in configuration.
|
|
2522
2516
|
maxLength: 64
|
|
2523
2517
|
example: "5678"
|
|
2524
2518
|
orderReference:
|
|
@@ -2527,10 +2521,12 @@ components:
|
|
|
2527
2521
|
Reference of the order for the supplier.
|
|
2528
2522
|
maxLength: 64
|
|
2529
2523
|
example: "Order-5678"
|
|
2524
|
+
required:
|
|
2525
|
+
- supplierId
|
|
2530
2526
|
CheckoutResponse:
|
|
2531
2527
|
type: object
|
|
2532
2528
|
xml:
|
|
2533
|
-
name:
|
|
2529
|
+
name: 'checkoutResponse'
|
|
2534
2530
|
description: |
|
|
2535
2531
|
The Checkout corresponds to the order of the WL API. We do not take additionalInput from the WL API. We have no
|
|
2536
2532
|
shipping and use deliveryAddress instead of address.
|
|
@@ -2551,31 +2547,31 @@ components:
|
|
|
2551
2547
|
maxLength: 20
|
|
2552
2548
|
example: "1234"
|
|
2553
2549
|
amountOfMoney:
|
|
2554
|
-
$ref:
|
|
2550
|
+
$ref: '#/components/schemas/AmountOfMoney'
|
|
2555
2551
|
references:
|
|
2556
|
-
$ref:
|
|
2552
|
+
$ref: '#/components/schemas/CheckoutReferences'
|
|
2557
2553
|
shipping:
|
|
2558
|
-
$ref:
|
|
2554
|
+
$ref: '#/components/schemas/Shipping'
|
|
2559
2555
|
shoppingCart:
|
|
2560
|
-
$ref:
|
|
2556
|
+
$ref: '#/components/schemas/ShoppingCartResult'
|
|
2561
2557
|
paymentExecutions:
|
|
2562
2558
|
type: array
|
|
2563
2559
|
items:
|
|
2564
|
-
$ref:
|
|
2560
|
+
$ref: '#/components/schemas/PaymentExecution'
|
|
2565
2561
|
checkoutStatus:
|
|
2566
|
-
$ref:
|
|
2562
|
+
$ref: '#/components/schemas/StatusCheckout'
|
|
2567
2563
|
statusOutput:
|
|
2568
|
-
$ref:
|
|
2564
|
+
$ref: '#/components/schemas/StatusOutput'
|
|
2569
2565
|
paymentInformation:
|
|
2570
2566
|
type: array
|
|
2571
2567
|
items:
|
|
2572
|
-
$ref:
|
|
2568
|
+
$ref: '#/components/schemas/PaymentInformationResponse'
|
|
2573
2569
|
creationDateTime:
|
|
2574
|
-
$ref:
|
|
2570
|
+
$ref: '#/components/schemas/CreationDateTime'
|
|
2575
2571
|
allowedPaymentActions:
|
|
2576
2572
|
type: array
|
|
2577
2573
|
items:
|
|
2578
|
-
$ref:
|
|
2574
|
+
$ref: '#/components/schemas/AllowedPaymentActions'
|
|
2579
2575
|
CompleteFinancingPaymentMethodSpecificInput:
|
|
2580
2576
|
type: object
|
|
2581
2577
|
description: |
|
|
@@ -2597,10 +2593,10 @@ components:
|
|
|
2597
2593
|
* true = the payment requires approval before the funds will be captured using the Approve payment or
|
|
2598
2594
|
Capture payment API
|
|
2599
2595
|
* false = the payment does not require approval, and the funds will be captured automatically
|
|
2600
|
-
|
|
2596
|
+
|
|
2601
2597
|
If the parameter is not provided in the request, the default value will be true
|
|
2602
2598
|
paymentProduct3391SpecificInput:
|
|
2603
|
-
$ref:
|
|
2599
|
+
$ref: '#/components/schemas/PaymentProduct3391SpecificInput'
|
|
2604
2600
|
CompleteOrderRequest:
|
|
2605
2601
|
type: object
|
|
2606
2602
|
description: |-
|
|
@@ -2608,16 +2604,16 @@ components:
|
|
|
2608
2604
|
The previously provided data from the Commerce Case, Checkout and Order will automatically be loaded and used for the completion of the Order.
|
|
2609
2605
|
properties:
|
|
2610
2606
|
completePaymentMethodSpecificInput:
|
|
2611
|
-
$ref:
|
|
2607
|
+
$ref: '#/components/schemas/CompletePaymentMethodSpecificInput'
|
|
2612
2608
|
CompletePaymentMethodSpecificInput:
|
|
2613
2609
|
type: object
|
|
2614
2610
|
description: |
|
|
2615
2611
|
To complete the Order the completePaymentMethodSpecificInput has to be provided, containing the selected installmentOptionId as well as the the bankAccountInformation of the customer.
|
|
2616
2612
|
properties:
|
|
2617
2613
|
paymentProduct3391SpecificInput:
|
|
2618
|
-
$ref:
|
|
2614
|
+
$ref: '#/components/schemas/PaymentProduct3391SpecificInput'
|
|
2619
2615
|
paymentProduct840SpecificInput:
|
|
2620
|
-
$ref:
|
|
2616
|
+
$ref: '#/components/schemas/CompletePaymentProduct840SpecificInput'
|
|
2621
2617
|
CompletePaymentProduct840SpecificInput:
|
|
2622
2618
|
type: object
|
|
2623
2619
|
description: |-
|
|
@@ -2649,58 +2645,58 @@ components:
|
|
|
2649
2645
|
The data for the order object should not differ from the previously provided information in Commerce Case, Checkout and Payment, but will not be validated nor automatically loaded from the Commerce Platform.
|
|
2650
2646
|
properties:
|
|
2651
2647
|
financingPaymentMethodSpecificInput:
|
|
2652
|
-
$ref:
|
|
2648
|
+
$ref: '#/components/schemas/CompleteFinancingPaymentMethodSpecificInput'
|
|
2653
2649
|
redirectPaymentMethodSpecificInput:
|
|
2654
|
-
$ref:
|
|
2650
|
+
$ref: '#/components/schemas/CompleteRedirectPaymentMethodSpecificInput'
|
|
2655
2651
|
order:
|
|
2656
|
-
$ref:
|
|
2652
|
+
$ref: '#/components/schemas/Order'
|
|
2657
2653
|
device:
|
|
2658
|
-
$ref:
|
|
2654
|
+
$ref: '#/components/schemas/CustomerDevice'
|
|
2659
2655
|
CompletePaymentResponse:
|
|
2660
2656
|
type: object
|
|
2661
2657
|
description: |-
|
|
2662
2658
|
Object containing the response of the completed Payment.
|
|
2663
2659
|
properties:
|
|
2664
2660
|
creationOutput:
|
|
2665
|
-
$ref:
|
|
2661
|
+
$ref: '#/components/schemas/PaymentCreationOutput'
|
|
2666
2662
|
merchantAction:
|
|
2667
|
-
$ref:
|
|
2663
|
+
$ref: '#/components/schemas/MerchantAction'
|
|
2668
2664
|
payment:
|
|
2669
|
-
$ref:
|
|
2665
|
+
$ref: '#/components/schemas/PaymentResponse'
|
|
2670
2666
|
CompleteRedirectPaymentMethodSpecificInput:
|
|
2671
2667
|
type: object
|
|
2672
2668
|
description: |-
|
|
2673
2669
|
Object containing the redirect payment product details.
|
|
2674
2670
|
properties:
|
|
2675
2671
|
paymentProductId:
|
|
2676
|
-
$ref:
|
|
2672
|
+
$ref: '#/components/schemas/PaymentProductId'
|
|
2677
2673
|
paymentProduct840SpecificInput:
|
|
2678
|
-
$ref:
|
|
2674
|
+
$ref: '#/components/schemas/CompletePaymentProduct840SpecificInput'
|
|
2679
2675
|
CreateCheckoutRequest:
|
|
2680
2676
|
type: object
|
|
2681
2677
|
description: |
|
|
2682
2678
|
Request to create a Checkout for a Commerce Case.
|
|
2683
2679
|
The payment for the Checkout can be directly executed if autoExecuteOrder = true.
|
|
2684
2680
|
In this case, the paymentMethodSpecificInput must be provided and only a full order is possible.
|
|
2685
|
-
|
|
2681
|
+
|
|
2686
2682
|
If no amountOfMoney is provided, the platform will calculate the respective Checkout amount based on the
|
|
2687
2683
|
cartItem productPrice and quantity.
|
|
2688
|
-
|
|
2684
|
+
|
|
2689
2685
|
In case of a payment error, the payment can be retried by providing the respective commerceCaseId and checkoutId
|
|
2690
2686
|
to the the Order or Payment Execution endpoint.
|
|
2691
2687
|
properties:
|
|
2692
2688
|
amountOfMoney:
|
|
2693
|
-
$ref:
|
|
2689
|
+
$ref: '#/components/schemas/AmountOfMoney'
|
|
2694
2690
|
references:
|
|
2695
|
-
$ref:
|
|
2691
|
+
$ref: '#/components/schemas/CheckoutReferences'
|
|
2696
2692
|
shipping:
|
|
2697
|
-
$ref:
|
|
2693
|
+
$ref: '#/components/schemas/Shipping'
|
|
2698
2694
|
shoppingCart:
|
|
2699
|
-
$ref:
|
|
2695
|
+
$ref: '#/components/schemas/ShoppingCartInput'
|
|
2700
2696
|
orderRequest:
|
|
2701
|
-
$ref:
|
|
2697
|
+
$ref: '#/components/schemas/OrderRequest'
|
|
2702
2698
|
creationDateTime:
|
|
2703
|
-
$ref:
|
|
2699
|
+
$ref: '#/components/schemas/CreationDateTime'
|
|
2704
2700
|
autoExecuteOrder:
|
|
2705
2701
|
description: |
|
|
2706
2702
|
Set this flag to directly execute a payment when creating a Commerce Case or Checkout.
|
|
@@ -2721,29 +2717,29 @@ components:
|
|
|
2721
2717
|
format: UUID
|
|
2722
2718
|
example: "707ef15b-7a0a-48f2-b7d8-c95103418a9c"
|
|
2723
2719
|
shoppingCart:
|
|
2724
|
-
$ref:
|
|
2720
|
+
$ref: '#/components/schemas/ShoppingCartResult'
|
|
2725
2721
|
paymentResponse:
|
|
2726
|
-
$ref:
|
|
2722
|
+
$ref: '#/components/schemas/CreatePaymentResponse'
|
|
2727
2723
|
errorResponse:
|
|
2728
|
-
$ref:
|
|
2724
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
2729
2725
|
amountOfMoney:
|
|
2730
|
-
$ref:
|
|
2726
|
+
$ref: '#/components/schemas/AmountOfMoney'
|
|
2731
2727
|
references:
|
|
2732
|
-
$ref:
|
|
2728
|
+
$ref: '#/components/schemas/CheckoutReferences'
|
|
2733
2729
|
shipping:
|
|
2734
|
-
$ref:
|
|
2730
|
+
$ref: '#/components/schemas/Shipping'
|
|
2735
2731
|
paymentExecution:
|
|
2736
|
-
$ref:
|
|
2732
|
+
$ref: '#/components/schemas/PaymentExecution'
|
|
2737
2733
|
checkoutStatus:
|
|
2738
|
-
$ref:
|
|
2734
|
+
$ref: '#/components/schemas/StatusCheckout'
|
|
2739
2735
|
statusOutput:
|
|
2740
|
-
$ref:
|
|
2736
|
+
$ref: '#/components/schemas/StatusOutput'
|
|
2741
2737
|
creationDateTime:
|
|
2742
|
-
$ref:
|
|
2738
|
+
$ref: '#/components/schemas/CreationDateTime'
|
|
2743
2739
|
allowedPaymentActions:
|
|
2744
2740
|
type: array
|
|
2745
2741
|
items:
|
|
2746
|
-
$ref:
|
|
2742
|
+
$ref: '#/components/schemas/AllowedPaymentActions'
|
|
2747
2743
|
CheckoutReferences:
|
|
2748
2744
|
type: object
|
|
2749
2745
|
description: Object containing all details that are linked to the Checkout.
|
|
@@ -2756,7 +2752,8 @@ components:
|
|
|
2756
2752
|
example: customer-order-1234
|
|
2757
2753
|
merchantShopReference:
|
|
2758
2754
|
type: string
|
|
2759
|
-
description:
|
|
2755
|
+
description:
|
|
2756
|
+
Optional parameter to define the shop or touchpoint where a sale has been realized (e.g. different stores).
|
|
2760
2757
|
maxLength: 64
|
|
2761
2758
|
example: Shop-12345
|
|
2762
2759
|
CheckoutsResponse:
|
|
@@ -2774,7 +2771,7 @@ components:
|
|
|
2774
2771
|
type: array
|
|
2775
2772
|
description: List of Checkouts
|
|
2776
2773
|
items:
|
|
2777
|
-
$ref:
|
|
2774
|
+
$ref: '#/components/schemas/CheckoutResponse'
|
|
2778
2775
|
CompanyInformation:
|
|
2779
2776
|
description: Object containing details of the company.
|
|
2780
2777
|
type: object
|
|
@@ -2800,18 +2797,18 @@ components:
|
|
|
2800
2797
|
Unique ID reference of the Commerce Case. It can be used to add additional Checkouts to the Commerce Case.
|
|
2801
2798
|
example: 0c3ab9d7-19ed-40da-9a0e-1f96f4cfb8ae
|
|
2802
2799
|
customer:
|
|
2803
|
-
$ref:
|
|
2800
|
+
$ref: '#/components/schemas/Customer'
|
|
2804
2801
|
checkouts:
|
|
2805
2802
|
type: array
|
|
2806
2803
|
items:
|
|
2807
|
-
$ref:
|
|
2804
|
+
$ref: '#/components/schemas/CheckoutResponse'
|
|
2808
2805
|
creationDateTime:
|
|
2809
|
-
$ref:
|
|
2806
|
+
$ref: '#/components/schemas/CreationDateTime'
|
|
2810
2807
|
CommerceCasesResponse:
|
|
2811
2808
|
type: array
|
|
2812
2809
|
description: List of Commerce Cases
|
|
2813
2810
|
items:
|
|
2814
|
-
$ref:
|
|
2811
|
+
$ref: '#/components/schemas/CommerceCaseResponse'
|
|
2815
2812
|
ContactDetails:
|
|
2816
2813
|
type: object
|
|
2817
2814
|
description: |-
|
|
@@ -2837,11 +2834,11 @@ components:
|
|
|
2837
2834
|
maxLength: 40
|
|
2838
2835
|
example: customer-commerce-case-123
|
|
2839
2836
|
customer:
|
|
2840
|
-
$ref:
|
|
2837
|
+
$ref: '#/components/schemas/Customer'
|
|
2841
2838
|
creationDateTime:
|
|
2842
|
-
$ref:
|
|
2839
|
+
$ref: '#/components/schemas/CreationDateTime'
|
|
2843
2840
|
checkout:
|
|
2844
|
-
$ref:
|
|
2841
|
+
$ref: '#/components/schemas/CreateCheckoutRequest'
|
|
2845
2842
|
CreateCommerceCaseResponse:
|
|
2846
2843
|
type: object
|
|
2847
2844
|
description: |-
|
|
@@ -2860,24 +2857,24 @@ components:
|
|
|
2860
2857
|
maxLength: 40
|
|
2861
2858
|
example: customer-commerce-case-123
|
|
2862
2859
|
customer:
|
|
2863
|
-
$ref:
|
|
2860
|
+
$ref: '#/components/schemas/Customer'
|
|
2864
2861
|
checkout:
|
|
2865
|
-
$ref:
|
|
2862
|
+
$ref: '#/components/schemas/CreateCheckoutResponse'
|
|
2866
2863
|
creationDateTime:
|
|
2867
|
-
$ref:
|
|
2864
|
+
$ref: '#/components/schemas/CreationDateTime'
|
|
2868
2865
|
CreatePaymentResponse:
|
|
2869
2866
|
type: object
|
|
2870
2867
|
description: Object containing details on the created payment it has directly be executed.
|
|
2871
2868
|
additionalProperties: false
|
|
2872
2869
|
properties:
|
|
2873
2870
|
creationOutput:
|
|
2874
|
-
$ref:
|
|
2871
|
+
$ref: '#/components/schemas/PaymentCreationOutput'
|
|
2875
2872
|
merchantAction:
|
|
2876
|
-
$ref:
|
|
2873
|
+
$ref: '#/components/schemas/MerchantAction'
|
|
2877
2874
|
payment:
|
|
2878
|
-
$ref:
|
|
2875
|
+
$ref: '#/components/schemas/PaymentResponse'
|
|
2879
2876
|
fundSplit:
|
|
2880
|
-
$ref:
|
|
2877
|
+
$ref: '#/components/schemas/FundSplit'
|
|
2881
2878
|
paymentExecutionId:
|
|
2882
2879
|
description: reference to the paymentExecution.
|
|
2883
2880
|
type: string
|
|
@@ -2891,7 +2888,7 @@ components:
|
|
|
2891
2888
|
otherwise will be automatically set to the time when the request CreateCommerceCase was received.
|
|
2892
2889
|
Response values will always be in UTC time, but when providing this field in the requests, the time offset
|
|
2893
2890
|
can have different formats.
|
|
2894
|
-
|
|
2891
|
+
|
|
2895
2892
|
Accepted formats are:
|
|
2896
2893
|
* YYYY-MM-DD'T'HH:mm:ss'Z'
|
|
2897
2894
|
* YYYY-MM-DD'T'HH:mm:ss+XX:XX
|
|
@@ -2899,7 +2896,7 @@ components:
|
|
|
2899
2896
|
* YYYY-MM-DD'T'HH:mm'Z'
|
|
2900
2897
|
* YYYY-MM-DD'T'HH:mm+XX:XX
|
|
2901
2898
|
* YYYY-MM-DD'T'HH:mm-XX:XX
|
|
2902
|
-
|
|
2899
|
+
|
|
2903
2900
|
All other formats may be ignored by the system.
|
|
2904
2901
|
example: 2023-12-06T23:59:60Z
|
|
2905
2902
|
Customer:
|
|
@@ -2909,16 +2906,16 @@ components:
|
|
|
2909
2906
|
additionalProperties: false
|
|
2910
2907
|
properties:
|
|
2911
2908
|
companyInformation:
|
|
2912
|
-
$ref:
|
|
2909
|
+
$ref: '#/components/schemas/CompanyInformation'
|
|
2913
2910
|
merchantCustomerId:
|
|
2914
2911
|
type: string
|
|
2915
2912
|
description: Unique identifier for the customer.
|
|
2916
2913
|
maxLength: 20
|
|
2917
2914
|
example: "1234"
|
|
2918
2915
|
billingAddress:
|
|
2919
|
-
$ref:
|
|
2916
|
+
$ref: '#/components/schemas/Address'
|
|
2920
2917
|
contactDetails:
|
|
2921
|
-
$ref:
|
|
2918
|
+
$ref: '#/components/schemas/ContactDetails'
|
|
2922
2919
|
fiscalNumber:
|
|
2923
2920
|
maxLength: 14
|
|
2924
2921
|
type: string
|
|
@@ -2951,13 +2948,13 @@ components:
|
|
|
2951
2948
|
type: string
|
|
2952
2949
|
description: |-
|
|
2953
2950
|
The locale that the customer should be addressed in (for 3rd parties).
|
|
2954
|
-
|
|
2951
|
+
|
|
2955
2952
|
Note: Only the language code is supported.
|
|
2956
2953
|
example: de
|
|
2957
2954
|
personalInformation:
|
|
2958
|
-
$ref:
|
|
2955
|
+
$ref: '#/components/schemas/PersonalInformation'
|
|
2959
2956
|
account:
|
|
2960
|
-
$ref:
|
|
2957
|
+
$ref: '#/components/schemas/CustomerAccount'
|
|
2961
2958
|
CustomerAccount:
|
|
2962
2959
|
type: object
|
|
2963
2960
|
description: Object containing data related to the account the customer has with you.
|
|
@@ -2980,7 +2977,7 @@ components:
|
|
|
2980
2977
|
properties:
|
|
2981
2978
|
acceptHeader:
|
|
2982
2979
|
type: string
|
|
2983
|
-
description: |
|
|
2980
|
+
description: |
|
|
2984
2981
|
The accept-header of the customer client from the HTTP Headers.
|
|
2985
2982
|
This field can be mandatory depending on the selected payment method and routing option.
|
|
2986
2983
|
maxLength: 2048
|
|
@@ -2992,8 +2989,7 @@ components:
|
|
|
2992
2989
|
deviceToken:
|
|
2993
2990
|
maxLength: 255
|
|
2994
2991
|
type: string
|
|
2995
|
-
description:
|
|
2996
|
-
Tokenized representation of the end customers device. For example
|
|
2992
|
+
description: Tokenized representation of the end customers device. For example
|
|
2997
2993
|
used for PAYONE Buy Now, Pay Later (BNPL).
|
|
2998
2994
|
userAgent:
|
|
2999
2995
|
type: string
|
|
@@ -3032,14 +3028,14 @@ components:
|
|
|
3032
3028
|
The platform will automatically calculate the respective amount to trigger the Capture. For a partial Deliver a
|
|
3033
3029
|
list of items must be provided.
|
|
3034
3030
|
The item details for the Capture will be automatically loaded from the Checkout.
|
|
3035
|
-
|
|
3031
|
+
|
|
3036
3032
|
The cancellationReason must be provided if deliverType is set to PARTIAL and isFinal is set to true for BNPL
|
|
3037
3033
|
payment methods (paymentProductId 3390, 3391 and 3392).
|
|
3038
3034
|
For other payment methods the cancellationReason is not mandatory in this case but can be used for reporting
|
|
3039
3035
|
and reconciliation purposes.
|
|
3040
3036
|
properties:
|
|
3041
3037
|
deliverType:
|
|
3042
|
-
$ref:
|
|
3038
|
+
$ref: '#/components/schemas/DeliverType'
|
|
3043
3039
|
isFinal:
|
|
3044
3040
|
type: boolean
|
|
3045
3041
|
default: false
|
|
@@ -3048,20 +3044,20 @@ components:
|
|
|
3048
3044
|
For deliverType FULL, it is always the final operation.
|
|
3049
3045
|
If deliverType PARTIAL is provided and the property is set to true, the remaining amount of the items will be cancelled and the items are marked as CANCELLED.
|
|
3050
3046
|
cancellationReason:
|
|
3051
|
-
$ref:
|
|
3047
|
+
$ref: '#/components/schemas/CancellationReason'
|
|
3052
3048
|
deliverItems:
|
|
3053
3049
|
type: array
|
|
3054
3050
|
items:
|
|
3055
|
-
$ref:
|
|
3051
|
+
$ref: '#/components/schemas/DeliverItem'
|
|
3056
3052
|
fundSplit:
|
|
3057
|
-
$ref:
|
|
3053
|
+
$ref: '#/components/schemas/FundSplit'
|
|
3058
3054
|
DeliverResponse:
|
|
3059
3055
|
type: object
|
|
3060
3056
|
properties:
|
|
3061
3057
|
capturePaymentResponse:
|
|
3062
|
-
$ref:
|
|
3058
|
+
$ref: '#/components/schemas/CapturePaymentResponse'
|
|
3063
3059
|
shoppingCart:
|
|
3064
|
-
$ref:
|
|
3060
|
+
$ref: '#/components/schemas/ShoppingCartResult'
|
|
3065
3061
|
DeliverType:
|
|
3066
3062
|
type: string
|
|
3067
3063
|
description: |
|
|
@@ -3088,7 +3084,7 @@ components:
|
|
|
3088
3084
|
type: array
|
|
3089
3085
|
description: Items delivered.
|
|
3090
3086
|
items:
|
|
3091
|
-
$ref:
|
|
3087
|
+
$ref: '#/components/schemas/CartItemInput'
|
|
3092
3088
|
ErrorResponse:
|
|
3093
3089
|
type: object
|
|
3094
3090
|
additionalProperties: false
|
|
@@ -3099,7 +3095,7 @@ components:
|
|
|
3099
3095
|
errors:
|
|
3100
3096
|
type: array
|
|
3101
3097
|
items:
|
|
3102
|
-
$ref:
|
|
3098
|
+
$ref: '#/components/schemas/APIError'
|
|
3103
3099
|
ExtendedCheckoutStatus:
|
|
3104
3100
|
type: string
|
|
3105
3101
|
description: |
|
|
@@ -3149,10 +3145,10 @@ components:
|
|
|
3149
3145
|
* true = the payment requires approval before the funds will be captured using the Approve payment or
|
|
3150
3146
|
Capture payment API
|
|
3151
3147
|
* false = the payment does not require approval, and the funds will be captured automatically
|
|
3152
|
-
|
|
3148
|
+
|
|
3153
3149
|
If the parameter is not provided in the request, the default value will be true
|
|
3154
3150
|
paymentProduct3392SpecificInput:
|
|
3155
|
-
$ref:
|
|
3151
|
+
$ref: '#/components/schemas/PaymentProduct3392SpecificInput'
|
|
3156
3152
|
FinancingPaymentMethodSpecificOutput:
|
|
3157
3153
|
type: object
|
|
3158
3154
|
description: Object containing the specific output details for financing payment methods (Buy Now Pay Later)
|
|
@@ -3170,9 +3166,9 @@ components:
|
|
|
3170
3166
|
format: int32
|
|
3171
3167
|
example: 3390
|
|
3172
3168
|
paymentProduct3391SpecificOutput:
|
|
3173
|
-
$ref:
|
|
3169
|
+
$ref: '#/components/schemas/PaymentProduct3391SpecificOutput'
|
|
3174
3170
|
paymentInstructions:
|
|
3175
|
-
$ref:
|
|
3171
|
+
$ref: '#/components/schemas/PaymentInstructions'
|
|
3176
3172
|
FundDistribution:
|
|
3177
3173
|
type: object
|
|
3178
3174
|
description: Instructions for distributing funds to multiple sellers or partners in a marketplace context.
|
|
@@ -3227,7 +3223,9 @@ components:
|
|
|
3227
3223
|
- type
|
|
3228
3224
|
FundSplit:
|
|
3229
3225
|
type: object
|
|
3230
|
-
description:
|
|
3226
|
+
description: |
|
|
3227
|
+
Instructions for distributing funds to multiple suppliers or partners in a marketplace context.
|
|
3228
|
+
Only allowed for marketplace merchants or if feature to ignore Marketplace fields is enabled in configuration.
|
|
3231
3229
|
additionalProperties: false
|
|
3232
3230
|
properties:
|
|
3233
3231
|
id:
|
|
@@ -3241,14 +3239,13 @@ components:
|
|
|
3241
3239
|
fundDistributions:
|
|
3242
3240
|
type: array
|
|
3243
3241
|
items:
|
|
3244
|
-
$ref:
|
|
3242
|
+
$ref: '#/components/schemas/FundDistribution'
|
|
3245
3243
|
InstallmentOption:
|
|
3246
3244
|
type: object
|
|
3247
3245
|
properties:
|
|
3248
3246
|
installmentOptionId:
|
|
3249
3247
|
type: string
|
|
3250
|
-
description:
|
|
3251
|
-
Installment option Identifier. Use this in the Complete Payment
|
|
3248
|
+
description: Installment option Identifier. Use this in the Complete Payment
|
|
3252
3249
|
for the selected installment option.
|
|
3253
3250
|
example: IOP_478d44fea0494eea86bc87f9e4a63328
|
|
3254
3251
|
numberOfPayments:
|
|
@@ -3260,12 +3257,12 @@ components:
|
|
|
3260
3257
|
type: object
|
|
3261
3258
|
description: Monthly rate amount.
|
|
3262
3259
|
allOf:
|
|
3263
|
-
- $ref:
|
|
3260
|
+
- $ref: '#/components/schemas/AmountOfMoney'
|
|
3264
3261
|
lastRateAmount:
|
|
3265
3262
|
type: object
|
|
3266
3263
|
description: Last rate amount.
|
|
3267
3264
|
allOf:
|
|
3268
|
-
- $ref:
|
|
3265
|
+
- $ref: '#/components/schemas/AmountOfMoney'
|
|
3269
3266
|
effectiveInterestRate:
|
|
3270
3267
|
type: integer
|
|
3271
3268
|
description: Effective interest amount in percent with two decimals.
|
|
@@ -3280,7 +3277,7 @@ components:
|
|
|
3280
3277
|
type: object
|
|
3281
3278
|
description: Total rate amount.
|
|
3282
3279
|
allOf:
|
|
3283
|
-
- $ref:
|
|
3280
|
+
- $ref: '#/components/schemas/AmountOfMoney'
|
|
3284
3281
|
firstRateDate:
|
|
3285
3282
|
maxLength: 8
|
|
3286
3283
|
pattern: ^((19|20|21)\d{6})?$
|
|
@@ -3292,7 +3289,7 @@ components:
|
|
|
3292
3289
|
type: object
|
|
3293
3290
|
description: Link with credit information.
|
|
3294
3291
|
allOf:
|
|
3295
|
-
- $ref:
|
|
3292
|
+
- $ref: '#/components/schemas/LinkInformation'
|
|
3296
3293
|
required:
|
|
3297
3294
|
- creditInformation
|
|
3298
3295
|
- effectiveInterestRate
|
|
@@ -3356,16 +3353,16 @@ components:
|
|
|
3356
3353
|
- MOBILE_THREEDS_CHALLENGE
|
|
3357
3354
|
- CALL_THIRD_PARTY
|
|
3358
3355
|
redirectData:
|
|
3359
|
-
$ref:
|
|
3356
|
+
$ref: '#/components/schemas/RedirectData'
|
|
3360
3357
|
MobilePaymentMethodSpecificInput:
|
|
3361
3358
|
type: object
|
|
3362
3359
|
description: Object containing the specific input details for mobile payments.
|
|
3363
3360
|
additionalProperties: false
|
|
3364
3361
|
properties:
|
|
3365
3362
|
paymentProductId:
|
|
3366
|
-
$ref:
|
|
3363
|
+
$ref: '#/components/schemas/PaymentProductId'
|
|
3367
3364
|
authorizationMode:
|
|
3368
|
-
$ref:
|
|
3365
|
+
$ref: '#/components/schemas/AuthorizationMode'
|
|
3369
3366
|
encryptedPaymentData:
|
|
3370
3367
|
type: string
|
|
3371
3368
|
description: |-
|
|
@@ -3380,11 +3377,11 @@ components:
|
|
|
3380
3377
|
type: string
|
|
3381
3378
|
description: Ephemeral Key A unique generated key used by Apple to encrypt data.
|
|
3382
3379
|
threeDSecure:
|
|
3383
|
-
$ref:
|
|
3380
|
+
$ref: '#/components/schemas/MobilePaymentThreeDSecure'
|
|
3384
3381
|
paymentProduct302SpecificInput:
|
|
3385
|
-
$ref:
|
|
3382
|
+
$ref: '#/components/schemas/PaymentProduct302SpecificInput'
|
|
3386
3383
|
paymentProduct5002SpecificInput:
|
|
3387
|
-
$ref:
|
|
3384
|
+
$ref: '#/components/schemas/PaymentProduct5002SpecificInput'
|
|
3388
3385
|
MobilePaymentMethodSpecificOutput:
|
|
3389
3386
|
type: object
|
|
3390
3387
|
description: Object containing the mobile payment method details.
|
|
@@ -3402,9 +3399,9 @@ components:
|
|
|
3402
3399
|
description: Card Authorization code as returned by the acquirer
|
|
3403
3400
|
type: string
|
|
3404
3401
|
fraudResults:
|
|
3405
|
-
$ref:
|
|
3402
|
+
$ref: '#/components/schemas/CardFraudResults'
|
|
3406
3403
|
threeDSecureResults:
|
|
3407
|
-
$ref:
|
|
3404
|
+
$ref: '#/components/schemas/ThreeDSecureResults'
|
|
3408
3405
|
network:
|
|
3409
3406
|
type: string
|
|
3410
3407
|
description: The card network that was used for a mobile payment method operation
|
|
@@ -3433,7 +3430,7 @@ components:
|
|
|
3433
3430
|
Necessary to perform 3D Secure when there is no liability shift from the wallet and corresponding card network.
|
|
3434
3431
|
properties:
|
|
3435
3432
|
redirectionData:
|
|
3436
|
-
$ref:
|
|
3433
|
+
$ref: '#/components/schemas/RedirectionData'
|
|
3437
3434
|
Order:
|
|
3438
3435
|
type: object
|
|
3439
3436
|
description: |-
|
|
@@ -3441,15 +3438,15 @@ components:
|
|
|
3441
3438
|
amount.
|
|
3442
3439
|
properties:
|
|
3443
3440
|
amountOfMoney:
|
|
3444
|
-
$ref:
|
|
3441
|
+
$ref: '#/components/schemas/AmountOfMoney'
|
|
3445
3442
|
customer:
|
|
3446
|
-
$ref:
|
|
3443
|
+
$ref: '#/components/schemas/Customer'
|
|
3447
3444
|
references:
|
|
3448
|
-
$ref:
|
|
3445
|
+
$ref: '#/components/schemas/References'
|
|
3449
3446
|
shipping:
|
|
3450
|
-
$ref:
|
|
3447
|
+
$ref: '#/components/schemas/Shipping'
|
|
3451
3448
|
shoppingCart:
|
|
3452
|
-
$ref:
|
|
3449
|
+
$ref: '#/components/schemas/ShoppingCartInput'
|
|
3453
3450
|
required:
|
|
3454
3451
|
- references
|
|
3455
3452
|
OrderItem:
|
|
@@ -3493,7 +3490,7 @@ components:
|
|
|
3493
3490
|
minimum: 0
|
|
3494
3491
|
example: 480
|
|
3495
3492
|
productType:
|
|
3496
|
-
$ref:
|
|
3493
|
+
$ref: '#/components/schemas/ProductType'
|
|
3497
3494
|
quantity:
|
|
3498
3495
|
type: integer
|
|
3499
3496
|
description: |-
|
|
@@ -3512,7 +3509,7 @@ components:
|
|
|
3512
3509
|
example: 0
|
|
3513
3510
|
taxAmountPerUnit:
|
|
3514
3511
|
type: boolean
|
|
3515
|
-
description: |-
|
|
3512
|
+
description: |-
|
|
3516
3513
|
This field indicates if the `taxAmount` is to be interpreted as the tax amount per unit rather than for the entire line item.
|
|
3517
3514
|
This field is included in the response only when `taxAmount` is set; otherwise, it will return as `null`.
|
|
3518
3515
|
format: int64
|
|
@@ -3560,24 +3557,25 @@ components:
|
|
|
3560
3557
|
Object containing additional information that when supplied can have a beneficial effect on the discountrates.
|
|
3561
3558
|
additionalProperties: false
|
|
3562
3559
|
allOf:
|
|
3563
|
-
- $ref:
|
|
3564
|
-
|
|
3565
|
-
|
|
3566
|
-
|
|
3567
|
-
|
|
3568
|
-
|
|
3569
|
-
|
|
3570
|
-
|
|
3571
|
-
|
|
3572
|
-
|
|
3573
|
-
|
|
3560
|
+
- $ref: '#/components/schemas/OrderLineDetailsInput'
|
|
3561
|
+
- type: object
|
|
3562
|
+
properties:
|
|
3563
|
+
id:
|
|
3564
|
+
description: Unique identifier of a cart item
|
|
3565
|
+
type: string
|
|
3566
|
+
format: UUID
|
|
3567
|
+
example: 7a3444d3-f6ce-4b6e-b6c4-2486a160cf19
|
|
3568
|
+
status:
|
|
3569
|
+
type: array
|
|
3570
|
+
items:
|
|
3571
|
+
$ref: '#/components/schemas/CartItemOrderStatus'
|
|
3574
3572
|
OrderLineDetailsResult:
|
|
3575
3573
|
type: object
|
|
3576
3574
|
description: |
|
|
3577
3575
|
Object containing additional information that when supplied can have a beneficial effect on the discountrates.
|
|
3578
3576
|
additionalProperties: false
|
|
3579
3577
|
allOf:
|
|
3580
|
-
- $ref:
|
|
3578
|
+
- $ref: '#/components/schemas/OrderLineDetailsInput'
|
|
3581
3579
|
properties:
|
|
3582
3580
|
id:
|
|
3583
3581
|
description: Unique identifier of a cart item
|
|
@@ -3587,7 +3585,7 @@ components:
|
|
|
3587
3585
|
status:
|
|
3588
3586
|
type: array
|
|
3589
3587
|
items:
|
|
3590
|
-
$ref:
|
|
3588
|
+
$ref: '#/components/schemas/CartItemOrderStatus'
|
|
3591
3589
|
OrderRequest:
|
|
3592
3590
|
type: object
|
|
3593
3591
|
description: |
|
|
@@ -3601,26 +3599,26 @@ components:
|
|
|
3601
3599
|
execution.
|
|
3602
3600
|
properties:
|
|
3603
3601
|
orderType:
|
|
3604
|
-
$ref:
|
|
3602
|
+
$ref: '#/components/schemas/OrderType'
|
|
3605
3603
|
orderReferences:
|
|
3606
|
-
$ref:
|
|
3604
|
+
$ref: '#/components/schemas/References'
|
|
3607
3605
|
items:
|
|
3608
3606
|
type: array
|
|
3609
3607
|
items:
|
|
3610
|
-
$ref:
|
|
3608
|
+
$ref: '#/components/schemas/OrderItem'
|
|
3611
3609
|
paymentMethodSpecificInput:
|
|
3612
|
-
$ref:
|
|
3610
|
+
$ref: '#/components/schemas/PaymentMethodSpecificInput'
|
|
3613
3611
|
fundSplit:
|
|
3614
|
-
$ref:
|
|
3612
|
+
$ref: '#/components/schemas/FundSplit'
|
|
3615
3613
|
OrderResponse:
|
|
3616
3614
|
type: object
|
|
3617
3615
|
description: Object that contains details on the created payment in case one has been created.
|
|
3618
3616
|
additionalProperties: false
|
|
3619
3617
|
properties:
|
|
3620
3618
|
createPaymentResponse:
|
|
3621
|
-
$ref:
|
|
3619
|
+
$ref: '#/components/schemas/CreatePaymentResponse'
|
|
3622
3620
|
shoppingCart:
|
|
3623
|
-
$ref:
|
|
3621
|
+
$ref: '#/components/schemas/ShoppingCartResult'
|
|
3624
3622
|
OrderType:
|
|
3625
3623
|
type: string
|
|
3626
3624
|
description: |
|
|
@@ -3638,38 +3636,37 @@ components:
|
|
|
3638
3636
|
enum:
|
|
3639
3637
|
- FULL
|
|
3640
3638
|
- PARTIAL
|
|
3641
|
-
readOnly: true
|
|
3642
3639
|
PatchCheckoutRequest:
|
|
3643
3640
|
type: object
|
|
3644
3641
|
description: |
|
|
3645
3642
|
An existing shopping cart of a Checkout will not be overwritten with the Patch request.
|
|
3646
3643
|
New items can be added to the shoppingCart by providing them in the request.
|
|
3647
3644
|
To change existing items (delete, modify or add), the respective itemId must be provided. An item can be completely removed if quantity = 0 is provided.
|
|
3648
|
-
|
|
3645
|
+
|
|
3649
3646
|
The price of an item can be changed as long as no payment has happened for this item (i.e. as long as an item has no specific status).
|
|
3650
3647
|
Items with a status can no longer be removed entirely, however the quantity can be increased or decreased (for items without payment) by using the itemId.
|
|
3651
|
-
|
|
3648
|
+
|
|
3652
3649
|
If no amountOfMoney for the Checkout is provided, the platform will calculate the respective amount based on the cartItem productPrice and productQuantity.
|
|
3653
3650
|
properties:
|
|
3654
3651
|
amountOfMoney:
|
|
3655
|
-
$ref:
|
|
3652
|
+
$ref: '#/components/schemas/AmountOfMoney'
|
|
3656
3653
|
references:
|
|
3657
|
-
$ref:
|
|
3654
|
+
$ref: '#/components/schemas/CheckoutReferences'
|
|
3658
3655
|
shipping:
|
|
3659
|
-
$ref:
|
|
3656
|
+
$ref: '#/components/schemas/Shipping'
|
|
3660
3657
|
shoppingCart:
|
|
3661
|
-
$ref:
|
|
3658
|
+
$ref: '#/components/schemas/ShoppingCartPatch'
|
|
3662
3659
|
paymentMethodSpecificInput:
|
|
3663
|
-
$ref:
|
|
3660
|
+
$ref: '#/components/schemas/PaymentMethodSpecificInput'
|
|
3664
3661
|
paymentReferences:
|
|
3665
|
-
$ref:
|
|
3662
|
+
$ref: '#/components/schemas/References'
|
|
3666
3663
|
PatchCommerceCaseRequest:
|
|
3667
3664
|
type: object
|
|
3668
3665
|
description: |
|
|
3669
3666
|
Update the customer data of the given Commerce Case
|
|
3670
3667
|
properties:
|
|
3671
3668
|
customer:
|
|
3672
|
-
$ref:
|
|
3669
|
+
$ref: '#/components/schemas/Customer'
|
|
3673
3670
|
PausePaymentRequest:
|
|
3674
3671
|
type: object
|
|
3675
3672
|
description: Request to pause a payment for a specific payment method.
|
|
@@ -3678,7 +3675,7 @@ components:
|
|
|
3678
3675
|
type: object
|
|
3679
3676
|
properties:
|
|
3680
3677
|
status:
|
|
3681
|
-
$ref:
|
|
3678
|
+
$ref: '#/components/schemas/StatusValue'
|
|
3682
3679
|
PaymentChannel:
|
|
3683
3680
|
type: string
|
|
3684
3681
|
enum:
|
|
@@ -3721,13 +3718,13 @@ components:
|
|
|
3721
3718
|
description: Detailed information regarding an occurred payment event.
|
|
3722
3719
|
properties:
|
|
3723
3720
|
type:
|
|
3724
|
-
$ref:
|
|
3721
|
+
$ref: '#/components/schemas/PaymentType'
|
|
3725
3722
|
amountOfMoney:
|
|
3726
|
-
$ref:
|
|
3723
|
+
$ref: '#/components/schemas/AmountOfMoney'
|
|
3727
3724
|
paymentStatus:
|
|
3728
|
-
$ref:
|
|
3725
|
+
$ref: '#/components/schemas/StatusValue'
|
|
3729
3726
|
cancellationReason:
|
|
3730
|
-
$ref:
|
|
3727
|
+
$ref: '#/components/schemas/CancellationReason'
|
|
3731
3728
|
returnReason:
|
|
3732
3729
|
type: string
|
|
3733
3730
|
description: |-
|
|
@@ -3735,7 +3732,7 @@ components:
|
|
|
3735
3732
|
maxLength: 255
|
|
3736
3733
|
example: Customer complained
|
|
3737
3734
|
paymentInstructions:
|
|
3738
|
-
$ref:
|
|
3735
|
+
$ref: '#/components/schemas/PaymentInstructions'
|
|
3739
3736
|
paymentEventId:
|
|
3740
3737
|
type: string
|
|
3741
3738
|
format: UUID
|
|
@@ -3746,12 +3743,18 @@ components:
|
|
|
3746
3743
|
readOnly: true
|
|
3747
3744
|
description: |-
|
|
3748
3745
|
The date and time when the payment event was created.
|
|
3749
|
-
|
|
3746
|
+
|
|
3750
3747
|
Format will be in one of the following formats:
|
|
3751
3748
|
* YYYY-MM-DD'T'HH:mm:ss'Z'
|
|
3752
3749
|
* YYYY-MM-DD'T'HH:mm:ss+XX:XX
|
|
3753
3750
|
* YYYY-MM-DD'T'HH:mm:ss-XX:XX
|
|
3754
3751
|
example: 2022-01-01T00:00:00Z
|
|
3752
|
+
merchantReference:
|
|
3753
|
+
type: string
|
|
3754
|
+
description: |-
|
|
3755
|
+
Unique reference from the merchant that was used when the event was created (e.g. from the capture request).
|
|
3756
|
+
maxLength: 20
|
|
3757
|
+
example: your-order-6372
|
|
3755
3758
|
PaymentExecution:
|
|
3756
3759
|
type: object
|
|
3757
3760
|
description: |-
|
|
@@ -3765,23 +3768,23 @@ components:
|
|
|
3765
3768
|
paymentId:
|
|
3766
3769
|
type: string
|
|
3767
3770
|
description: Unique payment transaction identifier of the payment gateway.
|
|
3768
|
-
example:
|
|
3771
|
+
example: '3066019730_1'
|
|
3769
3772
|
cardPaymentMethodSpecificInput:
|
|
3770
|
-
$ref:
|
|
3773
|
+
$ref: '#/components/schemas/CardPaymentMethodSpecificInput'
|
|
3771
3774
|
mobilePaymentMethodSpecificInput:
|
|
3772
|
-
$ref:
|
|
3775
|
+
$ref: '#/components/schemas/MobilePaymentMethodSpecificInput'
|
|
3773
3776
|
redirectPaymentMethodSpecificInput:
|
|
3774
|
-
$ref:
|
|
3777
|
+
$ref: '#/components/schemas/RedirectPaymentMethodSpecificInput'
|
|
3775
3778
|
sepaDirectDebitPaymentMethodSpecificInput:
|
|
3776
|
-
$ref:
|
|
3779
|
+
$ref: '#/components/schemas/SepaDirectDebitPaymentMethodSpecificInput'
|
|
3777
3780
|
financingPaymentMethodSpecificInput:
|
|
3778
|
-
$ref:
|
|
3781
|
+
$ref: '#/components/schemas/FinancingPaymentMethodSpecificInput'
|
|
3779
3782
|
bankPayoutMethodSpecificInput:
|
|
3780
|
-
$ref:
|
|
3783
|
+
$ref: '#/components/schemas/BankPayoutMethodSpecificInput'
|
|
3781
3784
|
paymentChannel:
|
|
3782
|
-
$ref:
|
|
3785
|
+
$ref: '#/components/schemas/PaymentChannel'
|
|
3783
3786
|
references:
|
|
3784
|
-
$ref:
|
|
3787
|
+
$ref: '#/components/schemas/References'
|
|
3785
3788
|
previousPayment:
|
|
3786
3789
|
type: string
|
|
3787
3790
|
format: UUID
|
|
@@ -3791,7 +3794,7 @@ components:
|
|
|
3791
3794
|
format: date-time
|
|
3792
3795
|
description: |-
|
|
3793
3796
|
The date and time when the payment was created.
|
|
3794
|
-
|
|
3797
|
+
|
|
3795
3798
|
Format will be in one of the following formats:
|
|
3796
3799
|
* YYYY-MM-DD'T'HH:mm:ss'Z'
|
|
3797
3800
|
* YYYY-MM-DD'T'HH:mm:ss+XX:XX
|
|
@@ -3802,7 +3805,7 @@ components:
|
|
|
3802
3805
|
format: date-time
|
|
3803
3806
|
description: |-
|
|
3804
3807
|
The date and time when the payment was last updated.
|
|
3805
|
-
|
|
3808
|
+
|
|
3806
3809
|
Format will be in one of the following formats:
|
|
3807
3810
|
* YYYY-MM-DD'T'HH:mm:ss'Z'
|
|
3808
3811
|
* YYYY-MM-DD'T'HH:mm:ss+XX:XX
|
|
@@ -3811,11 +3814,11 @@ components:
|
|
|
3811
3814
|
events:
|
|
3812
3815
|
type: array
|
|
3813
3816
|
items:
|
|
3814
|
-
$ref:
|
|
3817
|
+
$ref: '#/components/schemas/PaymentEvent'
|
|
3815
3818
|
fundSplits:
|
|
3816
3819
|
type: array
|
|
3817
3820
|
items:
|
|
3818
|
-
$ref:
|
|
3821
|
+
$ref: '#/components/schemas/FundSplit'
|
|
3819
3822
|
PaymentExecutionRequest:
|
|
3820
3823
|
type: object
|
|
3821
3824
|
description: |
|
|
@@ -3826,9 +3829,9 @@ components:
|
|
|
3826
3829
|
For more details regarding payment method specific input please check the documentation.
|
|
3827
3830
|
properties:
|
|
3828
3831
|
paymentMethodSpecificInput:
|
|
3829
|
-
$ref:
|
|
3832
|
+
$ref: '#/components/schemas/PaymentMethodSpecificInput'
|
|
3830
3833
|
paymentExecutionSpecificInput:
|
|
3831
|
-
$ref:
|
|
3834
|
+
$ref: '#/components/schemas/PaymentExecutionSpecificInput'
|
|
3832
3835
|
PaymentExecutionSpecificInput:
|
|
3833
3836
|
type: object
|
|
3834
3837
|
description: |
|
|
@@ -3840,13 +3843,13 @@ components:
|
|
|
3840
3843
|
If the ShoppingCart elements differ from the data provided in the Checkout, the existing data will not be overwritten.
|
|
3841
3844
|
properties:
|
|
3842
3845
|
amountOfMoney:
|
|
3843
|
-
$ref:
|
|
3846
|
+
$ref: '#/components/schemas/AmountOfMoney'
|
|
3844
3847
|
shoppingCart:
|
|
3845
|
-
$ref:
|
|
3848
|
+
$ref: '#/components/schemas/ShoppingCartInput'
|
|
3846
3849
|
paymentReferences:
|
|
3847
|
-
$ref:
|
|
3850
|
+
$ref: '#/components/schemas/References'
|
|
3848
3851
|
fundSplit:
|
|
3849
|
-
$ref:
|
|
3852
|
+
$ref: '#/components/schemas/FundSplit'
|
|
3850
3853
|
required:
|
|
3851
3854
|
- paymentReferences
|
|
3852
3855
|
PaymentInformationRefundRequest:
|
|
@@ -3857,9 +3860,9 @@ components:
|
|
|
3857
3860
|
additionalProperties: false
|
|
3858
3861
|
properties:
|
|
3859
3862
|
amountOfMoney:
|
|
3860
|
-
$ref:
|
|
3863
|
+
$ref: '#/components/schemas/PositiveAmountOfMoney'
|
|
3861
3864
|
references:
|
|
3862
|
-
$ref:
|
|
3865
|
+
$ref: '#/components/schemas/PaymentReferences'
|
|
3863
3866
|
accountHolder:
|
|
3864
3867
|
maxLength: 50
|
|
3865
3868
|
type: string
|
|
@@ -3875,7 +3878,7 @@ components:
|
|
|
3875
3878
|
additionalProperties: false
|
|
3876
3879
|
properties:
|
|
3877
3880
|
payment:
|
|
3878
|
-
$ref:
|
|
3881
|
+
$ref: '#/components/schemas/PayoutResponse'
|
|
3879
3882
|
paymentExecutionId:
|
|
3880
3883
|
description: reference to the paymentExecution.
|
|
3881
3884
|
type: string
|
|
@@ -3886,13 +3889,13 @@ components:
|
|
|
3886
3889
|
additionalProperties: false
|
|
3887
3890
|
properties:
|
|
3888
3891
|
amountOfMoney:
|
|
3889
|
-
$ref:
|
|
3892
|
+
$ref: '#/components/schemas/AmountOfMoney'
|
|
3890
3893
|
type:
|
|
3891
|
-
$ref:
|
|
3894
|
+
$ref: '#/components/schemas/PaymentType'
|
|
3892
3895
|
paymentChannel:
|
|
3893
|
-
$ref:
|
|
3896
|
+
$ref: '#/components/schemas/PaymentChannel'
|
|
3894
3897
|
paymentProductId:
|
|
3895
|
-
$ref:
|
|
3898
|
+
$ref: '#/components/schemas/PaymentProductId'
|
|
3896
3899
|
merchantReference:
|
|
3897
3900
|
type: string
|
|
3898
3901
|
description: |
|
|
@@ -3931,9 +3934,9 @@ components:
|
|
|
3931
3934
|
format: UUID
|
|
3932
3935
|
example: "637ef15b-1a0a-48f2-27d8-c954a344329c"
|
|
3933
3936
|
paymentChannel:
|
|
3934
|
-
$ref:
|
|
3937
|
+
$ref: '#/components/schemas/PaymentChannel'
|
|
3935
3938
|
paymentProductId:
|
|
3936
|
-
$ref:
|
|
3939
|
+
$ref: '#/components/schemas/PaymentProductId'
|
|
3937
3940
|
terminalId:
|
|
3938
3941
|
description: Unique identifier of the POS terminal of the payment transaction.
|
|
3939
3942
|
type: string
|
|
@@ -3960,7 +3963,7 @@ components:
|
|
|
3960
3963
|
format: date-time
|
|
3961
3964
|
description: |-
|
|
3962
3965
|
The date and time when the payment was created.
|
|
3963
|
-
|
|
3966
|
+
|
|
3964
3967
|
Format will be in one of the following formats:
|
|
3965
3968
|
* YYYY-MM-DD'T'HH:mm:ss'Z'
|
|
3966
3969
|
* YYYY-MM-DD'T'HH:mm:ss+XX:XX
|
|
@@ -3971,18 +3974,18 @@ components:
|
|
|
3971
3974
|
format: date-time
|
|
3972
3975
|
description: |-
|
|
3973
3976
|
The date and time when the payment was last updated.
|
|
3974
|
-
|
|
3977
|
+
|
|
3975
3978
|
Format will be in one of the following formats:
|
|
3976
3979
|
* YYYY-MM-DD'T'HH:mm:ss'Z'
|
|
3977
3980
|
* YYYY-MM-DD'T'HH:mm:ss+XX:XX
|
|
3978
3981
|
* YYYY-MM-DD'T'HH:mm:ss-XX:XX
|
|
3979
3982
|
example: 2022-01-01T00:00:00Z
|
|
3980
3983
|
cardPaymentDetails:
|
|
3981
|
-
$ref:
|
|
3984
|
+
$ref: '#/components/schemas/CardPaymentDetails'
|
|
3982
3985
|
events:
|
|
3983
3986
|
type: array
|
|
3984
3987
|
items:
|
|
3985
|
-
$ref:
|
|
3988
|
+
$ref: '#/components/schemas/PaymentEvent'
|
|
3986
3989
|
PaymentInstructions:
|
|
3987
3990
|
required:
|
|
3988
3991
|
- payee
|
|
@@ -3991,7 +3994,7 @@ components:
|
|
|
3991
3994
|
type: object
|
|
3992
3995
|
properties:
|
|
3993
3996
|
payee:
|
|
3994
|
-
$ref:
|
|
3997
|
+
$ref: '#/components/schemas/Payee'
|
|
3995
3998
|
dueDate:
|
|
3996
3999
|
maxLength: 8
|
|
3997
4000
|
pattern: ^((19|20|21)\d{6})?$
|
|
@@ -4016,19 +4019,19 @@ components:
|
|
|
4016
4019
|
If a new input will be provided, the existing input will be updated.
|
|
4017
4020
|
properties:
|
|
4018
4021
|
cardPaymentMethodSpecificInput:
|
|
4019
|
-
$ref:
|
|
4022
|
+
$ref: '#/components/schemas/CardPaymentMethodSpecificInput'
|
|
4020
4023
|
mobilePaymentMethodSpecificInput:
|
|
4021
|
-
$ref:
|
|
4024
|
+
$ref: '#/components/schemas/MobilePaymentMethodSpecificInput'
|
|
4022
4025
|
redirectPaymentMethodSpecificInput:
|
|
4023
|
-
$ref:
|
|
4026
|
+
$ref: '#/components/schemas/RedirectPaymentMethodSpecificInput'
|
|
4024
4027
|
sepaDirectDebitPaymentMethodSpecificInput:
|
|
4025
|
-
$ref:
|
|
4028
|
+
$ref: '#/components/schemas/SepaDirectDebitPaymentMethodSpecificInput'
|
|
4026
4029
|
financingPaymentMethodSpecificInput:
|
|
4027
|
-
$ref:
|
|
4030
|
+
$ref: '#/components/schemas/FinancingPaymentMethodSpecificInput'
|
|
4028
4031
|
customerDevice:
|
|
4029
|
-
$ref:
|
|
4032
|
+
$ref: '#/components/schemas/CustomerDevice'
|
|
4030
4033
|
paymentChannel:
|
|
4031
|
-
$ref:
|
|
4034
|
+
$ref: '#/components/schemas/PaymentChannel'
|
|
4032
4035
|
PaymentOutput:
|
|
4033
4036
|
type: object
|
|
4034
4037
|
description: |
|
|
@@ -4036,7 +4039,7 @@ components:
|
|
|
4036
4039
|
additionalProperties: false
|
|
4037
4040
|
properties:
|
|
4038
4041
|
amountOfMoney:
|
|
4039
|
-
$ref:
|
|
4042
|
+
$ref: '#/components/schemas/AmountOfMoney'
|
|
4040
4043
|
merchantParameters:
|
|
4041
4044
|
type: string
|
|
4042
4045
|
description:
|
|
@@ -4045,20 +4048,20 @@ components:
|
|
|
4045
4048
|
maxLength: 1000
|
|
4046
4049
|
example: "{'SessionID':'126548354','ShopperID':'7354131'}"
|
|
4047
4050
|
references:
|
|
4048
|
-
$ref:
|
|
4051
|
+
$ref: '#/components/schemas/PaymentReferences'
|
|
4049
4052
|
cardPaymentMethodSpecificOutput:
|
|
4050
|
-
$ref:
|
|
4053
|
+
$ref: '#/components/schemas/CardPaymentMethodSpecificOutput'
|
|
4051
4054
|
mobilePaymentMethodSpecificOutput:
|
|
4052
|
-
$ref:
|
|
4055
|
+
$ref: '#/components/schemas/MobilePaymentMethodSpecificOutput'
|
|
4053
4056
|
paymentMethod:
|
|
4054
4057
|
type: string
|
|
4055
4058
|
description: Payment method identifier based on the paymentProductId.
|
|
4056
4059
|
redirectPaymentMethodSpecificOutput:
|
|
4057
|
-
$ref:
|
|
4060
|
+
$ref: '#/components/schemas/RedirectPaymentMethodSpecificOutput'
|
|
4058
4061
|
sepaDirectDebitPaymentMethodSpecificOutput:
|
|
4059
|
-
$ref:
|
|
4062
|
+
$ref: '#/components/schemas/SepaDirectDebitPaymentMethodSpecificOutput'
|
|
4060
4063
|
financingPaymentMethodSpecificOutput:
|
|
4061
|
-
$ref:
|
|
4064
|
+
$ref: '#/components/schemas/FinancingPaymentMethodSpecificOutput'
|
|
4062
4065
|
PaymentProduct302SpecificInput:
|
|
4063
4066
|
type: object
|
|
4064
4067
|
description: Object containing additional Information needed for Apple Pay payment transactions.
|
|
@@ -4074,9 +4077,9 @@ components:
|
|
|
4074
4077
|
- MASS_ENABLEMENT
|
|
4075
4078
|
example: MASS_ENABLEMENT
|
|
4076
4079
|
network:
|
|
4077
|
-
$ref:
|
|
4080
|
+
$ref: '#/components/schemas/MobilePaymentNetwork'
|
|
4078
4081
|
token:
|
|
4079
|
-
$ref:
|
|
4082
|
+
$ref: '#/components/schemas/ApplePaymentDataTokenInformation'
|
|
4080
4083
|
domainName:
|
|
4081
4084
|
type: string
|
|
4082
4085
|
description: Domain of your Webshop. Needed for initialization of the Apple Pay payment session with integrationType=MASS_ENABLEMENT.
|
|
@@ -4094,7 +4097,7 @@ components:
|
|
|
4094
4097
|
ID of the selected installment option. Will be provided in the response of the Order / Payment Execution
|
|
4095
4098
|
request.
|
|
4096
4099
|
bankAccountInformation:
|
|
4097
|
-
$ref:
|
|
4100
|
+
$ref: '#/components/schemas/BankAccountInformation'
|
|
4098
4101
|
required:
|
|
4099
4102
|
- bankAccountInformation
|
|
4100
4103
|
- installmentOptionId
|
|
@@ -4105,14 +4108,14 @@ components:
|
|
|
4105
4108
|
type: array
|
|
4106
4109
|
description: List of installment options.
|
|
4107
4110
|
items:
|
|
4108
|
-
$ref:
|
|
4111
|
+
$ref: '#/components/schemas/InstallmentOption'
|
|
4109
4112
|
description: Object containing specific information for PAYONE Secured Installment.
|
|
4110
4113
|
PaymentProduct3392SpecificInput:
|
|
4111
4114
|
type: object
|
|
4112
4115
|
description: Object containing specific information for PAYONE Secured Direct Debit.
|
|
4113
4116
|
properties:
|
|
4114
4117
|
bankAccountInformation:
|
|
4115
|
-
$ref:
|
|
4118
|
+
$ref: '#/components/schemas/BankAccountInformation'
|
|
4116
4119
|
required:
|
|
4117
4120
|
- bankAccountInformation
|
|
4118
4121
|
PaymentProduct5002SpecificInput:
|
|
@@ -4120,7 +4123,7 @@ components:
|
|
|
4120
4123
|
description: Object containing additional Information needed for Click To Pay processing.
|
|
4121
4124
|
properties:
|
|
4122
4125
|
network:
|
|
4123
|
-
$ref:
|
|
4126
|
+
$ref: '#/components/schemas/MobilePaymentNetwork'
|
|
4124
4127
|
paymentCheckoutData:
|
|
4125
4128
|
type: string
|
|
4126
4129
|
description: |-
|
|
@@ -4169,11 +4172,11 @@ components:
|
|
|
4169
4172
|
additionalProperties: false
|
|
4170
4173
|
properties:
|
|
4171
4174
|
billingAddress:
|
|
4172
|
-
$ref:
|
|
4175
|
+
$ref: '#/components/schemas/Address'
|
|
4173
4176
|
customerAccount:
|
|
4174
|
-
$ref:
|
|
4177
|
+
$ref: '#/components/schemas/PaymentProduct840CustomerAccount'
|
|
4175
4178
|
shippingAddress:
|
|
4176
|
-
$ref:
|
|
4179
|
+
$ref: '#/components/schemas/Address'
|
|
4177
4180
|
payPalTransactionId:
|
|
4178
4181
|
type: string
|
|
4179
4182
|
maxLength: 20
|
|
@@ -4197,20 +4200,35 @@ components:
|
|
|
4197
4200
|
merchantReference:
|
|
4198
4201
|
type: string
|
|
4199
4202
|
description: |-
|
|
4200
|
-
Unique reference of
|
|
4203
|
+
Unique reference of payment transactions, also returned for reporting and reconciliation purposes.
|
|
4204
|
+
For capture requests, providing this value is recommended to support an end-to-end refund flow.
|
|
4205
|
+
If provided for captures or refunds, it must be unique per Checkout.
|
|
4201
4206
|
maxLength: 20
|
|
4202
4207
|
example: your-order-6372
|
|
4208
|
+
PaymentReferencesForRefund:
|
|
4209
|
+
type: object
|
|
4210
|
+
description: Object that holds all reference properties that are linked to this transaction.
|
|
4211
|
+
additionalProperties: false
|
|
4212
|
+
allOf:
|
|
4213
|
+
- $ref: '#/components/schemas/PaymentReferences'
|
|
4214
|
+
- type: object
|
|
4215
|
+
properties:
|
|
4216
|
+
captureReference:
|
|
4217
|
+
description: |-
|
|
4218
|
+
Reference of the capture that should be used for the refund.
|
|
4219
|
+
example: your-order-6372
|
|
4220
|
+
type: string
|
|
4203
4221
|
PaymentResponse:
|
|
4204
4222
|
type: object
|
|
4205
4223
|
description: Object that holds the payment related properties.
|
|
4206
4224
|
additionalProperties: false
|
|
4207
4225
|
properties:
|
|
4208
4226
|
paymentOutput:
|
|
4209
|
-
$ref:
|
|
4227
|
+
$ref: '#/components/schemas/PaymentOutput'
|
|
4210
4228
|
status:
|
|
4211
|
-
$ref:
|
|
4229
|
+
$ref: '#/components/schemas/StatusValue'
|
|
4212
4230
|
statusOutput:
|
|
4213
|
-
$ref:
|
|
4231
|
+
$ref: '#/components/schemas/PaymentStatusOutput'
|
|
4214
4232
|
id:
|
|
4215
4233
|
type: string
|
|
4216
4234
|
description: Unique payment transaction identifier of the payment gateway.
|
|
@@ -4227,7 +4245,7 @@ components:
|
|
|
4227
4245
|
type: boolean
|
|
4228
4246
|
description: Flag indicating if the payment can be cancelled
|
|
4229
4247
|
statusCategory:
|
|
4230
|
-
$ref:
|
|
4248
|
+
$ref: '#/components/schemas/StatusCategoryValue'
|
|
4231
4249
|
isAuthorized:
|
|
4232
4250
|
description: Indicates if the transaction has been authorized
|
|
4233
4251
|
type: boolean
|
|
@@ -4254,9 +4272,9 @@ components:
|
|
|
4254
4272
|
additionalProperties: false
|
|
4255
4273
|
properties:
|
|
4256
4274
|
amountOfMoney:
|
|
4257
|
-
$ref:
|
|
4275
|
+
$ref: '#/components/schemas/AmountOfMoney'
|
|
4258
4276
|
references:
|
|
4259
|
-
$ref:
|
|
4277
|
+
$ref: '#/components/schemas/PaymentReferences'
|
|
4260
4278
|
paymentMethod:
|
|
4261
4279
|
type: string
|
|
4262
4280
|
description: Payment method identifier based on the paymentProductId.
|
|
@@ -4266,11 +4284,11 @@ components:
|
|
|
4266
4284
|
additionalProperties: false
|
|
4267
4285
|
properties:
|
|
4268
4286
|
payoutOutput:
|
|
4269
|
-
$ref:
|
|
4287
|
+
$ref: '#/components/schemas/PayoutOutput'
|
|
4270
4288
|
status:
|
|
4271
|
-
$ref:
|
|
4289
|
+
$ref: '#/components/schemas/StatusValue'
|
|
4272
4290
|
statusCategory:
|
|
4273
|
-
$ref:
|
|
4291
|
+
$ref: '#/components/schemas/StatusCategoryValue'
|
|
4274
4292
|
id:
|
|
4275
4293
|
type: string
|
|
4276
4294
|
description: Unique payment transaction identifier of the payment gateway.
|
|
@@ -4299,7 +4317,7 @@ components:
|
|
|
4299
4317
|
- FEMALE
|
|
4300
4318
|
- UNKNOWN
|
|
4301
4319
|
name:
|
|
4302
|
-
$ref:
|
|
4320
|
+
$ref: '#/components/schemas/PersonalName'
|
|
4303
4321
|
PersonalName:
|
|
4304
4322
|
type: object
|
|
4305
4323
|
description: Object containing the name details of the customer
|
|
@@ -4349,9 +4367,9 @@ components:
|
|
|
4349
4367
|
Renamed from CreateMandateWithReturnUrl to ProcessingMandateInformation.
|
|
4350
4368
|
properties:
|
|
4351
4369
|
bankAccountIban:
|
|
4352
|
-
$ref:
|
|
4370
|
+
$ref: '#/components/schemas/BankAccountInformation'
|
|
4353
4371
|
recurrenceType:
|
|
4354
|
-
$ref:
|
|
4372
|
+
$ref: '#/components/schemas/MandateRecurrenceType'
|
|
4355
4373
|
uniqueMandateReference:
|
|
4356
4374
|
maxLength: 35
|
|
4357
4375
|
pattern: ^[A-Za-z0-9\+\-\.()]{1,35}$
|
|
@@ -4434,7 +4452,7 @@ components:
|
|
|
4434
4452
|
* true = the payment requires approval before the funds will be captured using the Approve payment or
|
|
4435
4453
|
Capture payment API
|
|
4436
4454
|
* false = the payment does not require approval, and the funds will be captured automatically
|
|
4437
|
-
|
|
4455
|
+
|
|
4438
4456
|
If the parameter is not provided in the request, the default value will be true
|
|
4439
4457
|
paymentProcessingToken:
|
|
4440
4458
|
type: string
|
|
@@ -4456,11 +4474,11 @@ components:
|
|
|
4456
4474
|
tokenization of recurring payments.
|
|
4457
4475
|
example: false
|
|
4458
4476
|
paymentProductId:
|
|
4459
|
-
$ref:
|
|
4477
|
+
$ref: '#/components/schemas/PaymentProductId'
|
|
4460
4478
|
paymentProduct840SpecificInput:
|
|
4461
|
-
$ref:
|
|
4479
|
+
$ref: '#/components/schemas/RedirectPaymentProduct840SpecificInput'
|
|
4462
4480
|
redirectionData:
|
|
4463
|
-
$ref:
|
|
4481
|
+
$ref: '#/components/schemas/RedirectionData'
|
|
4464
4482
|
RedirectPaymentMethodSpecificOutput:
|
|
4465
4483
|
type: object
|
|
4466
4484
|
description: |
|
|
@@ -4468,9 +4486,9 @@ components:
|
|
|
4468
4486
|
additionalProperties: false
|
|
4469
4487
|
properties:
|
|
4470
4488
|
paymentProductId:
|
|
4471
|
-
$ref:
|
|
4489
|
+
$ref: '#/components/schemas/PaymentProductId'
|
|
4472
4490
|
paymentProduct840SpecificOutput:
|
|
4473
|
-
$ref:
|
|
4491
|
+
$ref: '#/components/schemas/PaymentProduct840SpecificOutput'
|
|
4474
4492
|
paymentProcessingToken:
|
|
4475
4493
|
type: string
|
|
4476
4494
|
description: ID of the token. This property is populated when the payment was done with a token.
|
|
@@ -4580,7 +4598,7 @@ components:
|
|
|
4580
4598
|
description: Request to refresh the payment status of a specific payment.
|
|
4581
4599
|
properties:
|
|
4582
4600
|
refreshType:
|
|
4583
|
-
$ref:
|
|
4601
|
+
$ref: '#/components/schemas/RefreshType'
|
|
4584
4602
|
required:
|
|
4585
4603
|
- refreshType
|
|
4586
4604
|
RefreshType:
|
|
@@ -4606,7 +4624,7 @@ components:
|
|
|
4606
4624
|
errors:
|
|
4607
4625
|
type: array
|
|
4608
4626
|
items:
|
|
4609
|
-
$ref:
|
|
4627
|
+
$ref: '#/components/schemas/APIError'
|
|
4610
4628
|
RefundOutput:
|
|
4611
4629
|
type: object
|
|
4612
4630
|
description: |
|
|
@@ -4614,7 +4632,7 @@ components:
|
|
|
4614
4632
|
additionalProperties: false
|
|
4615
4633
|
properties:
|
|
4616
4634
|
amountOfMoney:
|
|
4617
|
-
$ref:
|
|
4635
|
+
$ref: '#/components/schemas/AmountOfMoney'
|
|
4618
4636
|
merchantParameters:
|
|
4619
4637
|
type: string
|
|
4620
4638
|
description: |
|
|
@@ -4623,7 +4641,7 @@ components:
|
|
|
4623
4641
|
maxLength: 1000
|
|
4624
4642
|
example: "{'SessionID':'126548354','ShopperID':'7354131'}"
|
|
4625
4643
|
references:
|
|
4626
|
-
$ref:
|
|
4644
|
+
$ref: '#/components/schemas/PaymentReferences'
|
|
4627
4645
|
paymentMethod:
|
|
4628
4646
|
type: string
|
|
4629
4647
|
description: Payment method identifier used by the our payment engine.
|
|
@@ -4636,17 +4654,17 @@ components:
|
|
|
4636
4654
|
additionalProperties: false
|
|
4637
4655
|
properties:
|
|
4638
4656
|
refundOutput:
|
|
4639
|
-
$ref:
|
|
4657
|
+
$ref: '#/components/schemas/RefundOutput'
|
|
4640
4658
|
status:
|
|
4641
|
-
$ref:
|
|
4659
|
+
$ref: '#/components/schemas/StatusValue'
|
|
4642
4660
|
statusOutput:
|
|
4643
|
-
$ref:
|
|
4661
|
+
$ref: '#/components/schemas/PaymentStatusOutput'
|
|
4644
4662
|
fundSplit:
|
|
4645
|
-
$ref:
|
|
4663
|
+
$ref: '#/components/schemas/FundSplit'
|
|
4646
4664
|
id:
|
|
4647
4665
|
type: string
|
|
4648
4666
|
description: Unique payment transaction identifier of the payment gateway.
|
|
4649
|
-
example:
|
|
4667
|
+
example: '3066019730_1'
|
|
4650
4668
|
RefundRequest:
|
|
4651
4669
|
type: object
|
|
4652
4670
|
description: |
|
|
@@ -4656,13 +4674,13 @@ components:
|
|
|
4656
4674
|
additionalProperties: false
|
|
4657
4675
|
properties:
|
|
4658
4676
|
amountOfMoney:
|
|
4659
|
-
$ref:
|
|
4677
|
+
$ref: '#/components/schemas/PositiveAmountOfMoney'
|
|
4660
4678
|
references:
|
|
4661
|
-
$ref:
|
|
4679
|
+
$ref: '#/components/schemas/PaymentReferencesForRefund'
|
|
4662
4680
|
return:
|
|
4663
|
-
$ref:
|
|
4681
|
+
$ref: '#/components/schemas/ReturnInformation'
|
|
4664
4682
|
fundSplit:
|
|
4665
|
-
$ref:
|
|
4683
|
+
$ref: '#/components/schemas/FundSplit'
|
|
4666
4684
|
ReturnInformation:
|
|
4667
4685
|
type: object
|
|
4668
4686
|
description: |-
|
|
@@ -4680,7 +4698,7 @@ components:
|
|
|
4680
4698
|
description: |-
|
|
4681
4699
|
Items returned.
|
|
4682
4700
|
items:
|
|
4683
|
-
$ref:
|
|
4701
|
+
$ref: '#/components/schemas/CartItemInput'
|
|
4684
4702
|
ReturnItem:
|
|
4685
4703
|
type: object
|
|
4686
4704
|
properties:
|
|
@@ -4713,7 +4731,7 @@ components:
|
|
|
4713
4731
|
The returnReason can be provided for reporting and reconciliation purposes but is not mandatory.
|
|
4714
4732
|
properties:
|
|
4715
4733
|
returnType:
|
|
4716
|
-
$ref:
|
|
4734
|
+
$ref: '#/components/schemas/ReturnType'
|
|
4717
4735
|
returnReason:
|
|
4718
4736
|
type: string
|
|
4719
4737
|
description: |-
|
|
@@ -4723,16 +4741,16 @@ components:
|
|
|
4723
4741
|
returnItems:
|
|
4724
4742
|
type: array
|
|
4725
4743
|
items:
|
|
4726
|
-
$ref:
|
|
4744
|
+
$ref: '#/components/schemas/ReturnItem'
|
|
4727
4745
|
fundSplit:
|
|
4728
|
-
$ref:
|
|
4746
|
+
$ref: '#/components/schemas/FundSplit'
|
|
4729
4747
|
ReturnResponse:
|
|
4730
4748
|
type: object
|
|
4731
4749
|
properties:
|
|
4732
4750
|
returnPaymentResponse:
|
|
4733
|
-
$ref:
|
|
4751
|
+
$ref: '#/components/schemas/RefundPaymentResponse'
|
|
4734
4752
|
shoppingCart:
|
|
4735
|
-
$ref:
|
|
4753
|
+
$ref: '#/components/schemas/ShoppingCartResult'
|
|
4736
4754
|
ReturnType:
|
|
4737
4755
|
type: string
|
|
4738
4756
|
description: |
|
|
@@ -4755,18 +4773,18 @@ components:
|
|
|
4755
4773
|
additionalProperties: false
|
|
4756
4774
|
properties:
|
|
4757
4775
|
paymentProduct771SpecificInput:
|
|
4758
|
-
$ref:
|
|
4776
|
+
$ref: '#/components/schemas/SepaDirectDebitPaymentProduct771SpecificInput'
|
|
4759
4777
|
paymentProductId:
|
|
4760
|
-
$ref:
|
|
4778
|
+
$ref: '#/components/schemas/PaymentProductId'
|
|
4761
4779
|
SepaDirectDebitPaymentMethodSpecificOutput:
|
|
4762
4780
|
type: object
|
|
4763
4781
|
description: Object containing the SEPA direct debit details.
|
|
4764
4782
|
additionalProperties: false
|
|
4765
4783
|
properties:
|
|
4766
4784
|
paymentProductId:
|
|
4767
|
-
$ref:
|
|
4785
|
+
$ref: '#/components/schemas/PaymentProductId'
|
|
4768
4786
|
paymentProduct771SpecificOutput:
|
|
4769
|
-
$ref:
|
|
4787
|
+
$ref: '#/components/schemas/PaymentProduct771SpecificOutput'
|
|
4770
4788
|
SepaDirectDebitPaymentProduct771SpecificInput:
|
|
4771
4789
|
type: object
|
|
4772
4790
|
description: Object containing information specific to SEPA Direct Debit
|
|
@@ -4774,15 +4792,15 @@ components:
|
|
|
4774
4792
|
existingUniqueMandateReference:
|
|
4775
4793
|
type: string
|
|
4776
4794
|
description: The unique reference of the existing mandate to use in this payment.
|
|
4777
|
-
example:
|
|
4795
|
+
example: 'exampleMandateReference'
|
|
4778
4796
|
mandate:
|
|
4779
|
-
$ref:
|
|
4797
|
+
$ref: '#/components/schemas/ProcessingMandateInformation'
|
|
4780
4798
|
SepaTransferPaymentProduct772SpecificInput:
|
|
4781
4799
|
type: object
|
|
4782
4800
|
description: Object containing the specific input details for SEPA credit transfers excluding cross-border ones
|
|
4783
4801
|
properties:
|
|
4784
4802
|
bankAccountInformation:
|
|
4785
|
-
$ref:
|
|
4803
|
+
$ref: '#/components/schemas/BankAccountInformation'
|
|
4786
4804
|
Shipping:
|
|
4787
4805
|
type: object
|
|
4788
4806
|
description: |
|
|
@@ -4790,7 +4808,7 @@ components:
|
|
|
4790
4808
|
additionalProperties: false
|
|
4791
4809
|
properties:
|
|
4792
4810
|
address:
|
|
4793
|
-
$ref:
|
|
4811
|
+
$ref: '#/components/schemas/AddressPersonal'
|
|
4794
4812
|
ShoppingCartInput:
|
|
4795
4813
|
type: object
|
|
4796
4814
|
description: |
|
|
@@ -4799,7 +4817,7 @@ components:
|
|
|
4799
4817
|
items:
|
|
4800
4818
|
type: array
|
|
4801
4819
|
items:
|
|
4802
|
-
$ref:
|
|
4820
|
+
$ref: '#/components/schemas/CartItemInput'
|
|
4803
4821
|
ShoppingCartPatch:
|
|
4804
4822
|
type: object
|
|
4805
4823
|
description: |
|
|
@@ -4808,7 +4826,7 @@ components:
|
|
|
4808
4826
|
items:
|
|
4809
4827
|
type: array
|
|
4810
4828
|
items:
|
|
4811
|
-
$ref:
|
|
4829
|
+
$ref: '#/components/schemas/CartItemPatch'
|
|
4812
4830
|
ShoppingCartResult:
|
|
4813
4831
|
type: object
|
|
4814
4832
|
description: |
|
|
@@ -4817,7 +4835,7 @@ components:
|
|
|
4817
4835
|
items:
|
|
4818
4836
|
type: array
|
|
4819
4837
|
items:
|
|
4820
|
-
$ref:
|
|
4838
|
+
$ref: '#/components/schemas/CartItemResult'
|
|
4821
4839
|
StatusCategoryValue:
|
|
4822
4840
|
type: string
|
|
4823
4841
|
description: Highlevel status of the payment, payout or Refund.
|