-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNORBr API reference.postman_collection.json
More file actions
6487 lines (6487 loc) · 387 KB
/
Copy pathNORBr API reference.postman_collection.json
File metadata and controls
6487 lines (6487 loc) · 387 KB
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
{
"info": {
"_postman_id": "05bbd91e-02cf-4d96-9144-dfb5ca8ff884",
"name": "NORBr API reference",
"description": "The NORBr API is organized around **REST** :\n\n- has **predictable** resource-oriented URLs,\n \n- accepts raw JSON request bodies,\n \n- returns JSON responses,\n \n- uses **standard** HTTP response codes, authentication, and verbs.\n \n\nYou can use the NORBr API in **sandbox mode**, which does not affect your live data or interact with the banking networks.\n\nFor each object, you'll find data examples to set out and clarify the requests and enable you to move quicker with the integration\n\nFor each use case (recurring, 3ds, moto, etc..), you'll find a folder of request examples to ease your integration based on your own project.\n\nOur documentation also includes, the list of our [end-points](#direct-api) to facilitate their use, test cards to use our API right away and a clear definition of our return codes.\n\nWe use the snake_case style of writing for our API : all fields used in all the described endpoints will use this formatting.\n\n---\n\n<h1>Integration</h1>\n\nYou have 2 ways of integrating our platform, either via hosted elements or directly using our API.\n\n- [Hosted elements](#hosted-elements) : Card information here is handled by NORBr, it only requires PCI compliance with SAQ A or A-EP.\n \n- [Direct API](#direct-api) : This integration type implies the ability to handle securely card information and according to PCI DSS rules, in compliance with a SAQ D.\n \n\n---\n\n<h1>Test cards</h1>\n\nUse the following card numbers to proceed with your tests on the **sandbox environment**.\n\nFor all the cards, you can use any **expiry future date**.\n\n<h2>Successful transactions</h2>\n\n| scheme | type | card number | cvc |\n| --- | --- | --- | --- |\n| <img src=\"https://developer-static.norbr.io/Visa-small-logo.png\" alt=\"\"> | credit | 4242 4242 4242 4242 | 100 |\n| <img src=\"https://developer-static.norbr.io/Visa-small-logo.png\" alt=\"\"> | credit | 4543 4740 0224 9996 | 956 |\n| <img src=\"https://developer-static.norbr.io/mc-small-logo.png\" alt=\"\"> | credit | 5436 0310 3060 6378 | 257 |\n| <img src=\"https://developer-static.norbr.io/mc-small-logo.png\" alt=\"\"> | credit | 2223 0000 1047 9399 | 299 |\n| <img src=\"https://developer-static.norbr.io/mc-small-logo.png\" alt=\"\"> | credit | 5199 9923 1264 1465 | 299 |\n| <img src=\"https://developer-static.norbr.io/amex-small-logo.png\" alt=\"\"> | credit | 3456 7890 1234 564 | 1051 |\n| <img src=\"https://developer-static.norbr.io/amex-small-logo.png\" alt=\"\"> | credit | 3782 8224 6310 005 | 1000 |\n| <img src=\"https://developer-static.norbr.io/diners-small-logo.png\" alt=\"\"> | credit | 3012 3456 7890 19 | 257 |\n| <img src=\"https://developer-static.norbr.io/discover-small-logo.png\" alt=\"\"> | credit | 6011 1111 1111 1117 | 100 |\n| <img src=\"https://developer-static.norbr.io/jcb-small-logo.png\" alt=\"\"> | credit | 3530 1113 3330 0000 | 100 |\n| <img src=\"https://developer-static.norbr.io/Visa-small-logo.png\" alt=\"\"> | debit | 4658 5840 9000 0001 | 257 |\n\n---\n\n<h1>Return codes</h1>\n\nNORBr uses conventional HTTP response codes to indicate the success or failure of an API request.\n\nIn general:\n\n- Codes in the 2xx range indicate success.\n \n- Codes in the 4xx range indicate an error that failed due to the information provided (e.g., a required parameter is missing, an authorization failed, etc.).\n \n- Codes in the 5xx range indicate an error with NORBr's servers\n \n\nTo complete the HTTP response codes, you will also receive a detailed return code that gives more indication on what has exactly happened with your request.\n\nFor either a successful, pending or failed request, you will receive a code and its description.\n\nThe code answers is based on 6 digits structured as follows :\n\n- the first 4 digits give general information related to the kind of response and its origine\n \n\n| | 1st digit: order phase | 2nd digit: origin | 3rd digit: fallback | 4th digit: side |\n| --- | --- | --- | --- | --- |\n| 0 | | | possible | undetermined |\n| 1 | order creation | technical | not recommended | issuer side |\n| 2 | tokenization | processing | | acquirer side |\n| 3 | authentication | risk assessment | | ACS |\n| 4 | authorization | account related | | PSP |\n| 5 | capture | routing issue | | |\n| 6 | refund | incomplete | | |\n| 7 | cancel | | | |\n| 9 | success | | | |\n\n- the last 2 digits give detailed information related to the reason code (please see list below).\n \n\n> Example : \n \n\n| Code | Description |\n| --- | --- |\n| 420230 | risk rejection |\n\n> We are in the authorization phase (1st digit = 4), it's a processing return code (2nd digit = 2), a fallback is possible (3rd digit = 0), the decision comes from the acquirer side (4th digit = 2), and it's a risk related decision (last 2 digits = 30) \n \n\nYou can find the whole detailed list below:\n\n| Code | Description |\n| --- | --- |\n| 100301 | session creation unsuccessful |\n| 111011 | missing required parameter |\n| 111012 | invalid parameter |\n| 111013 | an error occurred |\n| 111022 | invalid API key |\n| 111023 | request forbidden due to limited credential rights - internal |\n| 111034 | max attempts reached |\n| 111035 | order is already being processed |\n| 131010 | blacklist |\n| 131011 | blocked by PLACEHOLDER |\n| 131020 | mismatch |\n| 131030 | external check (AVS, missing 3D, device fingerprint, etc.) |\n| 131040 | country not supported |\n| 131050 | velocity |\n| 131051 | card velocity |\n| 131052 | email velocity |\n| 131053 | IP velocity |\n| 131054 | verified info |\n| 131055 | bin velocity |\n| 131056 | billing address velocity |\n| 131057 | shipping address velocity |\n| 131058 | cardholder name velocity |\n| 131059 | custom data velocity |\n| 131088 | risk blocked transaction |\n| 133333 | risk approved |\n| 151021 | invalid psp credentials |\n| 151023 | request forbidden due to limited credential rights - external |\n| 151040 | no route available for the requested payment method |\n| 151041 | no route available for the requested currency |\n| 151042 | no route available for the requested channel |\n| 151043 | no route available for the requested partner |\n| 161000 | client dropped off |\n| 221420 | tokenization failed |\n| 240020 | invalid account |\n| 240021 | invalid account - card number |\n| 240022 | invalid account - card expired |\n| 241021 | token expired |\n| 241031 | invalid card information |\n| 261000 | client dropped off |\n| 310070 | Authentication declined |\n| 320001 | 3DS timeout |\n| 320088 | authentication failed |\n| 320120 | card not enrolled |\n| 320310 | ACS server unavailable |\n| 341000 | incorrect authentication |\n| 361000 | client dropped off |\n| 404000 | route does not exist |\n| 410070 | integration error |\n| 420030 | risk rejection |\n| 420040 | unsupported currency |\n| 420041 | unsupported payment method |\n| 420050 | 3DS required |\n| 420088 | declined |\n| 420100 | insufficient funds |\n| 420110 | issuer server unavailable |\n| 420111 | max invalid attempts reached |\n| 420130 | risk rejection |\n| 420150 | soft decline - 3DS required |\n| 420188 | declined by issuer |\n| 420210 | acquirer server unavailable |\n| 420230 | risk rejection |\n| 420240 | invalid merchant ID configuration |\n| 420241 | unsupported currency |\n| 420242 | unsupported payment method |\n| 420248 | error in merchant configuration |\n| 420250 | 3DS required |\n| 420260 | invalid amount |\n| 420288 | declined by acquirer |\n| 420410 | PSP server unavailable |\n| 421080 | pending authorization |\n| 421081 | declined |\n| 421101 | threshold limit |\n| 421110 | issuer server unavailable |\n| 421120 | unsupported currency |\n| 421125 | card expired |\n| 421126 | restricted card |\n| 421127 | operation not allowed |\n| 421130 | risk rejection |\n| 421131 | stolen card |\n| 421132 | lost card |\n| 440120 | invalid card - updated card available |\n| 441120 | invalid card |\n| 511030 | authorization already captured |\n| 511031 | capture amount exceeding authorization |\n| 511032 | duplicated capture request |\n| 511033 | too many capture requests |\n| 520120 | authorization expired |\n| 520220 | capture unavailable |\n| 521080 | pending capture request |\n| 521088 | capture declined |\n| 521100 | order cancelled by customer |\n| 521188 | capture declined |\n| 521260 | invalid amount |\n| 521270 | amount exceeding authorization |\n| 521271 | authorization already captured |\n| 521272 | duplicated capture request |\n| 521273 | too many capture requests |\n| 521288 | capture declined |\n| 611030 | refund amount exceeding captured amount |\n| 611031 | capture already refunded |\n| 611032 | duplicated refund request |\n| 611033 | too many refund requests |\n| 620210 | refund unavailable |\n| 621080 | pending refund request |\n| 621088 | refund declined |\n| 621120 | refund period expired |\n| 621260 | invalid amount |\n| 621261 | refund amount exceeding captured amount |\n| 621270 | capture already refunded |\n| 621271 | duplicated refund request |\n| 621272 | too many refund requests |\n| 621288 | refund declined |\n| 711030 | authorization expired |\n| 711031 | authorization already captured |\n| 711032 | authorization already cancelled |\n| 711033 | duplicated cancel request |\n| 720010 | authorization cancellation unavailable |\n| 721080 | pending cancel request |\n| 721088 | authorization cancellation declined |\n| 721170 | authorization expired |\n| 721171 | authorization already captured |\n| 721172 | authorization already cancelled |\n| 721188 | authorization cancellation declined |\n| 721288 | authorization cancellation declined |\n| 900000 | session created successfully |\n| 922222 | tokenization successful |\n| 944444 | authorization successful |\n| 955555 | capture successful |\n| 966666 | refund successful |\n| 977777 | cancel successful |\n| 988888 | settlement successful |\n\nHere is an exemple of the object you will receive in response.\n\n```\n{\n \"result\": {\n \"code\": \"944444\",\n \"description\": \"Authorization successful\"\n }\n}\n\n ```\n\n---\n\n<h1>Notifications</h1>\n\nYou can create a webhook directly in the setting menu of your NORBr account that will subscribe to a list of events on the order.\n\nWe strongly recommend to at least subscribe to the **authorization_successful** event to confirm the order on your own webshop.\n\nHere is a sample of a notification :\n\n``` json\n{\n\"request_id\":\"3456789876545678456789765\",\n\"order_id\": \"60509208505368000a3dfbd2\",\n\"transaction_id\":\"68HGVFT5RTGVU\",\n\"merchant_order_id\": \"9J3947DB29D\",\n\"merchant_contract_id\":\"489YGF68YGT545678YG\",\n\"status\": \"authorization_successful\",\n\"action_date\":\"2023-08-12T12:45:48+0000\",\n\"amount\":118.98,\n\"payin_partner\":\"checkout\",\n\"payin_transaction_id\":\"pay_5689IHVFR43456789UYHGVGYU876545678UYG\",\n\"payin_transaction_description\":\"APPROVED\",\n\"authentication_partner\":\"checkout\",\n\"authentication_result\":\"success\",\n\"risk_assessment_partner\":\"checkout\",\n\"risk_assessment_result\":\"accepted\",\n\"payment_method\":\"VISA\",\n\"capture_total_amount\":0.00,\n\"refund_total_amount\":0.00,\n\"currency\":\"EUR\",\n\"is_capturable\":true,\n\"is_refundable\":false,\n\"is_cancellable\":true,\n\"link_interface\":\"\",\n\"card_6_digits\": \"424242\",\n\"card_4_digits\": \"4242\",\n\"card_validity_month\": \"02\",\n\"card_validity_year\": \"25\",\n\"card_issuer\": \"\",\n\"card_country\": \"GB\",\n\"merchant_account\": \"615f3066c67357000ad556e1\",\n\"token\": \"072bd9c0b63dde38e2d41e906273d1b59acfe6dea2c3d9a877c8ed7806c2b5eb\",\n\"is_order_last_transaction\": true\n}\n\n ```\n\nThe **headers** will contain the `norbr-signature` parameter and the `norbr-timestamp`.\n\nTo verify the notification, you need to :\n\n- Transform the json body into string .\n \n- Concatenate : string-body+norbr-timestamp\n \n- Hash the string using HMAC-SHA256 and Secret Key (coding = UTF8)\n \n- Check that the encoded hash in base16 = `norbr-signature`\n \n\n<h2>Example</h2>\n\n- Headers\n \n\n| parameters | value |\n| --- | --- |\n| norbr-timestamp | 1639569054 |\n| norbr-signature | 5a938268e15a97a17f465a540ba0b7c05899b342b61e67aa1b3b1ba74d2f61a9 |\n\nIf the body of the notification is :\n\n``` json\n {\"request_id\":\"3456789876545678456789765\",\"order_id\":\"60509208505368000a3dfbd2\",\"transaction_id\":\"68HGVFT5RTGVU\",\"merchant_order_id\":\"9J3947DB29D\",\"merchant_contract_id\":\"489YGF68YGT545678YG\",\"status\":\"authorization_successful\",\"action_date\":\"2023-08-12T12:45:48+0000\",\"amount\":118.98,\"payin_partner\":\"checkout\",\"payin_transaction_id\":\"pay_5689IHVFR43456789UYHGVGYU876545678UYG\",\"payin_transaction_description\":\"APPROVED\",\"authentication_partner\":\"checkout\",\"authentication_result\":\"success\",\"risk_assessment_partner\":\"checkout\",\"risk_assessment_result\":\"accepted\",\"payment_method\":\"VISA\",\"capture_total_amount\":0,\"refund_total_amount\":0,\"currency\":\"EUR\",\"is_capturable\":true,\"is_refundable\":false,\"is_cancellable\":true,\"link_interface\":\"\",\"card_6_digits\":\"424242\",\"card_4_digits\":\"4242\",\"card_validity_month\":\"02\",\"card_validity_year\":\"25\",\"card_issuer\":\"\",\"card_country\":\"GB\",\"merchant_account\":\"615f3066c67357000ad556e1\",\"token\":\"072bd9c0b63dde38e2d41e906273d1b59acfe6dea2c3d9a877c8ed7806c2b5eb\",\"is_order_last_transaction\":true}\n\n ```\n\n- **Transform the json body into string** :\n \n\n> {\"request_id\":\"3456789876545678456789765\",\"order_id\":\"60509208505368000a3dfbd2\",\"transaction_id\":\"68HGVFT5RTGVU\",\"merchant_order_id\":\"9J3947DB29D\",\"merchant_contract_id\":\"489YGF68YGT545678YG\",\"status\":\"authorization_successful\",\"action_date\":\"2023-08-12T12:45:48+0000\",\"amount\":118.98,\"payin_partner\":\"checkout\",\"payin_transaction_id\":\"pay_5689IHVFR43456789UYHGVGYU876545678UYG\",\"payin_transaction_description\":\"APPROVED\",\"authentication_partner\":\"checkout\",\"authentication_result\":\"success\",\"risk_assessment_partner\":\"checkout\",\"risk_assessment_result\":\"accepted\",\"payment_method\":\"VISA\",\"capture_total_amount\":0,\"refund_total_amount\":0,\"currency\":\"EUR\",\"is_capturable\":true,\"is_refundable\":false,\"is_cancellable\":true,\"link_interface\":\"\",\"card_6_digits\":\"424242\",\"card_4_digits\":\"4242\",\"card_validity_month\":\"02\",\"card_validity_year\":\"25\",\"card_issuer\":\"\",\"card_country\":\"GB\",\"merchant_account\":\"615f3066c67357000ad556e1\",\"token\":\"072bd9c0b63dde38e2d41e906273d1b59acfe6dea2c3d9a877c8ed7806c2b5eb\",\"is_order_last_transaction\":true} \n \n\n- **Concatenate** **`string-body+norbr-timestamp`**\n \n\n> {\"request_id\":\"3456789876545678456789765\",\"order_id\":\"60509208505368000a3dfbd2\",\"transaction_id\":\"68HGVFT5RTGVU\",\"merchant_order_id\":\"9J3947DB29D\",\"merchant_contract_id\":\"489YGF68YGT545678YG\",\"status\":\"authorization_successful\",\"action_date\":\"2023-08-12T12:45:48+0000\",\"amount\":118.98,\"payin_partner\":\"checkout\",\"payin_transaction_id\":\"pay_5689IHVFR43456789UYHGVGYU876545678UYG\",\"payin_transaction_description\":\"APPROVED\",\"authentication_partner\":\"checkout\",\"authentication_result\":\"success\",\"risk_assessment_partner\":\"checkout\",\"risk_assessment_result\":\"accepted\",\"payment_method\":\"VISA\",\"capture_total_amount\":0,\"refund_total_amount\":0,\"currency\":\"EUR\",\"is_capturable\":true,\"is_refundable\":false,\"is_cancellable\":true,\"link_interface\":\"\",\"card_6_digits\":\"424242\",\"card_4_digits\":\"4242\",\"card_validity_month\":\"02\",\"card_validity_year\":\"25\",\"card_issuer\":\"\",\"card_country\":\"GB\",\"merchant_account\":\"615f3066c67357000ad556e1\",\"token\":\"072bd9c0b63dde38e2d41e906273d1b59acfe6dea2c3d9a877c8ed7806c2b5eb\",\"is_order_last_transaction\":true}1639569054 \n \n\n- **Hash the previous string using HMAC-SHA256 with SecretKey**\n \n\nIf `secret-key=3456789876543235TGY8` then hash is :\n\n> 5a938268e15a97a17f465a540ba0b7c05899b342b61e67aa1b3b1ba74d2f61a9 \n \n\n- **Check that** **`norbr-signature`** **value equals the encoded hash in the last step**\n \n\n---\n\n<h1>Hosted Elements</h1>\n\nNORBr hosted fields is an easy way to customize your checkout flow without having to deal with the hassle of PCI Compliance (you will only need to comply with SAQ A questionnaire). The sensitive information will be collected through these elements and sent out to NORBr without ever communicating with your own server, thanks to a script intercepting the sensitive information before submitting the form. You’ll just have to focus on customizing your checkout experience.\n\nThe NORBr hosted fields include several helpful features such as:\n\n- displaying the card logo once the first number of the card is entered\n \n- displaying 2 selectable logos in the case of co-branded cards (MIF compliant)\n \n- formatting the card information as it is filled in\n \n- customizing the look and feel of the payment page to seamlessly integrate it within your checkout flow\n \n- handling errors to help your customer fill out the form\n \n- using responsive fields that fit with your customers’ mobile device\n \n\n<h4>How to start using NORBr's hosted fields ?</h4>\n\nFirst you have to set-up the NORBr hosted fields library within your HTML page.\n\nA simple way to do it consists in adding the `script` tag to the head of your HTML file and the stylesheet, like in the following example :\n\n``` html\n<script src=\"https://secure-assets-sandbox.norbr.io/javascript/x.x/norbr-client.min.js\"></script>\n<link rel=\"stylesheet\" href=\"https://secure-assets-sandbox.norbr.io/stylesheet/x.x/norbr-client.min.css\">\n\n ```\n\nPlease contact [support@norbr.help](https://mailto:support@norbr.help) so we provide the last version (x.x) to use.\n\nThen you add a div for the container to display the fields. \nThe id of the div must be: norbr-payment-container\n\nThen you must create a JS instance of the NORBr component, by sending several parameters ,like in the following example:\n\n| Parameters | format | Description |\n| --- | --- | --- |\n| publicapikey | NR_PUB_XXXXXX | Your public api key available on your merchant portal and has restricted privileges for a client use. |\n| locale | alpha-2 | Language used to display the fields |\n| environment | enum | sandbox or production |\n| tokentype | enum | `oneshot` or `recurring`. refers to reusability of the token |\n| checkoutId | string | id of the checkout created previously |\n| paymentmethods | string | stringified version of the payment_methods returned in the response of the checkout created previously |\n| displayButtons | boolean | Display or not the pay button |\n| displayCardHolder | boolean | Display or not the cardholder name field |\n| displaySave | boolean | Display or not the card save button |\n| cardHolderValue | string | Dynamic field to display the name already filled out by your customer during his payment journey. |\n\n``` html\n const configuration = {\n publicapikey:\"\",\n locale:\"en\",\n environment:\"sandbox\",\n tokentype:\"oneshot\",\n checkoutId: '67ceac5ab0680aa29acb52e2',\n paymentmethods: '{\"payment_methods_available\":[{\"logo\":\"visa.svg\",\"name\":\"visa\"...}',\n displayButtons: true,\n displayCardHolder: true,\n displaySave: true,\n cardHolderValue: \"mr smith\",\n onSubmit: () => {\n ((place here the method to handle the data returned by the hosted fields)) \n }\n };\n var norbr = new Norbr(configuration);\n\n ```\n\nWhen the customer clicks on the button to validate the form, NORBr catches the form content and creates a token.\n\nYou will then have to use this token to create the order once the customer clicks on the pay button.\n\nFinally you can customize the look and feel of the fields by using CSS.\n\nHere is a diagram of the possible flow for a Hosted Elements integration :\n\n<img src=\"https://content.pstmn.io/cf47246f-0975-481a-93d0-83476fa52fe2/RmxvdyBpbnRlZ3JhdGlvbiBob3N0ZWQgZmllbGRzLmpwZw==\">\n\n---\n\n<h1>Direct API</h1>\n\n<h2>Authentication</h2>\n\nThe NORBr API uses API keys to authenticate requests. You can view and manage your API keys in your NORBr account.\n\nYour API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.\n\nProvide your API key in the header of your call via the `x-api-key` field in the header. You do not need to provide a password.\n\nAll API requests must be made over HTTPS, calls made over plain HTTP will fail. API requests without authentication will also fail.\n\n---\n\n<h2>Endpoints</h2>\n\n| Sandbox | Production |\n| --- | --- |\n| api-sandbox.norbr.io/payment/checkout | api.norbr.io/payment/checkout |\n| api-sandbox.norbr.io/payment/order | api.norbr.io/payment/order |\n| api-sandbox.norbr.io/payment/maintenance | api.norbr.io/payment/maintenance |\n\n[Post /payment/checkout](#edaf3114-ac2e-46fb-8435-f803008d5dce)\n\nUsed to create a checkout\n\n[Post /payment/order](#2703f158-72d4-4633-b65e-683095d01af8)\n\nUsed to create an order\n\n[Post /payment/maintenance](#aeaea73b-85cf-4913-a4d4-d0e1125ea95a)\n\nUsed to capture or refund an order and void an authorization\n\n---\n\n<h2>Versionning</h2>\n\nAll API requests require to send the version of the API used. The current version of our API is 1.0.0.\n\nThe version of the API needs to be sent in the header of all requests.\n\n---",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "16928280",
"_collection_link": "https://apiorg.postman.co/workspace/ae14123d-9bb8-4276-9a6f-58a25abdf83a/collection/16928280-05bbd91e-02cf-4d96-9144-dfb5ca8ff884?action=share&source=collection_link&creator=16928280"
},
"item": [
{
"name": "Checkout",
"item": [
{
"name": "Create checkout",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "x-api-key",
"value": "Private api key",
"description": "Private api key",
"type": "text"
},
{
"key": "version",
"value": "1.0.0",
"type": "text"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "accept_url",
"value": "<string> max 255",
"description": "URL to redirect your customer to once the payment process is completed successfully.",
"type": "text"
},
{
"key": "amount",
"value": "<float>",
"description": "A positive number with 3 decimals digit max to describe the charge of the order",
"type": "text"
},
{
"key": "authentication_indicator",
"value": "<enum>",
"description": "Selects the authentication scenario you want applied for this order : no_3ds, ask_3ds, force_3ds",
"type": "text"
},
{
"key": "basket_content",
"value": "<array>",
"description": "Details of the basket item by item, please refer to the example to see all the fields available in the array. We strongly recommend that you either use this field or the 3 following ones : 'order_description`,`order_availability` and order_availability_date`. But not all at the same time.",
"type": "text"
},
{
"key": "basket_id",
"value": "<string>",
"description": "Unique identifier of the basket.",
"type": "text"
},
{
"key": "basket_type",
"value": "<string>",
"description": "Indicates the type of items in the basket : `physical`, `digital` or `mixed`",
"type": "text"
},
{
"key": "cancel_url",
"value": "<string> max 255",
"description": "URL to redirect your customer to if the payment is cancelled (for hosted page only)",
"type": "text"
},
{
"key": "challenge_preference",
"value": "<enum>",
"description": "Selects the authentication scenario you want applied for this order : `no_preference`,`challenge_mandatory`,`challenge_requested`,`no_challenge`",
"type": "text"
},
{
"key": "contract_id",
"value": "<string>",
"description": "The unique id of the contract between you and your customer.",
"type": "text"
},
{
"key": "currency",
"value": "<string>",
"description": "The 3-letter ISO currency code refering to the authorization currency",
"type": "text"
},
{
"key": "customer_account_add_payment_means_date",
"value": "<string>",
"description": "The date of the payment method 's registration on the customer's account.",
"type": "text"
},
{
"key": "customer_account_attempts_order_day",
"value": "<integer>",
"description": "The number of order (succesfull or failed) registered for this customer in the last 24 hours",
"type": "text"
},
{
"key": "customer_account_attempts_order_six_months",
"value": "<integer>",
"description": "The number of order (succesfull or failed) registered for this customer in the last 6 months",
"type": "text"
},
{
"key": "customer_account_attempts_order_year",
"value": "<integer>",
"description": "The number of order (succesfull or failed) registered for this customer in the last year",
"type": "text"
},
{
"key": "customer_account_change_date",
"value": "<string>",
"description": "The date of the last update of the customer's account.",
"type": "text"
},
{
"key": "customer_account_change_password_date",
"value": "<string>",
"description": "The date of the last password change on the customer's account.",
"type": "text"
},
{
"key": "customer_account_creation_date",
"value": "<string>",
"description": "The creation date of the customer's account.",
"type": "text"
},
{
"key": "customer_account_successful_orders_day",
"value": "<integer>",
"description": "The number of successful order registered for this customer in the last 24 hours",
"type": "text"
},
{
"key": "customer_account_successful_orders_six_months",
"value": "<integer>",
"description": "The number of successful order registered for this customer in the last 6 months",
"type": "text"
},
{
"key": "customer_account_successful_orders_year",
"value": "<integer>",
"description": "The number of successful order registered for this customer in the last year.",
"type": "text"
},
{
"key": "customer_billing_city",
"value": "<string>",
"description": "The billing customer city.",
"type": "text"
},
{
"key": "customer_billing_country",
"value": "<string>",
"description": "The billing customer country. 2-letter ISO country code",
"type": "text"
},
{
"key": "customer_billing_first_name",
"value": "<string>",
"description": "The billing customer first name.",
"type": "text"
},
{
"key": "customer_billing_last_name",
"value": "<string>",
"description": "The billing customer last name.",
"type": "text"
},
{
"key": "customer_billing_street_name",
"value": "<string>",
"description": "The billing customer address.",
"type": "text"
},
{
"key": "customer_billing_zip_code",
"value": "<string>",
"description": "The billing customer zip code.",
"type": "text"
},
{
"key": "customer_birth_date",
"value": "<string>",
"description": "The customer birth date. ",
"type": "text"
},
{
"key": "customer_browser_info_accept_header",
"value": "<string>",
"description": "The accept header value of the customer's browser.",
"type": "text"
},
{
"key": "customer_browser_info_color_depth",
"value": "<string>",
"description": "The color depth of the customer's browser in bits per pixel.",
"type": "text"
},
{
"key": "customer_browser_info_java_enabled",
"value": "<boolean>",
"description": "Indicates if the customer's browser is able to execute java.",
"type": "text"
},
{
"key": "customer_browser_info_js_enabled",
"value": "<boolean>",
"description": "Indicates if the customer's browser is able to execute javascript",
"type": "text"
},
{
"key": "customer_browser_info_language",
"value": "<string>",
"description": "The language of the customer's browser.",
"type": "text"
},
{
"key": "customer_browser_info_screen_height",
"value": "<integer>",
"description": "The height of the customer's browser.",
"type": "text"
},
{
"key": "customer_browser_info_screen_width",
"value": "<integer>",
"description": "The width of the customer's browser.",
"type": "text"
},
{
"key": "customer_browser_info_time_zone",
"value": "<string>",
"description": "The time zone of the customer's browser. It could be in the one of the following format:\n\"±hh:mm\", \"±hhmm\", or \"±hh\"",
"type": "text"
},
{
"key": "customer_browser_info_user_agent",
"value": "<string>",
"description": "The user agent of the customer's browser.",
"type": "text"
},
{
"key": "customer_city",
"value": "<string>",
"description": "The customer's city.",
"type": "text"
},
{
"key": "customer_country",
"value": "<string>",
"description": "The customer's country. 2-letter ISO country code",
"type": "text"
},
{
"key": "customer_email",
"value": "<email>",
"description": "The customer's e-mail address.",
"type": "text"
},
{
"key": "customer_first_name",
"value": "<string> max 255",
"description": "The customer's first name.",
"type": "text"
},
{
"key": "customer_gender",
"value": "<enum>",
"description": "The customer's gender : `male`, `female`, `other`",
"type": "text"
},
{
"key": "customer_id",
"value": "<string>",
"description": "The unique identifier of the customer.",
"type": "text"
},
{
"key": "customer_identification_number",
"value": "<string> max 255",
"description": "The customer's identification number. Depending on the payment method, this field can be used to send an ID number or a fiscal number.",
"type": "text"
},
{
"key": "customer_ip",
"value": "<string> 2 to 26",
"description": "The customer's ip address.",
"type": "text"
},
{
"key": "customer_items_reorder",
"value": "<boolean>",
"description": "Indicates if the customer has already ordered one of the items in the basket during the past year.",
"type": "text"
},
{
"key": "customer_last_name",
"value": "<string>",
"description": "The customer's last name.",
"type": "text"
},
{
"key": "customer_os_version",
"value": "<string>",
"description": "Version of the mobile os of the customer",
"type": "text"
},
{
"key": "customer_phone_number",
"value": "<string> 7 to 50",
"description": "The customer phone number.",
"type": "text"
},
{
"key": "customer_phone_number_type",
"value": "<string>",
"description": "The customer type of phone number : `mobile`, `home`, `work`",
"type": "text"
},
{
"key": "customer_street_name",
"value": "<string>",
"description": "The customer's address.",
"type": "text"
},
{
"key": "customer_zip_code",
"value": "<string>",
"description": "The customer's zip code.",
"type": "text"
},
{
"key": "decline_url",
"value": "<string> max 255",
"description": "URL to redirect your customer to after the payment is declined.",
"type": "text"
},
{
"key": "device_type",
"value": "<enum>",
"description": "The type of device used by the customer for this order: `mobile`, `laptop`, `desktop`",
"type": "text"
},
{
"key": "exception_url",
"value": "<string> max 255",
"description": "URL to redirect your customer to after a system failure.",
"type": "text"
},
{
"key": "expiration_date",
"value": "<string>",
"description": "The checkout expiration date. A date in ISO format. The expiration will be 15mn by default if not provided.",
"type": "text"
},
{
"key": "hosted_fields_version",
"value": "<string>",
"description": "Version of the hosted fields or hosted elements used",
"type": "text"
},
{
"key": "integration_id",
"value": "<string>",
"description": "An optional technical id to be provided by NORBr in very specific integrations (please ask via support@norbr.help).",
"type": "text"
},
{
"key": "is_customer_registered",
"value": "<boolean>",
"description": "Indicates if the customer has an account.",
"type": "text"
},
{
"key": "is_return_accepted",
"value": "<boolean>",
"description": "Indicates if returns are accepted for this order.",
"type": "text"
},
{
"key": "locale",
"value": "<string>",
"description": "The 2-letter alpha ISO country code (ex: en, fr, it) followed by the 2-letter ISO language code (ex: en_GB, fr_FR, it_IT)",
"type": "text"
},
{
"key": "max_attempts",
"value": "<integer>",
"description": "Maximum number of attempts possible on this order. Includes update and fallbacks",
"type": "text"
},
{
"key": "operation_type",
"value": "<enum>",
"description": "Specify the kind of order you want to create: authorize or direct_capture",
"type": "text"
},
{
"key": "order_availability",
"value": "<boolean>",
"description": "Availability of the order at the moment of the order.",
"type": "text"
},
{
"key": "order_availability_date",
"value": "<string>",
"description": "Estimated date of availability of the order if not available at the moment of the order.",
"type": "text"
},
{
"key": "order_description",
"value": "<string> max 255",
"description": "General description of the order.",
"type": "text"
},
{
"key": "order_merchant_id",
"value": "<string> max 255",
"description": "(Required) Unique identifier used by the merchant for an order",
"type": "text"
},
{
"key": "order_tax_amount",
"value": "<float>",
"description": "Total amount of tax for the order",
"type": "text"
},
{
"key": "payment_channel",
"value": "<string>",
"description": "Describes where the transaction is taking place. Possible values : `e-commerce`, `moto`, `pos`",
"type": "text"
},
{
"key": "payment_method_name",
"value": "<string>",
"description": "The name of the method used by the customer to pay this order. Please refer to the [APM folder](https://developer.norbr.io/#cabed830-ec7f-4516-af2c-99f6b49f0d09)",
"type": "text"
},
{
"key": "payment_method_type",
"value": "<enum>",
"type": "text"
},
{
"key": "pending_url",
"value": "<string>",
"description": "URL to redirect your customer to when the payment request was processed but response is not yet available",
"type": "text"
},
{
"key": "plan_id",
"value": "<string>",
"description": "The unique id of the plan subscribed by the customer.",
"type": "text"
},
{
"key": "sca_exemption_reason",
"value": "<enum>",
"description": "Indicates the reason why the order should be exempted from 3DSecure : low_value, corporate, trusted_beneficiary, risk_analysis",
"type": "text"
},
{
"key": "shipping_address_city",
"value": "<string> max 255",
"description": "The shipping address city.",
"type": "text"
},
{
"key": "shipping_address_country",
"value": "<string> max 255",
"description": "The shipping address country. 2-letter ISO country code",
"type": "text"
},
{
"key": "shipping_address_first_use_date",
"value": "<string>",
"description": "The date when the shipping address was first used.",
"type": "text"
},
{
"key": "shipping_address_state",
"value": "<string>",
"description": "The shipping address state",
"type": "text"
},
{
"key": "shipping_address_street_name_line1",
"value": "<string> max 255",
"description": "The shipping address street name (first line)",
"type": "text"
},
{
"key": "shipping_address_street_name_line2",
"value": "<string> max 255",
"description": "The shipping address street name (second line)",
"type": "text"
},
{
"key": "shipping_address_zip_code",
"value": "<string> max 255",
"description": "The shipping address zip code.",
"type": "text"
},
{
"key": "shipping_carrier_name",
"value": "<string> max 255",
"description": "Name of the carrier used for the shipping",
"type": "text"
},
{
"key": "shipping_delivery_method",
"value": "<string>",
"description": "Indicates where the order is being delivered : `customer_address`, `in_store`, `pickup_store`, `other`",
"type": "text"
},
{
"key": "shipping_delivery_range",
"value": "<enum>",
"description": "Estimated range of delivery. Possible values : `sameday`, `lessthan2days`, `morethan2days`",
"type": "text"
},
{
"key": "shipping_email",
"value": "<string> max 25",
"description": "Email for the shipping",
"type": "text"
},
{
"key": "shipping_first_name",
"value": "<string> max 255",
"description": "The shipping address first name.",
"type": "text"
},
{
"key": "shipping_id",
"value": "<string> max 255",
"description": "Unique identifier of the shipping.",
"type": "text"
},
{
"key": "shipping_last_name",
"value": "<string> max 255",
"description": "The shipping address last name.",
"type": "text"
},
{
"key": "shipping_phone_number",
"value": "<string> 7 to 25",
"description": "The shipping address phone number",
"type": "text"
},
{
"key": "shipping_price",
"value": "<float>",
"description": "Total price of the delivery.",
"type": "text"
},
{
"key": "shipping_tax",
"value": "<string>",
"description": "Amount of tax included in the total shipping amount.",
"type": "text"
},
{
"key": "shipping_tax_rate",
"value": "<string>",
"description": "Tax rate applied on the shipping.",
"type": "text"
},
{
"key": "subscriber_id",
"value": "<string>",
"description": "The unique id of the suscriber.",
"type": "text"
},
{
"key": "subscription_count",
"value": "<integer>",
"description": "The rank in the installments plan.",
"type": "text"
},
{
"key": "subscription_description",
"value": "<string> max 255",
"description": "The description of the subscription.",
"type": "text"
},
{
"key": "subscription_end_date",
"value": "<string>",
"description": "The date of the end of the subscription",
"type": "text"
},
{
"key": "subscription_recurrence",
"value": "<enum>",
"description": "The occurence of the subscription :weekly, fifteen_days, month, two_months, three_months, yearly, other",
"type": "text"
},
{
"key": "sdk_version",
"value": "<string>",
"description": "Version of the sdk used. android_version_number, ios_version_number",
"type": "text"
},
{
"key": "token_type",
"value": "<enum>",
"description": "The type of token that will be used: \"oneshot\",\"recurring\"",
"type": "text"
},
{
"key": "type",
"value": "<enum>",
"description": "(Required) The type of checkout: “hosted_fields”, “hosted_page”,”api,”mobile_sdk”,”qrcode”,”mail_to_pay”",
"type": "text"
},
{
"key": "website_url",
"value": "<string>",
"description": "The website where the order was issued. ",
"type": "text"
}
]
},
"url": {
"raw": "{{apiUrl}}/payment/checkout",
"host": [
"{{apiUrl}}"
],
"path": [
"payment",
"checkout"
]
},
"description": "The `/payment/checkout` request can be used for different use cases and accept numerous information about your customer or the order itself.\n\nBelow, we list **all** the fields that are accepted in the `/payment/checkout` request, to give you the maximum overview of our endpoint.\n\nYou don't have to use them all, feel free to refer to the specific use case requests described in the documentation."
},
"response": [
{
"name": "Create checkout for type API",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
},
{
"key": "version",
"value": "1.0.0",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"api\",\n \"locale\": \"fr_FR\",\n \"payment_method_name\": \"visa\",\n \"operation_type\":\"authorize\",\n \"amount\": 68.18,\n \"currency\": \"EUR\",\n \"order_merchant_id\": \"276398531664\",\n \"payment_channel\": \"e-commerce\",\n \"website_url\": \"https://www.example.com/\",\n \"device_type\": \"mobile\",\n \"customer_id\": \"4025251046660958\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_first_name\": \"Kirby\",\n \"customer_last_name\": \"Nash\",\n \"customer_identification_number\": \"GTF730340H7\",\n \"customer_gender\": \"female\",\n \"customer_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_city\": \"SARTROUVILLE\",\n \"customer_zip_code\": \"78500\",\n \"customer_country\": \"FR\",\n \"customer_ip\": \"203.200.6.117\",\n \"customer_billing_first_name\": \"Kirby\",\n \"customer_billing_last_name\": \"Nash\",\n \"customer_billing_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_billing_city\": \"SARTROUVILLE\",\n \"customer_billing_zip_code\": \"78500\",\n \"customer_billing_country\": \"FR\",\n \"customer_birth_date\": \"2020-06-22\",\n \"customer_phone_number\": \"0686606737\",\n \"customer_phone_number_type\": \"mobile\",\n \"is_customer_registered\": true,\n \"customer_account_creation_date\": \"2020-03-19\",\n \"customer_account_change_date\": \"2020-06-18\",\n \"customer_account_change_password_date\": \"2020-06-18\",\n \"customer_account_attempts_order_day\": \"1\",\n \"customer_account_attempts_order_six_months\": \"6\",\n \"customer_account_attempts_order_year\": \"8\",\n \"customer_account_successful_orders_day\": \"1\",\n \"customer_account_successful_orders_six_months\": \"5\",\n \"customer_account_successful_orders_year\": \"7\",\n \"customer_account_add_payment_means_date\": \"2020-06-18\",\n \"customer_browser_info_color_depth\": \"test1\",\n \"customer_browser_info_accept_header\": \"test2\",\n \"customer_browser_info_java_enabled\": true,\n \"customer_browser_info_js_enabled\": false,\n \"customer_browser_info_language\": \"FR\",\n \"customer_browser_info_screen_height\": 119,\n \"customer_browser_info_screen_width\": 333,\n \"customer_browser_info_time_zone\": \"+01:00\",\n \"customer_browser_info_user_agent\": \"Mozilla---\",\n \"is_return_accepted\": true,\n \"basket_id\": \"BSK-5942478750\",\n \"basket_type\": \"physical\",\n \"basket_content\": [\n {\n \"product_sku\": \"TSH-MED-WHI-COT\",\n \"product_id\": \"39851062\",\n \"product_name\": \"Tee Shirt MED\",\n \"product_description\": \"White tee shirt, size M\",\n \"product_price\": \"20.00\",\n \"product_quantity\": \"2\",\n \"product_availability\": true,\n \"product_type\": \"physical\",\n \"product_tax_amount\": \"4.14\",\n \"total_amount\": \"44.14\",\n \"seller_id\": \"SEL-07428099\",\n \"seller_name\": \"nounplus\",\n \"seller_commission\": \"4.41\"\n },\n {\n \"product_sku\": \"DRE-MED-RED-LEA\",\n \"product_id\": \"40547343\",\n \"product_name\": \"Dress MED\",\n \"product_description\": \"Red dress, size M\",\n \"product_price\": \"22\",\n \"product_quantity\": \"1\",\n \"product_availability\": true,\n \"product_type\": \"physical\",\n \"product_tax_amount\": \"2.04\",\n \"total_amount\": \"24.04\",\n \"seller_id\": \"SEL-54539757\",\n \"seller_name\": \"faruber\",\n \"seller_commission\": \"2.4\"\n }\n ],\n \"shipping_id\": \"318378289489\",\n \"shipping_carrier_name\": \"DHL\",\n \"shipping_delivery_range\": \"sameday\",\n \"shipping_delivery_method\": \"customer_address\",\n \"shipping_price\": 20,\n \"shipping_tax\": 5,\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_phone_number\": \"\",\n \"shipping_address_street_name_line1\": \"16 rue de Raymond Poincaré\",\n \"shipping_address_street_name_line2\": null,\n \"shipping_address_city\": \"NEUILLY-SUR-SEINEs\",\n \"shipping_address_zip_code\": \"92200\",\n \"shipping_address_country\": \"FR\",\n \"shipping_address_first_use_date\": \"2020-03-19\",\n \"plan_id\": \"PL-532332\",\n \"contract_id\": \"CT-532332\",\n \"subscriber_id\": \"SBE-532332\",\n \"subscription_description\": \"3 months waranty\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{apiUrl}}/payment/checkout",
"host": [
"{{apiUrl}}"
],
"path": [
"payment",
"checkout"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "environment",
"value": "{{environment}}",
"description": "",
"type": "text"
}
],
"cookie": [],
"body": "{\n \"result\": {\n \"code\": \"011111\",\n \"description\": \"checkout created successfully\"\n },\n \"checkout\": {\n \"accept_url\": \"https://www.test.com\",\n \"amount\": 68.18,\n \"basket_content\": [\n {\n \"product_availability\": true,\n \"product_description\": \"White tee shirt, size M\",\n \"product_id\": \"39851062\",\n \"product_name\": \"Tee Shirt MED\",\n \"product_price\": 20,\n \"product_quantity\": 2,\n \"product_sku\": \"TSH-MED-WHI-COT\",\n \"product_tax_amount\": 4.14,\n \"product_type\": \"physical\",\n \"seller_commission\": 4.41,\n \"seller_id\": \"SEL-07428099\",\n \"seller_name\": \"nounplus\",\n \"total_amount\": 44.14\n },\n {\n \"product_availability\": true,\n \"product_description\": \"Red dress, size M\",\n \"product_id\": \"40547343\",\n \"product_name\": \"Dress MED\",\n \"product_price\": 22,\n \"product_quantity\": 1,\n \"product_sku\": \"DRE-MED-RED-LEA\",\n \"product_tax_amount\": 2.04,\n \"product_type\": \"physical\",\n \"seller_commission\": 2.4,\n \"seller_id\": \"SEL-54539757\",\n \"seller_name\": \"faruber\",\n \"total_amount\": 24.04\n }\n ],\n \"basket_id\": \"BSK-5942478750\",\n \"basket_type\": \"physical\",\n \"contract_id\": \"CT-532332\",\n \"currency\": \"EUR\",\n \"customer_account_add_payment_means_date\": \"2020-06-18T00:00:00.000Z\",\n \"customer_account_attempts_order_day\": 1,\n \"customer_account_attempts_order_six_months\": 6,\n \"customer_account_attempts_order_year\": 8,\n \"customer_account_change_date\": \"2020-06-18T00:00:00.000Z\",\n \"customer_account_change_password_date\": \"2020-06-18T00:00:00.000Z\",\n \"customer_account_creation_date\": \"2020-03-19T00:00:00.000Z\",\n \"customer_account_successful_orders_day\": 1,\n \"customer_account_successful_orders_six_months\": 5,\n \"customer_account_successful_orders_year\": 7,\n \"customer_billing_city\": \"SARTROUVILLE\",\n \"customer_billing_country\": \"FR\",\n \"customer_billing_first_name\": \"Kirby\",\n \"customer_billing_last_name\": \"Nash\",\n \"customer_billing_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_billing_zip_code\": \"78500\",\n \"customer_birth_date\": \"2020-06-22T00:00:00.000Z\",\n \"customer_browser_info_accept_header\": \"test2\",\n \"customer_browser_info_color_depth\": \"test1\",\n \"customer_browser_info_java_enabled\": true,\n \"customer_browser_info_js_enabled\": false,\n \"customer_browser_info_language\": \"FR\",\n \"customer_browser_info_screen_height\": 119,\n \"customer_browser_info_screen_width\": 333,\n \"customer_browser_info_time_zone\": \"Paris/London\",\n \"customer_browser_info_user_agent\": \"Mozilla---\",\n \"customer_city\": \"SARTROUVILLE\",\n \"customer_country\": \"FR\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_first_name\": \"Kirby\",\n \"customer_gender\": \"female\",\n \"customer_id\": \"4025251046660958\",\n \"customer_identification_number\": \"GTF730340H7\",\n \"customer_ip\": \"203.200.6.117\",\n \"customer_last_name\": \"Nash\",\n \"customer_phone_number\": \"0686606737\",\n \"customer_phone_number_type\": \"mobile\",\n \"customer_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_zip_code\": \"78500\",\n \"decline_url\": \"https://www.test.com\",\n \"device_type\": \"mobile\",\n \"exception_url\": \"https://www.test.com\",\n \"expiration_date\": \"2023-10-18T15:08:21.133Z\",\n \"is_customer_registered\": true,\n \"is_return_accepted\": true,\n \"locale\": \"fr-FR\",\n \"operation_type\": \"authorize\",\n \"order_merchant_id\": \"276398531664\",\n \"token_type\": \"oneshot\",\n \"type\": \"api\",\n \"payment_channel\": \"e-commerce\",\n \"payment_method_name\": \"visa\",\n \"pending_url\": \"https://www.test.com\",\n \"plan_id\": \"PL-532332\",\n \"shipping_address_city\": \"NEUILLY-SUR-SEINEs\",\n \"shipping_address_country\": \"FR\",\n \"shipping_address_first_use_date\": \"2020-03-19T00:00:00.000Z\",\n \"shipping_address_street_name_line1\": \"16 rue de Raymond Poincaré\",\n \"shipping_address_street_name_line2\": null,\n \"shipping_address_zip_code\": \"92200\",\n \"shipping_carrier_name\": \"DHL\",\n \"shipping_delivery_method\": \"customer_address\",\n \"shipping_delivery_range\": \"sameday\",\n \"shipping_first_name\": \"\",\n \"shipping_id\": \"318378289489\",\n \"shipping_last_name\": \"\",\n \"shipping_phone_number\": \"\",\n \"shipping_price\": 20,\n \"shipping_tax\": 5,\n \"status\": \"created\",\n \"subscriber_id\": \"SBE-532332\",\n \"subscription_description\": \"3 months waranty\",\n \"website_url\": \"www.exemple.com\",\n \"checkout_id\": \"652ff161fadcf444bedb4f65\"\n },\n \"payment_methods\": {\n \"payment_methods_available\": [\n {\n \"component_type\": \"card\",\n \"countries\": [\n \"all\"\n ],\n \"display_name\": \"Visa\",\n \"form_fields\": [\n {\n \"name\": \"card_number\",\n \"label\": \"card_number\",\n \"display_name\": \"card_number\",\n \"data_type\": \"integer\",\n \"enum\": [],\n \"example\": \"4111 xxxx xxxx xxxx\"\n },\n {\n \"name\": \"cvc\",\n \"label\": \"cvc\",\n \"display_name\": \"cvc\",\n \"data_type\": \"integer\",\n \"enum\": [],\n \"example\": \"123\"\n },\n {\n \"name\": \"card_validity\",\n \"label\": \"card_validity\",\n \"display_name\": \"card_validity\",\n \"data_type\": \"date\",\n \"enum\": [],\n \"example\": \"MM/YY\"\n },\n {\n \"name\": \"cardholder_name\",\n \"label\": \"cardholder_name\",\n \"display_name\": \"cardholder_name\",\n \"data_type\": \"name\",\n \"enum\": [],\n \"example\": \"Mickael Smith\"\n }\n ],\n \"logo\": \"visa.svg\",\n \"logo_png\": \"visa.png\",\n \"logo_colorbg\": \"Visa_colorbg.svg\",\n \"logo_colorbg_png\": \"Visa_colorbg@2x.png\",\n \"logo_favicon_colorbg\": \"Visa_favicon_colorbg.svg\",\n \"logo_favicon_colorbg_png\": \"Visa_favicon_colorbg@2x.png\",\n \"logo_favicon_whitebg\": \"Visa_favicon_whitebg.svg\",\n \"logo_favicon_whitebg_png\": \"Visa_favicon_whitebg@2x.png\",\n \"logo_white\": \"Visa_white.svg\",\n \"logo_white_png\": \"Visa_white@2x.png\",\n \"logo_whitebg\": \"Visa_whitebg.svg\",\n \"logo_whitebg_png\": \"Visa_whitebg@2x.png\",\n \"name\": \"visa\",\n \"partner\": \"checkout\",\n \"required_fields\": [\n \"payment_method_name\",\n \"token\",\n \"amount\",\n \"currency\"\n ]\n }\n ],\n \"payment_methods_saved\": [\n {\n \"component_type\": \"card\",\n \"countries\": [\n \"all\"\n ],\n \"display_name\": \"Visa\",\n \"form_fields\": [\n {\n \"name\": \"card_number\",\n \"label\": \"card_number\",\n \"display_name\": \"card_number\",\n \"data_type\": \"integer\",\n \"enum\": [],\n \"example\": \"4111 xxxx xxxx xxxx\"\n },\n {\n \"name\": \"cvc\",\n \"label\": \"cvc\",\n \"display_name\": \"cvc\",\n \"data_type\": \"integer\",\n \"enum\": [],\n \"example\": \"123\"\n },\n {\n \"name\": \"card_validity\",\n \"label\": \"card_validity\",\n \"display_name\": \"card_validity\",\n \"data_type\": \"date\",\n \"enum\": [],\n \"example\": \"MM/YY\"\n },\n {\n \"name\": \"cardholder_name\",\n \"label\": \"cardholder_name\",\n \"display_name\": \"cardholder_name\",\n \"data_type\": \"name\",\n \"enum\": [],\n \"example\": \"Mickael Smith\"\n }\n ],\n \"logo\": \"visa.svg\",\n \"logo_png\": \"visa.png\",\n \"logo_colorbg\": \"Visa_colorbg.svg\",\n \"logo_colorbg_png\": \"Visa_colorbg@2x.png\",\n \"logo_favicon_colorbg\": \"Visa_favicon_colorbg.svg\",\n \"logo_favicon_colorbg_png\": \"Visa_favicon_colorbg@2x.png\",\n \"logo_favicon_whitebg\": \"Visa_favicon_whitebg.svg\",\n \"logo_favicon_whitebg_png\": \"Visa_favicon_whitebg@2x.png\",\n \"logo_white\": \"Visa_white.svg\",\n \"logo_white_png\": \"Visa_white@2x.png\",\n \"logo_whitebg\": \"Visa_whitebg.svg\",\n \"logo_whitebg_png\": \"Visa_whitebg@2x.png\",\n \"name\": \"visa\",\n \"partner\": \"checkout\",\n \"required_fields\": [\n \"payment_method_name\",\n \"token\",\n \"amount\",\n \"currency\"\n ],\n \"id\": \"63e112302c34b18c94c9a1f5\",\n \"nb_use\": 1,\n \"date_last_use\": \"2023-02-06T14:44:00.615Z\",\n \"token\": \"78eed88ab5f60ff92904f4298977b8e609d7d48788265e8af056446e28c7ffd2\",\n \"payment_details\": [\n {\n \"key\": \"last_4_digits\",\n \"value\": \"4242\"\n },\n {\n \"key\": \"first_6_digits\",\n \"value\": \"424242\"\n },\n {\n \"key\": \"card_validity_month\",\n \"value\": \"02\"\n },\n {\n \"key\": \"card_validity_year\",\n \"value\": \"25\"\n }\n ]\n }\n ],\n \"payment_methods_used\": [\n {\n \"component_type\": \"card\",\n \"countries\": [\n \"all\"\n ],\n \"display_name\": \"Visa\",\n \"form_fields\": [\n {\n \"name\": \"card_number\",\n \"label\": \"card_number\",\n \"display_name\": \"card_number\",\n \"data_type\": \"integer\",\n \"enum\": [],\n \"example\": \"4111 xxxx xxxx xxxx\"\n },\n {\n \"name\": \"cvc\",\n \"label\": \"cvc\",\n \"display_name\": \"cvc\",\n \"data_type\": \"integer\",\n \"enum\": [],\n \"example\": \"123\"\n },\n {\n \"name\": \"card_validity\",\n \"label\": \"card_validity\",\n \"display_name\": \"card_validity\",\n \"data_type\": \"date\",\n \"enum\": [],\n \"example\": \"MM/YY\"\n },\n {\n \"name\": \"cardholder_name\",\n \"label\": \"cardholder_name\",\n \"display_name\": \"cardholder_name\",\n \"data_type\": \"name\",\n \"enum\": [],\n \"example\": \"Mickael Smith\"\n }\n ],\n \"logo\": \"visa.svg\",\n \"logo_png\": \"visa.png\",\n \"logo_colorbg\": \"Visa_colorbg.svg\",\n \"logo_colorbg_png\": \"Visa_colorbg@2x.png\",\n \"logo_favicon_colorbg\": \"Visa_favicon_colorbg.svg\",\n \"logo_favicon_colorbg_png\": \"Visa_favicon_colorbg@2x.png\",\n \"logo_favicon_whitebg\": \"Visa_favicon_whitebg.svg\",\n \"logo_favicon_whitebg_png\": \"Visa_favicon_whitebg@2x.png\",\n \"logo_white\": \"Visa_white.svg\",\n \"logo_white_png\": \"Visa_white@2x.png\",\n \"logo_whitebg\": \"Visa_whitebg.svg\",\n \"logo_whitebg_png\": \"Visa_whitebg@2x.png\",\n \"name\": \"visa\",\n \"partner\": \"checkout\",\n \"required_fields\": [\n \"payment_method_name\",\n \"token\",\n \"amount\",\n \"currency\"\n ],\n \"nb_use\": 30,\n \"date_last_use\": \"2023-02-08T09:13:26.364Z\"\n }\n ]\n }\n}"
},
{
"name": "Create checkout for type Hosted Page",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
},
{
"key": "version",
"value": "1.0.0",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"hosted_page\",\n \"locale\": \"fr_FR\",\n \"payment_method_name\": \"visa\",\n \"operation_type\":\"authorize\",\n \"amount\": 68.18,\n \"currency\": \"EUR\",\n \"order_merchant_id\": \"276398531664\",\n \"payment_channel\": \"e-commerce\",\n \"website_url\": \"https://www.example.com/\",\n \"cancel_url\": \"https://www.google.com/search?q=cancel\",\n \"device_type\": \"mobile\",\n \"customer_id\": \"4025251046660958\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_first_name\": \"Kirby\",\n \"customer_last_name\": \"Nash\",\n \"customer_identification_number\": \"GTF730340H7\",\n \"customer_gender\": \"female\",\n \"customer_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_city\": \"SARTROUVILLE\",\n \"customer_zip_code\": \"78500\",\n \"customer_country\": \"FR\",\n \"customer_ip\": \"203.200.6.117\",\n \"customer_billing_first_name\": \"Kirby\",\n \"customer_billing_last_name\": \"Nash\",\n \"customer_billing_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_billing_city\": \"SARTROUVILLE\",\n \"customer_billing_zip_code\": \"78500\",\n \"customer_billing_country\": \"FR\",\n \"customer_birth_date\": \"2020-06-22\",\n \"customer_phone_number\": \"0686606737\",\n \"customer_phone_number_type\": \"mobile\",\n \"is_customer_registered\": true,\n \"customer_account_creation_date\": \"2020-03-19\",\n \"customer_account_change_date\": \"2020-06-18\",\n \"customer_account_change_password_date\": \"2020-06-18\",\n \"customer_account_attempts_order_day\": \"1\",\n \"customer_account_attempts_order_six_months\": \"6\",\n \"customer_account_attempts_order_year\": \"8\",\n \"customer_account_successful_orders_day\": \"1\",\n \"customer_account_successful_orders_six_months\": \"5\",\n \"customer_account_successful_orders_year\": \"7\",\n \"customer_account_add_payment_means_date\": \"2020-06-18\",\n \"customer_browser_info_color_depth\": \"test1\",\n \"customer_browser_info_accept_header\": \"test2\",\n \"customer_browser_info_java_enabled\": true,\n \"customer_browser_info_js_enabled\": false,\n \"customer_browser_info_language\": \"FR\",\n \"customer_browser_info_screen_height\": 119,\n \"customer_browser_info_screen_width\": 333,\n \"customer_browser_info_time_zone\": \"+01:00\",\n \"customer_browser_info_user_agent\": \"Mozilla---\",\n \"is_return_accepted\": true,\n \"basket_id\": \"BSK-5942478750\",\n \"basket_type\": \"physical\",\n \"basket_content\": [\n {\n \"product_sku\": \"TSH-MED-WHI-COT\",\n \"product_id\": \"39851062\",\n \"product_name\": \"Tee Shirt MED\",\n \"product_description\": \"White tee shirt, size M\",\n \"product_price\": \"20.00\",\n \"product_quantity\": \"2\",\n \"product_availability\": true,\n \"product_type\": \"physical\",\n \"product_tax_amount\": \"4.14\",\n \"total_amount\": \"44.14\",\n \"seller_id\": \"SEL-07428099\",\n \"seller_name\": \"nounplus\",\n \"seller_commission\": \"4.41\"\n },\n {\n \"product_sku\": \"DRE-MED-RED-LEA\",\n \"product_id\": \"40547343\",\n \"product_name\": \"Dress MED\",\n \"product_description\": \"Red dress, size M\",\n \"product_price\": \"22\",\n \"product_quantity\": \"1\",\n \"product_availability\": true,\n \"product_type\": \"physical\",\n \"product_tax_amount\": \"2.04\",\n \"total_amount\": \"24.04\",\n \"seller_id\": \"SEL-54539757\",\n \"seller_name\": \"faruber\",\n \"seller_commission\": \"2.4\"\n }\n ],\n \"shipping_id\": \"318378289489\",\n \"shipping_carrier_name\": \"DHL\",\n \"shipping_delivery_range\": \"sameday\",\n \"shipping_delivery_method\": \"customer_address\",\n \"shipping_price\": 20,\n \"shipping_tax\": 5,\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_phone_number\": \"\",\n \"shipping_address_street_name_line1\": \"16 rue de Raymond Poincaré\",\n \"shipping_address_street_name_line2\": null,\n \"shipping_address_city\": \"NEUILLY-SUR-SEINEs\",\n \"shipping_address_zip_code\": \"92200\",\n \"shipping_address_country\": \"FR\",\n \"shipping_address_first_use_date\": \"2020-03-19\",\n \"plan_id\": \"PL-532332\",\n \"contract_id\": \"CT-532332\",\n \"subscriber_id\": \"SBE-532332\",\n \"subscription_description\": \"3 months waranty\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{apiUrl}}/payment/checkout",
"host": [
"{{apiUrl}}"
],
"path": [
"payment",
"checkout"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "environment",
"value": "{{environment}}",
"description": "",
"type": "text"
}
],
"cookie": [],
"body": "{\n \"result\": {\n \"code\": \"011111\",\n \"description\": \"checkout created successfully\"\n },\n \"redirect_url\": \"https://securepay-sandbox.norbr.com/d7b455b1c3fa3ff68da50e64db9ebec37e5497f1e0308fcb732d8fa3f20f49cc\",\n \"checkout\": {\n \"accept_url\": \"https://www.test.com\",\n \"amount\": 68.18,\n \"basket_content\": [\n {\n \"product_availability\": true,\n \"product_description\": \"White tee shirt, size M\",\n \"product_id\": \"39851062\",\n \"product_name\": \"Tee Shirt MED\",\n \"product_price\": 20,\n \"product_quantity\": 2,\n \"product_sku\": \"TSH-MED-WHI-COT\",\n \"product_tax_amount\": 4.14,\n \"product_type\": \"physical\",\n \"seller_commission\": 4.41,\n \"seller_id\": \"SEL-07428099\",\n \"seller_name\": \"nounplus\",\n \"total_amount\": 44.14\n },\n {\n \"product_availability\": true,\n \"product_description\": \"Red dress, size M\",\n \"product_id\": \"40547343\",\n \"product_name\": \"Dress MED\",\n \"product_price\": 22,\n \"product_quantity\": 1,\n \"product_sku\": \"DRE-MED-RED-LEA\",\n \"product_tax_amount\": 2.04,\n \"product_type\": \"physical\",\n \"seller_commission\": 2.4,\n \"seller_id\": \"SEL-54539757\",\n \"seller_name\": \"faruber\",\n \"total_amount\": 24.04\n }\n ],\n \"basket_id\": \"BSK-5942478750\",\n \"basket_type\": \"physical\",\n \"cancel_url\": \"https://www.google.com/search?q=cancel\",\n \"contract_id\": \"CT-532332\",\n \"currency\": \"EUR\",\n \"customer_account_add_payment_means_date\": \"2020-06-18T00:00:00.000Z\",\n \"customer_account_attempts_order_day\": 1,\n \"customer_account_attempts_order_six_months\": 6,\n \"customer_account_attempts_order_year\": 8,\n \"customer_account_change_date\": \"2020-06-18T00:00:00.000Z\",\n \"customer_account_change_password_date\": \"2020-06-18T00:00:00.000Z\",\n \"customer_account_creation_date\": \"2020-03-19T00:00:00.000Z\",\n \"customer_account_successful_orders_day\": 1,\n \"customer_account_successful_orders_six_months\": 5,\n \"customer_account_successful_orders_year\": 7,\n \"customer_billing_city\": \"SARTROUVILLE\",\n \"customer_billing_country\": \"FR\",\n \"customer_billing_first_name\": \"Kirby\",\n \"customer_billing_last_name\": \"Nash\",\n \"customer_billing_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_billing_zip_code\": \"78500\",\n \"customer_birth_date\": \"2020-06-22T00:00:00.000Z\",\n \"customer_browser_info_accept_header\": \"test2\",\n \"customer_browser_info_color_depth\": \"test1\",\n \"customer_browser_info_java_enabled\": true,\n \"customer_browser_info_js_enabled\": false,\n \"customer_browser_info_language\": \"FR\",\n \"customer_browser_info_screen_height\": 119,\n \"customer_browser_info_screen_width\": 333,\n \"customer_browser_info_time_zone\": \"Paris/London\",\n \"customer_browser_info_user_agent\": \"Mozilla---\",\n \"customer_city\": \"SARTROUVILLE\",\n \"customer_country\": \"FR\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_first_name\": \"Kirby\",\n \"customer_gender\": \"female\",\n \"customer_id\": \"4025251046660958\",\n \"customer_identification_number\": \"GTF730340H7\",\n \"customer_ip\": \"203.200.6.117\",\n \"customer_last_name\": \"Nash\",\n \"customer_phone_number\": \"0686606737\",\n \"customer_phone_number_type\": \"mobile\",\n \"customer_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_zip_code\": \"78500\",\n \"decline_url\": \"https://www.test.com\",\n \"device_type\": \"mobile\",\n \"exception_url\": \"https://www.test.com\",\n \"expiration_date\": \"2023-10-18T15:09:03.668Z\",\n \"is_customer_registered\": true,\n \"is_return_accepted\": true,\n \"locale\": \"fr-FR\",\n \"operation_type\": \"authorize\",\n \"order_merchant_id\": \"276398531664\",\n \"token_type\": \"oneshot\",\n \"type\": \"hosted_page\",\n \"payment_channel\": \"e-commerce\",\n \"payment_method_name\": \"visa\",\n \"pending_url\": \"https://www.test.com\",\n \"plan_id\": \"PL-532332\",\n \"shipping_address_city\": \"NEUILLY-SUR-SEINEs\",\n \"shipping_address_country\": \"FR\",\n \"shipping_address_first_use_date\": \"2020-03-19T00:00:00.000Z\",\n \"shipping_address_street_name_line1\": \"16 rue de Raymond Poincaré\",\n \"shipping_address_street_name_line2\": null,\n \"shipping_address_zip_code\": \"92200\",\n \"shipping_carrier_name\": \"DHL\",\n \"shipping_delivery_method\": \"customer_address\",\n \"shipping_delivery_range\": \"sameday\",\n \"shipping_first_name\": \"\",\n \"shipping_id\": \"318378289489\",\n \"shipping_last_name\": \"\",\n \"shipping_phone_number\": \"\",\n \"shipping_price\": 20,\n \"shipping_tax\": 5,\n \"status\": \"created\",\n \"subscriber_id\": \"SBE-532332\",\n \"subscription_description\": \"3 months waranty\",\n \"website_url\": \"www.exemple.com\",\n \"checkout_id\": \"652ff18bfadcf444bedb4f83\"\n }\n}"
}
]
}
],
"description": "Use this endpoint to build and customize your checkout depending on your customer specific situation and always be up to date between your payment stack and your payment page without further development.\n\nUse the `checkout_id` from the response when initiating the .js and directly see the result on your checkout page.\n\nOr use all the information from the response to build your own page with the required fields and logos for each payment methods."
},
{
"name": "Order",
"item": [
{
"name": "Create an order",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "x-api-key",
"value": "Private api key"
},
{
"key": "version",
"value": "1.0.0"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "operation_type",
"value": "<string>",
"description": "(Required) Specify the kind of order you want to create: `authorize` or `direct_capture`",
"type": "text"
},
{
"key": "token",
"value": "<string>",
"description": "(Required) Given in response to the `/payment/token` request",
"type": "text"
},
{
"key": "checkout_id",
"value": "<uuid>",
"description": "(Required) Specify the id of the checkout previously created. ",
"type": "text"
},
{
"key": "merchant_contract",
"value": "<string>",
"description": "The merchant contract id is used to process the transaction. You will find this information in your NORBr account",
"type": "text"
},
{
"key": "payment_method_name",
"value": "<string> ",
"description": "The name of the method used by the customer to pay this order. Please refer to the [APM folder](https://developer.norbr.io/#cabed830-ec7f-4516-af2c-99f6b49f0d09)",
"type": "text"
},
{
"key": "amount",
"value": "<float>",
"description": "(Required) A positive number with 3 decimals digit max to describe the charge of the order.",
"type": "text"
},
{
"key": "currency",
"value": "<string>",
"description": "(Required) The 3-letter ISO currency code refering to the authorization currency",
"type": "text"
},
{
"key": "order_merchant_id",
"value": "<string>",
"description": "(Required) Unique identifier used by the merchant for an order",
"type": "text"
},
{
"key": "payment_channel",
"value": "<string>",
"description": "(Required) Describes where the transaction is taking place : `e-commerce`, `recurring`, `moto`,` pos`",
"type": "text"
},
{
"key": "website_url",
"value": "<string>",
"description": "The website where the order was issued. ",
"type": "text"
},
{
"key": "customer_id",
"value": "<string>",
"description": "The unique identifier of the customer.",
"type": "text"
},
{
"key": "customer_email",
"value": "<email>",
"description": "The customer's e-mail address.",
"type": "text"
},
{
"key": "customer_first_name",
"value": "<string>",
"description": "The customer's first name.",
"type": "text"
},
{
"key": "customer_last_name",
"value": "<string>",
"description": "The customer's last name.",
"type": "text"
},
{
"key": "customer_street_name",
"value": "<string>",
"description": "The customer's address.",
"type": "text"
},
{
"key": "customer_city",
"value": "<string>",
"description": "The customer's city.",
"type": "text"
},
{
"key": "customer_zip_code",
"value": "<string>",
"description": "The customer's zip code.",
"type": "text"
},
{
"key": "customer_country",
"value": "<string>",
"description": "The 2-letter ISO country code referring to the customer's country",
"type": "text"
},
{
"key": "customer_ip",
"value": "<string>",
"description": "The customer's ip address.",
"type": "text"
},
{
"key": "accept_url",
"value": "<string>",
"description": "URL to redirect your customer to once the payment process is completed successfully.",
"type": "text"
},
{
"key": "decline_url",
"value": "<string>",
"description": "URL to redirect your customer to after the payment is declined.",
"type": "text"
},
{
"key": "pending_url",
"value": "<string>",
"description": "URL to redirect your customer to when the payment request was processed but response is not yet available",
"type": "text"
},
{
"key": "exception_url",
"value": "<string>",
"description": "URL to redirect your customer to after a system failure.",
"type": "text"
}
]
},
"url": {
"raw": "{{apiUrl}}/payment/order",
"host": [
"{{apiUrl}}"
],
"path": [
"payment",
"order"
]
},
"description": "The /payment/order request handles different use cases and accepts numerous information about your customer, the basket, the shipping or the order itself.\n\n\nA successful order created with the `operation_type=authorize` will only block the funds on your customer bank account but **won't debit the account**. In order to debit your customer bank account and receive the funds, you will need to **use the payment/maintenance endpoint to capture** the corresponding amount.\n\n\nIf you wish to send the debit request directly with the authorization request, you need to set the field `operation_type=direct_capture`.\n\n\nUse the `payment_method_name` to choose the payment method you want, be aware that you need at least one partner account with the payment method activated to be able to process it. \nGo to the [Payment Networks](https://www.merchant.norbr.com/payment-networks) page on your NORBr account to check if it's activated, or add a partner account with the specific payment method, and go to our [APM folder](https://developer.norbr.io/#cc0e1042-6e30-479a-af25-c4ecc0cc6abd) to check how to ask for a specific payment method."
},
"response": [
{
"name": "Create an order card",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
},
{
"key": "version",
"value": "1.0.0",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"operation_type\": \"authorize\",\n \"token\": \"b65ab7f6099b1fd8e357ea319dc851f70daebe9e333be065a23d8239130089c3\",\n \"merchant_contract\": \"608526227b9daa000b8c0174\",\n \"checkout_id\": \"67ceb0cb9af8068910f8a752\",\n \"payment_method_name\": \"visa\",\n \"amount\": 68.18,\n \"currency\": \"EUR\",\n \"order_merchant_id\": \"276398531664\",\n \"payment_channel\": \"e-commerce\",\n \"website_url\": \"https://www.example.com/\",\n \"customer_id\": \"4025251046660958\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_first_name\": \"Kirby\",\n \"customer_last_name\": \"Nash\",\n \"customer_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_city\": \"SARTROUVILLE\",\n \"customer_zip_code\": \"78500\",\n \"customer_country\": \"FR\",\n \"customer_ip\": \"127.0.0.1\",\n \"order_description\":\"1 jean t.38\",\n \"accept_url\": \"https://www.google.com/search?q=accept\",\n \"decline_url\": \"https://www.google.com/search?q=decline\",\n \"pending_url\": \"https://www.google.com/search?q=pendind\",\n \"exception_url\": \"https://www.google.com/search?q=exception\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{apiUrl}}/payment/order",
"host": [
"{{apiUrl}}"
],
"path": [
"payment",
"order"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "environment",
"value": "{{environment}}",
"description": "",
"type": "text"
}