pcp-server-ruby-sdk 1.3.1 → 1.5.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 +12 -0
- data/README.md +1 -1
- data/api-definition.yaml +955 -916
- data/example-app/example.rb +84 -0
- data/lib/PCP-server-Ruby-SDK/models/complete_payment_method_specific_input.rb +13 -4
- data/lib/PCP-server-Ruby-SDK/models/complete_payment_product840_specific_input.rb +232 -0
- data/lib/PCP-server-Ruby-SDK/models/complete_payment_request.rb +10 -1
- data/lib/PCP-server-Ruby-SDK/models/complete_redirect_payment_method_specific_input.rb +198 -0
- data/lib/PCP-server-Ruby-SDK/models/customer_device.rb +24 -4
- data/lib/PCP-server-Ruby-SDK/models/payment_product840_specific_output.rb +16 -6
- data/lib/PCP-server-Ruby-SDK/models/payment_type.rb +2 -1
- data/lib/PCP-server-Ruby-SDK/models/redirect_payment_method_specific_input.rb +14 -4
- data/lib/PCP-server-Ruby-SDK/models/redirect_payment_method_specific_output.rb +14 -4
- data/lib/PCP-server-Ruby-SDK/models/redirect_payment_product840_specific_input.rb +19 -6
- data/lib/PCP-server-Ruby-SDK/version.rb +1 -1
- data/lib/PCP-server-Ruby-SDK.rb +2 -0
- data/package-lock.json +411 -256
- data/package.json +1 -1
- data/scripts.sh +1 -1
- data/spec/endpoints/payment_execution_api_client_spec.rb +10 -1
- metadata +10 -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.40.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,32 +248,35 @@ 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: |-
|
|
263
|
-
|
|
263
|
+
This endpoint can be used to complete an Order that was created with the OrderManagementCheckoutActions endpoint.
|
|
264
|
+
It is needed for all payment flows where the payment needs interaction with the customer like:
|
|
265
|
+
* For PAYONE Secured Installment (paymentProductId 3391) to select the installment options.
|
|
266
|
+
* For PayPal (paymentProductId 840) if the JavaScript SDK flow is used to inform about the successful payment.
|
|
264
267
|
The first step is creating an Order, the second step is completing it by calling this API endpoint.
|
|
265
268
|
tags:
|
|
266
269
|
- OrderManagementCheckoutActions
|
|
267
270
|
operationId: completeOrder
|
|
268
271
|
parameters:
|
|
269
|
-
- $ref:
|
|
270
|
-
- $ref:
|
|
271
|
-
- $ref:
|
|
272
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
273
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
274
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
272
275
|
requestBody:
|
|
273
276
|
content:
|
|
274
277
|
application/json:
|
|
275
278
|
schema:
|
|
276
|
-
$ref:
|
|
279
|
+
$ref: "#/components/schemas/CompleteOrderRequest"
|
|
277
280
|
required: true
|
|
278
281
|
responses:
|
|
279
282
|
200:
|
|
@@ -281,59 +284,60 @@ paths:
|
|
|
281
284
|
content:
|
|
282
285
|
application/json:
|
|
283
286
|
schema:
|
|
284
|
-
$ref:
|
|
287
|
+
$ref: "#/components/schemas/CompletePaymentResponse"
|
|
285
288
|
400:
|
|
286
289
|
description: Incorrect input data
|
|
287
290
|
content:
|
|
288
291
|
application/json:
|
|
289
292
|
schema:
|
|
290
|
-
$ref:
|
|
293
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
291
294
|
402:
|
|
292
295
|
description: The payment was declined by a 3rd party (acquirer, payment processor, etc.)
|
|
293
296
|
content:
|
|
294
297
|
application/json:
|
|
295
298
|
schema:
|
|
296
|
-
$ref:
|
|
299
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
297
300
|
403:
|
|
298
301
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
299
302
|
content:
|
|
300
303
|
application/json:
|
|
301
304
|
schema:
|
|
302
|
-
$ref:
|
|
305
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
303
306
|
409:
|
|
304
307
|
description: Complete is not allowed
|
|
305
308
|
content:
|
|
306
309
|
application/json:
|
|
307
310
|
schema:
|
|
308
|
-
$ref:
|
|
311
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
309
312
|
422:
|
|
310
313
|
description: The request was well-formed but was unable to be processed due to semantic errors
|
|
311
314
|
content:
|
|
312
315
|
application/json:
|
|
313
316
|
schema:
|
|
314
|
-
$ref:
|
|
317
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
315
318
|
500:
|
|
316
319
|
description: Internal server exception
|
|
317
320
|
content:
|
|
318
321
|
application/json:
|
|
319
322
|
schema:
|
|
320
|
-
$ref:
|
|
323
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
321
324
|
502:
|
|
322
|
-
description:
|
|
325
|
+
description:
|
|
326
|
+
Any 5XX response points to something that went wrong on our
|
|
323
327
|
end. This could also be that the system was unable to route the transaction
|
|
324
328
|
to an appropriate acquirer/3rd party. Another reason for such a response
|
|
325
329
|
is when the 3rd party's response could not be understood.
|
|
326
330
|
content:
|
|
327
331
|
application/json:
|
|
328
332
|
schema:
|
|
329
|
-
$ref:
|
|
333
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
330
334
|
503:
|
|
331
335
|
description: Service unavailable
|
|
332
336
|
content:
|
|
333
337
|
application/json:
|
|
334
338
|
schema:
|
|
335
|
-
$ref:
|
|
336
|
-
|
|
339
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
340
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/deliver":
|
|
337
341
|
post:
|
|
338
342
|
summary: Mark items of a Checkout as delivered and automatically capture the payment for the items
|
|
339
343
|
description: |
|
|
@@ -347,24 +351,24 @@ paths:
|
|
|
347
351
|
- OrderManagementCheckoutActions
|
|
348
352
|
operationId: deliverOrder
|
|
349
353
|
parameters:
|
|
350
|
-
- $ref:
|
|
351
|
-
- $ref:
|
|
352
|
-
- $ref:
|
|
354
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
355
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
356
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
353
357
|
requestBody:
|
|
354
358
|
required: true
|
|
355
359
|
content:
|
|
356
360
|
application/json:
|
|
357
361
|
schema:
|
|
358
|
-
$ref:
|
|
362
|
+
$ref: "#/components/schemas/DeliverRequest"
|
|
359
363
|
responses:
|
|
360
|
-
|
|
364
|
+
"201":
|
|
361
365
|
x-nullable: true
|
|
362
366
|
description: The deliver was successfully created.
|
|
363
367
|
content:
|
|
364
368
|
application/json:
|
|
365
369
|
schema:
|
|
366
|
-
$ref:
|
|
367
|
-
|
|
370
|
+
$ref: "#/components/schemas/DeliverResponse"
|
|
371
|
+
"400":
|
|
368
372
|
x-nullable: true
|
|
369
373
|
description: |-
|
|
370
374
|
The request was malformed or was missing required data. When a required property was missing the error
|
|
@@ -372,15 +376,15 @@ paths:
|
|
|
372
376
|
content:
|
|
373
377
|
application/json:
|
|
374
378
|
schema:
|
|
375
|
-
$ref:
|
|
376
|
-
|
|
379
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
380
|
+
"403":
|
|
377
381
|
x-nullable: true
|
|
378
382
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
379
383
|
content:
|
|
380
384
|
application/json:
|
|
381
385
|
schema:
|
|
382
|
-
$ref:
|
|
383
|
-
|
|
386
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
387
|
+
"404":
|
|
384
388
|
x-nullable: true
|
|
385
389
|
description: |-
|
|
386
390
|
The most common cause for this response is that the Checkout status was not PENDING_COMPLETION, BILLED or
|
|
@@ -388,8 +392,8 @@ paths:
|
|
|
388
392
|
content:
|
|
389
393
|
application/json:
|
|
390
394
|
schema:
|
|
391
|
-
$ref:
|
|
392
|
-
|
|
395
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
396
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/return":
|
|
393
397
|
post:
|
|
394
398
|
summary: Mark items of a Checkout as returned and automatically refund the payment for the items
|
|
395
399
|
description: |
|
|
@@ -401,24 +405,24 @@ paths:
|
|
|
401
405
|
- OrderManagementCheckoutActions
|
|
402
406
|
operationId: returnOrder
|
|
403
407
|
parameters:
|
|
404
|
-
- $ref:
|
|
405
|
-
- $ref:
|
|
406
|
-
- $ref:
|
|
408
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
409
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
410
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
407
411
|
requestBody:
|
|
408
412
|
required: false
|
|
409
413
|
content:
|
|
410
414
|
application/json:
|
|
411
415
|
schema:
|
|
412
|
-
$ref:
|
|
416
|
+
$ref: "#/components/schemas/ReturnRequest"
|
|
413
417
|
responses:
|
|
414
|
-
|
|
418
|
+
"201":
|
|
415
419
|
x-nullable: true
|
|
416
420
|
description: The return was successfully executed.
|
|
417
421
|
content:
|
|
418
422
|
application/json:
|
|
419
423
|
schema:
|
|
420
|
-
$ref:
|
|
421
|
-
|
|
424
|
+
$ref: "#/components/schemas/ReturnResponse"
|
|
425
|
+
"400":
|
|
422
426
|
x-nullable: true
|
|
423
427
|
description: |-
|
|
424
428
|
The request was malformed or was missing required data. When a required property was missing the error
|
|
@@ -426,15 +430,15 @@ paths:
|
|
|
426
430
|
content:
|
|
427
431
|
application/json:
|
|
428
432
|
schema:
|
|
429
|
-
$ref:
|
|
430
|
-
|
|
433
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
434
|
+
"403":
|
|
431
435
|
x-nullable: true
|
|
432
436
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
433
437
|
content:
|
|
434
438
|
application/json:
|
|
435
439
|
schema:
|
|
436
|
-
$ref:
|
|
437
|
-
|
|
440
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
441
|
+
"404":
|
|
438
442
|
x-nullable: true
|
|
439
443
|
description: |-
|
|
440
444
|
The most common cause for this response is that the Checkout status was not PENDING_COMPLETION, BILLED or
|
|
@@ -442,8 +446,8 @@ paths:
|
|
|
442
446
|
content:
|
|
443
447
|
application/json:
|
|
444
448
|
schema:
|
|
445
|
-
$ref:
|
|
446
|
-
|
|
449
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
450
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/cancel":
|
|
447
451
|
post:
|
|
448
452
|
summary: Mark items of a Checkout as cancelled and automatically cancel the payment for the items
|
|
449
453
|
description: |-
|
|
@@ -452,7 +456,7 @@ paths:
|
|
|
452
456
|
The Cancel endpoint can be used to cancel a full or partial order.
|
|
453
457
|
The Cancel request will mark all or (for cancelType PARTIAL) the provided items as CANCELLED, and – in case of
|
|
454
458
|
an existing authorization – will reverse the payment.
|
|
455
|
-
|
|
459
|
+
|
|
456
460
|
In the light of card payments, reversing an authorization that is not needed will prevent you from having to pay
|
|
457
461
|
a fee/penalty for unused authorization requests.
|
|
458
462
|
Whilst scheme regulations require that acquirers and PSPs support authorization reversals, there are no rules
|
|
@@ -468,17 +472,17 @@ paths:
|
|
|
468
472
|
- OrderManagementCheckoutActions
|
|
469
473
|
operationId: cancelOrder
|
|
470
474
|
parameters:
|
|
471
|
-
- $ref:
|
|
472
|
-
- $ref:
|
|
473
|
-
- $ref:
|
|
475
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
476
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
477
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
474
478
|
requestBody:
|
|
475
479
|
required: false
|
|
476
480
|
content:
|
|
477
481
|
application/json:
|
|
478
482
|
schema:
|
|
479
|
-
$ref:
|
|
483
|
+
$ref: "#/components/schemas/CancelRequest"
|
|
480
484
|
responses:
|
|
481
|
-
|
|
485
|
+
"200":
|
|
482
486
|
x-nullable: true
|
|
483
487
|
description: |-
|
|
484
488
|
The payment has been cancelled. Some acquirers/issuers will provide some feedback in case a reversal of the
|
|
@@ -486,50 +490,50 @@ paths:
|
|
|
486
490
|
content:
|
|
487
491
|
application/json:
|
|
488
492
|
schema:
|
|
489
|
-
$ref:
|
|
490
|
-
|
|
493
|
+
$ref: "#/components/schemas/CancelResponse"
|
|
494
|
+
"400":
|
|
491
495
|
x-nullable: true
|
|
492
496
|
description: Incorrect input data
|
|
493
497
|
content:
|
|
494
498
|
application/json:
|
|
495
499
|
schema:
|
|
496
|
-
$ref:
|
|
497
|
-
|
|
500
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
501
|
+
"402":
|
|
498
502
|
x-nullable: true
|
|
499
503
|
description: Payment required
|
|
500
504
|
content:
|
|
501
505
|
application/json:
|
|
502
506
|
schema:
|
|
503
|
-
$ref:
|
|
504
|
-
|
|
507
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
508
|
+
"403":
|
|
505
509
|
x-nullable: true
|
|
506
510
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
507
511
|
content:
|
|
508
512
|
application/json:
|
|
509
513
|
schema:
|
|
510
|
-
$ref:
|
|
511
|
-
|
|
514
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
515
|
+
"404":
|
|
512
516
|
x-nullable: true
|
|
513
517
|
description: Payment was not found
|
|
514
518
|
content:
|
|
515
519
|
application/json:
|
|
516
520
|
schema:
|
|
517
|
-
$ref:
|
|
518
|
-
|
|
521
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
522
|
+
"409":
|
|
519
523
|
x-nullable: true
|
|
520
524
|
description: Cancellation is not allowed because payment is closed
|
|
521
525
|
content:
|
|
522
526
|
application/json:
|
|
523
527
|
schema:
|
|
524
|
-
$ref:
|
|
525
|
-
|
|
528
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
529
|
+
"500":
|
|
526
530
|
x-nullable: true
|
|
527
531
|
description: Internal server exception
|
|
528
532
|
content:
|
|
529
533
|
application/json:
|
|
530
534
|
schema:
|
|
531
|
-
$ref:
|
|
532
|
-
|
|
535
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
536
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts":
|
|
533
537
|
post:
|
|
534
538
|
summary: Add a Checkout to an existing Commerce Case
|
|
535
539
|
description: |-
|
|
@@ -540,38 +544,38 @@ paths:
|
|
|
540
544
|
- Checkout
|
|
541
545
|
operationId: createCheckout
|
|
542
546
|
parameters:
|
|
543
|
-
- $ref:
|
|
544
|
-
- $ref:
|
|
547
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
548
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
545
549
|
requestBody:
|
|
546
550
|
required: true
|
|
547
551
|
content:
|
|
548
552
|
application/json:
|
|
549
553
|
schema:
|
|
550
|
-
$ref:
|
|
554
|
+
$ref: "#/components/schemas/CreateCheckoutRequest"
|
|
551
555
|
responses:
|
|
552
|
-
|
|
556
|
+
"201":
|
|
553
557
|
x-nullable: true
|
|
554
558
|
description: The response contains the reference of the Checkout and possible the response for the payment.
|
|
555
559
|
content:
|
|
556
560
|
application/json:
|
|
557
561
|
schema:
|
|
558
|
-
$ref:
|
|
559
|
-
|
|
562
|
+
$ref: "#/components/schemas/CreateCheckoutResponse"
|
|
563
|
+
"202":
|
|
560
564
|
x-nullable: true
|
|
561
565
|
description: |-
|
|
562
566
|
The response contains the reference of the Checkout. But the Payment Execution was not successful.
|
|
563
567
|
content:
|
|
564
568
|
application/json:
|
|
565
569
|
schema:
|
|
566
|
-
$ref:
|
|
567
|
-
|
|
570
|
+
$ref: "#/components/schemas/CreateCheckoutResponse"
|
|
571
|
+
"400":
|
|
568
572
|
x-nullable: true
|
|
569
573
|
description: Payment not found.
|
|
570
574
|
content:
|
|
571
575
|
application/json:
|
|
572
576
|
schema:
|
|
573
|
-
$ref:
|
|
574
|
-
|
|
577
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
578
|
+
"/v1/{merchantId}/checkouts":
|
|
575
579
|
get:
|
|
576
580
|
summary: Get a list of Checkouts based on Search Parameters
|
|
577
581
|
description: |
|
|
@@ -583,57 +587,57 @@ paths:
|
|
|
583
587
|
- Checkout
|
|
584
588
|
operationId: getCheckouts
|
|
585
589
|
parameters:
|
|
586
|
-
- $ref:
|
|
587
|
-
- $ref:
|
|
588
|
-
- $ref:
|
|
589
|
-
- $ref:
|
|
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:
|
|
590
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
591
|
+
- $ref: "#/components/parameters/offset"
|
|
592
|
+
- $ref: "#/components/parameters/size"
|
|
593
|
+
- $ref: "#/components/parameters/fromDate"
|
|
594
|
+
- $ref: "#/components/parameters/toDate"
|
|
595
|
+
- $ref: "#/components/parameters/fromCheckoutAmount"
|
|
596
|
+
- $ref: "#/components/parameters/toCheckoutAmount"
|
|
597
|
+
- $ref: "#/components/parameters/fromOpenAmount"
|
|
598
|
+
- $ref: "#/components/parameters/toOpenAmount"
|
|
599
|
+
- $ref: "#/components/parameters/fromCollectedAmount"
|
|
600
|
+
- $ref: "#/components/parameters/toCollectedAmount"
|
|
601
|
+
- $ref: "#/components/parameters/fromCancelledAmount"
|
|
602
|
+
- $ref: "#/components/parameters/toCancelledAmount"
|
|
603
|
+
- $ref: "#/components/parameters/fromRefundAmount"
|
|
604
|
+
- $ref: "#/components/parameters/toRefundAmount"
|
|
605
|
+
- $ref: "#/components/parameters/fromChargebackAmount"
|
|
606
|
+
- $ref: "#/components/parameters/toChargebackAmount"
|
|
607
|
+
- $ref: "#/components/parameters/checkoutIdQuery"
|
|
608
|
+
- $ref: "#/components/parameters/merchantReference"
|
|
609
|
+
- $ref: "#/components/parameters/merchantCustomerId"
|
|
610
|
+
- $ref: "#/components/parameters/includePaymentProductId"
|
|
611
|
+
- $ref: "#/components/parameters/includeCheckoutStatus"
|
|
612
|
+
- $ref: "#/components/parameters/includeExtendedCheckoutStatus"
|
|
613
|
+
- $ref: "#/components/parameters/includePaymentChannel"
|
|
614
|
+
- $ref: "#/components/parameters/paymentReference"
|
|
615
|
+
- $ref: "#/components/parameters/paymentId"
|
|
616
|
+
- $ref: "#/components/parameters/firstName"
|
|
617
|
+
- $ref: "#/components/parameters/surname"
|
|
618
|
+
- $ref: "#/components/parameters/email"
|
|
619
|
+
- $ref: "#/components/parameters/phoneNumber"
|
|
620
|
+
- $ref: "#/components/parameters/dateOfBirth"
|
|
621
|
+
- $ref: "#/components/parameters/companyInformation"
|
|
622
|
+
- $ref: "#/components/parameters/terminalId"
|
|
623
|
+
- $ref: "#/components/parameters/reportingToken"
|
|
620
624
|
responses:
|
|
621
|
-
|
|
625
|
+
"200":
|
|
622
626
|
x-nullable: true
|
|
623
627
|
description: |
|
|
624
628
|
The response containing all found Checkouts for the provided criteria.
|
|
625
629
|
content:
|
|
626
630
|
application/json:
|
|
627
631
|
schema:
|
|
628
|
-
$ref:
|
|
629
|
-
|
|
632
|
+
$ref: "#/components/schemas/CheckoutsResponse"
|
|
633
|
+
"400":
|
|
630
634
|
x-nullable: true
|
|
631
635
|
description: Exception when requesting Checkouts with given parameters.
|
|
632
636
|
content:
|
|
633
637
|
application/json:
|
|
634
638
|
schema:
|
|
635
|
-
$ref:
|
|
636
|
-
|
|
639
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
640
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}":
|
|
637
641
|
get:
|
|
638
642
|
summary: Get Checkout Details
|
|
639
643
|
description: This endpoint can be used to get a Checkout.
|
|
@@ -641,24 +645,24 @@ paths:
|
|
|
641
645
|
- Checkout
|
|
642
646
|
operationId: getCheckout
|
|
643
647
|
parameters:
|
|
644
|
-
- $ref:
|
|
645
|
-
- $ref:
|
|
646
|
-
- $ref:
|
|
648
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
649
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
650
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
647
651
|
responses:
|
|
648
|
-
|
|
652
|
+
"200":
|
|
649
653
|
x-nullable: true
|
|
650
654
|
description: The response contains the Checkout.
|
|
651
655
|
content:
|
|
652
656
|
application/json:
|
|
653
657
|
schema:
|
|
654
|
-
$ref:
|
|
655
|
-
|
|
658
|
+
$ref: "#/components/schemas/CheckoutResponse"
|
|
659
|
+
"404":
|
|
656
660
|
x-nullable: true
|
|
657
661
|
description: Checkout not found
|
|
658
662
|
content:
|
|
659
663
|
application/json:
|
|
660
664
|
schema:
|
|
661
|
-
$ref:
|
|
665
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
662
666
|
patch:
|
|
663
667
|
summary: Modify a Checkout
|
|
664
668
|
description: This endpoint can be used to update or modify the data of a Checkout.
|
|
@@ -666,33 +670,33 @@ paths:
|
|
|
666
670
|
- Checkout
|
|
667
671
|
operationId: updateCheckout
|
|
668
672
|
parameters:
|
|
669
|
-
- $ref:
|
|
670
|
-
- $ref:
|
|
671
|
-
- $ref:
|
|
673
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
674
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
675
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
672
676
|
requestBody:
|
|
673
677
|
required: true
|
|
674
678
|
content:
|
|
675
679
|
application/json:
|
|
676
680
|
schema:
|
|
677
|
-
$ref:
|
|
681
|
+
$ref: "#/components/schemas/PatchCheckoutRequest"
|
|
678
682
|
responses:
|
|
679
|
-
|
|
683
|
+
"204":
|
|
680
684
|
x-nullable: true
|
|
681
685
|
description: The Checkout is updated successfully.
|
|
682
|
-
|
|
686
|
+
"400":
|
|
683
687
|
x-nullable: true
|
|
684
688
|
description: Payment not found.
|
|
685
689
|
content:
|
|
686
690
|
application/json:
|
|
687
691
|
schema:
|
|
688
|
-
$ref:
|
|
689
|
-
|
|
692
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
693
|
+
"409":
|
|
690
694
|
x-nullable: true
|
|
691
695
|
description: Conflict
|
|
692
696
|
content:
|
|
693
697
|
application/json:
|
|
694
698
|
schema:
|
|
695
|
-
$ref:
|
|
699
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
696
700
|
delete:
|
|
697
701
|
summary: Delete a Checkout
|
|
698
702
|
description: This endpoint can be used to delete an unused Checkout.
|
|
@@ -700,28 +704,28 @@ paths:
|
|
|
700
704
|
- Checkout
|
|
701
705
|
operationId: deleteCheckout
|
|
702
706
|
parameters:
|
|
703
|
-
- $ref:
|
|
704
|
-
- $ref:
|
|
705
|
-
- $ref:
|
|
707
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
708
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
709
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
706
710
|
responses:
|
|
707
|
-
|
|
711
|
+
"204":
|
|
708
712
|
x-nullable: true
|
|
709
713
|
description: The Checkout was successfully deleted.
|
|
710
|
-
|
|
714
|
+
"403":
|
|
711
715
|
x-nullable: true
|
|
712
716
|
description: You are not allowed to delete the Checkout
|
|
713
717
|
content:
|
|
714
718
|
application/json:
|
|
715
719
|
schema:
|
|
716
|
-
$ref:
|
|
717
|
-
|
|
720
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
721
|
+
"404":
|
|
718
722
|
x-nullable: true
|
|
719
723
|
description: The Checkout could not be found
|
|
720
724
|
content:
|
|
721
725
|
application/json:
|
|
722
726
|
schema:
|
|
723
|
-
$ref:
|
|
724
|
-
|
|
727
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
728
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-executions":
|
|
725
729
|
post:
|
|
726
730
|
summary: Create a Payment
|
|
727
731
|
description: |-
|
|
@@ -732,24 +736,24 @@ paths:
|
|
|
732
736
|
- PaymentExecution
|
|
733
737
|
operationId: createPayment
|
|
734
738
|
parameters:
|
|
735
|
-
- $ref:
|
|
736
|
-
- $ref:
|
|
737
|
-
- $ref:
|
|
739
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
740
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
741
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
738
742
|
requestBody:
|
|
739
743
|
required: true
|
|
740
744
|
content:
|
|
741
745
|
application/json:
|
|
742
746
|
schema:
|
|
743
|
-
$ref:
|
|
747
|
+
$ref: "#/components/schemas/PaymentExecutionRequest"
|
|
744
748
|
responses:
|
|
745
|
-
|
|
749
|
+
"201":
|
|
746
750
|
x-nullable: true
|
|
747
751
|
description: The payment request was successfully processed and a payment object was created.
|
|
748
752
|
content:
|
|
749
753
|
application/json:
|
|
750
754
|
schema:
|
|
751
|
-
$ref:
|
|
752
|
-
|
|
755
|
+
$ref: "#/components/schemas/CreatePaymentResponse"
|
|
756
|
+
"400":
|
|
753
757
|
x-nullable: true
|
|
754
758
|
description: |-
|
|
755
759
|
The request was malformed or was missing required data. When a required property was missing the error
|
|
@@ -757,36 +761,36 @@ paths:
|
|
|
757
761
|
content:
|
|
758
762
|
application/json:
|
|
759
763
|
schema:
|
|
760
|
-
$ref:
|
|
761
|
-
|
|
764
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
765
|
+
"402":
|
|
762
766
|
x-nullable: true
|
|
763
767
|
description: The payment was declined by a 3rd party (acquirer, payment processor, etc.)
|
|
764
768
|
content:
|
|
765
769
|
application/json:
|
|
766
770
|
schema:
|
|
767
|
-
$ref:
|
|
768
|
-
|
|
771
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
772
|
+
"403":
|
|
769
773
|
x-nullable: true
|
|
770
774
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
771
775
|
content:
|
|
772
776
|
application/json:
|
|
773
777
|
schema:
|
|
774
|
-
$ref:
|
|
775
|
-
|
|
778
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
779
|
+
"404":
|
|
776
780
|
x-nullable: true
|
|
777
781
|
description: Payment not found
|
|
778
782
|
content:
|
|
779
783
|
application/json:
|
|
780
784
|
schema:
|
|
781
|
-
$ref:
|
|
782
|
-
|
|
785
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
786
|
+
"409":
|
|
783
787
|
x-nullable: true
|
|
784
788
|
description: Conflict
|
|
785
789
|
content:
|
|
786
790
|
application/json:
|
|
787
791
|
schema:
|
|
788
|
-
$ref:
|
|
789
|
-
|
|
792
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
793
|
+
"502":
|
|
790
794
|
x-nullable: true
|
|
791
795
|
description: |-
|
|
792
796
|
Any 5XX response points to something that went wrong on our end. This could also be that the system was
|
|
@@ -795,15 +799,15 @@ paths:
|
|
|
795
799
|
content:
|
|
796
800
|
application/json:
|
|
797
801
|
schema:
|
|
798
|
-
$ref:
|
|
799
|
-
|
|
802
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
803
|
+
"503":
|
|
800
804
|
x-nullable: true
|
|
801
805
|
description: Service unavailable
|
|
802
806
|
content:
|
|
803
807
|
application/json:
|
|
804
808
|
schema:
|
|
805
|
-
$ref:
|
|
806
|
-
|
|
809
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
810
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-executions/{paymentExecutionId}/capture":
|
|
807
811
|
post:
|
|
808
812
|
summary: Capture a Payment
|
|
809
813
|
description: |-
|
|
@@ -812,7 +816,7 @@ paths:
|
|
|
812
816
|
OrderManagementActions will be impossible after using a PaymentExecution endpoint.
|
|
813
817
|
It is possible to perform multiple partial captures by providing an amount that is lower than the total
|
|
814
818
|
authorized amount.
|
|
815
|
-
|
|
819
|
+
|
|
816
820
|
The cancellationReason is mandatory for BNPL payment methods (paymentProductId 3390, 3391 and 3392) if isFinal
|
|
817
821
|
is set to true and the amount of the Capture is lower than the authorized amount.
|
|
818
822
|
For other payment methods the cancellationReason is not mandatory in this case but can be used for reporting and
|
|
@@ -821,25 +825,25 @@ paths:
|
|
|
821
825
|
- PaymentExecution
|
|
822
826
|
operationId: capturePaymentExecution
|
|
823
827
|
parameters:
|
|
824
|
-
- $ref:
|
|
825
|
-
- $ref:
|
|
826
|
-
- $ref:
|
|
827
|
-
- $ref:
|
|
828
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
829
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
830
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
831
|
+
- $ref: "#/components/parameters/paymentExecutionId"
|
|
828
832
|
requestBody:
|
|
829
833
|
required: true
|
|
830
834
|
content:
|
|
831
835
|
application/json:
|
|
832
836
|
schema:
|
|
833
|
-
$ref:
|
|
837
|
+
$ref: "#/components/schemas/CapturePaymentRequest"
|
|
834
838
|
responses:
|
|
835
|
-
|
|
839
|
+
"201":
|
|
836
840
|
x-nullable: true
|
|
837
841
|
description: The Capture was successfully created.
|
|
838
842
|
content:
|
|
839
843
|
application/json:
|
|
840
844
|
schema:
|
|
841
|
-
$ref:
|
|
842
|
-
|
|
845
|
+
$ref: "#/components/schemas/CapturePaymentResponse"
|
|
846
|
+
"400":
|
|
843
847
|
x-nullable: true
|
|
844
848
|
description: |-
|
|
845
849
|
The request was malformed or was missing required data. When a required property was missing the error
|
|
@@ -847,15 +851,15 @@ paths:
|
|
|
847
851
|
content:
|
|
848
852
|
application/json:
|
|
849
853
|
schema:
|
|
850
|
-
$ref:
|
|
851
|
-
|
|
854
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
855
|
+
"403":
|
|
852
856
|
x-nullable: true
|
|
853
857
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
854
858
|
content:
|
|
855
859
|
application/json:
|
|
856
860
|
schema:
|
|
857
|
-
$ref:
|
|
858
|
-
|
|
861
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
862
|
+
"404":
|
|
859
863
|
x-nullable: true
|
|
860
864
|
description: |-
|
|
861
865
|
The most common cause for this response is that the Checkout status was not PENDING_COMPLETION, BILLED or
|
|
@@ -863,15 +867,15 @@ paths:
|
|
|
863
867
|
content:
|
|
864
868
|
application/json:
|
|
865
869
|
schema:
|
|
866
|
-
$ref:
|
|
867
|
-
|
|
870
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
871
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-executions/{paymentExecutionId}/cancel":
|
|
868
872
|
post:
|
|
869
873
|
summary: Cancel a Payment
|
|
870
874
|
description: |-
|
|
871
875
|
This endpoint can be used to reverse the payment associated with this Checkout. The Cancel is only possible for
|
|
872
876
|
the entire amount of the payment and not partial payments.
|
|
873
877
|
OrderManagementActions will be impossible after using a PaymentExecution endpoint.
|
|
874
|
-
|
|
878
|
+
|
|
875
879
|
In the light of card payments, reversing an authorization that is not needed will prevent you from having to pay
|
|
876
880
|
a fee/penalty for unused authorization requests.
|
|
877
881
|
Whilst scheme regulations require that acquirers and PSPs support authorization reversals, there are no rules
|
|
@@ -887,18 +891,18 @@ paths:
|
|
|
887
891
|
- PaymentExecution
|
|
888
892
|
operationId: cancelPaymentExecution
|
|
889
893
|
parameters:
|
|
890
|
-
- $ref:
|
|
891
|
-
- $ref:
|
|
892
|
-
- $ref:
|
|
893
|
-
- $ref:
|
|
894
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
895
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
896
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
897
|
+
- $ref: "#/components/parameters/paymentExecutionId"
|
|
894
898
|
requestBody:
|
|
895
899
|
required: true
|
|
896
900
|
content:
|
|
897
901
|
application/json:
|
|
898
902
|
schema:
|
|
899
|
-
$ref:
|
|
903
|
+
$ref: "#/components/schemas/CancelPaymentRequest"
|
|
900
904
|
responses:
|
|
901
|
-
|
|
905
|
+
"200":
|
|
902
906
|
x-nullable: true
|
|
903
907
|
description: |-
|
|
904
908
|
The payment has been cancelled. Some acquirers/issuers will provide some feedback in case a reversal of the
|
|
@@ -906,50 +910,50 @@ paths:
|
|
|
906
910
|
content:
|
|
907
911
|
application/json:
|
|
908
912
|
schema:
|
|
909
|
-
$ref:
|
|
910
|
-
|
|
913
|
+
$ref: "#/components/schemas/CancelPaymentResponse"
|
|
914
|
+
"400":
|
|
911
915
|
x-nullable: true
|
|
912
916
|
description: Incorrect input data
|
|
913
917
|
content:
|
|
914
918
|
application/json:
|
|
915
919
|
schema:
|
|
916
|
-
$ref:
|
|
917
|
-
|
|
920
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
921
|
+
"402":
|
|
918
922
|
x-nullable: true
|
|
919
923
|
description: Payment required
|
|
920
924
|
content:
|
|
921
925
|
application/json:
|
|
922
926
|
schema:
|
|
923
|
-
$ref:
|
|
924
|
-
|
|
927
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
928
|
+
"403":
|
|
925
929
|
x-nullable: true
|
|
926
930
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
927
931
|
content:
|
|
928
932
|
application/json:
|
|
929
933
|
schema:
|
|
930
|
-
$ref:
|
|
931
|
-
|
|
934
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
935
|
+
"404":
|
|
932
936
|
x-nullable: true
|
|
933
937
|
description: Payment was not found
|
|
934
938
|
content:
|
|
935
939
|
application/json:
|
|
936
940
|
schema:
|
|
937
|
-
$ref:
|
|
938
|
-
|
|
941
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
942
|
+
"409":
|
|
939
943
|
x-nullable: true
|
|
940
944
|
description: Cancellation is not allowed because payment is closed
|
|
941
945
|
content:
|
|
942
946
|
application/json:
|
|
943
947
|
schema:
|
|
944
|
-
$ref:
|
|
945
|
-
|
|
948
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
949
|
+
"500":
|
|
946
950
|
x-nullable: true
|
|
947
951
|
description: Internal server exception
|
|
948
952
|
content:
|
|
949
953
|
application/json:
|
|
950
954
|
schema:
|
|
951
|
-
$ref:
|
|
952
|
-
|
|
955
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
956
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-executions/{paymentExecutionId}/refund":
|
|
953
957
|
post:
|
|
954
958
|
summary: Refund a Payment
|
|
955
959
|
description: |-
|
|
@@ -960,25 +964,25 @@ paths:
|
|
|
960
964
|
- PaymentExecution
|
|
961
965
|
operationId: refundPaymentExecution
|
|
962
966
|
parameters:
|
|
963
|
-
- $ref:
|
|
964
|
-
- $ref:
|
|
965
|
-
- $ref:
|
|
966
|
-
- $ref:
|
|
967
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
968
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
969
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
970
|
+
- $ref: "#/components/parameters/paymentExecutionId"
|
|
967
971
|
requestBody:
|
|
968
972
|
required: true
|
|
969
973
|
content:
|
|
970
974
|
application/json:
|
|
971
975
|
schema:
|
|
972
|
-
$ref:
|
|
976
|
+
$ref: "#/components/schemas/RefundRequest"
|
|
973
977
|
responses:
|
|
974
|
-
|
|
978
|
+
"201":
|
|
975
979
|
x-nullable: true
|
|
976
980
|
description: The Refund was successfully created.
|
|
977
981
|
content:
|
|
978
982
|
application/json:
|
|
979
983
|
schema:
|
|
980
|
-
$ref:
|
|
981
|
-
|
|
984
|
+
$ref: "#/components/schemas/RefundPaymentResponse"
|
|
985
|
+
"400":
|
|
982
986
|
x-nullable: true
|
|
983
987
|
description: |-
|
|
984
988
|
The request was malformed or was missing required data. When a required property was missing the error
|
|
@@ -986,41 +990,44 @@ paths:
|
|
|
986
990
|
content:
|
|
987
991
|
application/json:
|
|
988
992
|
schema:
|
|
989
|
-
$ref:
|
|
990
|
-
|
|
993
|
+
$ref: "#/components/schemas/RefundErrorResponse"
|
|
994
|
+
"403":
|
|
991
995
|
x-nullable: true
|
|
992
996
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
993
997
|
content:
|
|
994
998
|
application/json:
|
|
995
999
|
schema:
|
|
996
|
-
$ref:
|
|
997
|
-
|
|
1000
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1001
|
+
"404":
|
|
998
1002
|
x-nullable: true
|
|
999
1003
|
description: The most common cause for this response id that the payment was not in a cancelable state.
|
|
1000
1004
|
content:
|
|
1001
1005
|
application/json:
|
|
1002
1006
|
schema:
|
|
1003
|
-
$ref:
|
|
1004
|
-
|
|
1007
|
+
$ref: "#/components/schemas/RefundErrorResponse"
|
|
1008
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-executions/{paymentExecutionId}/complete":
|
|
1005
1009
|
post:
|
|
1006
1010
|
summary: Complete a Payment
|
|
1007
1011
|
description: |-
|
|
1008
|
-
|
|
1009
|
-
|
|
1012
|
+
This endpoint can be used to complete a Payment Execution.
|
|
1013
|
+
It is needed for all payment flows where the payment needs interaction with the customer like:
|
|
1014
|
+
* For PAYONE Secured Installment (paymentProductId 3391) to select the installment options.
|
|
1015
|
+
* For PayPal (paymentProductId 840) if the JavaScript SDK flow is used to inform about the successful payment.
|
|
1016
|
+
The first step is creating an Payment Execution, the second step is completing it by calling this API endpoint.
|
|
1010
1017
|
OrderManagementActions will be impossible after using a PaymentExecution endpoint.
|
|
1011
1018
|
tags:
|
|
1012
1019
|
- PaymentExecution
|
|
1013
1020
|
operationId: completePayment
|
|
1014
1021
|
parameters:
|
|
1015
|
-
- $ref:
|
|
1016
|
-
- $ref:
|
|
1017
|
-
- $ref:
|
|
1018
|
-
- $ref:
|
|
1022
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
1023
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
1024
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
1025
|
+
- $ref: "#/components/parameters/paymentExecutionId"
|
|
1019
1026
|
requestBody:
|
|
1020
1027
|
content:
|
|
1021
1028
|
application/json:
|
|
1022
1029
|
schema:
|
|
1023
|
-
$ref:
|
|
1030
|
+
$ref: "#/components/schemas/CompletePaymentRequest"
|
|
1024
1031
|
required: true
|
|
1025
1032
|
responses:
|
|
1026
1033
|
200:
|
|
@@ -1028,66 +1035,67 @@ paths:
|
|
|
1028
1035
|
content:
|
|
1029
1036
|
application/json:
|
|
1030
1037
|
schema:
|
|
1031
|
-
$ref:
|
|
1038
|
+
$ref: "#/components/schemas/CompletePaymentResponse"
|
|
1032
1039
|
400:
|
|
1033
1040
|
description: Incorrect input data
|
|
1034
1041
|
content:
|
|
1035
1042
|
application/json:
|
|
1036
1043
|
schema:
|
|
1037
|
-
$ref:
|
|
1044
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1038
1045
|
402:
|
|
1039
1046
|
description: The payment was declined by a 3rd party (acquirer, payment processor, etc.)
|
|
1040
1047
|
content:
|
|
1041
1048
|
application/json:
|
|
1042
1049
|
schema:
|
|
1043
|
-
$ref:
|
|
1050
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1044
1051
|
403:
|
|
1045
1052
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
1046
1053
|
content:
|
|
1047
1054
|
application/json:
|
|
1048
1055
|
schema:
|
|
1049
|
-
$ref:
|
|
1056
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1050
1057
|
409:
|
|
1051
1058
|
description: Complete is not allowed
|
|
1052
1059
|
content:
|
|
1053
1060
|
application/json:
|
|
1054
1061
|
schema:
|
|
1055
|
-
$ref:
|
|
1062
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1056
1063
|
422:
|
|
1057
1064
|
description: The request was well-formed but was unable to be processed due to semantic errors
|
|
1058
1065
|
content:
|
|
1059
1066
|
application/json:
|
|
1060
1067
|
schema:
|
|
1061
|
-
$ref:
|
|
1068
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1062
1069
|
500:
|
|
1063
1070
|
description: Internal server exception
|
|
1064
1071
|
content:
|
|
1065
1072
|
application/json:
|
|
1066
1073
|
schema:
|
|
1067
|
-
$ref:
|
|
1074
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1068
1075
|
502:
|
|
1069
|
-
description:
|
|
1076
|
+
description:
|
|
1077
|
+
Any 5XX response points to something that went wrong on our
|
|
1070
1078
|
end. This could also be that the system was unable to route the transaction
|
|
1071
1079
|
to an appropriate acquirer/3rd party. Another reason for such a response
|
|
1072
1080
|
is when the 3rd party's response could not be understood.
|
|
1073
1081
|
content:
|
|
1074
1082
|
application/json:
|
|
1075
1083
|
schema:
|
|
1076
|
-
$ref:
|
|
1084
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1077
1085
|
503:
|
|
1078
1086
|
description: Service unavailable
|
|
1079
1087
|
content:
|
|
1080
1088
|
application/json:
|
|
1081
1089
|
schema:
|
|
1082
|
-
$ref:
|
|
1083
|
-
|
|
1090
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1091
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-executions/{paymentExecutionId}/pause":
|
|
1084
1092
|
post:
|
|
1085
1093
|
summary: Pause a Payment for selected payment methods
|
|
1086
1094
|
description: |-
|
|
1087
1095
|
Defers next dunning step-up after a consumer has announced to send
|
|
1088
1096
|
back a shipped order. Merchant intends to do a REFUND call soon.
|
|
1089
1097
|
OrderManagementActions will be impossible after using a PaymentExecution endpoint.
|
|
1090
|
-
|
|
1098
|
+
|
|
1091
1099
|
Currently only applicable for PAYONE Buy Now, Pay Later (BNPL).
|
|
1092
1100
|
|
|
1093
1101
|
* 3390 - PAYONE Secured Invoice
|
|
@@ -1097,82 +1105,86 @@ paths:
|
|
|
1097
1105
|
- PaymentExecution
|
|
1098
1106
|
operationId: pausePayment
|
|
1099
1107
|
parameters:
|
|
1100
|
-
- $ref:
|
|
1101
|
-
- $ref:
|
|
1102
|
-
- $ref:
|
|
1103
|
-
- $ref:
|
|
1108
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
1109
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
1110
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
1111
|
+
- $ref: "#/components/parameters/paymentExecutionId"
|
|
1104
1112
|
requestBody:
|
|
1105
1113
|
content:
|
|
1106
1114
|
application/json:
|
|
1107
1115
|
schema:
|
|
1108
|
-
$ref:
|
|
1116
|
+
$ref: "#/components/schemas/PausePaymentRequest"
|
|
1109
1117
|
responses:
|
|
1110
1118
|
200:
|
|
1111
1119
|
description: The pause was successful.
|
|
1112
1120
|
content:
|
|
1113
1121
|
application/json:
|
|
1114
1122
|
schema:
|
|
1115
|
-
$ref:
|
|
1123
|
+
$ref: "#/components/schemas/PausePaymentResponse"
|
|
1116
1124
|
400:
|
|
1117
1125
|
description: Incorrect input data
|
|
1118
1126
|
content:
|
|
1119
1127
|
application/json:
|
|
1120
1128
|
schema:
|
|
1121
|
-
$ref:
|
|
1129
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1122
1130
|
402:
|
|
1123
|
-
description:
|
|
1131
|
+
description:
|
|
1132
|
+
The payment was declined by a 3rd party (acquirer, payment
|
|
1124
1133
|
processor, etc.)
|
|
1125
1134
|
content:
|
|
1126
1135
|
application/json:
|
|
1127
1136
|
schema:
|
|
1128
|
-
$ref:
|
|
1137
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1129
1138
|
403:
|
|
1130
|
-
description:
|
|
1139
|
+
description:
|
|
1140
|
+
You are not allowed to access the service or account or your
|
|
1131
1141
|
API authentication failed.
|
|
1132
1142
|
content:
|
|
1133
1143
|
application/json:
|
|
1134
1144
|
schema:
|
|
1135
|
-
$ref:
|
|
1145
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1136
1146
|
409:
|
|
1137
1147
|
description: Pause is not allowed
|
|
1138
1148
|
content:
|
|
1139
1149
|
application/json:
|
|
1140
1150
|
schema:
|
|
1141
|
-
$ref:
|
|
1151
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1142
1152
|
422:
|
|
1143
|
-
description:
|
|
1153
|
+
description:
|
|
1154
|
+
The request was well-formed but was unable to be processed
|
|
1144
1155
|
due to semantic errors
|
|
1145
1156
|
content:
|
|
1146
1157
|
application/json:
|
|
1147
1158
|
schema:
|
|
1148
|
-
$ref:
|
|
1159
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1149
1160
|
500:
|
|
1150
1161
|
description: Internal server exception
|
|
1151
1162
|
content:
|
|
1152
1163
|
application/json:
|
|
1153
1164
|
schema:
|
|
1154
|
-
$ref:
|
|
1165
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1155
1166
|
502:
|
|
1156
|
-
description:
|
|
1167
|
+
description:
|
|
1168
|
+
Any 5XX response points to something that went wrong on our
|
|
1157
1169
|
end. This could also be that the system was unable to route the transaction
|
|
1158
1170
|
to an appropriate acquirer/3rd party. Another reason for such a response
|
|
1159
1171
|
is when the 3rd party's response could not be understood.
|
|
1160
1172
|
content:
|
|
1161
1173
|
application/json:
|
|
1162
1174
|
schema:
|
|
1163
|
-
$ref:
|
|
1175
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1164
1176
|
503:
|
|
1165
1177
|
description: Service unavailable
|
|
1166
1178
|
content:
|
|
1167
1179
|
application/json:
|
|
1168
1180
|
schema:
|
|
1169
|
-
$ref:
|
|
1170
|
-
|
|
1181
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1182
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-executions/{paymentExecutionId}/refresh":
|
|
1171
1183
|
post:
|
|
1172
1184
|
summary: Refresh information of a Payment Execution
|
|
1173
1185
|
description: |-
|
|
1174
1186
|
This endpoint can be used to refresh the information of a Payment Execution.
|
|
1175
|
-
|
|
1187
|
+
|
|
1176
1188
|
This endpoint can be used to refresh a Payment Execution in two different modes:
|
|
1177
1189
|
* PAYMENT_EVENTS = Refresh all events that belong to a payment. It can be used for a synchronisation with
|
|
1178
1190
|
the payment gateway e.g. in case of possible inconsistencies between the Commerce Platform and the payment gateway.
|
|
@@ -1180,7 +1192,7 @@ paths:
|
|
|
1180
1192
|
* PAYMENT_PROVIDER_DETAILS = Refresh the payment status of the payment and return the payment provider details.
|
|
1181
1193
|
It can be used for a synchronisation of the payment with the external payment provider. At the moment this call
|
|
1182
1194
|
will update the customer payment status of a transaction for PAYONE Buy Now, Pay Later (BNPL).
|
|
1183
|
-
|
|
1195
|
+
|
|
1184
1196
|
ATTENTION: This Refresh endpoint includes a rate limit of one request per Payment Execution every twelve hours.
|
|
1185
1197
|
The reason for this rate limit that for the currently supported use case a change in payment provider details is
|
|
1186
1198
|
not expected to change more frequently.
|
|
@@ -1188,58 +1200,60 @@ paths:
|
|
|
1188
1200
|
- PaymentExecution
|
|
1189
1201
|
operationId: refreshPayment
|
|
1190
1202
|
parameters:
|
|
1191
|
-
- $ref:
|
|
1192
|
-
- $ref:
|
|
1193
|
-
- $ref:
|
|
1194
|
-
- $ref:
|
|
1203
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
1204
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
1205
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
1206
|
+
- $ref: "#/components/parameters/paymentExecutionId"
|
|
1195
1207
|
requestBody:
|
|
1196
1208
|
content:
|
|
1197
1209
|
application/json:
|
|
1198
1210
|
schema:
|
|
1199
|
-
$ref:
|
|
1211
|
+
$ref: "#/components/schemas/RefreshPaymentRequest"
|
|
1200
1212
|
responses:
|
|
1201
1213
|
200:
|
|
1202
1214
|
description: The refresh was successful.
|
|
1203
1215
|
content:
|
|
1204
1216
|
application/json:
|
|
1205
1217
|
schema:
|
|
1206
|
-
$ref:
|
|
1218
|
+
$ref: "#/components/schemas/PaymentExecution"
|
|
1207
1219
|
400:
|
|
1208
1220
|
description: Incorrect input data
|
|
1209
1221
|
content:
|
|
1210
1222
|
application/json:
|
|
1211
1223
|
schema:
|
|
1212
|
-
$ref:
|
|
1224
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1213
1225
|
403:
|
|
1214
|
-
description:
|
|
1226
|
+
description:
|
|
1227
|
+
You are not allowed to access the service or account or your
|
|
1215
1228
|
API authentication failed.
|
|
1216
1229
|
content:
|
|
1217
1230
|
application/json:
|
|
1218
1231
|
schema:
|
|
1219
|
-
$ref:
|
|
1232
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1220
1233
|
500:
|
|
1221
1234
|
description: Internal server exception
|
|
1222
1235
|
content:
|
|
1223
1236
|
application/json:
|
|
1224
1237
|
schema:
|
|
1225
|
-
$ref:
|
|
1238
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1226
1239
|
502:
|
|
1227
|
-
description:
|
|
1240
|
+
description:
|
|
1241
|
+
Any 5XX response points to something that went wrong on our
|
|
1228
1242
|
end. This could also be that the system was unable to route the transaction
|
|
1229
1243
|
to an appropriate acquirer/3rd party. Another reason for such a response
|
|
1230
1244
|
is when the 3rd party's response could not be understood.
|
|
1231
1245
|
content:
|
|
1232
1246
|
application/json:
|
|
1233
1247
|
schema:
|
|
1234
|
-
$ref:
|
|
1248
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1235
1249
|
503:
|
|
1236
1250
|
description: Service unavailable
|
|
1237
1251
|
content:
|
|
1238
1252
|
application/json:
|
|
1239
1253
|
schema:
|
|
1240
|
-
$ref:
|
|
1254
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1241
1255
|
|
|
1242
|
-
|
|
1256
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-information":
|
|
1243
1257
|
post:
|
|
1244
1258
|
summary: Create a Payment Information
|
|
1245
1259
|
description: |-
|
|
@@ -1248,52 +1262,52 @@ paths:
|
|
|
1248
1262
|
- PaymentInformation
|
|
1249
1263
|
operationId: createPaymentInformation
|
|
1250
1264
|
parameters:
|
|
1251
|
-
- $ref:
|
|
1252
|
-
- $ref:
|
|
1253
|
-
- $ref:
|
|
1265
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
1266
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
1267
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
1254
1268
|
requestBody:
|
|
1255
1269
|
required: true
|
|
1256
1270
|
content:
|
|
1257
1271
|
application/json:
|
|
1258
1272
|
schema:
|
|
1259
|
-
$ref:
|
|
1273
|
+
$ref: "#/components/schemas/PaymentInformationRequest"
|
|
1260
1274
|
responses:
|
|
1261
|
-
|
|
1275
|
+
"201":
|
|
1262
1276
|
x-nullable: true
|
|
1263
1277
|
description: The response contains the reference of the created Payment Information.
|
|
1264
1278
|
content:
|
|
1265
1279
|
application/json:
|
|
1266
1280
|
schema:
|
|
1267
|
-
$ref:
|
|
1268
|
-
|
|
1281
|
+
$ref: "#/components/schemas/PaymentInformationResponse"
|
|
1282
|
+
"400":
|
|
1269
1283
|
x-nullable: true
|
|
1270
1284
|
description: Incorrect input data
|
|
1271
1285
|
content:
|
|
1272
1286
|
application/json:
|
|
1273
1287
|
schema:
|
|
1274
|
-
$ref:
|
|
1275
|
-
|
|
1288
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1289
|
+
"404":
|
|
1276
1290
|
x-nullable: true
|
|
1277
1291
|
description: Payment not found
|
|
1278
1292
|
content:
|
|
1279
1293
|
application/json:
|
|
1280
1294
|
schema:
|
|
1281
|
-
$ref:
|
|
1282
|
-
|
|
1295
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1296
|
+
"409":
|
|
1283
1297
|
x-nullable: true
|
|
1284
1298
|
description: Creation of Payment Information is not allowed
|
|
1285
1299
|
content:
|
|
1286
1300
|
application/json:
|
|
1287
1301
|
schema:
|
|
1288
|
-
$ref:
|
|
1289
|
-
|
|
1302
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1303
|
+
"500":
|
|
1290
1304
|
x-nullable: true
|
|
1291
1305
|
description: Internal server exception
|
|
1292
1306
|
content:
|
|
1293
1307
|
application/json:
|
|
1294
1308
|
schema:
|
|
1295
|
-
$ref:
|
|
1296
|
-
|
|
1309
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1310
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-information/{paymentInformationId}":
|
|
1297
1311
|
get:
|
|
1298
1312
|
summary: Get a Payment Information
|
|
1299
1313
|
description: |-
|
|
@@ -1302,26 +1316,26 @@ paths:
|
|
|
1302
1316
|
- PaymentInformation
|
|
1303
1317
|
operationId: getPaymentInformation
|
|
1304
1318
|
parameters:
|
|
1305
|
-
- $ref:
|
|
1306
|
-
- $ref:
|
|
1307
|
-
- $ref:
|
|
1308
|
-
- $ref:
|
|
1319
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
1320
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
1321
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
1322
|
+
- $ref: "#/components/parameters/paymentInformationId"
|
|
1309
1323
|
responses:
|
|
1310
|
-
|
|
1324
|
+
"200":
|
|
1311
1325
|
x-nullable: true
|
|
1312
1326
|
description: The response contains the reference of the created Payment Information.
|
|
1313
1327
|
content:
|
|
1314
1328
|
application/json:
|
|
1315
1329
|
schema:
|
|
1316
|
-
$ref:
|
|
1317
|
-
|
|
1330
|
+
$ref: "#/components/schemas/PaymentInformationResponse"
|
|
1331
|
+
"404":
|
|
1318
1332
|
x-nullable: true
|
|
1319
1333
|
description: Payment not found
|
|
1320
1334
|
content:
|
|
1321
1335
|
application/json:
|
|
1322
1336
|
schema:
|
|
1323
|
-
$ref:
|
|
1324
|
-
|
|
1337
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1338
|
+
"/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/payment-information/{paymentInformationId}/refund":
|
|
1325
1339
|
post:
|
|
1326
1340
|
summary: Refund a Payment Information
|
|
1327
1341
|
description: |-
|
|
@@ -1331,25 +1345,25 @@ paths:
|
|
|
1331
1345
|
- PaymentInformation
|
|
1332
1346
|
operationId: refundPaymentInformation
|
|
1333
1347
|
parameters:
|
|
1334
|
-
- $ref:
|
|
1335
|
-
- $ref:
|
|
1336
|
-
- $ref:
|
|
1337
|
-
- $ref:
|
|
1348
|
+
- $ref: "#/components/parameters/merchantIdPath"
|
|
1349
|
+
- $ref: "#/components/parameters/commerceCaseIdPath"
|
|
1350
|
+
- $ref: "#/components/parameters/checkoutIdPath"
|
|
1351
|
+
- $ref: "#/components/parameters/paymentInformationId"
|
|
1338
1352
|
requestBody:
|
|
1339
1353
|
required: true
|
|
1340
1354
|
content:
|
|
1341
1355
|
application/json:
|
|
1342
1356
|
schema:
|
|
1343
|
-
$ref:
|
|
1357
|
+
$ref: "#/components/schemas/PaymentInformationRefundRequest"
|
|
1344
1358
|
responses:
|
|
1345
|
-
|
|
1359
|
+
"201":
|
|
1346
1360
|
x-nullable: true
|
|
1347
1361
|
description: The Refund was successfully created.
|
|
1348
1362
|
content:
|
|
1349
1363
|
application/json:
|
|
1350
1364
|
schema:
|
|
1351
|
-
$ref:
|
|
1352
|
-
|
|
1365
|
+
$ref: "#/components/schemas/PaymentInformationRefundResponse"
|
|
1366
|
+
"400":
|
|
1353
1367
|
x-nullable: true
|
|
1354
1368
|
description: |-
|
|
1355
1369
|
The request was malformed or was missing required data. When a required property was missing the error
|
|
@@ -1357,21 +1371,21 @@ paths:
|
|
|
1357
1371
|
content:
|
|
1358
1372
|
application/json:
|
|
1359
1373
|
schema:
|
|
1360
|
-
$ref:
|
|
1361
|
-
|
|
1374
|
+
$ref: "#/components/schemas/RefundErrorResponse"
|
|
1375
|
+
"403":
|
|
1362
1376
|
x-nullable: true
|
|
1363
1377
|
description: You are not allowed to access the service or account or your API authentication failed.
|
|
1364
1378
|
content:
|
|
1365
1379
|
application/json:
|
|
1366
1380
|
schema:
|
|
1367
|
-
$ref:
|
|
1368
|
-
|
|
1381
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
1382
|
+
"404":
|
|
1369
1383
|
x-nullable: true
|
|
1370
1384
|
description: The most common cause for this response id that the payment was not in a cancelable state.
|
|
1371
1385
|
content:
|
|
1372
1386
|
application/json:
|
|
1373
1387
|
schema:
|
|
1374
|
-
$ref:
|
|
1388
|
+
$ref: "#/components/schemas/RefundErrorResponse"
|
|
1375
1389
|
|
|
1376
1390
|
components:
|
|
1377
1391
|
parameters:
|
|
@@ -1546,7 +1560,7 @@ components:
|
|
|
1546
1560
|
schema:
|
|
1547
1561
|
type: array
|
|
1548
1562
|
items:
|
|
1549
|
-
$ref:
|
|
1563
|
+
$ref: "#/components/schemas/StatusCheckout"
|
|
1550
1564
|
includeExtendedCheckoutStatus:
|
|
1551
1565
|
in: query
|
|
1552
1566
|
name: includeExtendedCheckoutStatus
|
|
@@ -1555,7 +1569,7 @@ components:
|
|
|
1555
1569
|
schema:
|
|
1556
1570
|
type: array
|
|
1557
1571
|
items:
|
|
1558
|
-
$ref:
|
|
1572
|
+
$ref: "#/components/schemas/ExtendedCheckoutStatus"
|
|
1559
1573
|
includePaymentChannel:
|
|
1560
1574
|
in: query
|
|
1561
1575
|
name: includePaymentChannel
|
|
@@ -1565,7 +1579,7 @@ components:
|
|
|
1565
1579
|
schema:
|
|
1566
1580
|
type: array
|
|
1567
1581
|
items:
|
|
1568
|
-
$ref:
|
|
1582
|
+
$ref: "#/components/schemas/PaymentChannel"
|
|
1569
1583
|
includePaymentProductId:
|
|
1570
1584
|
in: query
|
|
1571
1585
|
name: includePaymentProductId
|
|
@@ -1653,7 +1667,7 @@ components:
|
|
|
1653
1667
|
schema:
|
|
1654
1668
|
type: string
|
|
1655
1669
|
x-trim-at: 20
|
|
1656
|
-
example:
|
|
1670
|
+
example: "+1234567890"
|
|
1657
1671
|
reportingToken:
|
|
1658
1672
|
in: query
|
|
1659
1673
|
name: reportingToken
|
|
@@ -1875,7 +1889,7 @@ components:
|
|
|
1875
1889
|
minLength: 2
|
|
1876
1890
|
maxLength: 10
|
|
1877
1891
|
name:
|
|
1878
|
-
$ref:
|
|
1892
|
+
$ref: "#/components/schemas/PersonalName"
|
|
1879
1893
|
AllowedPaymentActions:
|
|
1880
1894
|
type: string
|
|
1881
1895
|
enum:
|
|
@@ -1909,45 +1923,6 @@ components:
|
|
|
1909
1923
|
required:
|
|
1910
1924
|
- amount
|
|
1911
1925
|
- currencyCode
|
|
1912
|
-
ApplePaymentDataTokenInformation:
|
|
1913
|
-
type: object
|
|
1914
|
-
description: |-
|
|
1915
|
-
Additional information about the Apple payment data token. This information are needed for checking the validity
|
|
1916
|
-
of the payment data token before decryption.
|
|
1917
|
-
properties:
|
|
1918
|
-
version:
|
|
1919
|
-
type: string
|
|
1920
|
-
description: |-
|
|
1921
|
-
Version information about the payment token. Currently only EC_v1 for ECC-encrypted data is supported.
|
|
1922
|
-
enum:
|
|
1923
|
-
- EC_V1
|
|
1924
|
-
example: EC_V1
|
|
1925
|
-
signature:
|
|
1926
|
-
type: string
|
|
1927
|
-
description: |-
|
|
1928
|
-
Detached PKCS #7 signature, Base64 encoded as string. Signature of the payment and header data. The
|
|
1929
|
-
signature includes the signing certificate, its intermediate CA certificate, and information about the
|
|
1930
|
-
signing algorithm.
|
|
1931
|
-
header:
|
|
1932
|
-
$ref: '#/components/schemas/ApplePaymentDataTokenHeaderInformation'
|
|
1933
|
-
required:
|
|
1934
|
-
- version
|
|
1935
|
-
- signature
|
|
1936
|
-
- header
|
|
1937
|
-
ApplePaymentDataTokenHeaderInformation:
|
|
1938
|
-
type: object
|
|
1939
|
-
description: Additional information about the Apple payment data token header.
|
|
1940
|
-
properties:
|
|
1941
|
-
transactionId:
|
|
1942
|
-
type: string
|
|
1943
|
-
description: A hexadecimal Transaction identifier identifier as a string.
|
|
1944
|
-
applicationData:
|
|
1945
|
-
type: string
|
|
1946
|
-
description: |-
|
|
1947
|
-
SHA–256 hash, hex encoded as a string. Hash of the applicationData property of the original PKPaymentRequest
|
|
1948
|
-
object.
|
|
1949
|
-
required:
|
|
1950
|
-
- transactionId
|
|
1951
1926
|
APIError:
|
|
1952
1927
|
description: Contains detailed information on one single error.
|
|
1953
1928
|
type: object
|
|
@@ -1999,6 +1974,45 @@ components:
|
|
|
1999
1974
|
example: paymentId
|
|
2000
1975
|
required:
|
|
2001
1976
|
- errorCode
|
|
1977
|
+
ApplePaymentDataTokenHeaderInformation:
|
|
1978
|
+
type: object
|
|
1979
|
+
description: Additional information about the Apple payment data token header.
|
|
1980
|
+
properties:
|
|
1981
|
+
transactionId:
|
|
1982
|
+
type: string
|
|
1983
|
+
description: A hexadecimal Transaction identifier identifier as a string.
|
|
1984
|
+
applicationData:
|
|
1985
|
+
type: string
|
|
1986
|
+
description: |-
|
|
1987
|
+
SHA–256 hash, hex encoded as a string. Hash of the applicationData property of the original PKPaymentRequest
|
|
1988
|
+
object.
|
|
1989
|
+
required:
|
|
1990
|
+
- transactionId
|
|
1991
|
+
ApplePaymentDataTokenInformation:
|
|
1992
|
+
type: object
|
|
1993
|
+
description: |-
|
|
1994
|
+
Additional information about the Apple payment data token. This information are needed for checking the validity
|
|
1995
|
+
of the payment data token before decryption.
|
|
1996
|
+
properties:
|
|
1997
|
+
version:
|
|
1998
|
+
type: string
|
|
1999
|
+
description: |-
|
|
2000
|
+
Version information about the payment token. Currently only EC_v1 for ECC-encrypted data is supported.
|
|
2001
|
+
enum:
|
|
2002
|
+
- EC_V1
|
|
2003
|
+
example: EC_V1
|
|
2004
|
+
signature:
|
|
2005
|
+
type: string
|
|
2006
|
+
description: |-
|
|
2007
|
+
Detached PKCS #7 signature, Base64 encoded as string. Signature of the payment and header data. The
|
|
2008
|
+
signature includes the signing certificate, its intermediate CA certificate, and information about the
|
|
2009
|
+
signing algorithm.
|
|
2010
|
+
header:
|
|
2011
|
+
$ref: "#/components/schemas/ApplePaymentDataTokenHeaderInformation"
|
|
2012
|
+
required:
|
|
2013
|
+
- version
|
|
2014
|
+
- signature
|
|
2015
|
+
- header
|
|
2002
2016
|
AuthorizationMode:
|
|
2003
2017
|
type: string
|
|
2004
2018
|
x-enum-to-string: false
|
|
@@ -2011,7 +2025,7 @@ components:
|
|
|
2011
2025
|
authortizations can be reversed and can be captured within 30 days. The capture amount can be lower than the
|
|
2012
2026
|
authorized amount.
|
|
2013
2027
|
* SALE - The payment creation results in an authorization that is already captured at the moment of approval.
|
|
2014
|
-
|
|
2028
|
+
|
|
2015
2029
|
If the parameter is not provided in the request, the default value will be PRE_AUTHORIZATION
|
|
2016
2030
|
BankAccountInformation:
|
|
2017
2031
|
type: object
|
|
@@ -2053,7 +2067,7 @@ components:
|
|
|
2053
2067
|
Payment product identifier - please check product documentation for a full overview of possible values.
|
|
2054
2068
|
example: 772
|
|
2055
2069
|
paymentProduct772SpecificInput:
|
|
2056
|
-
$ref:
|
|
2070
|
+
$ref: "#/components/schemas/SepaTransferPaymentProduct772SpecificInput"
|
|
2057
2071
|
CancelItem:
|
|
2058
2072
|
type: object
|
|
2059
2073
|
properties:
|
|
@@ -2103,13 +2117,13 @@ components:
|
|
|
2103
2117
|
type: object
|
|
2104
2118
|
properties:
|
|
2105
2119
|
cancellationReason:
|
|
2106
|
-
$ref:
|
|
2120
|
+
$ref: "#/components/schemas/CancellationReason"
|
|
2107
2121
|
CancelPaymentResponse:
|
|
2108
2122
|
type: object
|
|
2109
2123
|
additionalProperties: false
|
|
2110
2124
|
properties:
|
|
2111
2125
|
payment:
|
|
2112
|
-
$ref:
|
|
2126
|
+
$ref: "#/components/schemas/PaymentResponse"
|
|
2113
2127
|
CancelRequest:
|
|
2114
2128
|
type: object
|
|
2115
2129
|
description: |
|
|
@@ -2118,26 +2132,26 @@ components:
|
|
|
2118
2132
|
A Cancel can be created for a full or the partial ShoppingCart of the Checkout.
|
|
2119
2133
|
The platform will automatically calculate the respective amount to trigger the Cancel. For a partial Cancel a
|
|
2120
2134
|
list of items must be provided.
|
|
2121
|
-
|
|
2135
|
+
|
|
2122
2136
|
The cancellationReason is mandatory for BNPL payment methods (paymentProductId 3390, 3391 and 3392).
|
|
2123
2137
|
For other payment methods the cancellationReason is not mandatory but can be used for reporting and
|
|
2124
2138
|
reconciliation purposes.
|
|
2125
2139
|
properties:
|
|
2126
2140
|
cancelType:
|
|
2127
|
-
$ref:
|
|
2141
|
+
$ref: "#/components/schemas/CancelType"
|
|
2128
2142
|
cancellationReason:
|
|
2129
|
-
$ref:
|
|
2143
|
+
$ref: "#/components/schemas/CancellationReason"
|
|
2130
2144
|
cancelItems:
|
|
2131
2145
|
type: array
|
|
2132
2146
|
items:
|
|
2133
|
-
$ref:
|
|
2147
|
+
$ref: "#/components/schemas/CancelItem"
|
|
2134
2148
|
CancelResponse:
|
|
2135
2149
|
type: object
|
|
2136
2150
|
properties:
|
|
2137
2151
|
cancelPaymentResponse:
|
|
2138
|
-
$ref:
|
|
2152
|
+
$ref: "#/components/schemas/CancelPaymentResponse"
|
|
2139
2153
|
shoppingCart:
|
|
2140
|
-
$ref:
|
|
2154
|
+
$ref: "#/components/schemas/ShoppingCartResult"
|
|
2141
2155
|
CancelType:
|
|
2142
2156
|
type: string
|
|
2143
2157
|
description: |
|
|
@@ -2148,7 +2162,7 @@ components:
|
|
|
2148
2162
|
should not be made for the entire ShoppingCart. For this type the list of items has to be provided.
|
|
2149
2163
|
Please note that a reversal for a partial payment will not reverse the respective amount from the authorization
|
|
2150
2164
|
but only reduces the openAmount that is ready for collecting.
|
|
2151
|
-
|
|
2165
|
+
|
|
2152
2166
|
Following conditions apply to the Cancel request:
|
|
2153
2167
|
* items must be in status ORDERED
|
|
2154
2168
|
* there was no Capture, Refund or Cancel triggered over the Payment Execution resource
|
|
@@ -2164,7 +2178,7 @@ components:
|
|
|
2164
2178
|
additionalProperties: false
|
|
2165
2179
|
properties:
|
|
2166
2180
|
amountOfMoney:
|
|
2167
|
-
$ref:
|
|
2181
|
+
$ref: "#/components/schemas/AmountOfMoney"
|
|
2168
2182
|
merchantParameters:
|
|
2169
2183
|
type: string
|
|
2170
2184
|
description: |-
|
|
@@ -2173,12 +2187,12 @@ components:
|
|
|
2173
2187
|
maxLength: 1000
|
|
2174
2188
|
example: "{'SessionID':'126548354','ShopperID':'7354131'}"
|
|
2175
2189
|
references:
|
|
2176
|
-
$ref:
|
|
2190
|
+
$ref: "#/components/schemas/PaymentReferences"
|
|
2177
2191
|
paymentMethod:
|
|
2178
2192
|
type: string
|
|
2179
2193
|
description: Payment method identifier used by our payment engine.
|
|
2180
2194
|
paymentInstructions:
|
|
2181
|
-
$ref:
|
|
2195
|
+
$ref: "#/components/schemas/PaymentInstructions"
|
|
2182
2196
|
CapturePaymentRequest:
|
|
2183
2197
|
type: object
|
|
2184
2198
|
additionalProperties: false
|
|
@@ -2203,25 +2217,25 @@ components:
|
|
|
2203
2217
|
This property indicates whether this will be the final operation.
|
|
2204
2218
|
If the full amount should not captured but the property is set to true, the remaining amount will automatically be cancelled.
|
|
2205
2219
|
cancellationReason:
|
|
2206
|
-
$ref:
|
|
2220
|
+
$ref: "#/components/schemas/CancellationReason"
|
|
2207
2221
|
references:
|
|
2208
|
-
$ref:
|
|
2222
|
+
$ref: "#/components/schemas/PaymentReferences"
|
|
2209
2223
|
delivery:
|
|
2210
|
-
$ref:
|
|
2224
|
+
$ref: "#/components/schemas/DeliveryInformation"
|
|
2211
2225
|
CapturePaymentResponse:
|
|
2212
2226
|
type: object
|
|
2213
2227
|
additionalProperties: false
|
|
2214
2228
|
properties:
|
|
2215
2229
|
captureOutput:
|
|
2216
|
-
$ref:
|
|
2230
|
+
$ref: "#/components/schemas/CaptureOutput"
|
|
2217
2231
|
status:
|
|
2218
|
-
$ref:
|
|
2232
|
+
$ref: "#/components/schemas/StatusValue"
|
|
2219
2233
|
statusOutput:
|
|
2220
|
-
$ref:
|
|
2234
|
+
$ref: "#/components/schemas/PaymentStatusOutput"
|
|
2221
2235
|
id:
|
|
2222
2236
|
type: string
|
|
2223
2237
|
description: Unique payment transaction identifier of the payment gateway.
|
|
2224
|
-
example:
|
|
2238
|
+
example: "3066019730_1"
|
|
2225
2239
|
CardFraudResults:
|
|
2226
2240
|
type: object
|
|
2227
2241
|
description: |
|
|
@@ -2325,7 +2339,7 @@ components:
|
|
|
2325
2339
|
description: Detailed information regarding an occurred payment event.
|
|
2326
2340
|
properties:
|
|
2327
2341
|
cartItemStatus:
|
|
2328
|
-
$ref:
|
|
2342
|
+
$ref: "#/components/schemas/CartItemStatus"
|
|
2329
2343
|
quantity:
|
|
2330
2344
|
type: integer
|
|
2331
2345
|
description: |-
|
|
@@ -2334,27 +2348,6 @@ components:
|
|
|
2334
2348
|
maximum: 9999
|
|
2335
2349
|
minimum: 0
|
|
2336
2350
|
example: 1
|
|
2337
|
-
CardPaymentMethodSpecificOutput:
|
|
2338
|
-
type: object
|
|
2339
|
-
description: |
|
|
2340
|
-
Object containing the card payment method details.
|
|
2341
|
-
additionalProperties: false
|
|
2342
|
-
properties:
|
|
2343
|
-
paymentProductId:
|
|
2344
|
-
type: integer
|
|
2345
|
-
format: int32
|
|
2346
|
-
maximum: 99999
|
|
2347
|
-
minimum: 0
|
|
2348
|
-
description: |-
|
|
2349
|
-
Payment product identifier - please check product documentation for a full overview of possible values.
|
|
2350
|
-
example: 840
|
|
2351
|
-
authorisationCode:
|
|
2352
|
-
description: Card Authorization code as returned by the acquirer
|
|
2353
|
-
type: string
|
|
2354
|
-
fraudResults:
|
|
2355
|
-
$ref: '#/components/schemas/CardFraudResults'
|
|
2356
|
-
threeDSecureResults:
|
|
2357
|
-
$ref: '#/components/schemas/ThreeDSecureResults'
|
|
2358
2351
|
CardPaymentMethodSpecificInput:
|
|
2359
2352
|
type: object
|
|
2360
2353
|
description: |
|
|
@@ -2362,9 +2355,9 @@ components:
|
|
|
2362
2355
|
additionalProperties: false
|
|
2363
2356
|
properties:
|
|
2364
2357
|
authorizationMode:
|
|
2365
|
-
$ref:
|
|
2358
|
+
$ref: "#/components/schemas/AuthorizationMode"
|
|
2366
2359
|
recurring:
|
|
2367
|
-
$ref:
|
|
2360
|
+
$ref: "#/components/schemas/CardRecurrenceDetails"
|
|
2368
2361
|
paymentProcessingToken:
|
|
2369
2362
|
type: string
|
|
2370
2363
|
description: ID of the token to use to create the payment.
|
|
@@ -2377,21 +2370,15 @@ components:
|
|
|
2377
2370
|
example: 12a037cc-833d-8b45-8f6f-11c34171f4e1
|
|
2378
2371
|
maxLength: 40
|
|
2379
2372
|
transactionChannel:
|
|
2380
|
-
$ref:
|
|
2373
|
+
$ref: "#/components/schemas/TransactionChannel"
|
|
2381
2374
|
unscheduledCardOnFileRequestor:
|
|
2382
|
-
$ref:
|
|
2375
|
+
$ref: "#/components/schemas/UnscheduledCardOnFileRequestor"
|
|
2383
2376
|
unscheduledCardOnFileSequenceIndicator:
|
|
2384
|
-
$ref:
|
|
2377
|
+
$ref: "#/components/schemas/UnscheduledCardOnFileSequenceIndicator"
|
|
2385
2378
|
paymentProductId:
|
|
2386
|
-
|
|
2387
|
-
format: int32
|
|
2388
|
-
maximum: 99999
|
|
2389
|
-
minimum: 0
|
|
2390
|
-
description: |-
|
|
2391
|
-
Payment product identifier - please check product documentation for a full overview of possible values.
|
|
2392
|
-
example: 840
|
|
2379
|
+
$ref: "#/components/schemas/PaymentProductId"
|
|
2393
2380
|
card:
|
|
2394
|
-
$ref:
|
|
2381
|
+
$ref: "#/components/schemas/CardInfo"
|
|
2395
2382
|
returnUrl:
|
|
2396
2383
|
type: string
|
|
2397
2384
|
description: |-
|
|
@@ -2412,7 +2399,7 @@ components:
|
|
|
2412
2399
|
* Yearly
|
|
2413
2400
|
* Quarterly
|
|
2414
2401
|
* Monthly
|
|
2415
|
-
|
|
2402
|
+
|
|
2416
2403
|
* Weekly
|
|
2417
2404
|
* Daily
|
|
2418
2405
|
Supported soon
|
|
@@ -2429,6 +2416,21 @@ components:
|
|
|
2429
2416
|
description: |-
|
|
2430
2417
|
The end date of the last scheduled payment in a series of transactions.
|
|
2431
2418
|
Format YYYYMMDD Supported soon
|
|
2419
|
+
CardPaymentMethodSpecificOutput:
|
|
2420
|
+
type: object
|
|
2421
|
+
description: |
|
|
2422
|
+
Object containing the card payment method details.
|
|
2423
|
+
additionalProperties: false
|
|
2424
|
+
properties:
|
|
2425
|
+
paymentProductId:
|
|
2426
|
+
$ref: "#/components/schemas/PaymentProductId"
|
|
2427
|
+
authorisationCode:
|
|
2428
|
+
description: Card Authorization code as returned by the acquirer
|
|
2429
|
+
type: string
|
|
2430
|
+
fraudResults:
|
|
2431
|
+
$ref: "#/components/schemas/CardFraudResults"
|
|
2432
|
+
threeDSecureResults:
|
|
2433
|
+
$ref: "#/components/schemas/ThreeDSecureResults"
|
|
2432
2434
|
CardRecurrenceDetails:
|
|
2433
2435
|
type: object
|
|
2434
2436
|
description: Object containing data related to recurring.
|
|
@@ -2439,9 +2441,12 @@ components:
|
|
|
2439
2441
|
* first = This transaction is the first of a series of recurring transactions
|
|
2440
2442
|
* recurring = This transaction is a subsequent transaction in a series of recurring transactions
|
|
2441
2443
|
|
|
2442
|
-
|
|
2443
|
-
|
|
2444
|
-
response
|
|
2444
|
+
For the initial transaction of a recurring payment, the system will automatically generate a token
|
|
2445
|
+
that you will need for all subsequent transactions in the series. If a token has already been created,
|
|
2446
|
+
the response will indicate this with isNewToken set to False.
|
|
2447
|
+
|
|
2448
|
+
Important: This token generation mechanism is intended for regularly scheduled recurring payments initiated by you.
|
|
2449
|
+
It should not be used in conjunction with UnscheduledCardOnFileRequestor or unscheduledCardOnFileSequenceIndicator.
|
|
2445
2450
|
enum:
|
|
2446
2451
|
- first
|
|
2447
2452
|
- recurring
|
|
@@ -2452,9 +2457,20 @@ components:
|
|
|
2452
2457
|
additionalProperties: false
|
|
2453
2458
|
properties:
|
|
2454
2459
|
invoiceData:
|
|
2455
|
-
$ref:
|
|
2460
|
+
$ref: "#/components/schemas/CartItemInvoiceData"
|
|
2456
2461
|
orderLineDetails:
|
|
2457
|
-
$ref:
|
|
2462
|
+
$ref: "#/components/schemas/OrderLineDetailsInput"
|
|
2463
|
+
CartItemInvoiceData:
|
|
2464
|
+
type: object
|
|
2465
|
+
description: Object containing the line items of the invoice or shopping cart.
|
|
2466
|
+
properties:
|
|
2467
|
+
description:
|
|
2468
|
+
type: string
|
|
2469
|
+
description: |
|
|
2470
|
+
Shopping cart item description.
|
|
2471
|
+
The description will also be displayed in the portal as the product name.
|
|
2472
|
+
example: Smartwatch
|
|
2473
|
+
x-trim-at: 116
|
|
2458
2474
|
CartItemPatch:
|
|
2459
2475
|
type: object
|
|
2460
2476
|
description: This object contains information of all items in the cart.
|
|
@@ -2462,9 +2478,9 @@ components:
|
|
|
2462
2478
|
additionalProperties: false
|
|
2463
2479
|
properties:
|
|
2464
2480
|
invoiceData:
|
|
2465
|
-
$ref:
|
|
2481
|
+
$ref: "#/components/schemas/CartItemInvoiceData"
|
|
2466
2482
|
orderLineDetails:
|
|
2467
|
-
$ref:
|
|
2483
|
+
$ref: "#/components/schemas/OrderLineDetailsPatch"
|
|
2468
2484
|
CartItemResult:
|
|
2469
2485
|
type: object
|
|
2470
2486
|
description: This object contains information of all items in the cart.
|
|
@@ -2472,13 +2488,22 @@ components:
|
|
|
2472
2488
|
additionalProperties: false
|
|
2473
2489
|
properties:
|
|
2474
2490
|
invoiceData:
|
|
2475
|
-
$ref:
|
|
2491
|
+
$ref: "#/components/schemas/CartItemInvoiceData"
|
|
2476
2492
|
orderLineDetails:
|
|
2477
|
-
$ref:
|
|
2493
|
+
$ref: "#/components/schemas/OrderLineDetailsResult"
|
|
2494
|
+
CartItemStatus:
|
|
2495
|
+
type: string
|
|
2496
|
+
enum:
|
|
2497
|
+
- ORDERED
|
|
2498
|
+
- DELIVERED
|
|
2499
|
+
- CANCELLED
|
|
2500
|
+
- RETURNED
|
|
2501
|
+
- WAITING_FOR_PAYMENT
|
|
2502
|
+
description: Indicates in which status the line item is
|
|
2478
2503
|
CheckoutResponse:
|
|
2479
2504
|
type: object
|
|
2480
2505
|
xml:
|
|
2481
|
-
name:
|
|
2506
|
+
name: "checkoutResponse"
|
|
2482
2507
|
description: |
|
|
2483
2508
|
The Checkout corresponds to the order of the WL API. We do not take additionalInput from the WL API. We have no
|
|
2484
2509
|
shipping and use deliveryAddress instead of address.
|
|
@@ -2499,31 +2524,31 @@ components:
|
|
|
2499
2524
|
maxLength: 20
|
|
2500
2525
|
example: "1234"
|
|
2501
2526
|
amountOfMoney:
|
|
2502
|
-
$ref:
|
|
2527
|
+
$ref: "#/components/schemas/AmountOfMoney"
|
|
2503
2528
|
references:
|
|
2504
|
-
$ref:
|
|
2529
|
+
$ref: "#/components/schemas/CheckoutReferences"
|
|
2505
2530
|
shipping:
|
|
2506
|
-
$ref:
|
|
2531
|
+
$ref: "#/components/schemas/Shipping"
|
|
2507
2532
|
shoppingCart:
|
|
2508
|
-
$ref:
|
|
2533
|
+
$ref: "#/components/schemas/ShoppingCartResult"
|
|
2509
2534
|
paymentExecutions:
|
|
2510
2535
|
type: array
|
|
2511
2536
|
items:
|
|
2512
|
-
$ref:
|
|
2537
|
+
$ref: "#/components/schemas/PaymentExecution"
|
|
2513
2538
|
checkoutStatus:
|
|
2514
|
-
$ref:
|
|
2539
|
+
$ref: "#/components/schemas/StatusCheckout"
|
|
2515
2540
|
statusOutput:
|
|
2516
|
-
$ref:
|
|
2541
|
+
$ref: "#/components/schemas/StatusOutput"
|
|
2517
2542
|
paymentInformation:
|
|
2518
2543
|
type: array
|
|
2519
2544
|
items:
|
|
2520
|
-
$ref:
|
|
2545
|
+
$ref: "#/components/schemas/PaymentInformationResponse"
|
|
2521
2546
|
creationDateTime:
|
|
2522
|
-
$ref:
|
|
2547
|
+
$ref: "#/components/schemas/CreationDateTime"
|
|
2523
2548
|
allowedPaymentActions:
|
|
2524
2549
|
type: array
|
|
2525
2550
|
items:
|
|
2526
|
-
$ref:
|
|
2551
|
+
$ref: "#/components/schemas/AllowedPaymentActions"
|
|
2527
2552
|
CompleteFinancingPaymentMethodSpecificInput:
|
|
2528
2553
|
type: object
|
|
2529
2554
|
description: |
|
|
@@ -2545,10 +2570,10 @@ components:
|
|
|
2545
2570
|
* true = the payment requires approval before the funds will be captured using the Approve payment or
|
|
2546
2571
|
Capture payment API
|
|
2547
2572
|
* false = the payment does not require approval, and the funds will be captured automatically
|
|
2548
|
-
|
|
2573
|
+
|
|
2549
2574
|
If the parameter is not provided in the request, the default value will be true
|
|
2550
2575
|
paymentProduct3391SpecificInput:
|
|
2551
|
-
$ref:
|
|
2576
|
+
$ref: "#/components/schemas/PaymentProduct3391SpecificInput"
|
|
2552
2577
|
CompleteOrderRequest:
|
|
2553
2578
|
type: object
|
|
2554
2579
|
description: |-
|
|
@@ -2556,14 +2581,39 @@ components:
|
|
|
2556
2581
|
The previously provided data from the Commerce Case, Checkout and Order will automatically be loaded and used for the completion of the Order.
|
|
2557
2582
|
properties:
|
|
2558
2583
|
completePaymentMethodSpecificInput:
|
|
2559
|
-
$ref:
|
|
2584
|
+
$ref: "#/components/schemas/CompletePaymentMethodSpecificInput"
|
|
2560
2585
|
CompletePaymentMethodSpecificInput:
|
|
2561
2586
|
type: object
|
|
2562
2587
|
description: |
|
|
2563
2588
|
To complete the Order the completePaymentMethodSpecificInput has to be provided, containing the selected installmentOptionId as well as the the bankAccountInformation of the customer.
|
|
2564
2589
|
properties:
|
|
2565
2590
|
paymentProduct3391SpecificInput:
|
|
2566
|
-
$ref:
|
|
2591
|
+
$ref: "#/components/schemas/PaymentProduct3391SpecificInput"
|
|
2592
|
+
paymentProduct840SpecificInput:
|
|
2593
|
+
$ref: "#/components/schemas/CompletePaymentProduct840SpecificInput"
|
|
2594
|
+
CompletePaymentProduct840SpecificInput:
|
|
2595
|
+
type: object
|
|
2596
|
+
description: |-
|
|
2597
|
+
Object containing the specific input details for PayPal payments completed by the merchant.
|
|
2598
|
+
properties:
|
|
2599
|
+
javaScriptSdkFlow:
|
|
2600
|
+
type: boolean
|
|
2601
|
+
description: |-
|
|
2602
|
+
Indicates whether the PayPal JavaScript SDK flow is used.
|
|
2603
|
+
* true = The PayPal JavaScript SDK flow is used.
|
|
2604
|
+
* false = The PayPal JavaScript SDK flow is not used.
|
|
2605
|
+
Default value is false.
|
|
2606
|
+
default: false
|
|
2607
|
+
example: true
|
|
2608
|
+
action:
|
|
2609
|
+
type: string
|
|
2610
|
+
description: |-
|
|
2611
|
+
Confirmation of the order status in case of PayPal SDK integration.
|
|
2612
|
+
enum:
|
|
2613
|
+
- CONFIRM_ORDER_STATUS
|
|
2614
|
+
example: CONFIRM_ORDER_STATUS
|
|
2615
|
+
required:
|
|
2616
|
+
- action
|
|
2567
2617
|
CompletePaymentRequest:
|
|
2568
2618
|
type: object
|
|
2569
2619
|
description: |-
|
|
@@ -2572,45 +2622,58 @@ components:
|
|
|
2572
2622
|
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.
|
|
2573
2623
|
properties:
|
|
2574
2624
|
financingPaymentMethodSpecificInput:
|
|
2575
|
-
$ref:
|
|
2625
|
+
$ref: "#/components/schemas/CompleteFinancingPaymentMethodSpecificInput"
|
|
2626
|
+
redirectPaymentMethodSpecificInput:
|
|
2627
|
+
$ref: "#/components/schemas/CompleteRedirectPaymentMethodSpecificInput"
|
|
2576
2628
|
order:
|
|
2577
|
-
$ref:
|
|
2629
|
+
$ref: "#/components/schemas/Order"
|
|
2578
2630
|
device:
|
|
2579
|
-
$ref:
|
|
2631
|
+
$ref: "#/components/schemas/CustomerDevice"
|
|
2580
2632
|
CompletePaymentResponse:
|
|
2581
2633
|
type: object
|
|
2634
|
+
description: |-
|
|
2635
|
+
Object containing the response of the completed Payment.
|
|
2582
2636
|
properties:
|
|
2583
2637
|
creationOutput:
|
|
2584
|
-
$ref:
|
|
2638
|
+
$ref: "#/components/schemas/PaymentCreationOutput"
|
|
2585
2639
|
merchantAction:
|
|
2586
|
-
$ref:
|
|
2640
|
+
$ref: "#/components/schemas/MerchantAction"
|
|
2587
2641
|
payment:
|
|
2588
|
-
$ref:
|
|
2642
|
+
$ref: "#/components/schemas/PaymentResponse"
|
|
2643
|
+
CompleteRedirectPaymentMethodSpecificInput:
|
|
2644
|
+
type: object
|
|
2645
|
+
description: |-
|
|
2646
|
+
Object containing the redirect payment product details.
|
|
2647
|
+
properties:
|
|
2648
|
+
paymentProductId:
|
|
2649
|
+
$ref: "#/components/schemas/PaymentProductId"
|
|
2650
|
+
paymentProduct840SpecificInput:
|
|
2651
|
+
$ref: "#/components/schemas/CompletePaymentProduct840SpecificInput"
|
|
2589
2652
|
CreateCheckoutRequest:
|
|
2590
2653
|
type: object
|
|
2591
2654
|
description: |
|
|
2592
2655
|
Request to create a Checkout for a Commerce Case.
|
|
2593
2656
|
The payment for the Checkout can be directly executed if autoExecuteOrder = true.
|
|
2594
2657
|
In this case, the paymentMethodSpecificInput must be provided and only a full order is possible.
|
|
2595
|
-
|
|
2658
|
+
|
|
2596
2659
|
If no amountOfMoney is provided, the platform will calculate the respective Checkout amount based on the
|
|
2597
2660
|
cartItem productPrice and quantity.
|
|
2598
|
-
|
|
2661
|
+
|
|
2599
2662
|
In case of a payment error, the payment can be retried by providing the respective commerceCaseId and checkoutId
|
|
2600
2663
|
to the the Order or Payment Execution endpoint.
|
|
2601
2664
|
properties:
|
|
2602
2665
|
amountOfMoney:
|
|
2603
|
-
$ref:
|
|
2666
|
+
$ref: "#/components/schemas/AmountOfMoney"
|
|
2604
2667
|
references:
|
|
2605
|
-
$ref:
|
|
2668
|
+
$ref: "#/components/schemas/CheckoutReferences"
|
|
2606
2669
|
shipping:
|
|
2607
|
-
$ref:
|
|
2670
|
+
$ref: "#/components/schemas/Shipping"
|
|
2608
2671
|
shoppingCart:
|
|
2609
|
-
$ref:
|
|
2672
|
+
$ref: "#/components/schemas/ShoppingCartInput"
|
|
2610
2673
|
orderRequest:
|
|
2611
|
-
$ref:
|
|
2674
|
+
$ref: "#/components/schemas/OrderRequest"
|
|
2612
2675
|
creationDateTime:
|
|
2613
|
-
$ref:
|
|
2676
|
+
$ref: "#/components/schemas/CreationDateTime"
|
|
2614
2677
|
autoExecuteOrder:
|
|
2615
2678
|
description: |
|
|
2616
2679
|
Set this flag to directly execute a payment when creating a Commerce Case or Checkout.
|
|
@@ -2631,29 +2694,29 @@ components:
|
|
|
2631
2694
|
format: UUID
|
|
2632
2695
|
example: "707ef15b-7a0a-48f2-b7d8-c95103418a9c"
|
|
2633
2696
|
shoppingCart:
|
|
2634
|
-
$ref:
|
|
2697
|
+
$ref: "#/components/schemas/ShoppingCartResult"
|
|
2635
2698
|
paymentResponse:
|
|
2636
|
-
$ref:
|
|
2699
|
+
$ref: "#/components/schemas/CreatePaymentResponse"
|
|
2637
2700
|
errorResponse:
|
|
2638
|
-
$ref:
|
|
2701
|
+
$ref: "#/components/schemas/ErrorResponse"
|
|
2639
2702
|
amountOfMoney:
|
|
2640
|
-
$ref:
|
|
2703
|
+
$ref: "#/components/schemas/AmountOfMoney"
|
|
2641
2704
|
references:
|
|
2642
|
-
$ref:
|
|
2705
|
+
$ref: "#/components/schemas/CheckoutReferences"
|
|
2643
2706
|
shipping:
|
|
2644
|
-
$ref:
|
|
2707
|
+
$ref: "#/components/schemas/Shipping"
|
|
2645
2708
|
paymentExecution:
|
|
2646
|
-
$ref:
|
|
2709
|
+
$ref: "#/components/schemas/PaymentExecution"
|
|
2647
2710
|
checkoutStatus:
|
|
2648
|
-
$ref:
|
|
2711
|
+
$ref: "#/components/schemas/StatusCheckout"
|
|
2649
2712
|
statusOutput:
|
|
2650
|
-
$ref:
|
|
2713
|
+
$ref: "#/components/schemas/StatusOutput"
|
|
2651
2714
|
creationDateTime:
|
|
2652
|
-
$ref:
|
|
2715
|
+
$ref: "#/components/schemas/CreationDateTime"
|
|
2653
2716
|
allowedPaymentActions:
|
|
2654
2717
|
type: array
|
|
2655
2718
|
items:
|
|
2656
|
-
$ref:
|
|
2719
|
+
$ref: "#/components/schemas/AllowedPaymentActions"
|
|
2657
2720
|
CheckoutReferences:
|
|
2658
2721
|
type: object
|
|
2659
2722
|
description: Object containing all details that are linked to the Checkout.
|
|
@@ -2666,8 +2729,7 @@ components:
|
|
|
2666
2729
|
example: customer-order-1234
|
|
2667
2730
|
merchantShopReference:
|
|
2668
2731
|
type: string
|
|
2669
|
-
description:
|
|
2670
|
-
Optional parameter to define the shop or touchpoint where a sale has been realized (e.g. different stores).
|
|
2732
|
+
description: Optional parameter to define the shop or touchpoint where a sale has been realized (e.g. different stores).
|
|
2671
2733
|
maxLength: 64
|
|
2672
2734
|
example: Shop-12345
|
|
2673
2735
|
CheckoutsResponse:
|
|
@@ -2685,7 +2747,7 @@ components:
|
|
|
2685
2747
|
type: array
|
|
2686
2748
|
description: List of Checkouts
|
|
2687
2749
|
items:
|
|
2688
|
-
$ref:
|
|
2750
|
+
$ref: "#/components/schemas/CheckoutResponse"
|
|
2689
2751
|
CompanyInformation:
|
|
2690
2752
|
description: Object containing details of the company.
|
|
2691
2753
|
type: object
|
|
@@ -2711,41 +2773,18 @@ components:
|
|
|
2711
2773
|
Unique ID reference of the Commerce Case. It can be used to add additional Checkouts to the Commerce Case.
|
|
2712
2774
|
example: 0c3ab9d7-19ed-40da-9a0e-1f96f4cfb8ae
|
|
2713
2775
|
customer:
|
|
2714
|
-
$ref:
|
|
2776
|
+
$ref: "#/components/schemas/Customer"
|
|
2715
2777
|
checkouts:
|
|
2716
2778
|
type: array
|
|
2717
2779
|
items:
|
|
2718
|
-
$ref:
|
|
2780
|
+
$ref: "#/components/schemas/CheckoutResponse"
|
|
2719
2781
|
creationDateTime:
|
|
2720
|
-
$ref:
|
|
2782
|
+
$ref: "#/components/schemas/CreationDateTime"
|
|
2721
2783
|
CommerceCasesResponse:
|
|
2722
2784
|
type: array
|
|
2723
2785
|
description: List of Commerce Cases
|
|
2724
2786
|
items:
|
|
2725
|
-
$ref:
|
|
2726
|
-
CreateCommerceCaseResponse:
|
|
2727
|
-
type: object
|
|
2728
|
-
description: |-
|
|
2729
|
-
The response contains references to the created Commerce case and the Checkout. It also contains the payment
|
|
2730
|
-
response if the flag 'autoExecuteOrder' was set to true.
|
|
2731
|
-
properties:
|
|
2732
|
-
commerceCaseId:
|
|
2733
|
-
description: Unique ID of the Commerce Case. It can used to add additional Checkouts to the Commerce Case.
|
|
2734
|
-
type: string
|
|
2735
|
-
format: UUID
|
|
2736
|
-
example: "707ef15b-7a0a-48f2-b7d8-c95103418a9c"
|
|
2737
|
-
merchantReference:
|
|
2738
|
-
type: string
|
|
2739
|
-
description: |-
|
|
2740
|
-
Unique reference of the Commerce Case that is also returned for reporting and reconciliation purposes.
|
|
2741
|
-
maxLength: 40
|
|
2742
|
-
example: customer-commerce-case-123
|
|
2743
|
-
customer:
|
|
2744
|
-
$ref: '#/components/schemas/Customer'
|
|
2745
|
-
checkout:
|
|
2746
|
-
$ref: '#/components/schemas/CreateCheckoutResponse'
|
|
2747
|
-
creationDateTime:
|
|
2748
|
-
$ref: '#/components/schemas/CreationDateTime'
|
|
2787
|
+
$ref: "#/components/schemas/CommerceCaseResponse"
|
|
2749
2788
|
ContactDetails:
|
|
2750
2789
|
type: object
|
|
2751
2790
|
description: |-
|
|
@@ -2771,11 +2810,50 @@ components:
|
|
|
2771
2810
|
maxLength: 40
|
|
2772
2811
|
example: customer-commerce-case-123
|
|
2773
2812
|
customer:
|
|
2774
|
-
$ref:
|
|
2813
|
+
$ref: "#/components/schemas/Customer"
|
|
2775
2814
|
creationDateTime:
|
|
2776
|
-
$ref:
|
|
2815
|
+
$ref: "#/components/schemas/CreationDateTime"
|
|
2816
|
+
checkout:
|
|
2817
|
+
$ref: "#/components/schemas/CreateCheckoutRequest"
|
|
2818
|
+
CreateCommerceCaseResponse:
|
|
2819
|
+
type: object
|
|
2820
|
+
description: |-
|
|
2821
|
+
The response contains references to the created Commerce case and the Checkout. It also contains the payment
|
|
2822
|
+
response if the flag 'autoExecuteOrder' was set to true.
|
|
2823
|
+
properties:
|
|
2824
|
+
commerceCaseId:
|
|
2825
|
+
description: Unique ID of the Commerce Case. It can used to add additional Checkouts to the Commerce Case.
|
|
2826
|
+
type: string
|
|
2827
|
+
format: UUID
|
|
2828
|
+
example: "707ef15b-7a0a-48f2-b7d8-c95103418a9c"
|
|
2829
|
+
merchantReference:
|
|
2830
|
+
type: string
|
|
2831
|
+
description: |-
|
|
2832
|
+
Unique reference of the Commerce Case that is also returned for reporting and reconciliation purposes.
|
|
2833
|
+
maxLength: 40
|
|
2834
|
+
example: customer-commerce-case-123
|
|
2835
|
+
customer:
|
|
2836
|
+
$ref: "#/components/schemas/Customer"
|
|
2777
2837
|
checkout:
|
|
2778
|
-
$ref:
|
|
2838
|
+
$ref: "#/components/schemas/CreateCheckoutResponse"
|
|
2839
|
+
creationDateTime:
|
|
2840
|
+
$ref: "#/components/schemas/CreationDateTime"
|
|
2841
|
+
CreatePaymentResponse:
|
|
2842
|
+
type: object
|
|
2843
|
+
description: Object containing details on the created payment it has directly be executed.
|
|
2844
|
+
additionalProperties: false
|
|
2845
|
+
properties:
|
|
2846
|
+
creationOutput:
|
|
2847
|
+
$ref: "#/components/schemas/PaymentCreationOutput"
|
|
2848
|
+
merchantAction:
|
|
2849
|
+
$ref: "#/components/schemas/MerchantAction"
|
|
2850
|
+
payment:
|
|
2851
|
+
$ref: "#/components/schemas/PaymentResponse"
|
|
2852
|
+
paymentExecutionId:
|
|
2853
|
+
description: reference to the paymentExecution.
|
|
2854
|
+
type: string
|
|
2855
|
+
format: UUID
|
|
2856
|
+
example: "4f0c512e-f12c-11ec-8ea0-0242ac120002"
|
|
2779
2857
|
CreationDateTime:
|
|
2780
2858
|
type: string
|
|
2781
2859
|
format: date-time
|
|
@@ -2784,7 +2862,7 @@ components:
|
|
|
2784
2862
|
otherwise will be automatically set to the time when the request CreateCommerceCase was received.
|
|
2785
2863
|
Response values will always be in UTC time, but when providing this field in the requests, the time offset
|
|
2786
2864
|
can have different formats.
|
|
2787
|
-
|
|
2865
|
+
|
|
2788
2866
|
Accepted formats are:
|
|
2789
2867
|
* YYYY-MM-DD'T'HH:mm:ss'Z'
|
|
2790
2868
|
* YYYY-MM-DD'T'HH:mm:ss+XX:XX
|
|
@@ -2792,25 +2870,9 @@ components:
|
|
|
2792
2870
|
* YYYY-MM-DD'T'HH:mm'Z'
|
|
2793
2871
|
* YYYY-MM-DD'T'HH:mm+XX:XX
|
|
2794
2872
|
* YYYY-MM-DD'T'HH:mm-XX:XX
|
|
2795
|
-
|
|
2873
|
+
|
|
2796
2874
|
All other formats may be ignored by the system.
|
|
2797
2875
|
example: 2023-12-06T23:59:60Z
|
|
2798
|
-
CreatePaymentResponse:
|
|
2799
|
-
type: object
|
|
2800
|
-
description: Object containing details on the created payment it has directly be executed.
|
|
2801
|
-
additionalProperties: false
|
|
2802
|
-
properties:
|
|
2803
|
-
creationOutput:
|
|
2804
|
-
$ref: '#/components/schemas/PaymentCreationOutput'
|
|
2805
|
-
merchantAction:
|
|
2806
|
-
$ref: '#/components/schemas/MerchantAction'
|
|
2807
|
-
payment:
|
|
2808
|
-
$ref: '#/components/schemas/PaymentResponse'
|
|
2809
|
-
paymentExecutionId:
|
|
2810
|
-
description: reference to the paymentExecution.
|
|
2811
|
-
type: string
|
|
2812
|
-
format: UUID
|
|
2813
|
-
example: "4f0c512e-f12c-11ec-8ea0-0242ac120002"
|
|
2814
2876
|
Customer:
|
|
2815
2877
|
type: object
|
|
2816
2878
|
description: |
|
|
@@ -2818,16 +2880,16 @@ components:
|
|
|
2818
2880
|
additionalProperties: false
|
|
2819
2881
|
properties:
|
|
2820
2882
|
companyInformation:
|
|
2821
|
-
$ref:
|
|
2883
|
+
$ref: "#/components/schemas/CompanyInformation"
|
|
2822
2884
|
merchantCustomerId:
|
|
2823
2885
|
type: string
|
|
2824
2886
|
description: Unique identifier for the customer.
|
|
2825
2887
|
maxLength: 20
|
|
2826
2888
|
example: "1234"
|
|
2827
2889
|
billingAddress:
|
|
2828
|
-
$ref:
|
|
2890
|
+
$ref: "#/components/schemas/Address"
|
|
2829
2891
|
contactDetails:
|
|
2830
|
-
$ref:
|
|
2892
|
+
$ref: "#/components/schemas/ContactDetails"
|
|
2831
2893
|
fiscalNumber:
|
|
2832
2894
|
maxLength: 14
|
|
2833
2895
|
type: string
|
|
@@ -2860,13 +2922,13 @@ components:
|
|
|
2860
2922
|
type: string
|
|
2861
2923
|
description: |-
|
|
2862
2924
|
The locale that the customer should be addressed in (for 3rd parties).
|
|
2863
|
-
|
|
2925
|
+
|
|
2864
2926
|
Note: Only the language code is supported.
|
|
2865
2927
|
example: de
|
|
2866
2928
|
personalInformation:
|
|
2867
|
-
$ref:
|
|
2929
|
+
$ref: "#/components/schemas/PersonalInformation"
|
|
2868
2930
|
account:
|
|
2869
|
-
$ref:
|
|
2931
|
+
$ref: "#/components/schemas/CustomerAccount"
|
|
2870
2932
|
CustomerAccount:
|
|
2871
2933
|
type: object
|
|
2872
2934
|
description: Object containing data related to the account the customer has with you.
|
|
@@ -2884,10 +2946,16 @@ components:
|
|
|
2884
2946
|
* YYYY-MM-DD'T'HH:mm+XX:XX
|
|
2885
2947
|
* YYYY-MM-DD'T'HH:mm-XX:XX
|
|
2886
2948
|
example: 2023-10-05T14:30:15.123Z
|
|
2887
|
-
|
|
2888
2949
|
CustomerDevice:
|
|
2889
2950
|
type: object
|
|
2890
2951
|
properties:
|
|
2952
|
+
acceptHeader:
|
|
2953
|
+
type: string
|
|
2954
|
+
description: |
|
|
2955
|
+
The accept-header of the customer client from the HTTP Headers.
|
|
2956
|
+
This field can be mandatory depending on the selected payment method and routing option.
|
|
2957
|
+
maxLength: 2048
|
|
2958
|
+
example: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
|
|
2891
2959
|
ipAddress:
|
|
2892
2960
|
maxLength: 45
|
|
2893
2961
|
type: string
|
|
@@ -2895,21 +2963,18 @@ components:
|
|
|
2895
2963
|
deviceToken:
|
|
2896
2964
|
maxLength: 255
|
|
2897
2965
|
type: string
|
|
2898
|
-
description:
|
|
2966
|
+
description:
|
|
2967
|
+
Tokenized representation of the end customers device. For example
|
|
2899
2968
|
used for PAYONE Buy Now, Pay Later (BNPL).
|
|
2969
|
+
userAgent:
|
|
2970
|
+
type: string
|
|
2971
|
+
description: |
|
|
2972
|
+
User-Agent of the client device/browser from the HTTP Headers.
|
|
2973
|
+
This field can be mandatory depending on the selected payment method and routing option
|
|
2974
|
+
example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36
|
|
2975
|
+
maxLength: 2048
|
|
2900
2976
|
description: |
|
|
2901
2977
|
Object containing information about the device of the end customer.
|
|
2902
|
-
DeliveryInformation:
|
|
2903
|
-
type: object
|
|
2904
|
-
description: |-
|
|
2905
|
-
Delivery object contains additional information about the delivery/shipment, which is the basis for the Capture.
|
|
2906
|
-
The amountOfMoney in the cartItem will not be used in the request.
|
|
2907
|
-
properties:
|
|
2908
|
-
items:
|
|
2909
|
-
type: array
|
|
2910
|
-
description: Items delivered.
|
|
2911
|
-
items:
|
|
2912
|
-
$ref: '#/components/schemas/CartItemInput'
|
|
2913
2978
|
DeliverItem:
|
|
2914
2979
|
type: object
|
|
2915
2980
|
properties:
|
|
@@ -2938,14 +3003,14 @@ components:
|
|
|
2938
3003
|
The platform will automatically calculate the respective amount to trigger the Capture. For a partial Deliver a
|
|
2939
3004
|
list of items must be provided.
|
|
2940
3005
|
The item details for the Capture will be automatically loaded from the Checkout.
|
|
2941
|
-
|
|
3006
|
+
|
|
2942
3007
|
The cancellationReason must be provided if deliverType is set to PARTIAL and isFinal is set to true for BNPL
|
|
2943
3008
|
payment methods (paymentProductId 3390, 3391 and 3392).
|
|
2944
3009
|
For other payment methods the cancellationReason is not mandatory in this case but can be used for reporting
|
|
2945
3010
|
and reconciliation purposes.
|
|
2946
3011
|
properties:
|
|
2947
3012
|
deliverType:
|
|
2948
|
-
$ref:
|
|
3013
|
+
$ref: "#/components/schemas/DeliverType"
|
|
2949
3014
|
isFinal:
|
|
2950
3015
|
type: boolean
|
|
2951
3016
|
default: false
|
|
@@ -2954,18 +3019,18 @@ components:
|
|
|
2954
3019
|
For deliverType FULL, it is always the final operation.
|
|
2955
3020
|
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.
|
|
2956
3021
|
cancellationReason:
|
|
2957
|
-
$ref:
|
|
3022
|
+
$ref: "#/components/schemas/CancellationReason"
|
|
2958
3023
|
deliverItems:
|
|
2959
3024
|
type: array
|
|
2960
3025
|
items:
|
|
2961
|
-
$ref:
|
|
3026
|
+
$ref: "#/components/schemas/DeliverItem"
|
|
2962
3027
|
DeliverResponse:
|
|
2963
3028
|
type: object
|
|
2964
3029
|
properties:
|
|
2965
3030
|
capturePaymentResponse:
|
|
2966
|
-
$ref:
|
|
3031
|
+
$ref: "#/components/schemas/CapturePaymentResponse"
|
|
2967
3032
|
shoppingCart:
|
|
2968
|
-
$ref:
|
|
3033
|
+
$ref: "#/components/schemas/ShoppingCartResult"
|
|
2969
3034
|
DeliverType:
|
|
2970
3035
|
type: string
|
|
2971
3036
|
description: |
|
|
@@ -2982,7 +3047,17 @@ components:
|
|
|
2982
3047
|
enum:
|
|
2983
3048
|
- FULL
|
|
2984
3049
|
- PARTIAL
|
|
2985
|
-
|
|
3050
|
+
DeliveryInformation:
|
|
3051
|
+
type: object
|
|
3052
|
+
description: |-
|
|
3053
|
+
Delivery object contains additional information about the delivery/shipment, which is the basis for the Capture.
|
|
3054
|
+
The amountOfMoney in the cartItem will not be used in the request.
|
|
3055
|
+
properties:
|
|
3056
|
+
items:
|
|
3057
|
+
type: array
|
|
3058
|
+
description: Items delivered.
|
|
3059
|
+
items:
|
|
3060
|
+
$ref: "#/components/schemas/CartItemInput"
|
|
2986
3061
|
ErrorResponse:
|
|
2987
3062
|
type: object
|
|
2988
3063
|
additionalProperties: false
|
|
@@ -2993,8 +3068,7 @@ components:
|
|
|
2993
3068
|
errors:
|
|
2994
3069
|
type: array
|
|
2995
3070
|
items:
|
|
2996
|
-
$ref:
|
|
2997
|
-
|
|
3071
|
+
$ref: "#/components/schemas/APIError"
|
|
2998
3072
|
ExtendedCheckoutStatus:
|
|
2999
3073
|
type: string
|
|
3000
3074
|
description: |
|
|
@@ -3044,10 +3118,10 @@ components:
|
|
|
3044
3118
|
* true = the payment requires approval before the funds will be captured using the Approve payment or
|
|
3045
3119
|
Capture payment API
|
|
3046
3120
|
* false = the payment does not require approval, and the funds will be captured automatically
|
|
3047
|
-
|
|
3121
|
+
|
|
3048
3122
|
If the parameter is not provided in the request, the default value will be true
|
|
3049
3123
|
paymentProduct3392SpecificInput:
|
|
3050
|
-
$ref:
|
|
3124
|
+
$ref: "#/components/schemas/PaymentProduct3392SpecificInput"
|
|
3051
3125
|
FinancingPaymentMethodSpecificOutput:
|
|
3052
3126
|
type: object
|
|
3053
3127
|
description: Object containing the specific output details for financing payment methods (Buy Now Pay Later)
|
|
@@ -3065,15 +3139,16 @@ components:
|
|
|
3065
3139
|
format: int32
|
|
3066
3140
|
example: 3390
|
|
3067
3141
|
paymentProduct3391SpecificOutput:
|
|
3068
|
-
$ref:
|
|
3142
|
+
$ref: "#/components/schemas/PaymentProduct3391SpecificOutput"
|
|
3069
3143
|
paymentInstructions:
|
|
3070
|
-
$ref:
|
|
3144
|
+
$ref: "#/components/schemas/PaymentInstructions"
|
|
3071
3145
|
InstallmentOption:
|
|
3072
3146
|
type: object
|
|
3073
3147
|
properties:
|
|
3074
3148
|
installmentOptionId:
|
|
3075
3149
|
type: string
|
|
3076
|
-
description:
|
|
3150
|
+
description:
|
|
3151
|
+
Installment option Identifier. Use this in the Complete Payment
|
|
3077
3152
|
for the selected installment option.
|
|
3078
3153
|
example: IOP_478d44fea0494eea86bc87f9e4a63328
|
|
3079
3154
|
numberOfPayments:
|
|
@@ -3085,12 +3160,12 @@ components:
|
|
|
3085
3160
|
type: object
|
|
3086
3161
|
description: Monthly rate amount.
|
|
3087
3162
|
allOf:
|
|
3088
|
-
- $ref:
|
|
3163
|
+
- $ref: "#/components/schemas/AmountOfMoney"
|
|
3089
3164
|
lastRateAmount:
|
|
3090
3165
|
type: object
|
|
3091
3166
|
description: Last rate amount.
|
|
3092
3167
|
allOf:
|
|
3093
|
-
- $ref:
|
|
3168
|
+
- $ref: "#/components/schemas/AmountOfMoney"
|
|
3094
3169
|
effectiveInterestRate:
|
|
3095
3170
|
type: integer
|
|
3096
3171
|
description: Effective interest amount in percent with two decimals.
|
|
@@ -3105,7 +3180,7 @@ components:
|
|
|
3105
3180
|
type: object
|
|
3106
3181
|
description: Total rate amount.
|
|
3107
3182
|
allOf:
|
|
3108
|
-
- $ref:
|
|
3183
|
+
- $ref: "#/components/schemas/AmountOfMoney"
|
|
3109
3184
|
firstRateDate:
|
|
3110
3185
|
maxLength: 8
|
|
3111
3186
|
pattern: ^((19|20|21)\d{6})?$
|
|
@@ -3117,7 +3192,7 @@ components:
|
|
|
3117
3192
|
type: object
|
|
3118
3193
|
description: Link with credit information.
|
|
3119
3194
|
allOf:
|
|
3120
|
-
- $ref:
|
|
3195
|
+
- $ref: "#/components/schemas/LinkInformation"
|
|
3121
3196
|
required:
|
|
3122
3197
|
- creditInformation
|
|
3123
3198
|
- effectiveInterestRate
|
|
@@ -3128,17 +3203,6 @@ components:
|
|
|
3128
3203
|
- nominalInterestRate
|
|
3129
3204
|
- numberOfPayments
|
|
3130
3205
|
- totalAmount
|
|
3131
|
-
CartItemInvoiceData:
|
|
3132
|
-
type: object
|
|
3133
|
-
description: Object containing the line items of the invoice or shopping cart.
|
|
3134
|
-
properties:
|
|
3135
|
-
description:
|
|
3136
|
-
type: string
|
|
3137
|
-
description: |
|
|
3138
|
-
Shopping cart item description.
|
|
3139
|
-
The description will also be displayed in the portal as the product name.
|
|
3140
|
-
example: Smartwatch
|
|
3141
|
-
x-trim-at: 116
|
|
3142
3206
|
LinkInformation:
|
|
3143
3207
|
type: object
|
|
3144
3208
|
description: URL and content type information for an web resource.
|
|
@@ -3152,15 +3216,6 @@ components:
|
|
|
3152
3216
|
required:
|
|
3153
3217
|
- href
|
|
3154
3218
|
- type
|
|
3155
|
-
CartItemStatus:
|
|
3156
|
-
type: string
|
|
3157
|
-
enum:
|
|
3158
|
-
- ORDERED
|
|
3159
|
-
- DELIVERED
|
|
3160
|
-
- CANCELLED
|
|
3161
|
-
- RETURNED
|
|
3162
|
-
- WAITING_FOR_PAYMENT
|
|
3163
|
-
description: Indicates in which status the line item is
|
|
3164
3219
|
MandateRecurrenceType:
|
|
3165
3220
|
type: string
|
|
3166
3221
|
enum:
|
|
@@ -3201,22 +3256,16 @@ components:
|
|
|
3201
3256
|
- MOBILE_THREEDS_CHALLENGE
|
|
3202
3257
|
- CALL_THIRD_PARTY
|
|
3203
3258
|
redirectData:
|
|
3204
|
-
$ref:
|
|
3259
|
+
$ref: "#/components/schemas/RedirectData"
|
|
3205
3260
|
MobilePaymentMethodSpecificInput:
|
|
3206
3261
|
type: object
|
|
3207
3262
|
description: Object containing the specific input details for mobile payments.
|
|
3208
3263
|
additionalProperties: false
|
|
3209
3264
|
properties:
|
|
3210
3265
|
paymentProductId:
|
|
3211
|
-
|
|
3212
|
-
format: int32
|
|
3213
|
-
maximum: 99999
|
|
3214
|
-
minimum: 0
|
|
3215
|
-
description: |-
|
|
3216
|
-
Payment product identifier - please check product documentation for a full overview of possible values.
|
|
3217
|
-
example: 840
|
|
3266
|
+
$ref: "#/components/schemas/PaymentProductId"
|
|
3218
3267
|
authorizationMode:
|
|
3219
|
-
$ref:
|
|
3268
|
+
$ref: "#/components/schemas/AuthorizationMode"
|
|
3220
3269
|
encryptedPaymentData:
|
|
3221
3270
|
type: string
|
|
3222
3271
|
description: |-
|
|
@@ -3231,9 +3280,9 @@ components:
|
|
|
3231
3280
|
type: string
|
|
3232
3281
|
description: Ephemeral Key A unique generated key used by Apple to encrypt data.
|
|
3233
3282
|
threeDSecure:
|
|
3234
|
-
$ref:
|
|
3283
|
+
$ref: "#/components/schemas/MobilePaymentThreeDSecure"
|
|
3235
3284
|
paymentProduct302SpecificInput:
|
|
3236
|
-
$ref:
|
|
3285
|
+
$ref: "#/components/schemas/PaymentProduct302SpecificInput"
|
|
3237
3286
|
MobilePaymentMethodSpecificOutput:
|
|
3238
3287
|
type: object
|
|
3239
3288
|
description: Object containing the mobile payment method details.
|
|
@@ -3251,9 +3300,9 @@ components:
|
|
|
3251
3300
|
description: Card Authorization code as returned by the acquirer
|
|
3252
3301
|
type: string
|
|
3253
3302
|
fraudResults:
|
|
3254
|
-
$ref:
|
|
3303
|
+
$ref: "#/components/schemas/CardFraudResults"
|
|
3255
3304
|
threeDSecureResults:
|
|
3256
|
-
$ref:
|
|
3305
|
+
$ref: "#/components/schemas/ThreeDSecureResults"
|
|
3257
3306
|
network:
|
|
3258
3307
|
type: string
|
|
3259
3308
|
description: The card network that was used for a mobile payment method operation
|
|
@@ -3264,7 +3313,7 @@ components:
|
|
|
3264
3313
|
Necessary to perform 3D Secure when there is no liability shift from the wallet and corresponding card network.
|
|
3265
3314
|
properties:
|
|
3266
3315
|
redirectionData:
|
|
3267
|
-
$ref:
|
|
3316
|
+
$ref: "#/components/schemas/RedirectionData"
|
|
3268
3317
|
Order:
|
|
3269
3318
|
type: object
|
|
3270
3319
|
description: |-
|
|
@@ -3272,15 +3321,15 @@ components:
|
|
|
3272
3321
|
amount.
|
|
3273
3322
|
properties:
|
|
3274
3323
|
amountOfMoney:
|
|
3275
|
-
$ref:
|
|
3324
|
+
$ref: "#/components/schemas/AmountOfMoney"
|
|
3276
3325
|
customer:
|
|
3277
|
-
$ref:
|
|
3326
|
+
$ref: "#/components/schemas/Customer"
|
|
3278
3327
|
references:
|
|
3279
|
-
$ref:
|
|
3328
|
+
$ref: "#/components/schemas/References"
|
|
3280
3329
|
shipping:
|
|
3281
|
-
$ref:
|
|
3330
|
+
$ref: "#/components/schemas/Shipping"
|
|
3282
3331
|
shoppingCart:
|
|
3283
|
-
$ref:
|
|
3332
|
+
$ref: "#/components/schemas/ShoppingCartInput"
|
|
3284
3333
|
required:
|
|
3285
3334
|
- references
|
|
3286
3335
|
OrderItem:
|
|
@@ -3324,7 +3373,7 @@ components:
|
|
|
3324
3373
|
minimum: 0
|
|
3325
3374
|
example: 480
|
|
3326
3375
|
productType:
|
|
3327
|
-
$ref:
|
|
3376
|
+
$ref: "#/components/schemas/ProductType"
|
|
3328
3377
|
quantity:
|
|
3329
3378
|
type: integer
|
|
3330
3379
|
description: |-
|
|
@@ -3343,7 +3392,7 @@ components:
|
|
|
3343
3392
|
example: 0
|
|
3344
3393
|
taxAmountPerUnit:
|
|
3345
3394
|
type: boolean
|
|
3346
|
-
description: |-
|
|
3395
|
+
description: |-
|
|
3347
3396
|
This field indicates if the `taxAmount` is to be interpreted as the tax amount per unit rather than for the entire line item.
|
|
3348
3397
|
This field is included in the response only when `taxAmount` is set; otherwise, it will return as `null`.
|
|
3349
3398
|
format: int64
|
|
@@ -3391,7 +3440,7 @@ components:
|
|
|
3391
3440
|
Object containing additional information that when supplied can have a beneficial effect on the discountrates.
|
|
3392
3441
|
additionalProperties: false
|
|
3393
3442
|
allOf:
|
|
3394
|
-
- $ref:
|
|
3443
|
+
- $ref: "#/components/schemas/OrderLineDetailsInput"
|
|
3395
3444
|
properties:
|
|
3396
3445
|
id:
|
|
3397
3446
|
description: Unique identifier of a cart item
|
|
@@ -3401,14 +3450,14 @@ components:
|
|
|
3401
3450
|
status:
|
|
3402
3451
|
type: array
|
|
3403
3452
|
items:
|
|
3404
|
-
$ref:
|
|
3453
|
+
$ref: "#/components/schemas/CartItemOrderStatus"
|
|
3405
3454
|
OrderLineDetailsResult:
|
|
3406
3455
|
type: object
|
|
3407
3456
|
description: |
|
|
3408
3457
|
Object containing additional information that when supplied can have a beneficial effect on the discountrates.
|
|
3409
3458
|
additionalProperties: false
|
|
3410
3459
|
allOf:
|
|
3411
|
-
- $ref:
|
|
3460
|
+
- $ref: "#/components/schemas/OrderLineDetailsInput"
|
|
3412
3461
|
properties:
|
|
3413
3462
|
id:
|
|
3414
3463
|
description: Unique identifier of a cart item
|
|
@@ -3418,84 +3467,7 @@ components:
|
|
|
3418
3467
|
status:
|
|
3419
3468
|
type: array
|
|
3420
3469
|
items:
|
|
3421
|
-
$ref:
|
|
3422
|
-
ProductType:
|
|
3423
|
-
type: string
|
|
3424
|
-
description: |-
|
|
3425
|
-
Enum to classify items that are purchased
|
|
3426
|
-
* GOODS - Goods
|
|
3427
|
-
* SHIPMENT - Shipping charges
|
|
3428
|
-
* HANDLING_FEE - Handling fee
|
|
3429
|
-
* DISCOUNT - Voucher / discount
|
|
3430
|
-
enum:
|
|
3431
|
-
- GOODS
|
|
3432
|
-
- SHIPMENT
|
|
3433
|
-
- HANDLING_FEE
|
|
3434
|
-
- DISCOUNT
|
|
3435
|
-
References:
|
|
3436
|
-
type: object
|
|
3437
|
-
description: Object that holds all reference properties that are linked to this transaction.
|
|
3438
|
-
properties:
|
|
3439
|
-
descriptor:
|
|
3440
|
-
type: string
|
|
3441
|
-
description: |-
|
|
3442
|
-
Descriptive text that is used towards to customer, either during an online Checkout at a third party and/or
|
|
3443
|
-
on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor.
|
|
3444
|
-
The maximum allowed length varies per card acquirer:
|
|
3445
|
-
* AIB - 22 characters
|
|
3446
|
-
* American Express - 25 characters
|
|
3447
|
-
* Atos Origin BNP - 15 characters
|
|
3448
|
-
* Barclays - 25 characters
|
|
3449
|
-
* Catella - 22 characters
|
|
3450
|
-
* CBA - 20 characters
|
|
3451
|
-
* Elavon - 25 characters
|
|
3452
|
-
* First Data - 25 characters
|
|
3453
|
-
* INICIS (INIPAY) - 22-30 characters
|
|
3454
|
-
* JCB - 25 characters
|
|
3455
|
-
* Merchant Solutions - 22-25 characters
|
|
3456
|
-
* Payvision (EU & HK) - 25 characters
|
|
3457
|
-
* SEB Euroline - 22 characters
|
|
3458
|
-
* Sub1 Argentina - 15 characters
|
|
3459
|
-
* Wells Fargo - 25 characters
|
|
3460
|
-
|
|
3461
|
-
Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers
|
|
3462
|
-
will start to truncate. We currently also only allow per API call overrides for AIB and Barclays
|
|
3463
|
-
For alternative payment products the maximum allowed length varies per payment product:
|
|
3464
|
-
* 402 e-Przelewy - 30 characters
|
|
3465
|
-
* 404 INICIS - 80 characters
|
|
3466
|
-
* 802 Nordea ePayment Finland - 234 characters
|
|
3467
|
-
* 809 iDeal - 32 characters
|
|
3468
|
-
* 836 SOFORT - 42 characters
|
|
3469
|
-
* 840 PayPal - 127 characters
|
|
3470
|
-
* 841 WebMoney - 175 characters
|
|
3471
|
-
* 849 Yandex - 64 characters
|
|
3472
|
-
* 861 Alipay - 256 characters
|
|
3473
|
-
* 863 WeChat Pay - 32 characters
|
|
3474
|
-
* 880 BOKU - 20 characters
|
|
3475
|
-
* 8580 Qiwi - 255 characters
|
|
3476
|
-
* 1504 Konbini - 80 characters
|
|
3477
|
-
|
|
3478
|
-
All other payment products don't support a descriptor.
|
|
3479
|
-
maxLength: 256
|
|
3480
|
-
merchantReference:
|
|
3481
|
-
type: string
|
|
3482
|
-
description: |
|
|
3483
|
-
The merchantReference is a unique identifier for a payment and can be used for reporting purposes. The
|
|
3484
|
-
merchantReference is required for the execution of a payment and has to be unique. In case a payment has
|
|
3485
|
-
failed the same merchantReference can be used again.
|
|
3486
|
-
Once a successful payment has been made the same merchantReference can no longer be used and will be
|
|
3487
|
-
rejected.
|
|
3488
|
-
maxLength: 20
|
|
3489
|
-
example: 5a891df0b8cf11edaeb2af87d8ff0b2f
|
|
3490
|
-
merchantParameters:
|
|
3491
|
-
type: string
|
|
3492
|
-
description:
|
|
3493
|
-
It allows you to store additional parameters for the transaction in JSON format.
|
|
3494
|
-
This field must not contain any personal data.
|
|
3495
|
-
maxLength: 1000
|
|
3496
|
-
example: "{'SessionID':'126548354','ShopperID':'7354131'}"
|
|
3497
|
-
required:
|
|
3498
|
-
- merchantReference
|
|
3470
|
+
$ref: "#/components/schemas/CartItemOrderStatus"
|
|
3499
3471
|
OrderRequest:
|
|
3500
3472
|
type: object
|
|
3501
3473
|
description: |
|
|
@@ -3509,24 +3481,24 @@ components:
|
|
|
3509
3481
|
execution.
|
|
3510
3482
|
properties:
|
|
3511
3483
|
orderType:
|
|
3512
|
-
$ref:
|
|
3484
|
+
$ref: "#/components/schemas/OrderType"
|
|
3513
3485
|
orderReferences:
|
|
3514
|
-
$ref:
|
|
3486
|
+
$ref: "#/components/schemas/References"
|
|
3515
3487
|
items:
|
|
3516
3488
|
type: array
|
|
3517
3489
|
items:
|
|
3518
|
-
$ref:
|
|
3490
|
+
$ref: "#/components/schemas/OrderItem"
|
|
3519
3491
|
paymentMethodSpecificInput:
|
|
3520
|
-
$ref:
|
|
3492
|
+
$ref: "#/components/schemas/PaymentMethodSpecificInput"
|
|
3521
3493
|
OrderResponse:
|
|
3522
3494
|
type: object
|
|
3523
3495
|
description: Object that contains details on the created payment in case one has been created.
|
|
3524
3496
|
additionalProperties: false
|
|
3525
3497
|
properties:
|
|
3526
3498
|
createPaymentResponse:
|
|
3527
|
-
$ref:
|
|
3499
|
+
$ref: "#/components/schemas/CreatePaymentResponse"
|
|
3528
3500
|
shoppingCart:
|
|
3529
|
-
$ref:
|
|
3501
|
+
$ref: "#/components/schemas/ShoppingCartResult"
|
|
3530
3502
|
OrderType:
|
|
3531
3503
|
type: string
|
|
3532
3504
|
description: |
|
|
@@ -3550,31 +3522,31 @@ components:
|
|
|
3550
3522
|
An existing shopping cart of a Checkout will not be overwritten with the Patch request.
|
|
3551
3523
|
New items can be added to the shoppingCart by providing them in the request.
|
|
3552
3524
|
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.
|
|
3553
|
-
|
|
3525
|
+
|
|
3554
3526
|
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).
|
|
3555
3527
|
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.
|
|
3556
|
-
|
|
3528
|
+
|
|
3557
3529
|
If no amountOfMoney for the Checkout is provided, the platform will calculate the respective amount based on the cartItem productPrice and productQuantity.
|
|
3558
3530
|
properties:
|
|
3559
3531
|
amountOfMoney:
|
|
3560
|
-
$ref:
|
|
3532
|
+
$ref: "#/components/schemas/AmountOfMoney"
|
|
3561
3533
|
references:
|
|
3562
|
-
$ref:
|
|
3534
|
+
$ref: "#/components/schemas/CheckoutReferences"
|
|
3563
3535
|
shipping:
|
|
3564
|
-
$ref:
|
|
3536
|
+
$ref: "#/components/schemas/Shipping"
|
|
3565
3537
|
shoppingCart:
|
|
3566
|
-
$ref:
|
|
3538
|
+
$ref: "#/components/schemas/ShoppingCartPatch"
|
|
3567
3539
|
paymentMethodSpecificInput:
|
|
3568
|
-
$ref:
|
|
3540
|
+
$ref: "#/components/schemas/PaymentMethodSpecificInput"
|
|
3569
3541
|
paymentReferences:
|
|
3570
|
-
$ref:
|
|
3542
|
+
$ref: "#/components/schemas/References"
|
|
3571
3543
|
PatchCommerceCaseRequest:
|
|
3572
3544
|
type: object
|
|
3573
3545
|
description: |
|
|
3574
3546
|
Update the customer data of the given Commerce Case
|
|
3575
3547
|
properties:
|
|
3576
3548
|
customer:
|
|
3577
|
-
$ref:
|
|
3549
|
+
$ref: "#/components/schemas/Customer"
|
|
3578
3550
|
PausePaymentRequest:
|
|
3579
3551
|
type: object
|
|
3580
3552
|
description: Request to pause a payment for a specific payment method.
|
|
@@ -3583,7 +3555,7 @@ components:
|
|
|
3583
3555
|
type: object
|
|
3584
3556
|
properties:
|
|
3585
3557
|
status:
|
|
3586
|
-
$ref:
|
|
3558
|
+
$ref: "#/components/schemas/StatusValue"
|
|
3587
3559
|
PaymentChannel:
|
|
3588
3560
|
type: string
|
|
3589
3561
|
enum:
|
|
@@ -3626,13 +3598,13 @@ components:
|
|
|
3626
3598
|
description: Detailed information regarding an occurred payment event.
|
|
3627
3599
|
properties:
|
|
3628
3600
|
type:
|
|
3629
|
-
$ref:
|
|
3601
|
+
$ref: "#/components/schemas/PaymentType"
|
|
3630
3602
|
amountOfMoney:
|
|
3631
|
-
$ref:
|
|
3603
|
+
$ref: "#/components/schemas/AmountOfMoney"
|
|
3632
3604
|
paymentStatus:
|
|
3633
|
-
$ref:
|
|
3605
|
+
$ref: "#/components/schemas/StatusValue"
|
|
3634
3606
|
cancellationReason:
|
|
3635
|
-
$ref:
|
|
3607
|
+
$ref: "#/components/schemas/CancellationReason"
|
|
3636
3608
|
returnReason:
|
|
3637
3609
|
type: string
|
|
3638
3610
|
description: |-
|
|
@@ -3640,7 +3612,7 @@ components:
|
|
|
3640
3612
|
maxLength: 255
|
|
3641
3613
|
example: Customer complained
|
|
3642
3614
|
paymentInstructions:
|
|
3643
|
-
$ref:
|
|
3615
|
+
$ref: "#/components/schemas/PaymentInstructions"
|
|
3644
3616
|
PaymentExecution:
|
|
3645
3617
|
type: object
|
|
3646
3618
|
description: |-
|
|
@@ -3654,23 +3626,23 @@ components:
|
|
|
3654
3626
|
paymentId:
|
|
3655
3627
|
type: string
|
|
3656
3628
|
description: Unique payment transaction identifier of the payment gateway.
|
|
3657
|
-
example:
|
|
3629
|
+
example: "3066019730_1"
|
|
3658
3630
|
cardPaymentMethodSpecificInput:
|
|
3659
|
-
$ref:
|
|
3631
|
+
$ref: "#/components/schemas/CardPaymentMethodSpecificInput"
|
|
3660
3632
|
mobilePaymentMethodSpecificInput:
|
|
3661
|
-
$ref:
|
|
3633
|
+
$ref: "#/components/schemas/MobilePaymentMethodSpecificInput"
|
|
3662
3634
|
redirectPaymentMethodSpecificInput:
|
|
3663
|
-
$ref:
|
|
3635
|
+
$ref: "#/components/schemas/RedirectPaymentMethodSpecificInput"
|
|
3664
3636
|
sepaDirectDebitPaymentMethodSpecificInput:
|
|
3665
|
-
$ref:
|
|
3637
|
+
$ref: "#/components/schemas/SepaDirectDebitPaymentMethodSpecificInput"
|
|
3666
3638
|
financingPaymentMethodSpecificInput:
|
|
3667
|
-
$ref:
|
|
3639
|
+
$ref: "#/components/schemas/FinancingPaymentMethodSpecificInput"
|
|
3668
3640
|
bankPayoutMethodSpecificInput:
|
|
3669
|
-
$ref:
|
|
3641
|
+
$ref: "#/components/schemas/BankPayoutMethodSpecificInput"
|
|
3670
3642
|
paymentChannel:
|
|
3671
|
-
$ref:
|
|
3643
|
+
$ref: "#/components/schemas/PaymentChannel"
|
|
3672
3644
|
references:
|
|
3673
|
-
$ref:
|
|
3645
|
+
$ref: "#/components/schemas/References"
|
|
3674
3646
|
previousPayment:
|
|
3675
3647
|
type: string
|
|
3676
3648
|
format: UUID
|
|
@@ -3680,7 +3652,7 @@ components:
|
|
|
3680
3652
|
format: date-time
|
|
3681
3653
|
description: |-
|
|
3682
3654
|
The date and time when the payment was created.
|
|
3683
|
-
|
|
3655
|
+
|
|
3684
3656
|
Format will be in one of the following formats:
|
|
3685
3657
|
* YYYY-MM-DD'T'HH:mm:ss'Z'
|
|
3686
3658
|
* YYYY-MM-DD'T'HH:mm:ss+XX:XX
|
|
@@ -3691,7 +3663,7 @@ components:
|
|
|
3691
3663
|
format: date-time
|
|
3692
3664
|
description: |-
|
|
3693
3665
|
The date and time when the payment was last updated.
|
|
3694
|
-
|
|
3666
|
+
|
|
3695
3667
|
Format will be in one of the following formats:
|
|
3696
3668
|
* YYYY-MM-DD'T'HH:mm:ss'Z'
|
|
3697
3669
|
* YYYY-MM-DD'T'HH:mm:ss+XX:XX
|
|
@@ -3700,7 +3672,7 @@ components:
|
|
|
3700
3672
|
events:
|
|
3701
3673
|
type: array
|
|
3702
3674
|
items:
|
|
3703
|
-
$ref:
|
|
3675
|
+
$ref: "#/components/schemas/PaymentEvent"
|
|
3704
3676
|
PaymentExecutionRequest:
|
|
3705
3677
|
type: object
|
|
3706
3678
|
description: |
|
|
@@ -3711,9 +3683,9 @@ components:
|
|
|
3711
3683
|
For more details regarding payment method specific input please check the documentation.
|
|
3712
3684
|
properties:
|
|
3713
3685
|
paymentMethodSpecificInput:
|
|
3714
|
-
$ref:
|
|
3686
|
+
$ref: "#/components/schemas/PaymentMethodSpecificInput"
|
|
3715
3687
|
paymentExecutionSpecificInput:
|
|
3716
|
-
$ref:
|
|
3688
|
+
$ref: "#/components/schemas/PaymentExecutionSpecificInput"
|
|
3717
3689
|
PaymentExecutionSpecificInput:
|
|
3718
3690
|
type: object
|
|
3719
3691
|
description: |
|
|
@@ -3725,11 +3697,11 @@ components:
|
|
|
3725
3697
|
If the ShoppingCart elements differ from the data provided in the Checkout, the existing data will not be overwritten.
|
|
3726
3698
|
properties:
|
|
3727
3699
|
amountOfMoney:
|
|
3728
|
-
$ref:
|
|
3700
|
+
$ref: "#/components/schemas/AmountOfMoney"
|
|
3729
3701
|
shoppingCart:
|
|
3730
|
-
$ref:
|
|
3702
|
+
$ref: "#/components/schemas/ShoppingCartInput"
|
|
3731
3703
|
paymentReferences:
|
|
3732
|
-
$ref:
|
|
3704
|
+
$ref: "#/components/schemas/References"
|
|
3733
3705
|
required:
|
|
3734
3706
|
- paymentReferences
|
|
3735
3707
|
PaymentInformationRefundRequest:
|
|
@@ -3740,9 +3712,9 @@ components:
|
|
|
3740
3712
|
additionalProperties: false
|
|
3741
3713
|
properties:
|
|
3742
3714
|
amountOfMoney:
|
|
3743
|
-
$ref:
|
|
3715
|
+
$ref: "#/components/schemas/PositiveAmountOfMoney"
|
|
3744
3716
|
references:
|
|
3745
|
-
$ref:
|
|
3717
|
+
$ref: "#/components/schemas/PaymentReferences"
|
|
3746
3718
|
accountHolder:
|
|
3747
3719
|
maxLength: 50
|
|
3748
3720
|
type: string
|
|
@@ -3758,7 +3730,7 @@ components:
|
|
|
3758
3730
|
additionalProperties: false
|
|
3759
3731
|
properties:
|
|
3760
3732
|
payment:
|
|
3761
|
-
$ref:
|
|
3733
|
+
$ref: "#/components/schemas/PayoutResponse"
|
|
3762
3734
|
paymentExecutionId:
|
|
3763
3735
|
description: reference to the paymentExecution.
|
|
3764
3736
|
type: string
|
|
@@ -3769,18 +3741,13 @@ components:
|
|
|
3769
3741
|
additionalProperties: false
|
|
3770
3742
|
properties:
|
|
3771
3743
|
amountOfMoney:
|
|
3772
|
-
$ref:
|
|
3744
|
+
$ref: "#/components/schemas/AmountOfMoney"
|
|
3773
3745
|
type:
|
|
3774
|
-
$ref:
|
|
3746
|
+
$ref: "#/components/schemas/PaymentType"
|
|
3775
3747
|
paymentChannel:
|
|
3776
|
-
$ref:
|
|
3748
|
+
$ref: "#/components/schemas/PaymentChannel"
|
|
3777
3749
|
paymentProductId:
|
|
3778
|
-
|
|
3779
|
-
format: int32
|
|
3780
|
-
maximum: 99999
|
|
3781
|
-
minimum: 0
|
|
3782
|
-
description: |-
|
|
3783
|
-
Payment method identifier - please check the product documentation for a full overview of possible values.
|
|
3750
|
+
$ref: "#/components/schemas/PaymentProductId"
|
|
3784
3751
|
merchantReference:
|
|
3785
3752
|
type: string
|
|
3786
3753
|
description: |
|
|
@@ -3819,15 +3786,9 @@ components:
|
|
|
3819
3786
|
format: UUID
|
|
3820
3787
|
example: "637ef15b-1a0a-48f2-27d8-c954a344329c"
|
|
3821
3788
|
paymentChannel:
|
|
3822
|
-
$ref:
|
|
3789
|
+
$ref: "#/components/schemas/PaymentChannel"
|
|
3823
3790
|
paymentProductId:
|
|
3824
|
-
|
|
3825
|
-
format: int32
|
|
3826
|
-
maximum: 99999
|
|
3827
|
-
minimum: 0
|
|
3828
|
-
description: |-
|
|
3829
|
-
Payment product identifier - please check see product documentation for a full overview of possible values.
|
|
3830
|
-
example: 840
|
|
3791
|
+
$ref: "#/components/schemas/PaymentProductId"
|
|
3831
3792
|
terminalId:
|
|
3832
3793
|
description: Unique identifier of the POS terminal of the payment transaction.
|
|
3833
3794
|
type: string
|
|
@@ -3854,7 +3815,7 @@ components:
|
|
|
3854
3815
|
format: date-time
|
|
3855
3816
|
description: |-
|
|
3856
3817
|
The date and time when the payment was created.
|
|
3857
|
-
|
|
3818
|
+
|
|
3858
3819
|
Format will be in one of the following formats:
|
|
3859
3820
|
* YYYY-MM-DD'T'HH:mm:ss'Z'
|
|
3860
3821
|
* YYYY-MM-DD'T'HH:mm:ss+XX:XX
|
|
@@ -3865,18 +3826,18 @@ components:
|
|
|
3865
3826
|
format: date-time
|
|
3866
3827
|
description: |-
|
|
3867
3828
|
The date and time when the payment was last updated.
|
|
3868
|
-
|
|
3829
|
+
|
|
3869
3830
|
Format will be in one of the following formats:
|
|
3870
3831
|
* YYYY-MM-DD'T'HH:mm:ss'Z'
|
|
3871
3832
|
* YYYY-MM-DD'T'HH:mm:ss+XX:XX
|
|
3872
3833
|
* YYYY-MM-DD'T'HH:mm:ss-XX:XX
|
|
3873
3834
|
example: 2022-01-01T00:00:00Z
|
|
3874
3835
|
cardPaymentDetails:
|
|
3875
|
-
$ref:
|
|
3836
|
+
$ref: "#/components/schemas/CardPaymentDetails"
|
|
3876
3837
|
events:
|
|
3877
3838
|
type: array
|
|
3878
3839
|
items:
|
|
3879
|
-
$ref:
|
|
3840
|
+
$ref: "#/components/schemas/PaymentEvent"
|
|
3880
3841
|
PaymentInstructions:
|
|
3881
3842
|
required:
|
|
3882
3843
|
- payee
|
|
@@ -3885,7 +3846,7 @@ components:
|
|
|
3885
3846
|
type: object
|
|
3886
3847
|
properties:
|
|
3887
3848
|
payee:
|
|
3888
|
-
$ref:
|
|
3849
|
+
$ref: "#/components/schemas/Payee"
|
|
3889
3850
|
dueDate:
|
|
3890
3851
|
maxLength: 8
|
|
3891
3852
|
pattern: ^((19|20|21)\d{6})?$
|
|
@@ -3910,19 +3871,19 @@ components:
|
|
|
3910
3871
|
If a new input will be provided, the existing input will be updated.
|
|
3911
3872
|
properties:
|
|
3912
3873
|
cardPaymentMethodSpecificInput:
|
|
3913
|
-
$ref:
|
|
3874
|
+
$ref: "#/components/schemas/CardPaymentMethodSpecificInput"
|
|
3914
3875
|
mobilePaymentMethodSpecificInput:
|
|
3915
|
-
$ref:
|
|
3876
|
+
$ref: "#/components/schemas/MobilePaymentMethodSpecificInput"
|
|
3916
3877
|
redirectPaymentMethodSpecificInput:
|
|
3917
|
-
$ref:
|
|
3878
|
+
$ref: "#/components/schemas/RedirectPaymentMethodSpecificInput"
|
|
3918
3879
|
sepaDirectDebitPaymentMethodSpecificInput:
|
|
3919
|
-
$ref:
|
|
3880
|
+
$ref: "#/components/schemas/SepaDirectDebitPaymentMethodSpecificInput"
|
|
3920
3881
|
financingPaymentMethodSpecificInput:
|
|
3921
|
-
$ref:
|
|
3882
|
+
$ref: "#/components/schemas/FinancingPaymentMethodSpecificInput"
|
|
3922
3883
|
customerDevice:
|
|
3923
|
-
$ref:
|
|
3884
|
+
$ref: "#/components/schemas/CustomerDevice"
|
|
3924
3885
|
paymentChannel:
|
|
3925
|
-
$ref:
|
|
3886
|
+
$ref: "#/components/schemas/PaymentChannel"
|
|
3926
3887
|
PaymentOutput:
|
|
3927
3888
|
type: object
|
|
3928
3889
|
description: |
|
|
@@ -3930,7 +3891,7 @@ components:
|
|
|
3930
3891
|
additionalProperties: false
|
|
3931
3892
|
properties:
|
|
3932
3893
|
amountOfMoney:
|
|
3933
|
-
$ref:
|
|
3894
|
+
$ref: "#/components/schemas/AmountOfMoney"
|
|
3934
3895
|
merchantParameters:
|
|
3935
3896
|
type: string
|
|
3936
3897
|
description:
|
|
@@ -3939,33 +3900,20 @@ components:
|
|
|
3939
3900
|
maxLength: 1000
|
|
3940
3901
|
example: "{'SessionID':'126548354','ShopperID':'7354131'}"
|
|
3941
3902
|
references:
|
|
3942
|
-
$ref:
|
|
3903
|
+
$ref: "#/components/schemas/PaymentReferences"
|
|
3943
3904
|
cardPaymentMethodSpecificOutput:
|
|
3944
|
-
$ref:
|
|
3905
|
+
$ref: "#/components/schemas/CardPaymentMethodSpecificOutput"
|
|
3945
3906
|
mobilePaymentMethodSpecificOutput:
|
|
3946
|
-
$ref:
|
|
3907
|
+
$ref: "#/components/schemas/MobilePaymentMethodSpecificOutput"
|
|
3947
3908
|
paymentMethod:
|
|
3948
3909
|
type: string
|
|
3949
3910
|
description: Payment method identifier based on the paymentProductId.
|
|
3950
3911
|
redirectPaymentMethodSpecificOutput:
|
|
3951
|
-
$ref:
|
|
3912
|
+
$ref: "#/components/schemas/RedirectPaymentMethodSpecificOutput"
|
|
3952
3913
|
sepaDirectDebitPaymentMethodSpecificOutput:
|
|
3953
|
-
$ref:
|
|
3914
|
+
$ref: "#/components/schemas/SepaDirectDebitPaymentMethodSpecificOutput"
|
|
3954
3915
|
financingPaymentMethodSpecificOutput:
|
|
3955
|
-
$ref:
|
|
3956
|
-
PayoutOutput:
|
|
3957
|
-
type: object
|
|
3958
|
-
description: |
|
|
3959
|
-
Object containing details from the created payout.
|
|
3960
|
-
additionalProperties: false
|
|
3961
|
-
properties:
|
|
3962
|
-
amountOfMoney:
|
|
3963
|
-
$ref: '#/components/schemas/AmountOfMoney'
|
|
3964
|
-
references:
|
|
3965
|
-
$ref: '#/components/schemas/PaymentReferences'
|
|
3966
|
-
paymentMethod:
|
|
3967
|
-
type: string
|
|
3968
|
-
description: Payment method identifier based on the paymentProductId.
|
|
3916
|
+
$ref: "#/components/schemas/FinancingPaymentMethodSpecificOutput"
|
|
3969
3917
|
PaymentProduct302SpecificInput:
|
|
3970
3918
|
type: object
|
|
3971
3919
|
description: Object containing additional Information needed for Apple Pay payment transactions.
|
|
@@ -3999,7 +3947,7 @@ components:
|
|
|
3999
3947
|
- JCB
|
|
4000
3948
|
example: GIROCARD
|
|
4001
3949
|
token:
|
|
4002
|
-
$ref:
|
|
3950
|
+
$ref: "#/components/schemas/ApplePaymentDataTokenInformation"
|
|
4003
3951
|
domainName:
|
|
4004
3952
|
type: string
|
|
4005
3953
|
description: Domain of your Webshop. Needed for initialization of the Apple Pay payment session with integrationType=MASS_ENABLEMENT.
|
|
@@ -4017,7 +3965,7 @@ components:
|
|
|
4017
3965
|
ID of the selected installment option. Will be provided in the response of the Order / Payment Execution
|
|
4018
3966
|
request.
|
|
4019
3967
|
bankAccountInformation:
|
|
4020
|
-
$ref:
|
|
3968
|
+
$ref: "#/components/schemas/BankAccountInformation"
|
|
4021
3969
|
required:
|
|
4022
3970
|
- bankAccountInformation
|
|
4023
3971
|
- installmentOptionId
|
|
@@ -4028,14 +3976,14 @@ components:
|
|
|
4028
3976
|
type: array
|
|
4029
3977
|
description: List of installment options.
|
|
4030
3978
|
items:
|
|
4031
|
-
$ref:
|
|
3979
|
+
$ref: "#/components/schemas/InstallmentOption"
|
|
4032
3980
|
description: Object containing specific information for PAYONE Secured Installment.
|
|
4033
3981
|
PaymentProduct3392SpecificInput:
|
|
4034
3982
|
type: object
|
|
4035
3983
|
description: Object containing specific information for PAYONE Secured Direct Debit.
|
|
4036
3984
|
properties:
|
|
4037
3985
|
bankAccountInformation:
|
|
4038
|
-
$ref:
|
|
3986
|
+
$ref: "#/components/schemas/BankAccountInformation"
|
|
4039
3987
|
required:
|
|
4040
3988
|
- bankAccountInformation
|
|
4041
3989
|
PaymentProduct771SpecificOutput:
|
|
@@ -4076,11 +4024,26 @@ components:
|
|
|
4076
4024
|
additionalProperties: false
|
|
4077
4025
|
properties:
|
|
4078
4026
|
billingAddress:
|
|
4079
|
-
$ref:
|
|
4027
|
+
$ref: "#/components/schemas/Address"
|
|
4080
4028
|
customerAccount:
|
|
4081
|
-
$ref:
|
|
4029
|
+
$ref: "#/components/schemas/PaymentProduct840CustomerAccount"
|
|
4082
4030
|
shippingAddress:
|
|
4083
|
-
$ref:
|
|
4031
|
+
$ref: "#/components/schemas/Address"
|
|
4032
|
+
payPalTransactionId:
|
|
4033
|
+
type: string
|
|
4034
|
+
maxLength: 20
|
|
4035
|
+
description: |-
|
|
4036
|
+
A 17-character unique identifier of the PayPal transaction. This identifier is used to identify the transaction in the
|
|
4037
|
+
PayPal system and needed for the PayPal Javascript SDK flow.
|
|
4038
|
+
example: 9A1234567890123
|
|
4039
|
+
PaymentProductId:
|
|
4040
|
+
type: integer
|
|
4041
|
+
format: int32
|
|
4042
|
+
maximum: 99999
|
|
4043
|
+
minimum: 0
|
|
4044
|
+
description: |-
|
|
4045
|
+
Payment product identifier - please check product documentation for a full overview of possible values.
|
|
4046
|
+
example: 840
|
|
4084
4047
|
PaymentReferences:
|
|
4085
4048
|
type: object
|
|
4086
4049
|
description: Object that holds all reference properties that are linked to this transaction.
|
|
@@ -4098,26 +4061,11 @@ components:
|
|
|
4098
4061
|
additionalProperties: false
|
|
4099
4062
|
properties:
|
|
4100
4063
|
paymentOutput:
|
|
4101
|
-
$ref:
|
|
4064
|
+
$ref: "#/components/schemas/PaymentOutput"
|
|
4102
4065
|
status:
|
|
4103
|
-
$ref:
|
|
4066
|
+
$ref: "#/components/schemas/StatusValue"
|
|
4104
4067
|
statusOutput:
|
|
4105
|
-
$ref:
|
|
4106
|
-
id:
|
|
4107
|
-
type: string
|
|
4108
|
-
description: Unique payment transaction identifier of the payment gateway.
|
|
4109
|
-
example: PP1AA7KKLSFB9MBG
|
|
4110
|
-
PayoutResponse:
|
|
4111
|
-
type: object
|
|
4112
|
-
description: Object that holds the payment related properties for the refund of a Payment Information.
|
|
4113
|
-
additionalProperties: false
|
|
4114
|
-
properties:
|
|
4115
|
-
payoutOutput:
|
|
4116
|
-
$ref: '#/components/schemas/PayoutOutput'
|
|
4117
|
-
status:
|
|
4118
|
-
$ref: '#/components/schemas/StatusValue'
|
|
4119
|
-
statusCategory:
|
|
4120
|
-
$ref: '#/components/schemas/StatusCategoryValue'
|
|
4068
|
+
$ref: "#/components/schemas/PaymentStatusOutput"
|
|
4121
4069
|
id:
|
|
4122
4070
|
type: string
|
|
4123
4071
|
description: Unique payment transaction identifier of the payment gateway.
|
|
@@ -4134,7 +4082,7 @@ components:
|
|
|
4134
4082
|
type: boolean
|
|
4135
4083
|
description: Flag indicating if the payment can be cancelled
|
|
4136
4084
|
statusCategory:
|
|
4137
|
-
$ref:
|
|
4085
|
+
$ref: "#/components/schemas/StatusCategoryValue"
|
|
4138
4086
|
isAuthorized:
|
|
4139
4087
|
description: Indicates if the transaction has been authorized
|
|
4140
4088
|
type: boolean
|
|
@@ -4150,9 +4098,38 @@ components:
|
|
|
4150
4098
|
- CAPTURE
|
|
4151
4099
|
- REFUND
|
|
4152
4100
|
- REVERSAL
|
|
4101
|
+
- CHARGEBACK
|
|
4153
4102
|
- CHARGEBACK_REVERSAL
|
|
4154
4103
|
- CREDIT_NOTE
|
|
4155
4104
|
- DEBIT_NOTE
|
|
4105
|
+
PayoutOutput:
|
|
4106
|
+
type: object
|
|
4107
|
+
description: |
|
|
4108
|
+
Object containing details from the created payout.
|
|
4109
|
+
additionalProperties: false
|
|
4110
|
+
properties:
|
|
4111
|
+
amountOfMoney:
|
|
4112
|
+
$ref: "#/components/schemas/AmountOfMoney"
|
|
4113
|
+
references:
|
|
4114
|
+
$ref: "#/components/schemas/PaymentReferences"
|
|
4115
|
+
paymentMethod:
|
|
4116
|
+
type: string
|
|
4117
|
+
description: Payment method identifier based on the paymentProductId.
|
|
4118
|
+
PayoutResponse:
|
|
4119
|
+
type: object
|
|
4120
|
+
description: Object that holds the payment related properties for the refund of a Payment Information.
|
|
4121
|
+
additionalProperties: false
|
|
4122
|
+
properties:
|
|
4123
|
+
payoutOutput:
|
|
4124
|
+
$ref: "#/components/schemas/PayoutOutput"
|
|
4125
|
+
status:
|
|
4126
|
+
$ref: "#/components/schemas/StatusValue"
|
|
4127
|
+
statusCategory:
|
|
4128
|
+
$ref: "#/components/schemas/StatusCategoryValue"
|
|
4129
|
+
id:
|
|
4130
|
+
type: string
|
|
4131
|
+
description: Unique payment transaction identifier of the payment gateway.
|
|
4132
|
+
example: PP1AA7KKLSFB9MBG
|
|
4156
4133
|
PersonalInformation:
|
|
4157
4134
|
type: object
|
|
4158
4135
|
description: Object containing personal information like name, date of birth and gender.
|
|
@@ -4177,7 +4154,7 @@ components:
|
|
|
4177
4154
|
- FEMALE
|
|
4178
4155
|
- UNKNOWN
|
|
4179
4156
|
name:
|
|
4180
|
-
$ref:
|
|
4157
|
+
$ref: "#/components/schemas/PersonalName"
|
|
4181
4158
|
PersonalName:
|
|
4182
4159
|
type: object
|
|
4183
4160
|
description: Object containing the name details of the customer
|
|
@@ -4227,9 +4204,9 @@ components:
|
|
|
4227
4204
|
Renamed from CreateMandateWithReturnUrl to ProcessingMandateInformation.
|
|
4228
4205
|
properties:
|
|
4229
4206
|
bankAccountIban:
|
|
4230
|
-
$ref:
|
|
4207
|
+
$ref: "#/components/schemas/BankAccountInformation"
|
|
4231
4208
|
recurrenceType:
|
|
4232
|
-
$ref:
|
|
4209
|
+
$ref: "#/components/schemas/MandateRecurrenceType"
|
|
4233
4210
|
uniqueMandateReference:
|
|
4234
4211
|
maxLength: 35
|
|
4235
4212
|
pattern: ^[A-Za-z0-9\+\-\.()]{1,35}$
|
|
@@ -4256,6 +4233,19 @@ components:
|
|
|
4256
4233
|
- dateOfSignature
|
|
4257
4234
|
- recurrenceType
|
|
4258
4235
|
- uniqueMandateReference
|
|
4236
|
+
ProductType:
|
|
4237
|
+
type: string
|
|
4238
|
+
description: |-
|
|
4239
|
+
Enum to classify items that are purchased
|
|
4240
|
+
* GOODS - Goods
|
|
4241
|
+
* SHIPMENT - Shipping charges
|
|
4242
|
+
* HANDLING_FEE - Handling fee
|
|
4243
|
+
* DISCOUNT - Voucher / discount
|
|
4244
|
+
enum:
|
|
4245
|
+
- GOODS
|
|
4246
|
+
- SHIPMENT
|
|
4247
|
+
- HANDLING_FEE
|
|
4248
|
+
- DISCOUNT
|
|
4259
4249
|
RedirectData:
|
|
4260
4250
|
type: object
|
|
4261
4251
|
description: |-
|
|
@@ -4299,7 +4289,7 @@ components:
|
|
|
4299
4289
|
* true = the payment requires approval before the funds will be captured using the Approve payment or
|
|
4300
4290
|
Capture payment API
|
|
4301
4291
|
* false = the payment does not require approval, and the funds will be captured automatically
|
|
4302
|
-
|
|
4292
|
+
|
|
4303
4293
|
If the parameter is not provided in the request, the default value will be true
|
|
4304
4294
|
paymentProcessingToken:
|
|
4305
4295
|
type: string
|
|
@@ -4321,17 +4311,11 @@ components:
|
|
|
4321
4311
|
tokenization of recurring payments.
|
|
4322
4312
|
example: false
|
|
4323
4313
|
paymentProductId:
|
|
4324
|
-
|
|
4325
|
-
format: int32
|
|
4326
|
-
maximum: 99999
|
|
4327
|
-
minimum: 0
|
|
4328
|
-
description: |-
|
|
4329
|
-
Payment product identifier - please check product documentation for a full overview of possible values.
|
|
4330
|
-
example: 840
|
|
4314
|
+
$ref: "#/components/schemas/PaymentProductId"
|
|
4331
4315
|
paymentProduct840SpecificInput:
|
|
4332
|
-
$ref:
|
|
4316
|
+
$ref: "#/components/schemas/RedirectPaymentProduct840SpecificInput"
|
|
4333
4317
|
redirectionData:
|
|
4334
|
-
$ref:
|
|
4318
|
+
$ref: "#/components/schemas/RedirectionData"
|
|
4335
4319
|
RedirectPaymentMethodSpecificOutput:
|
|
4336
4320
|
type: object
|
|
4337
4321
|
description: |
|
|
@@ -4339,15 +4323,9 @@ components:
|
|
|
4339
4323
|
additionalProperties: false
|
|
4340
4324
|
properties:
|
|
4341
4325
|
paymentProductId:
|
|
4342
|
-
|
|
4343
|
-
format: int32
|
|
4344
|
-
maximum: 99999
|
|
4345
|
-
minimum: 0
|
|
4346
|
-
description: <-
|
|
4347
|
-
Payment product identifier - please check product documentation for a full overview of possible values.
|
|
4348
|
-
example: 840
|
|
4326
|
+
$ref: "#/components/schemas/PaymentProductId"
|
|
4349
4327
|
paymentProduct840SpecificOutput:
|
|
4350
|
-
$ref:
|
|
4328
|
+
$ref: "#/components/schemas/PaymentProduct840SpecificOutput"
|
|
4351
4329
|
paymentProcessingToken:
|
|
4352
4330
|
type: string
|
|
4353
4331
|
description: ID of the token. This property is populated when the payment was done with a token.
|
|
@@ -4379,12 +4357,85 @@ components:
|
|
|
4379
4357
|
customer-initiated transactions, when the FraudNet SDK is used, and to be passed in the API request the same tracking ID value
|
|
4380
4358
|
(FraudNet Session Identifier).
|
|
4381
4359
|
example: 686e5823-1ffd-42f7-9ba3-42b41b57d8dd
|
|
4360
|
+
javaScriptSdkFlow:
|
|
4361
|
+
type: boolean
|
|
4362
|
+
description: |-
|
|
4363
|
+
Indicates whether the PayPal JavaScript SDK flow is used.
|
|
4364
|
+
* true = The PayPal JavaScript SDK flow is used.
|
|
4365
|
+
* false = The PayPal JavaScript SDK flow is not used.
|
|
4366
|
+
Default value is false.
|
|
4367
|
+
default: false
|
|
4368
|
+
example: true
|
|
4369
|
+
References:
|
|
4370
|
+
type: object
|
|
4371
|
+
description: Object that holds all reference properties that are linked to this transaction.
|
|
4372
|
+
properties:
|
|
4373
|
+
descriptor:
|
|
4374
|
+
type: string
|
|
4375
|
+
description: |-
|
|
4376
|
+
Descriptive text that is used towards to customer, either during an online Checkout at a third party and/or
|
|
4377
|
+
on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor.
|
|
4378
|
+
The maximum allowed length varies per card acquirer:
|
|
4379
|
+
* AIB - 22 characters
|
|
4380
|
+
* American Express - 25 characters
|
|
4381
|
+
* Atos Origin BNP - 15 characters
|
|
4382
|
+
* Barclays - 25 characters
|
|
4383
|
+
* Catella - 22 characters
|
|
4384
|
+
* CBA - 20 characters
|
|
4385
|
+
* Elavon - 25 characters
|
|
4386
|
+
* First Data - 25 characters
|
|
4387
|
+
* INICIS (INIPAY) - 22-30 characters
|
|
4388
|
+
* JCB - 25 characters
|
|
4389
|
+
* Merchant Solutions - 22-25 characters
|
|
4390
|
+
* Payvision (EU & HK) - 25 characters
|
|
4391
|
+
* SEB Euroline - 22 characters
|
|
4392
|
+
* Sub1 Argentina - 15 characters
|
|
4393
|
+
* Wells Fargo - 25 characters
|
|
4394
|
+
|
|
4395
|
+
Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers
|
|
4396
|
+
will start to truncate. We currently also only allow per API call overrides for AIB and Barclays
|
|
4397
|
+
For alternative payment products the maximum allowed length varies per payment product:
|
|
4398
|
+
* 402 e-Przelewy - 30 characters
|
|
4399
|
+
* 404 INICIS - 80 characters
|
|
4400
|
+
* 802 Nordea ePayment Finland - 234 characters
|
|
4401
|
+
* 809 iDeal - 32 characters
|
|
4402
|
+
* 836 SOFORT - 42 characters
|
|
4403
|
+
* 840 PayPal - 127 characters
|
|
4404
|
+
* 841 WebMoney - 175 characters
|
|
4405
|
+
* 849 Yandex - 64 characters
|
|
4406
|
+
* 861 Alipay - 256 characters
|
|
4407
|
+
* 863 WeChat Pay - 32 characters
|
|
4408
|
+
* 880 BOKU - 20 characters
|
|
4409
|
+
* 8580 Qiwi - 255 characters
|
|
4410
|
+
* 1504 Konbini - 80 characters
|
|
4411
|
+
|
|
4412
|
+
All other payment products don't support a descriptor.
|
|
4413
|
+
maxLength: 256
|
|
4414
|
+
merchantReference:
|
|
4415
|
+
type: string
|
|
4416
|
+
description: |
|
|
4417
|
+
The merchantReference is a unique identifier for a payment and can be used for reporting purposes. The
|
|
4418
|
+
merchantReference is required for the execution of a payment and has to be unique. In case a payment has
|
|
4419
|
+
failed the same merchantReference can be used again.
|
|
4420
|
+
Once a successful payment has been made the same merchantReference can no longer be used and will be
|
|
4421
|
+
rejected.
|
|
4422
|
+
maxLength: 20
|
|
4423
|
+
example: 5a891df0b8cf11edaeb2af87d8ff0b2f
|
|
4424
|
+
merchantParameters:
|
|
4425
|
+
type: string
|
|
4426
|
+
description:
|
|
4427
|
+
It allows you to store additional parameters for the transaction in JSON format.
|
|
4428
|
+
This field must not contain any personal data.
|
|
4429
|
+
maxLength: 1000
|
|
4430
|
+
example: "{'SessionID':'126548354','ShopperID':'7354131'}"
|
|
4431
|
+
required:
|
|
4432
|
+
- merchantReference
|
|
4382
4433
|
RefreshPaymentRequest:
|
|
4383
4434
|
type: object
|
|
4384
4435
|
description: Request to refresh the payment status of a specific payment.
|
|
4385
4436
|
properties:
|
|
4386
4437
|
refreshType:
|
|
4387
|
-
$ref:
|
|
4438
|
+
$ref: "#/components/schemas/RefreshType"
|
|
4388
4439
|
required:
|
|
4389
4440
|
- refreshType
|
|
4390
4441
|
RefreshType:
|
|
@@ -4410,7 +4461,7 @@ components:
|
|
|
4410
4461
|
errors:
|
|
4411
4462
|
type: array
|
|
4412
4463
|
items:
|
|
4413
|
-
$ref:
|
|
4464
|
+
$ref: "#/components/schemas/APIError"
|
|
4414
4465
|
RefundOutput:
|
|
4415
4466
|
type: object
|
|
4416
4467
|
description: |
|
|
@@ -4418,7 +4469,7 @@ components:
|
|
|
4418
4469
|
additionalProperties: false
|
|
4419
4470
|
properties:
|
|
4420
4471
|
amountOfMoney:
|
|
4421
|
-
$ref:
|
|
4472
|
+
$ref: "#/components/schemas/AmountOfMoney"
|
|
4422
4473
|
merchantParameters:
|
|
4423
4474
|
type: string
|
|
4424
4475
|
description: |
|
|
@@ -4427,24 +4478,10 @@ components:
|
|
|
4427
4478
|
maxLength: 1000
|
|
4428
4479
|
example: "{'SessionID':'126548354','ShopperID':'7354131'}"
|
|
4429
4480
|
references:
|
|
4430
|
-
$ref:
|
|
4481
|
+
$ref: "#/components/schemas/PaymentReferences"
|
|
4431
4482
|
paymentMethod:
|
|
4432
4483
|
type: string
|
|
4433
4484
|
description: Payment method identifier used by the our payment engine.
|
|
4434
|
-
RefundRequest:
|
|
4435
|
-
type: object
|
|
4436
|
-
description: |
|
|
4437
|
-
Request to refund a payment for a Checkout. It is possible to perform multiple partial refunds by providing an
|
|
4438
|
-
amount that is lower than the total captured amount.
|
|
4439
|
-
The returnReason can be provided for reporting and reconciliation purposes but is not mandatory.
|
|
4440
|
-
additionalProperties: false
|
|
4441
|
-
properties:
|
|
4442
|
-
amountOfMoney:
|
|
4443
|
-
$ref: '#/components/schemas/PositiveAmountOfMoney'
|
|
4444
|
-
references:
|
|
4445
|
-
$ref: '#/components/schemas/PaymentReferences'
|
|
4446
|
-
return:
|
|
4447
|
-
$ref: '#/components/schemas/ReturnInformation'
|
|
4448
4485
|
RefundPaymentResponse:
|
|
4449
4486
|
type: object
|
|
4450
4487
|
description: |-
|
|
@@ -4454,15 +4491,29 @@ components:
|
|
|
4454
4491
|
additionalProperties: false
|
|
4455
4492
|
properties:
|
|
4456
4493
|
refundOutput:
|
|
4457
|
-
$ref:
|
|
4494
|
+
$ref: "#/components/schemas/RefundOutput"
|
|
4458
4495
|
status:
|
|
4459
|
-
$ref:
|
|
4496
|
+
$ref: "#/components/schemas/StatusValue"
|
|
4460
4497
|
statusOutput:
|
|
4461
|
-
$ref:
|
|
4498
|
+
$ref: "#/components/schemas/PaymentStatusOutput"
|
|
4462
4499
|
id:
|
|
4463
4500
|
type: string
|
|
4464
4501
|
description: Unique payment transaction identifier of the payment gateway.
|
|
4465
|
-
example:
|
|
4502
|
+
example: "3066019730_1"
|
|
4503
|
+
RefundRequest:
|
|
4504
|
+
type: object
|
|
4505
|
+
description: |
|
|
4506
|
+
Request to refund a payment for a Checkout. It is possible to perform multiple partial refunds by providing an
|
|
4507
|
+
amount that is lower than the total captured amount.
|
|
4508
|
+
The returnReason can be provided for reporting and reconciliation purposes but is not mandatory.
|
|
4509
|
+
additionalProperties: false
|
|
4510
|
+
properties:
|
|
4511
|
+
amountOfMoney:
|
|
4512
|
+
$ref: "#/components/schemas/PositiveAmountOfMoney"
|
|
4513
|
+
references:
|
|
4514
|
+
$ref: "#/components/schemas/PaymentReferences"
|
|
4515
|
+
return:
|
|
4516
|
+
$ref: "#/components/schemas/ReturnInformation"
|
|
4466
4517
|
ReturnInformation:
|
|
4467
4518
|
type: object
|
|
4468
4519
|
description: |-
|
|
@@ -4480,7 +4531,7 @@ components:
|
|
|
4480
4531
|
description: |-
|
|
4481
4532
|
Items returned.
|
|
4482
4533
|
items:
|
|
4483
|
-
$ref:
|
|
4534
|
+
$ref: "#/components/schemas/CartItemInput"
|
|
4484
4535
|
ReturnItem:
|
|
4485
4536
|
type: object
|
|
4486
4537
|
properties:
|
|
@@ -4513,7 +4564,7 @@ components:
|
|
|
4513
4564
|
The returnReason can be provided for reporting and reconciliation purposes but is not mandatory.
|
|
4514
4565
|
properties:
|
|
4515
4566
|
returnType:
|
|
4516
|
-
$ref:
|
|
4567
|
+
$ref: "#/components/schemas/ReturnType"
|
|
4517
4568
|
returnReason:
|
|
4518
4569
|
type: string
|
|
4519
4570
|
description: |-
|
|
@@ -4523,14 +4574,14 @@ components:
|
|
|
4523
4574
|
returnItems:
|
|
4524
4575
|
type: array
|
|
4525
4576
|
items:
|
|
4526
|
-
$ref:
|
|
4577
|
+
$ref: "#/components/schemas/ReturnItem"
|
|
4527
4578
|
ReturnResponse:
|
|
4528
4579
|
type: object
|
|
4529
4580
|
properties:
|
|
4530
4581
|
returnPaymentResponse:
|
|
4531
|
-
$ref:
|
|
4582
|
+
$ref: "#/components/schemas/RefundPaymentResponse"
|
|
4532
4583
|
shoppingCart:
|
|
4533
|
-
$ref:
|
|
4584
|
+
$ref: "#/components/schemas/ShoppingCartResult"
|
|
4534
4585
|
ReturnType:
|
|
4535
4586
|
type: string
|
|
4536
4587
|
description: |
|
|
@@ -4553,15 +4604,18 @@ components:
|
|
|
4553
4604
|
additionalProperties: false
|
|
4554
4605
|
properties:
|
|
4555
4606
|
paymentProduct771SpecificInput:
|
|
4556
|
-
$ref:
|
|
4607
|
+
$ref: "#/components/schemas/SepaDirectDebitPaymentProduct771SpecificInput"
|
|
4557
4608
|
paymentProductId:
|
|
4558
|
-
|
|
4559
|
-
|
|
4560
|
-
|
|
4561
|
-
|
|
4562
|
-
|
|
4563
|
-
|
|
4564
|
-
|
|
4609
|
+
$ref: "#/components/schemas/PaymentProductId"
|
|
4610
|
+
SepaDirectDebitPaymentMethodSpecificOutput:
|
|
4611
|
+
type: object
|
|
4612
|
+
description: Object containing the SEPA direct debit details.
|
|
4613
|
+
additionalProperties: false
|
|
4614
|
+
properties:
|
|
4615
|
+
paymentProductId:
|
|
4616
|
+
$ref: "#/components/schemas/PaymentProductId"
|
|
4617
|
+
paymentProduct771SpecificOutput:
|
|
4618
|
+
$ref: "#/components/schemas/PaymentProduct771SpecificOutput"
|
|
4565
4619
|
SepaDirectDebitPaymentProduct771SpecificInput:
|
|
4566
4620
|
type: object
|
|
4567
4621
|
description: Object containing information specific to SEPA Direct Debit
|
|
@@ -4569,30 +4623,15 @@ components:
|
|
|
4569
4623
|
existingUniqueMandateReference:
|
|
4570
4624
|
type: string
|
|
4571
4625
|
description: The unique reference of the existing mandate to use in this payment.
|
|
4572
|
-
example:
|
|
4626
|
+
example: "exampleMandateReference"
|
|
4573
4627
|
mandate:
|
|
4574
|
-
$ref:
|
|
4575
|
-
SepaDirectDebitPaymentMethodSpecificOutput:
|
|
4576
|
-
type: object
|
|
4577
|
-
description: Object containing the SEPA direct debit details.
|
|
4578
|
-
additionalProperties: false
|
|
4579
|
-
properties:
|
|
4580
|
-
paymentProductId:
|
|
4581
|
-
type: integer
|
|
4582
|
-
format: int32
|
|
4583
|
-
maximum: 99999
|
|
4584
|
-
minimum: 0
|
|
4585
|
-
description: |-
|
|
4586
|
-
Payment product identifier - please check product documentation for a full overview of possible values.
|
|
4587
|
-
example: 840
|
|
4588
|
-
paymentProduct771SpecificOutput:
|
|
4589
|
-
$ref: '#/components/schemas/PaymentProduct771SpecificOutput'
|
|
4628
|
+
$ref: "#/components/schemas/ProcessingMandateInformation"
|
|
4590
4629
|
SepaTransferPaymentProduct772SpecificInput:
|
|
4591
4630
|
type: object
|
|
4592
4631
|
description: Object containing the specific input details for SEPA credit transfers excluding cross-border ones
|
|
4593
4632
|
properties:
|
|
4594
4633
|
bankAccountInformation:
|
|
4595
|
-
$ref:
|
|
4634
|
+
$ref: "#/components/schemas/BankAccountInformation"
|
|
4596
4635
|
Shipping:
|
|
4597
4636
|
type: object
|
|
4598
4637
|
description: |
|
|
@@ -4600,7 +4639,7 @@ components:
|
|
|
4600
4639
|
additionalProperties: false
|
|
4601
4640
|
properties:
|
|
4602
4641
|
address:
|
|
4603
|
-
$ref:
|
|
4642
|
+
$ref: "#/components/schemas/AddressPersonal"
|
|
4604
4643
|
ShoppingCartInput:
|
|
4605
4644
|
type: object
|
|
4606
4645
|
description: |
|
|
@@ -4609,7 +4648,7 @@ components:
|
|
|
4609
4648
|
items:
|
|
4610
4649
|
type: array
|
|
4611
4650
|
items:
|
|
4612
|
-
$ref:
|
|
4651
|
+
$ref: "#/components/schemas/CartItemInput"
|
|
4613
4652
|
ShoppingCartPatch:
|
|
4614
4653
|
type: object
|
|
4615
4654
|
description: |
|
|
@@ -4618,7 +4657,7 @@ components:
|
|
|
4618
4657
|
items:
|
|
4619
4658
|
type: array
|
|
4620
4659
|
items:
|
|
4621
|
-
$ref:
|
|
4660
|
+
$ref: "#/components/schemas/CartItemPatch"
|
|
4622
4661
|
ShoppingCartResult:
|
|
4623
4662
|
type: object
|
|
4624
4663
|
description: |
|
|
@@ -4627,7 +4666,7 @@ components:
|
|
|
4627
4666
|
items:
|
|
4628
4667
|
type: array
|
|
4629
4668
|
items:
|
|
4630
|
-
$ref:
|
|
4669
|
+
$ref: "#/components/schemas/CartItemResult"
|
|
4631
4670
|
StatusCategoryValue:
|
|
4632
4671
|
type: string
|
|
4633
4672
|
description: Highlevel status of the payment, payout or Refund.
|
|
@@ -4800,4 +4839,4 @@ components:
|
|
|
4800
4839
|
enum:
|
|
4801
4840
|
- first
|
|
4802
4841
|
- subsequent
|
|
4803
|
-
x-enum-to-string: false
|
|
4842
|
+
x-enum-to-string: false
|