0

UpdateMerchantSettings

by
Published Oct 17, 2025

Updates the merchant-level settings for a Square-hosted checkout page.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * UpdateMerchantSettings
7
 * Updates the merchant-level settings for a Square-hosted checkout page.
8
 */
9
export async function main(
10
  auth: Square,
11
  body: {
12
    merchant_settings: {
13
      payment_methods?: {
14
        apple_pay?: { enabled?: false | true };
15
        google_pay?: { enabled?: false | true };
16
        cash_app?: { enabled?: false | true };
17
        afterpay_clearpay?: {
18
          order_eligibility_range?: {
19
            min: {
20
              amount?: number;
21
              currency?:
22
                | "UNKNOWN_CURRENCY"
23
                | "AED"
24
                | "AFN"
25
                | "ALL"
26
                | "AMD"
27
                | "ANG"
28
                | "AOA"
29
                | "ARS"
30
                | "AUD"
31
                | "AWG"
32
                | "AZN"
33
                | "BAM"
34
                | "BBD"
35
                | "BDT"
36
                | "BGN"
37
                | "BHD"
38
                | "BIF"
39
                | "BMD"
40
                | "BND"
41
                | "BOB"
42
                | "BOV"
43
                | "BRL"
44
                | "BSD"
45
                | "BTN"
46
                | "BWP"
47
                | "BYR"
48
                | "BZD"
49
                | "CAD"
50
                | "CDF"
51
                | "CHE"
52
                | "CHF"
53
                | "CHW"
54
                | "CLF"
55
                | "CLP"
56
                | "CNY"
57
                | "COP"
58
                | "COU"
59
                | "CRC"
60
                | "CUC"
61
                | "CUP"
62
                | "CVE"
63
                | "CZK"
64
                | "DJF"
65
                | "DKK"
66
                | "DOP"
67
                | "DZD"
68
                | "EGP"
69
                | "ERN"
70
                | "ETB"
71
                | "EUR"
72
                | "FJD"
73
                | "FKP"
74
                | "GBP"
75
                | "GEL"
76
                | "GHS"
77
                | "GIP"
78
                | "GMD"
79
                | "GNF"
80
                | "GTQ"
81
                | "GYD"
82
                | "HKD"
83
                | "HNL"
84
                | "HRK"
85
                | "HTG"
86
                | "HUF"
87
                | "IDR"
88
                | "ILS"
89
                | "INR"
90
                | "IQD"
91
                | "IRR"
92
                | "ISK"
93
                | "JMD"
94
                | "JOD"
95
                | "JPY"
96
                | "KES"
97
                | "KGS"
98
                | "KHR"
99
                | "KMF"
100
                | "KPW"
101
                | "KRW"
102
                | "KWD"
103
                | "KYD"
104
                | "KZT"
105
                | "LAK"
106
                | "LBP"
107
                | "LKR"
108
                | "LRD"
109
                | "LSL"
110
                | "LTL"
111
                | "LVL"
112
                | "LYD"
113
                | "MAD"
114
                | "MDL"
115
                | "MGA"
116
                | "MKD"
117
                | "MMK"
118
                | "MNT"
119
                | "MOP"
120
                | "MRO"
121
                | "MUR"
122
                | "MVR"
123
                | "MWK"
124
                | "MXN"
125
                | "MXV"
126
                | "MYR"
127
                | "MZN"
128
                | "NAD"
129
                | "NGN"
130
                | "NIO"
131
                | "NOK"
132
                | "NPR"
133
                | "NZD"
134
                | "OMR"
135
                | "PAB"
136
                | "PEN"
137
                | "PGK"
138
                | "PHP"
139
                | "PKR"
140
                | "PLN"
141
                | "PYG"
142
                | "QAR"
143
                | "RON"
144
                | "RSD"
145
                | "RUB"
146
                | "RWF"
147
                | "SAR"
148
                | "SBD"
149
                | "SCR"
150
                | "SDG"
151
                | "SEK"
152
                | "SGD"
153
                | "SHP"
154
                | "SLL"
155
                | "SLE"
156
                | "SOS"
157
                | "SRD"
158
                | "SSP"
159
                | "STD"
160
                | "SVC"
161
                | "SYP"
162
                | "SZL"
163
                | "THB"
164
                | "TJS"
165
                | "TMT"
166
                | "TND"
167
                | "TOP"
168
                | "TRY"
169
                | "TTD"
170
                | "TWD"
171
                | "TZS"
172
                | "UAH"
173
                | "UGX"
174
                | "USD"
175
                | "USN"
176
                | "USS"
177
                | "UYI"
178
                | "UYU"
179
                | "UZS"
180
                | "VEF"
181
                | "VND"
182
                | "VUV"
183
                | "WST"
184
                | "XAF"
185
                | "XAG"
186
                | "XAU"
187
                | "XBA"
188
                | "XBB"
189
                | "XBC"
190
                | "XBD"
191
                | "XCD"
192
                | "XDR"
193
                | "XOF"
194
                | "XPD"
195
                | "XPF"
196
                | "XPT"
197
                | "XTS"
198
                | "XXX"
199
                | "YER"
200
                | "ZAR"
201
                | "ZMK"
202
                | "ZMW"
203
                | "BTC"
204
                | "XUS";
205
            };
206
            max: {
207
              amount?: number;
208
              currency?:
209
                | "UNKNOWN_CURRENCY"
210
                | "AED"
211
                | "AFN"
212
                | "ALL"
213
                | "AMD"
214
                | "ANG"
215
                | "AOA"
216
                | "ARS"
217
                | "AUD"
218
                | "AWG"
219
                | "AZN"
220
                | "BAM"
221
                | "BBD"
222
                | "BDT"
223
                | "BGN"
224
                | "BHD"
225
                | "BIF"
226
                | "BMD"
227
                | "BND"
228
                | "BOB"
229
                | "BOV"
230
                | "BRL"
231
                | "BSD"
232
                | "BTN"
233
                | "BWP"
234
                | "BYR"
235
                | "BZD"
236
                | "CAD"
237
                | "CDF"
238
                | "CHE"
239
                | "CHF"
240
                | "CHW"
241
                | "CLF"
242
                | "CLP"
243
                | "CNY"
244
                | "COP"
245
                | "COU"
246
                | "CRC"
247
                | "CUC"
248
                | "CUP"
249
                | "CVE"
250
                | "CZK"
251
                | "DJF"
252
                | "DKK"
253
                | "DOP"
254
                | "DZD"
255
                | "EGP"
256
                | "ERN"
257
                | "ETB"
258
                | "EUR"
259
                | "FJD"
260
                | "FKP"
261
                | "GBP"
262
                | "GEL"
263
                | "GHS"
264
                | "GIP"
265
                | "GMD"
266
                | "GNF"
267
                | "GTQ"
268
                | "GYD"
269
                | "HKD"
270
                | "HNL"
271
                | "HRK"
272
                | "HTG"
273
                | "HUF"
274
                | "IDR"
275
                | "ILS"
276
                | "INR"
277
                | "IQD"
278
                | "IRR"
279
                | "ISK"
280
                | "JMD"
281
                | "JOD"
282
                | "JPY"
283
                | "KES"
284
                | "KGS"
285
                | "KHR"
286
                | "KMF"
287
                | "KPW"
288
                | "KRW"
289
                | "KWD"
290
                | "KYD"
291
                | "KZT"
292
                | "LAK"
293
                | "LBP"
294
                | "LKR"
295
                | "LRD"
296
                | "LSL"
297
                | "LTL"
298
                | "LVL"
299
                | "LYD"
300
                | "MAD"
301
                | "MDL"
302
                | "MGA"
303
                | "MKD"
304
                | "MMK"
305
                | "MNT"
306
                | "MOP"
307
                | "MRO"
308
                | "MUR"
309
                | "MVR"
310
                | "MWK"
311
                | "MXN"
312
                | "MXV"
313
                | "MYR"
314
                | "MZN"
315
                | "NAD"
316
                | "NGN"
317
                | "NIO"
318
                | "NOK"
319
                | "NPR"
320
                | "NZD"
321
                | "OMR"
322
                | "PAB"
323
                | "PEN"
324
                | "PGK"
325
                | "PHP"
326
                | "PKR"
327
                | "PLN"
328
                | "PYG"
329
                | "QAR"
330
                | "RON"
331
                | "RSD"
332
                | "RUB"
333
                | "RWF"
334
                | "SAR"
335
                | "SBD"
336
                | "SCR"
337
                | "SDG"
338
                | "SEK"
339
                | "SGD"
340
                | "SHP"
341
                | "SLL"
342
                | "SLE"
343
                | "SOS"
344
                | "SRD"
345
                | "SSP"
346
                | "STD"
347
                | "SVC"
348
                | "SYP"
349
                | "SZL"
350
                | "THB"
351
                | "TJS"
352
                | "TMT"
353
                | "TND"
354
                | "TOP"
355
                | "TRY"
356
                | "TTD"
357
                | "TWD"
358
                | "TZS"
359
                | "UAH"
360
                | "UGX"
361
                | "USD"
362
                | "USN"
363
                | "USS"
364
                | "UYI"
365
                | "UYU"
366
                | "UZS"
367
                | "VEF"
368
                | "VND"
369
                | "VUV"
370
                | "WST"
371
                | "XAF"
372
                | "XAG"
373
                | "XAU"
374
                | "XBA"
375
                | "XBB"
376
                | "XBC"
377
                | "XBD"
378
                | "XCD"
379
                | "XDR"
380
                | "XOF"
381
                | "XPD"
382
                | "XPF"
383
                | "XPT"
384
                | "XTS"
385
                | "XXX"
386
                | "YER"
387
                | "ZAR"
388
                | "ZMK"
389
                | "ZMW"
390
                | "BTC"
391
                | "XUS";
392
            };
393
          };
394
          item_eligibility_range?: {
395
            min: {
396
              amount?: number;
397
              currency?:
398
                | "UNKNOWN_CURRENCY"
399
                | "AED"
400
                | "AFN"
401
                | "ALL"
402
                | "AMD"
403
                | "ANG"
404
                | "AOA"
405
                | "ARS"
406
                | "AUD"
407
                | "AWG"
408
                | "AZN"
409
                | "BAM"
410
                | "BBD"
411
                | "BDT"
412
                | "BGN"
413
                | "BHD"
414
                | "BIF"
415
                | "BMD"
416
                | "BND"
417
                | "BOB"
418
                | "BOV"
419
                | "BRL"
420
                | "BSD"
421
                | "BTN"
422
                | "BWP"
423
                | "BYR"
424
                | "BZD"
425
                | "CAD"
426
                | "CDF"
427
                | "CHE"
428
                | "CHF"
429
                | "CHW"
430
                | "CLF"
431
                | "CLP"
432
                | "CNY"
433
                | "COP"
434
                | "COU"
435
                | "CRC"
436
                | "CUC"
437
                | "CUP"
438
                | "CVE"
439
                | "CZK"
440
                | "DJF"
441
                | "DKK"
442
                | "DOP"
443
                | "DZD"
444
                | "EGP"
445
                | "ERN"
446
                | "ETB"
447
                | "EUR"
448
                | "FJD"
449
                | "FKP"
450
                | "GBP"
451
                | "GEL"
452
                | "GHS"
453
                | "GIP"
454
                | "GMD"
455
                | "GNF"
456
                | "GTQ"
457
                | "GYD"
458
                | "HKD"
459
                | "HNL"
460
                | "HRK"
461
                | "HTG"
462
                | "HUF"
463
                | "IDR"
464
                | "ILS"
465
                | "INR"
466
                | "IQD"
467
                | "IRR"
468
                | "ISK"
469
                | "JMD"
470
                | "JOD"
471
                | "JPY"
472
                | "KES"
473
                | "KGS"
474
                | "KHR"
475
                | "KMF"
476
                | "KPW"
477
                | "KRW"
478
                | "KWD"
479
                | "KYD"
480
                | "KZT"
481
                | "LAK"
482
                | "LBP"
483
                | "LKR"
484
                | "LRD"
485
                | "LSL"
486
                | "LTL"
487
                | "LVL"
488
                | "LYD"
489
                | "MAD"
490
                | "MDL"
491
                | "MGA"
492
                | "MKD"
493
                | "MMK"
494
                | "MNT"
495
                | "MOP"
496
                | "MRO"
497
                | "MUR"
498
                | "MVR"
499
                | "MWK"
500
                | "MXN"
501
                | "MXV"
502
                | "MYR"
503
                | "MZN"
504
                | "NAD"
505
                | "NGN"
506
                | "NIO"
507
                | "NOK"
508
                | "NPR"
509
                | "NZD"
510
                | "OMR"
511
                | "PAB"
512
                | "PEN"
513
                | "PGK"
514
                | "PHP"
515
                | "PKR"
516
                | "PLN"
517
                | "PYG"
518
                | "QAR"
519
                | "RON"
520
                | "RSD"
521
                | "RUB"
522
                | "RWF"
523
                | "SAR"
524
                | "SBD"
525
                | "SCR"
526
                | "SDG"
527
                | "SEK"
528
                | "SGD"
529
                | "SHP"
530
                | "SLL"
531
                | "SLE"
532
                | "SOS"
533
                | "SRD"
534
                | "SSP"
535
                | "STD"
536
                | "SVC"
537
                | "SYP"
538
                | "SZL"
539
                | "THB"
540
                | "TJS"
541
                | "TMT"
542
                | "TND"
543
                | "TOP"
544
                | "TRY"
545
                | "TTD"
546
                | "TWD"
547
                | "TZS"
548
                | "UAH"
549
                | "UGX"
550
                | "USD"
551
                | "USN"
552
                | "USS"
553
                | "UYI"
554
                | "UYU"
555
                | "UZS"
556
                | "VEF"
557
                | "VND"
558
                | "VUV"
559
                | "WST"
560
                | "XAF"
561
                | "XAG"
562
                | "XAU"
563
                | "XBA"
564
                | "XBB"
565
                | "XBC"
566
                | "XBD"
567
                | "XCD"
568
                | "XDR"
569
                | "XOF"
570
                | "XPD"
571
                | "XPF"
572
                | "XPT"
573
                | "XTS"
574
                | "XXX"
575
                | "YER"
576
                | "ZAR"
577
                | "ZMK"
578
                | "ZMW"
579
                | "BTC"
580
                | "XUS";
581
            };
582
            max: {
583
              amount?: number;
584
              currency?:
585
                | "UNKNOWN_CURRENCY"
586
                | "AED"
587
                | "AFN"
588
                | "ALL"
589
                | "AMD"
590
                | "ANG"
591
                | "AOA"
592
                | "ARS"
593
                | "AUD"
594
                | "AWG"
595
                | "AZN"
596
                | "BAM"
597
                | "BBD"
598
                | "BDT"
599
                | "BGN"
600
                | "BHD"
601
                | "BIF"
602
                | "BMD"
603
                | "BND"
604
                | "BOB"
605
                | "BOV"
606
                | "BRL"
607
                | "BSD"
608
                | "BTN"
609
                | "BWP"
610
                | "BYR"
611
                | "BZD"
612
                | "CAD"
613
                | "CDF"
614
                | "CHE"
615
                | "CHF"
616
                | "CHW"
617
                | "CLF"
618
                | "CLP"
619
                | "CNY"
620
                | "COP"
621
                | "COU"
622
                | "CRC"
623
                | "CUC"
624
                | "CUP"
625
                | "CVE"
626
                | "CZK"
627
                | "DJF"
628
                | "DKK"
629
                | "DOP"
630
                | "DZD"
631
                | "EGP"
632
                | "ERN"
633
                | "ETB"
634
                | "EUR"
635
                | "FJD"
636
                | "FKP"
637
                | "GBP"
638
                | "GEL"
639
                | "GHS"
640
                | "GIP"
641
                | "GMD"
642
                | "GNF"
643
                | "GTQ"
644
                | "GYD"
645
                | "HKD"
646
                | "HNL"
647
                | "HRK"
648
                | "HTG"
649
                | "HUF"
650
                | "IDR"
651
                | "ILS"
652
                | "INR"
653
                | "IQD"
654
                | "IRR"
655
                | "ISK"
656
                | "JMD"
657
                | "JOD"
658
                | "JPY"
659
                | "KES"
660
                | "KGS"
661
                | "KHR"
662
                | "KMF"
663
                | "KPW"
664
                | "KRW"
665
                | "KWD"
666
                | "KYD"
667
                | "KZT"
668
                | "LAK"
669
                | "LBP"
670
                | "LKR"
671
                | "LRD"
672
                | "LSL"
673
                | "LTL"
674
                | "LVL"
675
                | "LYD"
676
                | "MAD"
677
                | "MDL"
678
                | "MGA"
679
                | "MKD"
680
                | "MMK"
681
                | "MNT"
682
                | "MOP"
683
                | "MRO"
684
                | "MUR"
685
                | "MVR"
686
                | "MWK"
687
                | "MXN"
688
                | "MXV"
689
                | "MYR"
690
                | "MZN"
691
                | "NAD"
692
                | "NGN"
693
                | "NIO"
694
                | "NOK"
695
                | "NPR"
696
                | "NZD"
697
                | "OMR"
698
                | "PAB"
699
                | "PEN"
700
                | "PGK"
701
                | "PHP"
702
                | "PKR"
703
                | "PLN"
704
                | "PYG"
705
                | "QAR"
706
                | "RON"
707
                | "RSD"
708
                | "RUB"
709
                | "RWF"
710
                | "SAR"
711
                | "SBD"
712
                | "SCR"
713
                | "SDG"
714
                | "SEK"
715
                | "SGD"
716
                | "SHP"
717
                | "SLL"
718
                | "SLE"
719
                | "SOS"
720
                | "SRD"
721
                | "SSP"
722
                | "STD"
723
                | "SVC"
724
                | "SYP"
725
                | "SZL"
726
                | "THB"
727
                | "TJS"
728
                | "TMT"
729
                | "TND"
730
                | "TOP"
731
                | "TRY"
732
                | "TTD"
733
                | "TWD"
734
                | "TZS"
735
                | "UAH"
736
                | "UGX"
737
                | "USD"
738
                | "USN"
739
                | "USS"
740
                | "UYI"
741
                | "UYU"
742
                | "UZS"
743
                | "VEF"
744
                | "VND"
745
                | "VUV"
746
                | "WST"
747
                | "XAF"
748
                | "XAG"
749
                | "XAU"
750
                | "XBA"
751
                | "XBB"
752
                | "XBC"
753
                | "XBD"
754
                | "XCD"
755
                | "XDR"
756
                | "XOF"
757
                | "XPD"
758
                | "XPF"
759
                | "XPT"
760
                | "XTS"
761
                | "XXX"
762
                | "YER"
763
                | "ZAR"
764
                | "ZMK"
765
                | "ZMW"
766
                | "BTC"
767
                | "XUS";
768
            };
769
          };
770
          enabled?: false | true;
771
        };
772
      };
773
      updated_at?: string;
774
    };
775
  },
776
) {
777
  const url = new URL(
778
    `https://connect.squareup.com/v2/online-checkout/merchant-settings`,
779
  );
780

781
  const response = await fetch(url, {
782
    method: "PUT",
783
    headers: {
784
      "Content-Type": "application/json",
785
      Authorization: "Bearer " + auth.token,
786
    },
787
    body: JSON.stringify(body),
788
  });
789
  if (!response.ok) {
790
    const text = await response.text();
791
    throw new Error(`${response.status} ${text}`);
792
  }
793
  return await response.json();
794
}
795