generated from Apodini/Template-Repository
-
Notifications
You must be signed in to change notification settings - Fork 0
/
adyen-payment-25.yaml
3739 lines (3531 loc) · 164 KB
/
adyen-payment-25.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
servers:
- url: https://pal-test.adyen.com/pal/servlet/Payment/v25
info:
contact:
email: [email protected]
name: Adyen Developer Experience team
url: https://www.adyen.help/hc/en-us/community/topics
x-twitter: Adyen
description: |-
A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.
To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).
## Authentication
To connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:
```
curl
-U "[email protected]":"YourWsPassword" \
-H "Content-Type: application/json" \
...
```
Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).
## Versioning
Payments API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.
For example:
```
https://pal-test.adyen.com/pal/servlet/Payment/v25/authorise
```
termsOfService: https://www.adyen.com/legal/terms-and-conditions
title: Adyen Payment API
version: "25"
x-apisguru-categories:
- payment
x-logo:
url: https://twitter.com/Adyen/profile_image?size=original
x-origin:
- converter:
url: https://github.com/mermade/oas-kit
version: 7.0.4
format: openapi
url: https://raw.githubusercontent.com/Adyen/adyen-openapi/master/json/PaymentService-v25.json
version: "3.1"
x-preferred: false
x-providerName: adyen.com
x-publicVersion: true
x-serviceName: PaymentService
paths:
/authorise:
post:
description: |-
Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.
> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.
operationId: post-authorise
requestBody:
content:
application/json:
examples:
authorise-3dsecure:
$ref: "#/components/examples/post-authorise-authorise-3dsecure"
authorise-card:
$ref: "#/components/examples/post-authorise-authorise-card"
authorise-recurringcontauth:
$ref: "#/components/examples/post-authorise-authorise-recurringcontauth"
authorise-recurringoneclick:
$ref: "#/components/examples/post-authorise-authorise-recurringoneclick"
authorise-recurringstore:
$ref: "#/components/examples/post-authorise-authorise-recurringstore"
schema:
$ref: "#/components/schemas/PaymentRequest"
responses:
"200":
content:
application/json:
examples:
authorise-recurringcontauth:
$ref: "#/components/examples/post-authorise-authorise-recurringcontauth-200"
schema:
$ref: "#/components/schemas/PaymentResult"
description: OK - the request has succeeded.
"400":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-400"
schema:
$ref: "#/components/schemas/ServiceError"
description: Bad Request - a problem reading or understanding the request.
"401":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-401"
schema:
$ref: "#/components/schemas/ServiceError"
description: Unauthorized - authentication required.
"403":
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceError"
description: Forbidden - insufficient permissions to process the request.
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceError"
description: Unprocessable Entity - a request validation error.
"500":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-500"
schema:
$ref: "#/components/schemas/ServiceError"
description: Internal Server Error - the server could not process the request.
security:
- BasicAuth: []
- ApiKeyAuth: []
summary: Creates a payment authorisation.
tags:
- General
x-groupName: General
x-sortIndex: 1
/authorise3d:
post:
description: |-
For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.
> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.
operationId: post-authorise3d
requestBody:
content:
application/json:
examples:
authorise3d:
$ref: "#/components/examples/post-authorise3d-authorise3d"
schema:
$ref: "#/components/schemas/PaymentRequest3d"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/PaymentResult"
description: OK - the request has succeeded.
"400":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-400"
schema:
$ref: "#/components/schemas/ServiceError"
description: Bad Request - a problem reading or understanding the request.
"401":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-401"
schema:
$ref: "#/components/schemas/ServiceError"
description: Unauthorized - authentication required.
"403":
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceError"
description: Forbidden - insufficient permissions to process the request.
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceError"
description: Unprocessable Entity - a request validation error.
"500":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-500"
schema:
$ref: "#/components/schemas/ServiceError"
description: Internal Server Error - the server could not process the request.
security:
- BasicAuth: []
- ApiKeyAuth: []
summary: Completes a 3D Secure payment authorisation.
tags:
- General
x-groupName: General
x-sortIndex: 2
/cancel:
post:
description: |-
Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures.
For more information, refer to [Cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel).
> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/cancels) endpoint under Checkout API instead.
operationId: post-cancel
requestBody:
content:
application/json:
examples:
cancel:
$ref: "#/components/examples/post-cancel-cancel"
schema:
$ref: "#/components/schemas/CancelRequest"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ModificationResult"
description: OK - the request has succeeded.
"400":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-400"
schema:
$ref: "#/components/schemas/ServiceError"
description: Bad Request - a problem reading or understanding the request.
"401":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-401"
schema:
$ref: "#/components/schemas/ServiceError"
description: Unauthorized - authentication required.
"403":
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceError"
description: Forbidden - insufficient permissions to process the request.
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceError"
description: Unprocessable Entity - a request validation error.
"500":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-500"
schema:
$ref: "#/components/schemas/ServiceError"
description: Internal Server Error - the server could not process the request.
security:
- BasicAuth: []
- ApiKeyAuth: []
summary: Cancels an authorised payment.
tags:
- Modifications
x-groupName: Modifications
x-sortIndex: 2
/cancelOrRefund:
post:
description: |-
Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).
Do not use this endpoint for payments that involve:
* [Multiple partial captures](https://docs.adyen.com/online-payments/capture).
* [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.
Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.
For more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).
> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.
operationId: post-cancelOrRefund
requestBody:
content:
application/json:
examples:
cancelOrRefund:
$ref: "#/components/examples/post-cancelOrRefund-cancelOrRefund"
schema:
$ref: "#/components/schemas/CancelOrRefundRequest"
responses:
"200":
content:
application/json:
examples:
cancelOrRefund:
$ref: "#/components/examples/post-cancelOrRefund-cancelOrRefund-200"
schema:
$ref: "#/components/schemas/ModificationResult"
description: OK - the request has succeeded.
"400":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-400"
schema:
$ref: "#/components/schemas/ServiceError"
description: Bad Request - a problem reading or understanding the request.
"401":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-401"
schema:
$ref: "#/components/schemas/ServiceError"
description: Unauthorized - authentication required.
"403":
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceError"
description: Forbidden - insufficient permissions to process the request.
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceError"
description: Unprocessable Entity - a request validation error.
"500":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-500"
schema:
$ref: "#/components/schemas/ServiceError"
description: Internal Server Error - the server could not process the request.
security:
- BasicAuth: []
- ApiKeyAuth: []
summary: Cancels or refunds a payment.
tags:
- Modifications
x-groupName: Modifications
x-sortIndex: 4
/capture:
post:
description: |+
Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, however it's also possible to capture a smaller amount, which results in cancelling the remaining authorisation balance.
Payment methods that are captured automatically after authorisation don't need to be captured. However, submitting a capture request on these transactions will not result in double charges. If immediate or delayed auto-capture is enabled, calling the capture method is not neccessary.
For more information refer to [Capture](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/capture).
> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/captures`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/captures) endpoint on Checkout API instead.
operationId: post-capture
requestBody:
content:
application/json:
examples:
capture:
$ref: "#/components/examples/post-capture-capture"
schema:
$ref: "#/components/schemas/CaptureRequest"
responses:
"200":
content:
application/json:
examples:
capture:
$ref: "#/components/examples/post-capture-capture-200"
schema:
$ref: "#/components/schemas/ModificationResult"
description: OK - the request has succeeded.
"400":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-400"
schema:
$ref: "#/components/schemas/ServiceError"
description: Bad Request - a problem reading or understanding the request.
"401":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-401"
schema:
$ref: "#/components/schemas/ServiceError"
description: Unauthorized - authentication required.
"403":
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceError"
description: Forbidden - insufficient permissions to process the request.
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceError"
description: Unprocessable Entity - a request validation error.
"500":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-500"
schema:
$ref: "#/components/schemas/ServiceError"
description: Internal Server Error - the server could not process the request.
security:
- BasicAuth: []
- ApiKeyAuth: []
summary: Captures an authorised payment.
tags:
- Modifications
x-groupName: Modifications
x-sortIndex: 1
/refund:
post:
description: |-
Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a partial amount. Multiple (partial) refunds will be accepted as long as their sum doesn't exceed the captured amount. Payments which have been authorised, but not captured, cannot be refunded, use the /cancel method instead.
Some payment methods/gateways do not support partial/multiple refunds.
A margin above the captured limit can be configured to cover shipping/handling costs.
For more information, refer to [Refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/refund).
> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/refunds`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/refunds) endpoint under Checkout API instead.
operationId: post-refund
requestBody:
content:
application/json:
examples:
refund:
$ref: "#/components/examples/post-refund-refund"
schema:
$ref: "#/components/schemas/RefundRequest"
responses:
"200":
content:
application/json:
examples:
refund:
$ref: "#/components/examples/post-refund-refund-200"
schema:
$ref: "#/components/schemas/ModificationResult"
description: OK - the request has succeeded.
"400":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-400"
schema:
$ref: "#/components/schemas/ServiceError"
description: Bad Request - a problem reading or understanding the request.
"401":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-401"
schema:
$ref: "#/components/schemas/ServiceError"
description: Unauthorized - authentication required.
"403":
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceError"
description: Forbidden - insufficient permissions to process the request.
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceError"
description: Unprocessable Entity - a request validation error.
"500":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-500"
schema:
$ref: "#/components/schemas/ServiceError"
description: Internal Server Error - the server could not process the request.
security:
- BasicAuth: []
- ApiKeyAuth: []
summary: Refunds a captured payment.
tags:
- Modifications
x-groupName: Modifications
x-sortIndex: 3
/voidPendingRefund:
post:
description: |-
This endpoint allows you to cancel the refund request before it has been completed.
In your call, you can refer to the original refund request either by using the `tenderReference`, or the `pspReference`. We recommend implementing based on the `tenderReference`, as this is generated for both offline and online transactions.
For more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).
operationId: post-voidPendingRefund
requestBody:
content:
application/json:
examples:
voidpendingrefund-pspreference:
$ref: "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference"
voidpendingrefund-tenderreference:
$ref: "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference"
schema:
$ref: "#/components/schemas/VoidPendingRefundRequest"
responses:
"200":
content:
application/json:
examples:
voidpendingrefund-pspreference:
$ref: "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200"
voidpendingrefund-tenderreference:
$ref: "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200"
schema:
$ref: "#/components/schemas/ModificationResult"
description: OK - the request has succeeded.
"400":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-400"
schema:
$ref: "#/components/schemas/ServiceError"
description: Bad Request - a problem reading or understanding the request.
"401":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-401"
schema:
$ref: "#/components/schemas/ServiceError"
description: Unauthorized - authentication required.
"403":
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceError"
description: Forbidden - insufficient permissions to process the request.
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceError"
description: Unprocessable Entity - a request validation error.
"500":
content:
application/json:
examples:
generic:
$ref: "#/components/examples/generic-500"
schema:
$ref: "#/components/schemas/ServiceError"
description: Internal Server Error - the server could not process the request.
security:
- BasicAuth: []
- ApiKeyAuth: []
summary: Cancels a POS refund request before it has been completed.
tags:
- Modifications
x-addedInVersion: "25"
x-groupName: Modifications
x-sortIndex: 7
components:
examples:
generic-400:
summary: Response code 400. Bad request.
value:
errorCode: "702"
errorType: validation
message: 'Unexpected input: ", expected: }'
status: 400
generic-401:
summary: Response code 401. Unauthorized.
value:
errorCode: "000"
errorType: security
message: HTTP Status Response - Unauthorized
status: 401
generic-500:
summary: Response code 500. Internal server error.
value:
errorCode: "905"
errorType: configuration
message: Payment details are not supported
pspReference: "8516091485743033"
status: 500
post-authorise-authorise-3dsecure:
summary: Initiate a 3D Secure payment
value:
amount:
currency: EUR
value: 1500
browserInfo:
acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0
card:
cvc: "737"
expiryMonth: "03"
expiryYear: "2030"
holderName: John Smith
number: "5212345678901234"
merchantAccount: YOUR_MERCHANT_ACCOUNT
reference: YOUR_REFERENCE
post-authorise-authorise-card:
summary: Authorise a card payment
value:
amount:
currency: EUR
value: 1500
card:
cvc: "737"
expiryMonth: "03"
expiryYear: "2030"
holderName: John Smith
number: "4111111111111111"
merchantAccount: YOUR_MERCHANT_ACCOUNT
reference: YOUR_REFERENCE
post-authorise-authorise-recurringcontauth:
summary: Authorise a recurring payment
value:
amount:
currency: EUR
value: 2000
merchantAccount: YOUR_MERCHANT_ACCOUNT
recurring:
contract: RECURRING
reference: YOUR_REFERENCE
selectedRecurringDetailReference: LATEST
shopperEmail: [email protected]
shopperIP: 61.294.12.12
shopperInteraction: ContAuth
shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j
post-authorise-authorise-recurringcontauth-200:
summary: Example response for request 'authorise-recurringcontauth'
value:
additionalData:
recurring.recurringDetailReference: "8316172010100170"
recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j
recurringProcessingModel: CardOnFile
authCode: "065914"
pspReference: 852617895343904C
resultCode: Authorised
post-authorise-authorise-recurringoneclick:
summary: Authorise a one-click payment
value:
amount:
currency: EUR
value: 2000
card:
cvc: "737"
merchantAccount: YOUR_MERCHANT_ACCOUNT
recurring:
contract: ONECLICK
reference: YOUR_REFERENCE
selectedRecurringDetailReference: LATEST
shopperEmail: [email protected]
shopperIP: 61.294.12.12
shopperInteraction: Ecommerce
shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j
post-authorise-authorise-recurringstore:
summary: Store card details for recurring payments
value:
amount:
currency: EUR
value: 2000
card:
cvc: "737"
expiryMonth: "03"
expiryYear: "2030"
holderName: John Smith
number: "4111111111111111"
merchantAccount: YOUR_MERCHANT_ACCOUNT
recurring:
contract: RECURRING,ONECLICK
reference: YOUR_REFERENCE
shopperEmail: [email protected]
shopperIP: 61.294.12.12
shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j
post-authorise3d-authorise3d:
summary: Complete a 3D Secure payment
value:
md: 31h..........vOXek7w
merchantAccount: YOUR_MERCHANT_ACCOUNT
paResponse: eNqtmF........wGVA4Ch
shopperIP: 61.294.12.12
post-cancel-cancel:
summary: Cancel an authorised payment
value:
merchantAccount: YOUR_MERCHANT_ACCOUNT
originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE
reference: YourModificationReference
post-cancelOrRefund-cancelOrRefund:
summary: Cancel or refund a payment
value:
merchantAccount: YOUR_MERCHANT_ACCOUNT
originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE
reference: YourModificationReference
post-cancelOrRefund-cancelOrRefund-200:
summary: Example response for request 'cancelOrRefund'
value:
pspReference: 851617892359708H
response: "[cancelOrRefund-received]"
post-capture-capture:
summary: Capture an authorised payment
value:
merchantAccount: YOUR_MERCHANT_ACCOUNT
modificationAmount:
currency: EUR
value: 500
originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE
reference: YOUR_REFERENCE
post-capture-capture-200:
summary: Example response for request 'capture'
value:
pspReference: 861617892359057J
response: "[capture-received]"
post-refund-refund:
summary: Refund a captured payment
value:
merchantAccount: YOUR_MERCHANT_ACCOUNT
modificationAmount:
currency: EUR
value: 500
originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE
reference: YOUR_REFERENCE
post-refund-refund-200:
summary: Example response for request 'refund'
value:
pspReference: 861617892360059B
response: "[refund-received]"
post-voidPendingRefund-voidpendingrefund-pspreference:
summary: Cancel a POS refund request with PSP reference before it has been completed
value:
merchantAccount: YOUR_MERCHANT_ACCOUNT
originalReference: "9914748988390044"
post-voidPendingRefund-voidpendingrefund-pspreference-200:
summary: Example response for request 'voidpendingrefund-pspreference'
value:
pspReference: 861617892360062F
response: "[voidPendingRefund-received]"
post-voidPendingRefund-voidpendingrefund-tenderreference:
summary: Cancels a POS refund request with tender reference before it has been completed
value:
merchantAccount: YOUR_MERCHANT_ACCOUNT
tenderReference: 5Iw8001176969533005
uniqueTerminalId: VX820-123456789
post-voidPendingRefund-voidpendingrefund-tenderreference-200:
summary: Example response for request 'voidpendingrefund-tenderreference'
value:
pspReference: 881617892360409G
response: "[voidPendingRefund-received]"
schemas:
AdditionalData3DSecure:
properties:
allow3DS2:
description: |
Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).
> This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.
Possible values:
* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.
* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.
type: string
executeThreeD:
description: |
Indicates if you want to perform 3D Secure authentication on a transaction.
> Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.
Possible values:
* **true** – Perform 3D Secure authentication.
* **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations.
type: string
mpiImplementationType:
description: In case of Secure+, this field must be set to **CUPSecurePlus**.
type: string
scaExemption:
description: |-
Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.
Possible values:
* **lowValue**
* **secureCorporate**
* **trustedBeneficiary**
* **transactionRiskAnalysis**
type: string
threeDSVersion:
description: |+
Indicates your preference for the 3D Secure version.
> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.
Possible values:
* **1.0.2**: Apply 3D Secure version 1.0.2.
* **2.1.0**: Apply 3D Secure version 2.1.0.
* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.
The following rules apply:
* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.
* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.
type: string
AdditionalDataAirline:
properties:
airline.agency_invoice_number:
description: |-
Reference number for the invoice, issued by the agency.
* minLength: 1
* maxLength: 6
type: string
airline.agency_plan_name:
description: |-
2-letter agency plan identifier; alphabetical.
* minLength: 2
* maxLength: 2
type: string
airline.airline_code:
description: |-
[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX); numeric. It identifies the carrier.
* Format: IATA 3-digit accounting code (PAX)
* Example: KLM = 074
* minLength: 3
* maxLength: 3
type: string
airline.airline_designator_code:
description: |-
[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.
* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code
* Example: KLM = KL
* minLength: 2
* maxLength: 2
type: string
airline.boarding_fee:
description: |-
Chargeable amount for boarding the plane.
The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
* minLength: 1
* maxLength: 18
type: string
airline.computerized_reservation_system:
description: |-
The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.
* Format: alphanumeric.
* minLength: 4
* maxLength: 4
type: string
airline.customer_reference_number:
description: |-
Reference number; alphanumeric.
* minLength: 0
* maxLength: 20
type: string
airline.document_type:
description: |-
Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements.
* Format: 2-digit code
* Example: Passenger ticket = 01
* minLength: 2
* maxLength: 2
type: string
airline.flight_date:
description: |-
Flight departure date. Local time `(HH:mm)` is optional.
* Date format: `yyyy-MM-dd`
* Date and time format: `yyyy-MM-dd HH:mm`
* minLength: 10
* maxLength: 16
type: string
airline.leg.carrier_code:
description: |-
[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.
This field is required/mandatory if the airline data includes leg details.
* Format: IATA 2-letter airline code
* Example: KLM = KL
* minLength: 2
* maxLength: 2
type: string
airline.leg.class_of_travel:
description: |-
1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently:
* F: first class
* J: business class
* Y: economy class
* W: premium economy
Limitations:
* minLength: 1
* maxLength: 1
type: string
airline.leg.date_of_travel:
description: |-
Date and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.
* Format: `yyyy-MM-dd HH:mm`
* minLength: 16
* maxLength: 16
type: string
airline.leg.depart_airport:
description: |-
Alphabetical identifier of the departure airport.
This field is required if the airline data includes leg details.
* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.
* Example: Amsterdam = AMS
* minLength: 3
* maxLength: 3
type: string
airline.leg.depart_tax:
description: |-
[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).
* minLength: 1
* maxLength: 12
type: string
airline.leg.destination_code:
description: |-
Alphabetical identifier of the destination/arrival airport.
This field is required/mandatory if the airline data includes leg details.
* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.
* Example: Amsterdam = AMS
* minLength: 3
* maxLength: 3
type: string
airline.leg.fare_base_code:
description: |-
[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric.
* minLength: 1
* maxLength: 7
type: string
airline.leg.flight_number:
description: |-
The flight identifier.
* minLength: 1
* maxLength: 5
type: string
airline.leg.stop_over_code:
description: |-
1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed:
* O: Stopover allowed
* X: Stopover not allowed
Limitations:
* minLength: 1
* maxLength: 1
type: string
airline.passenger.date_of_birth:
description: |-
Date of birth of the passenger.
Date format: `yyyy-MM-dd`
* minLength: 10
* maxLength: 10
type: string
airline.passenger.first_name:
description: |-
Passenger first name/given name.
> This field is required/mandatory if the airline data includes passenger details or leg details.
type: string
airline.passenger.last_name:
description: |-
Passenger last name/family name.
> This field is required/mandatory if the airline data includes passenger details or leg details.
type: string
airline.passenger.telephone_number:
description: |-
Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs.
* minLength: 3
* maxLength: 30
type: string
airline.passenger.traveller_type:
description: |-
Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS.
However, several carriers use non-standard codes that can be up to 5 alphanumeric characters.
* minLength: 3
* maxLength: 6
type: string
airline.passenger_name:
description: |-
Passenger name, initials, and a title.
* Format: last name + first name or initials + title.
* Example: *FLYER / MARY MS*.