-
Notifications
You must be signed in to change notification settings - Fork 50
/
CheckoutService-v51.json
3505 lines (3505 loc) · 188 KB
/
CheckoutService-v51.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi" : "3.0.0",
"servers" : [
{
"url" : "https://checkout-test.adyen.com/v51"
}
],
"info" : {
"version" : "51",
"title" : "Adyen Checkout API",
"description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including One-Click and 3D Secure), mobile wallets, and local payment methods (e.g. iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/checkout).\n\n## Authentication\nEach request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/user-management/how-to-get-the-api-key). Then set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: Your_Checkout_API_key\" \\\n...\n```\nNote that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nCheckout 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.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v51/payments\n```",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Support",
"url" : "https://support.adyen.com/",
"email" : "support@adyen.com"
}
},
"x-groups" : [
"API Integration",
"SDK Integration"
],
"paths" : {
"/paymentLinks" : {
"post" : {
"summary" : "Creates a payment link.",
"description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/checkout/pay-by-link#create-payment-links-through-api).",
"x-groupName" : "API Integration",
"x-sortIndex" : 8,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreatePaymentLinkRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreatePaymentLinkResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"description" : "Bad Request - a problem reading or understanding the request."
},
"422" : {
"description" : "Unprocessable Entity - a request validation error."
},
"401" : {
"description" : "Unauthorized - authentication required."
},
"500" : {
"description" : "Internal Server Error - the server could not process the request."
},
"403" : {
"description" : "Forbidden - insufficient permissions to process the request."
}
}
}
},
"/paymentMethods" : {
"post" : {
"summary" : "Returns available payment methods.",
"description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.",
"x-groupName" : "API Integration",
"x-sortIndex" : 1,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentMethodsRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentMethodsResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"description" : "Bad Request - a problem reading or understanding the request."
},
"422" : {
"description" : "Unprocessable Entity - a request validation error."
},
"401" : {
"description" : "Unauthorized - authentication required."
},
"500" : {
"description" : "Internal Server Error - the server could not process the request."
},
"403" : {
"description" : "Forbidden - insufficient permissions to process the request."
}
}
}
},
"/paymentSession" : {
"post" : {
"summary" : "Creates a payment session.",
"description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/checkout#howitworks).",
"x-groupName" : "SDK Integration",
"x-sortIndex" : 1,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentSetupRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentSetupResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"description" : "Bad Request - a problem reading or understanding the request."
},
"422" : {
"description" : "Unprocessable Entity - a request validation error."
},
"401" : {
"description" : "Unauthorized - authentication required."
},
"500" : {
"description" : "Internal Server Error - the server could not process the request."
},
"403" : {
"description" : "Forbidden - insufficient permissions to process the request."
}
}
}
},
"/payments" : {
"post" : {
"summary" : "Starts a transaction.",
"description" : "Sends payment parameters (like amount, country, and currency) together with the input details collected from the shopper. The response returns the result of the payment request:\n* For some payment methods (e.g. Visa, Mastercard, and SEPA Direct Debits) you'll get a final state in the `resultCode` (e.g. `authorised` or `refused`).\n* For other payment methods, you'll receive `redirectShopper` as `resultCode` together with a `redirectUrl`. In this case, the shopper must finalize the payment on the page behind the `redirectUrl`.",
"x-groupName" : "API Integration",
"x-sortIndex" : 2,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"description" : "Bad Request - a problem reading or understanding the request."
},
"422" : {
"description" : "Unprocessable Entity - a request validation error."
},
"401" : {
"description" : "Unauthorized - authentication required."
},
"500" : {
"description" : "Internal Server Error - the server could not process the request."
},
"403" : {
"description" : "Forbidden - insufficient permissions to process the request."
}
}
}
},
"/payments/details" : {
"post" : {
"summary" : "Submits details for a payment.",
"description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request (for example for 3D Secure, or when getting redirected back directly from a payment method using an app switch).\n\nThe exact details, which need to be sent to this endpoint, are always specified in the response of the associated `/payments` request.\n\nIn addition, the endpoint can be used to verify a `payload`, which is returned after coming back from the Checkout SDK or any of the redirect based methods on the Checkout API.",
"x-groupName" : "API Integration",
"x-sortIndex" : 3,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DetailsRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"description" : "Bad Request - a problem reading or understanding the request."
},
"422" : {
"description" : "Unprocessable Entity - a request validation error."
},
"401" : {
"description" : "Unauthorized - authentication required."
},
"500" : {
"description" : "Internal Server Error - the server could not process the request."
},
"403" : {
"description" : "Forbidden - insufficient permissions to process the request."
}
}
}
},
"/payments/result" : {
"post" : {
"summary" : "Verifies payment result.",
"description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/checkout#howitworks).",
"x-groupName" : "SDK Integration",
"x-sortIndex" : 2,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentVerificationRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentVerificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"description" : "Bad Request - a problem reading or understanding the request."
},
"422" : {
"description" : "Unprocessable Entity - a request validation error."
},
"401" : {
"description" : "Unauthorized - authentication required."
},
"500" : {
"description" : "Internal Server Error - the server could not process the request."
},
"403" : {
"description" : "Forbidden - insufficient permissions to process the request."
}
}
}
}
},
"components" : {
"schemas" : {
"AccountInfo" : {
"properties" : {
"accountAgeIndicator" : {
"description" : "Indicator for the length of time since this shopper account was created in the merchant's environment.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days",
"enum" : [
"notApplicable",
"thisTransaction",
"lessThan30Days",
"from30To60Days",
"moreThan60Days"
],
"type" : "string"
},
"accountChangeDate" : {
"description" : "Date when the shopper's account was last changed.",
"format" : "date-time",
"type" : "string"
},
"accountChangeIndicator" : {
"description" : "Indicator for the length of time since the shopper's account was last updated.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days",
"enum" : [
"thisTransaction",
"lessThan30Days",
"from30To60Days",
"moreThan60Days"
],
"type" : "string"
},
"accountCreationDate" : {
"description" : "Date when the shopper's account was created.",
"format" : "date-time",
"type" : "string"
},
"accountType" : {
"description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit",
"enum" : [
"notApplicable",
"credit",
"debit"
],
"type" : "string"
},
"addCardAttemptsDay" : {
"description" : "Number of attempts the shopper tried to add a card to their account in the last day.",
"format" : "int32",
"type" : "integer"
},
"deliveryAddressUsageDate" : {
"description" : "Date the selected delivery address was first used.",
"format" : "date-time",
"type" : "string"
},
"deliveryAddressUsageIndicator" : {
"description" : "Indicator for the length of time since this delivery address was first used.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days",
"enum" : [
"thisTransaction",
"lessThan30Days",
"from30To60Days",
"moreThan60Days"
],
"type" : "string"
},
"homePhone" : {
"description" : "Shopper's home phone number (including the country code).",
"type" : "string"
},
"mobilePhone" : {
"description" : "Shopper's mobile phone number (including the country code).",
"type" : "string"
},
"passwordChangeDate" : {
"description" : "Date when the shopper last changed their password.",
"format" : "date-time",
"type" : "string"
},
"passwordChangeIndicator" : {
"description" : "Indicator when the shopper has changed their password.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days",
"enum" : [
"notApplicable",
"thisTransaction",
"lessThan30Days",
"from30To60Days",
"moreThan60Days"
],
"type" : "string"
},
"pastTransactionsDay" : {
"description" : "Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.",
"format" : "int32",
"type" : "integer"
},
"pastTransactionsYear" : {
"description" : "Number of all transactions (successful and abandoned) from this shopper in the past year.",
"format" : "int32",
"type" : "integer"
},
"paymentAccountAge" : {
"description" : "Date this payment method was added to the shopper's account.",
"format" : "date-time",
"type" : "string"
},
"paymentAccountIndicator" : {
"description" : "Indicator for the length of time since this payment method was added to this shopper's account.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days",
"enum" : [
"notApplicable",
"thisTransaction",
"lessThan30Days",
"from30To60Days",
"moreThan60Days"
],
"type" : "string"
},
"purchasesLast6Months" : {
"description" : "Number of successful purchases in the last six months.",
"format" : "int32",
"type" : "integer"
},
"suspiciousActivity" : {
"description" : "Whether suspicious activity was recorded on this account.",
"type" : "boolean"
},
"workPhone" : {
"description" : "Shopper's work phone number (including the country code).",
"type" : "string"
}
}
},
"AdditionalDataCommon" : {
"properties" : {
"authorisationType" : {
"description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/checkout/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.",
"type" : "string"
},
"customRoutingFlag" : {
"description" : "Allows you to determine or override the acquirer account that should be used for the transaction.\n\nIf you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer.\n\nTo enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).",
"type" : "string"
},
"networkTxReference" : {
"description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardonFile** to ensure that the transaction is classified as MIT.",
"type" : "string"
},
"overwriteBrand" : {
"description" : "Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.",
"type" : "string"
},
"RequestedTestErrorResponseCode" : {
"description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.",
"type" : "string"
},
"subMerchantID" : {
"description" : "This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID, which is used by schemes to identify the merchant.\n\nA unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator.\n* Format: alpha-numeric.\n* Fixed length: 15 characters.",
"type" : "string"
}
}
},
"AdditionalData3DSecure" : {
"properties" : {
"allow3DS2" : {
"description" : "This parameter indicates that you are able to process 3D Secure 2 transactions natively on your payment page. Send this field when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/checkout/3d-secure/native-3ds2), such as Components or Drop-in. Possible values:\n* **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.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n> This parameter only indicates your readiness to support 3D Secure 2 natively on Drop-in or Components. To specify that you want to perform 3D Secure on a transaction, use Dynamic 3D Secure or send the executeThreeD parameter.",
"type" : "string"
},
"executeThreeD" : {
"description" : "This parameter indicates if you want to perform 3D Secure authentication on a transaction or not. Allowed values:\n* **true** – Perform 3D Secure authentication.\n* **false** – Don't perform 3D Secure authentication.\n> Alternatively, you can also use Dynamic 3D Secure to configure rules for applying 3D Secure.",
"type" : "string"
},
"mpiImplementationType" : {
"description" : "In case of Secure+, this field must be set to **CUPSecurePlus**.",
"type" : "string"
}
}
},
"AdditionalDataAirline" : {
"properties" : {
"airline.passenger_name" : {
"description" : "Passenger name, initials, and a title.\n* Format: last name + first name or initials + title.\n* Example: *FLYER / MARY MS*.\n* minLength: 1\n* maxLength: 49",
"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.\n* Format: alphanumeric.\n* minLength: 4\n* maxLength: 4",
"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.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3\n* maxLength: 3",
"type" : "string"
},
"airline.ticket_number" : {
"description" : "The ticket's unique identifier.\n* minLength: 1\n* maxLength: 150",
"type" : "string"
},
"airline.flight_date" : {
"description" : "Flight departure date. Local time `(HH:mm)` is optional.\n* Date format: `yyyy-MM-dd`\n* Date and time format: `yyyy-MM-dd HH:mm`\n* minLength: 10\n* maxLength: 16",
"type" : "string"
},
"airline.customer_reference_number" : {
"description" : "Reference number; alphanumeric.\n* minLength: 0\n* maxLength: 20",
"type" : "string"
},
"airline.ticket_issue_address" : {
"description" : "Address of the place/agency that issued the ticket.\n* minLength: 0\n* maxLength: 16",
"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.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2",
"type" : "string"
},
"airline.travel_agency_code" : {
"description" : "IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies.\n* minLength: 1\n* maxLength: 8",
"type" : "string"
},
"airline.travel_agency_name" : {
"description" : "The name of the travel agency.\n* minLength: 1\n* maxLength: 25",
"type" : "string"
},
"airline.agency_plan_name" : {
"description" : "2-letter agency plan identifier; alphabetical.\n* minLength: 2\n* maxLength: 2",
"type" : "string"
},
"airline.agency_invoice_number" : {
"description" : "Reference number for the invoice, issued by the agency.\n* minLength: 1\n* maxLength: 6",
"type" : "string"
},
"airline.boarding_fee" : {
"description" : "Chargeable amount for boarding the plane.\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 18",
"type" : "string"
},
"airline.leg.depart_airport" : {
"description" : "Alphabetical identifier of the departure airport.\nThis field is required if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3",
"type" : "string"
},
"airline.leg.flight_number" : {
"description" : "The flight identifier.\n* minLength: 1\n* maxLength: 5",
"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.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: IATA 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2",
"type" : "string"
},
"airline.leg.fare_base_code" : {
"description" : "[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric.\n* minLength: 1\n* maxLength: 7",
"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:\n* F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\nLimitations:\n* minLength: 1\n* maxLength: 1",
"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:\n* O: Stopover allowed\n* X: Stopover not allowed\n\nLimitations:\n* minLength: 1\n* maxLength: 1",
"type" : "string"
},
"airline.leg.destination_code" : {
"description" : "Alphabetical identifier of the destination/arrival airport.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3",
"type" : "string"
},
"airline.leg.date_of_travel" : {
"description" : "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n* Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16",
"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).\n* minLength: 1\n* maxLength: 12",
"type" : "string"
},
"airline.passenger.first_name" : {
"description" : "Passenger first name/given name.\n> 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.\n> This field is required/mandatory if the airline data includes passenger details or leg details.",
"type" : "string"
},
"airline.passenger.traveller_type" : {
"description" : "Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS.\n\nHowever, several carriers use non-standard codes that can be up to 5 alphanumeric characters.\n* minLength: 3\n* maxLength: 6",
"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.\n* minLength: 3\n* maxLength: 30",
"type" : "string"
},
"airline.passenger.date_of_birth" : {
"description" : "Date of birth of the passenger.\n\nDate format: `yyyy-MM-dd`\n* minLength: 10\n* maxLength: 10",
"type" : "string"
}
}
},
"AdditionalDataCarRental" : {
"properties": {
"carRental.rentalAgreementNumber": {
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 14",
"type" : "string"
},
"carRental.renterName": {
"description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26",
"type" : "string"
},
"carRental.returnCity": {
"description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18",
"type" : "string"
},
"carRental.returnStateProvince": {
"description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3",
"type" : "string"
},
"carRental.returnCountry": {
"description" : "The country where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 2",
"type" : "string"
},
"carRental.returnLocationId": {
"description" : "Agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10",
"type" : "string"
},
"carRental.returnDate": {
"description" : "The last date to return the car by.\n* Date format: `yyyyMMdd`",
"type" : "string"
},
"carRental.checkOutDate": {
"description" : "Pick-up date.\n* Date format: `yyyyMMdd`",
"type" : "string"
},
"carRental.customerServiceTollFreeNumber": {
"description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17",
"type" : "string"
},
"carRental.rate": {
"description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12",
"type" : "string"
},
"carRental.rateIndicator": {
"description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.",
"type" : "string"
},
"carRental.locationCity": {
"description" : "The location from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"type" : "string"
},
"carRental.locationStateProvince": {
"description" : "Pick-up date.\n* Date format: `yyyyMMdd`",
"type" : "string"
},
"carRental.locationCountry": {
"description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17",
"type" : "string"
},
"carRental.rentalClassId": {
"description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12",
"type" : "string"
},
"carRental.daysRented": {
"description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.",
"type" : "string"
},
"carRental.taxExemptIndicator": {
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* 0 - Tax was not collected\n* 1 - Goods or services were tax exempt",
"type" : "string"
},
"travelEntertainmentAuthData.market": {
"description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1",
"type" : "string"
},
"travelEntertainmentAuthData.duration": {
"description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2",
"type" : "string"
},
"carRental.fuelCharges": {
"description" : "Any fuel charges associated with the rental.\n* Format: Numeric\n* maxLength: 12",
"type" : "string"
},
"carRental.insuranceCharges": {
"description" : "Any insurance charges associated with the rental.\n* Format: Numeric\n* maxLength: 12",
"type" : "string"
},
"carRental.noShowIndicator": {
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* 0 - Not applicable.\n* 1 - Customer was a no show.",
"type" : "string"
},
"carRental.oneWayDropOffCharges": {
"description" : "Charge associated with not returning a vehicle to the original rental location.",
"type" : "string"
}
}
},
"AdditionalDataLevel23" : {
"properties": {
"enhancedSchemeData.customerReference": {
"description" : "Customer code, if supplied by a customer.\nEncoding: ASCII.\nMax length: 25 characters.\n> Required for Level 2 and Level 3 data.",
"type" : "string"
},
"enhancedSchemeData.totalTaxAmount": {
"description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\nMax length: 12 characters.\n> Required for Level 2 and Level 3 data.",
"type" : "number"
},
"enhancedSchemeData.freightAmount": {
"description" : "Shipping amount, in minor units.\n\nFor example, 2000 means USD 20.00.\nMax length: 12 characters.",
"type" : "number"
},
"enhancedSchemeData.dutyAmount": {
"description" : "Duty amount, in minor units.\n\nFor example, 2000 means USD 20.00.\nMax length: 12 characters.",
"type" : "number"
},
"enhancedSchemeData.destinationPostalCode": {
"description" : "The postal code of a destination address.\n\nEncoding: ASCII.\nMax length: 10 characters.\n> Required for American Express.",
"type" : "string"
},
"enhancedSchemeData.destinationStateProvinceCode": {
"description" : "Destination state or province code.\n\nEncoding: ASCII.Max length: 3 characters.",
"type" : "string"
},
"enhancedSchemeData.shipFromPostalCode": {
"description" : "The postal code of a \"ship-from\" address.\n\nEncoding: ASCII.\nMax length: 10 characters.",
"type" : "string"
},
"enhancedSchemeData.destinationCountryCode": {
"description" : "Destination country code.\n\nEncoding: ASCII.\nMax length: 3 characters.",
"type" : "string"
},
"enhancedSchemeData.orderDate": {
"description" : "Order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII.\nMax length: 6 characters.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].commodityCode": {
"description" : "Item commodity code.\nEncoding: ASCII.\nMax length: 12 characters.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].description": {
"description" : "Item description.\nEncoding: ASCII.\nMax length: 26 characters.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].productCode": {
"description" : "Product code.\nEncoding: ASCII.\nMax length: 12 characters.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].quantity": {
"description" : "Quantity, specified as an integer value.\nValue must be greater than 0.\nMax length: 12 characters.",
"type" : "number"
},
"enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure": {
"description" : "Item unit of measurement.\nEncoding: ASCII.\nMax length: 3 characters.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].unitPrice": {
"description" : "Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes).\nMax length: 12 characters.",
"type" : "number"
},
"enhancedSchemeData.itemDetailLine[itemNr].discountAmount": {
"description" : "Discount amount, in minor units.\n\nFor example, 2000 means USD 20.00.\nMax length: 12 characters.",
"type" : "number"
},
"enhancedSchemeData.itemDetailLine[itemNr].totalAmount": {
"description" : "Total amount, in minor units.\nFor example, 2000 means USD 20.00.\nMax length: 12 characters.",
"type" : "number"
}
}
},
"AdditionalDataLodging" : {
"properties": {
"lodging.customerServiceTollFreeNumber": {
"description": "The toll free phone number for the hotel/lodgings.\n* Format: Alphanumeric\n* maxLength: 17",
"type": "string"
},
"lodging.checkInDate": {
"description": "The arrival date.\n* Date format: `yyyyMMdd`",
"type": "string"
},
"lodging.checkOutDate": {
"description": "The departure date.\n* Date format: `yyyyMMdd`",
"type": "string"
},
"lodging.folioNumber": {
"description": "Card acceptor’s internal invoice or billing ID reference number.\n* Format: Alphanumeric\n* maxLength: 25",
"type": "string"
},
"lodging.propertyPhoneNumber": {
"description": "Identifies specific lodging property location by its local phone number.\n* Format: Alphanumeric\n* maxLength: 17",
"type": "string"
},
"lodging.room1.rate": {
"description": "The rate of the room.\n* Format: Numeric\n* maxLength: 12",
"type": "string"
},
"lodging.room1.tax": {
"description": "The total amount of tax to be paid.\n* Format: Numeric\n* maxLength: 12",
"type": "string"
},
"lodging.room1.numberOfNights": {
"description": "Total number of nights the room will be rented.\n* Format: Numeric\n* maxLength: 4",
"type": "string"
},
"lodging.fireSafetyActIndicator": {
"description": "Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'.\n* Format: Alphabetic\n* maxLength: 1",
"type": "string"
},
"travelEntertainmentAuthData.market": {
"description": "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1",
"type": "string"
},
"travelEntertainmentAuthData.duration": {
"description": "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2",
"type": "string"
},
"lodging.folioCashAdvances": {
"description": "The folio cash advances.\n* Format: Numeric\n* maxLength: 12",
"type": "string"
},
"lodging.foodBeverageCharges": {
"description": "Any charges for food and beverages associated with the booking.\n* Format: Numeric\n* maxLength: 12",
"type": "string"
},
"lodging.noShowIndicator": {
"description": "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n\nValue should be Y or N.\n* Format: Numeric\n* maxLength: 1",
"type": "string"
},
"lodging.prepaidExpenses": {
"description": "Prepaid expenses for the booking.\n* Format: Numeric\n* maxLength: 12",
"type": "string"
},
"lodging.totalTax": {
"description": "Total tax amount.\n* Format: Numeric\n* maxLength: 12",
"type": "string"
},
"lodging.totalRoomTax": {
"description": "Total room tax amount.\n* Format: Numeric\n* maxLength: 12",
"type": "string"
}
}
},
"AdditionalDataOpenInvoice" : {
"properties": {
"openinvoicedata.numberOfLines": {
"description" : "The number of invoice lines included in `openinvoicedata`.\n\nThere needs to be at least one line, so `numberOfLines` needs to be at least 1.",
"type" : "integer"
},
"openinvoicedata.merchantData": {
"description" : "Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.\n\nThe `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end.\n\nSince the field is optional, if it's not included it does not impact computing the merchant signature.\n\nApplies only to Klarna.\n\nYou can contact Klarna for the format and structure of the string.",
"type" : "string"
},
"openinvoicedata.installmentConfigurationKey": {
"description" : "Required for the Klarna account, identifying an installment plan. Include Klarna’s `pclassid` for the installment plan.",
"type" : "string"
},
"openinvoicedata.line[itemNr].currencyCode": {
"description" : "The three-character ISO currency code.",
"type" : "string"
},
"openinvoicedata.line[itemNr].description": {
"description" : "A text description of the product the invoice line refers to.",
"type" : "string"
},
"openinvoicedata.line[itemNr].itemAmount": {
"description" : "The price for one item in the invoice line, represented in minor units.\n\nThe due amount for the item, VAT excluded.",
"type" : "integer"
},
"openinvoicedata.line[itemNr].itemVatAmount": {
"description" : "The VAT due for one item in the invoice line, represented in minor units.",
"type" : "integer"
},
"openinvoicedata.line[itemNr].itemVatPercentage": {
"description" : "The VAT percentage for one item in the invoice line, represented in minor units.\n\nFor example, 19% VAT is specified as 1900.",
"type" : "integer"
},
"openinvoicedata.line[itemNr].itemId": {
"description" : "A unique id for this item. Required for RatePay if the description of each item is not unique.",
"type" : "string"
},
"openinvoicedata.line[itemNr].numberOfItems": {
"description" : "The number of units purchased of a specific product.",
"type" : "integer"
},
"openinvoicedata.line[itemNr].vatCategory": {
"description" : "The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.",
"type" : "string"
}
}
},
"AdditionalDataRatepay" : {
"properties" : {
"ratepay.installmentAmount" : {
"description" : "Amount the customer has to pay each month.",
"type" : "integer"
},
"ratepay.lastInstallmentAmount" : {
"description" : "Amount of the last installment.",
"type" : "integer"
},
"ratepay.interestRate" : {
"description" : "Interest rate of this installment. Double",
"type" : "integer"
},
"ratepay.paymentFirstday" : {
"description" : "Calendar day of the first payment.",
"type" : "integer"
},
"ratepaydata.invoiceId" : {
"description" : "Identification name or number for the invoice, defined by the merchant.",
"type" : "string"
},
"ratepaydata.invoiceDate" : {
"description" : "Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.",
"type" : "string"
},
"ratepaydata.deliveryDate" : {
"description" : "Date the merchant delivered the goods to the customer.",
"type" : "string"
},
"ratepaydata.dueDate" : {
"description" : "Date by which the customer must settle the payment.",
"type" : "string"
}
}
},
"AdditionalDataRetry" : {
"properties" : {
"retry.chainAttemptNumber" : {
"description" : "The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.",
"type" : "integer"
},
"retry.orderAttemptNumber" : {
"description" : "The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.",
"type" : "integer"
},
"retry.skipRetry" : {
"description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.",
"type" : "boolean"
}
}
},
"AdditionalDataRisk" : {
"properties": {
"riskdata.deliveryMethod": {
"description" : "The method to deliver the goods to the shopper.\n\nUsed in [Delivery Method](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#delivery-method) check.",
"type" : "string"
},
"riskdata.accountCreationDate": {
"description" : "The creation date of a shopper account on the merchant's platform.\n* Format: `yyyy-MM-dd HH:mm:ss`\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules). ",
"type" : "string"
},
"riskdata.shopperAccountCreationDate": {
"description" : "This specifies the date when the shopper's account was created.\n* Format: `yyyy-MM-dd HH:mm:ss.sssZ`\n\nUsed in [Shopper Account Age check](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#shopper-account-age).",
"type" : "string"
},
"riskdata.externalRiskScore": {
"description" : "A risk score coming from a system external to Adyen.\n* Format: Numeric (when used in custom risk checks)\n\nUsed in [External Risk Score check](https://docs.adyen.com/risk-management/configure-standard-risk-rules/external-risk-rules#external-risk-score-generic).\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "string"
},
"riskdata.externalSuspectedFraud": {
"description" : "Usually a boolean representing the fraud risk assessment coming from a system external to Adyen.\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "string"
},
"riskdata.operatorCode": {
"description" : "A code corresponding to a telecom network operator\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "string"
},
"riskdata.operatorCountry": {
"description" : "Country corresponding to the telecom network operator. Usually a two letter country code.\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "object"
},
"riskdata.operatorName": {
"description" : "Name of a telecom network operator e.g. Vodafone, Orange etc.\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "string"
},
"riskdata.operatorProductCode": {
"description" : "Product code of a telecom product.\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "string"
},
"riskdata.paymentMethod": {
"description" : "Represents the payment method as it is understood by the merchant. Does not necessarily have to coincide with the payment method determined by Adyen.\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).\n\nFor visacheckout, masterpass, and paywithgoogle, use `riskdata.paymentDataSource` instead.",
"type" : "string"
},
"riskdata.paymentDataSource": {
"description" : "Used in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules) for visacheckout, masterpass, and paywithgoogle.",
"type" : "string"
},
"riskdata.previousSuccessfulOrders": {
"description" : "The number of previous non-fraudulent orders made by a shopper.\n* Format: Numeric\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "string"
},
"riskdata.referralMethod": {
"description" : "The referral method/reason for joining the merchant's platform.\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "string"
},
"riskdata.referrerUserName": {
"description" : "The user name of a member who referred somebody to the merchant's platform.\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "string"
},
"riskdata.riskProfileId": {
"description" : "The id of the risk profile to use instead of the merchant account's currently set risk profile.",
"type" : "string"
},
"riskdata.secondaryPhoneNumber": {
"description" : "A secondary phone number for a user of the merchant's platform.\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "object"
},
"riskdata.shippingMethod": {
"description" : "Name of the shipping method.\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "string"
},
"riskdata.shopperCountry": {
"description" : "The shopper country as determined by the merchant, usually as a 2 letter country code. Does not have to coincide with the Adyen determined shopper country.\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "string"
},
"riskdata.simDistributor": {
"description" : "Usually a SIM distribution company name e.g. Core, Elite, GK Tel etc.\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "string"
},
"riskdata.userName": {
"description" : "User name of an account on the merchant's platform.\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "string"
},
"riskdata.userStatus": {
"description" : "Usually a user's loyalty status e.g. Gold, Silver etc.\n\nUsed in [Custom risk checks](https://docs.adyen.com/risk-management/configure-custom-risk-rules).",
"type" : "string"
},
"riskdata.browserLanguage": {