@tapsilat/tapsilat-js 2026.4.2 → 2026.7.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +72 -0
- package/dist/TapsilatSDK.d.ts +270 -73
- package/dist/TapsilatSDK.d.ts.map +1 -1
- package/dist/http/HttpClient.d.ts +1 -0
- package/dist/http/HttpClient.d.ts.map +1 -1
- package/dist/index.cjs +754 -168
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +950 -111
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +755 -169
- package/dist/index.js.map +1 -1
- package/dist/types/index.d.ts +682 -37
- package/dist/types/index.d.ts.map +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -109,7 +109,12 @@ interface Address {
|
|
|
109
109
|
* @interface BillingAddress
|
|
110
110
|
*/
|
|
111
111
|
interface BillingAddress extends Address {
|
|
112
|
-
billing_type: "PERSONAL" | "CORPORATE";
|
|
112
|
+
billing_type: "PERSONAL" | "BUSINESS" | "CORPORATE";
|
|
113
|
+
citizenship?: string;
|
|
114
|
+
neighbourhood?: string;
|
|
115
|
+
street1?: string;
|
|
116
|
+
street2?: string;
|
|
117
|
+
street3?: string;
|
|
113
118
|
vat_number?: string;
|
|
114
119
|
tax_office?: string;
|
|
115
120
|
title?: string;
|
|
@@ -125,12 +130,20 @@ interface BasketItem {
|
|
|
125
130
|
name?: string;
|
|
126
131
|
category1?: string;
|
|
127
132
|
category2?: string;
|
|
133
|
+
commission_amount?: number;
|
|
134
|
+
coupon?: string;
|
|
135
|
+
mcc?: string;
|
|
128
136
|
item_type?: string;
|
|
137
|
+
paid_amount?: number;
|
|
138
|
+
payer?: BasketItemPayerDTO;
|
|
129
139
|
price?: number;
|
|
130
140
|
quantity?: number;
|
|
141
|
+
quantity_float?: number;
|
|
131
142
|
coupon_discount?: number;
|
|
132
143
|
data?: string;
|
|
133
144
|
quantity_unit?: string;
|
|
145
|
+
sub_merchant_key?: string;
|
|
146
|
+
sub_merchant_price?: string;
|
|
134
147
|
}
|
|
135
148
|
/**
|
|
136
149
|
* @category Payment Processing
|
|
@@ -138,7 +151,7 @@ interface BasketItem {
|
|
|
138
151
|
* @description Different payment methods that can be enabled for an order
|
|
139
152
|
* @typedef {string} PaymentOption
|
|
140
153
|
*/
|
|
141
|
-
type PaymentOption = "PAY_WITH_WALLET" | "PAY_WITH_CARD" | "PAY_WITH_LOAN" | "PAY_WITH_CASH" | "PAY_WITH_BANK";
|
|
154
|
+
type PaymentOption = "credit_card" | "bank_transfer" | "cash" | "debit_card" | "PAY_WITH_WALLET" | "PAY_WITH_CARD" | "PAY_WITH_LOAN" | "PAY_WITH_CASH" | "PAY_WITH_BANK";
|
|
142
155
|
/**
|
|
143
156
|
* @category Refunds
|
|
144
157
|
* @summary Information needed to process a refund
|
|
@@ -248,12 +261,14 @@ interface Buyer {
|
|
|
248
261
|
id?: string;
|
|
249
262
|
name: string;
|
|
250
263
|
surname: string;
|
|
264
|
+
birth_date?: string;
|
|
251
265
|
email: string;
|
|
252
266
|
gsm_number?: string;
|
|
253
267
|
identity_number?: string;
|
|
254
268
|
registration_address?: string;
|
|
255
269
|
city?: string;
|
|
256
270
|
country?: string;
|
|
271
|
+
title?: string;
|
|
257
272
|
zip_code?: string;
|
|
258
273
|
ip?: string;
|
|
259
274
|
registration_date?: string;
|
|
@@ -275,20 +290,30 @@ interface OrderCreateRequest {
|
|
|
275
290
|
locale: Locale;
|
|
276
291
|
three_d_force?: boolean;
|
|
277
292
|
currency: Currency;
|
|
278
|
-
|
|
293
|
+
checkout_design?: CheckoutDesignDTO;
|
|
294
|
+
shipping_address?: ShippingAddressDTO;
|
|
279
295
|
basket_items?: BasketItem[];
|
|
280
296
|
billing_address?: BillingAddress;
|
|
281
297
|
buyer: Buyer;
|
|
282
298
|
consents?: OrderConsent[];
|
|
283
299
|
conversation_id?: string;
|
|
300
|
+
external_reference_id?: string;
|
|
301
|
+
order_cards?: OrderCardDTO[];
|
|
302
|
+
paid_amount?: number;
|
|
284
303
|
partial_payment?: boolean;
|
|
304
|
+
payment_mode?: string;
|
|
285
305
|
payment_methods?: boolean;
|
|
286
306
|
payment_options?: PaymentOption[];
|
|
287
307
|
payment_success_url?: string;
|
|
288
308
|
payment_failure_url?: string;
|
|
309
|
+
payment_terms?: PaymentTermDTO[];
|
|
310
|
+
pf_sub_merchant?: OrderPFSubMerchantDTO;
|
|
311
|
+
redirect_failure_url?: string;
|
|
312
|
+
redirect_success_url?: string;
|
|
289
313
|
enabled_installments?: number[];
|
|
290
314
|
metadata?: OrderMetadata[];
|
|
291
315
|
sub_organization?: SubOrganizationDTO;
|
|
316
|
+
submerchants?: SubmerchantDTO[];
|
|
292
317
|
}
|
|
293
318
|
/**
|
|
294
319
|
* @category Order Management
|
|
@@ -297,7 +322,11 @@ interface OrderCreateRequest {
|
|
|
297
322
|
* @interface OrderCreateResponse
|
|
298
323
|
*/
|
|
299
324
|
interface OrderCreateResponse {
|
|
300
|
-
|
|
325
|
+
code?: number;
|
|
326
|
+
id?: string;
|
|
327
|
+
message?: string;
|
|
328
|
+
organization_id?: string;
|
|
329
|
+
order_id?: string;
|
|
301
330
|
reference_id: string;
|
|
302
331
|
checkout_url?: string;
|
|
303
332
|
conversation_id?: string;
|
|
@@ -326,6 +355,111 @@ interface Order extends OrderCreateResponse {
|
|
|
326
355
|
organization?: string;
|
|
327
356
|
unpaid_amount?: number;
|
|
328
357
|
}
|
|
358
|
+
/**
|
|
359
|
+
* @category Order Management
|
|
360
|
+
* @summary Response payload for order detail retrieval
|
|
361
|
+
* @description Swagger-aligned response schema for GET /order/{id}
|
|
362
|
+
* @interface GetOrderResponse
|
|
363
|
+
*/
|
|
364
|
+
interface GetOrderResponse {
|
|
365
|
+
amount?: string;
|
|
366
|
+
basket_items?: BasketItemDTO[];
|
|
367
|
+
billing_address?: BillingAddressDTO;
|
|
368
|
+
buyer?: BuyerDTO;
|
|
369
|
+
checkout_design?: CheckoutDesignDTO;
|
|
370
|
+
checkout_url?: string;
|
|
371
|
+
conversation_id?: string;
|
|
372
|
+
created_at?: string;
|
|
373
|
+
currency?: string;
|
|
374
|
+
external_reference_id?: string;
|
|
375
|
+
locale?: string;
|
|
376
|
+
metadata?: MetadataDTO[];
|
|
377
|
+
paid_amount?: string;
|
|
378
|
+
payment_failure_url?: string;
|
|
379
|
+
payment_options?: string[];
|
|
380
|
+
payment_success_url?: string;
|
|
381
|
+
payment_terms?: PaymentTermDTO[];
|
|
382
|
+
redirect_failure_url?: string;
|
|
383
|
+
redirect_success_url?: string;
|
|
384
|
+
reference_id?: string;
|
|
385
|
+
refunded_amount?: string;
|
|
386
|
+
shipping_address?: ShippingAddressDTO;
|
|
387
|
+
status?: number;
|
|
388
|
+
status_enum?: string;
|
|
389
|
+
total?: string;
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
* @category Order Management
|
|
393
|
+
* @summary Query parameters for order listing
|
|
394
|
+
* @description Swagger-aligned query options for GET /order/list
|
|
395
|
+
* @interface GetOrdersRequest
|
|
396
|
+
*/
|
|
397
|
+
interface GetOrdersRequest {
|
|
398
|
+
page?: number;
|
|
399
|
+
per_page?: number;
|
|
400
|
+
start_date?: string;
|
|
401
|
+
end_date?: string;
|
|
402
|
+
organization_id?: string;
|
|
403
|
+
related_reference_id?: string;
|
|
404
|
+
buyer_id?: string;
|
|
405
|
+
status?: number;
|
|
406
|
+
}
|
|
407
|
+
/**
|
|
408
|
+
* @category Order Management
|
|
409
|
+
* @summary Single list item returned by order listing
|
|
410
|
+
* @description Swagger-aligned row schema for GET /order/list
|
|
411
|
+
* @interface GetOrdersListItem
|
|
412
|
+
*/
|
|
413
|
+
interface GetOrdersListItem {
|
|
414
|
+
checkout_url?: string;
|
|
415
|
+
email?: string;
|
|
416
|
+
id?: string;
|
|
417
|
+
metadata?: MetadataDTO[];
|
|
418
|
+
name?: string;
|
|
419
|
+
organization?: string;
|
|
420
|
+
organization_id?: string;
|
|
421
|
+
paid_amount?: number;
|
|
422
|
+
paid_term_count?: number;
|
|
423
|
+
reference_id?: string;
|
|
424
|
+
refund_date?: string;
|
|
425
|
+
status?: number;
|
|
426
|
+
total?: string;
|
|
427
|
+
total_term_count?: number;
|
|
428
|
+
unpaid_amount?: number;
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
* @category Order Management
|
|
432
|
+
* @summary Response payload for order listing
|
|
433
|
+
* @description Swagger-aligned response schema for GET /order/list
|
|
434
|
+
* @interface GetOrdersResponse
|
|
435
|
+
*/
|
|
436
|
+
interface GetOrdersResponse {
|
|
437
|
+
page?: number;
|
|
438
|
+
per_page?: number;
|
|
439
|
+
rows?: GetOrdersListItem[];
|
|
440
|
+
total?: number;
|
|
441
|
+
total_pages?: number;
|
|
442
|
+
}
|
|
443
|
+
/**
|
|
444
|
+
* @category Order Management
|
|
445
|
+
* @summary Request payload for order cancellation
|
|
446
|
+
* @description Swagger-aligned request schema for POST /order/cancel
|
|
447
|
+
* @interface CancelOrderRequest
|
|
448
|
+
*/
|
|
449
|
+
interface CancelOrderRequest {
|
|
450
|
+
reference_id: string;
|
|
451
|
+
}
|
|
452
|
+
/**
|
|
453
|
+
* @category Order Management
|
|
454
|
+
* @summary Response payload for order cancellation
|
|
455
|
+
* @description Swagger-aligned response schema for POST /order/cancel
|
|
456
|
+
* @interface CancelOrderResponse
|
|
457
|
+
*/
|
|
458
|
+
interface CancelOrderResponse {
|
|
459
|
+
is_success?: boolean;
|
|
460
|
+
message?: string;
|
|
461
|
+
status?: string;
|
|
462
|
+
}
|
|
329
463
|
/**
|
|
330
464
|
* @category Refunds
|
|
331
465
|
* @summary Refund request information for an order
|
|
@@ -335,6 +469,8 @@ interface Order extends OrderCreateResponse {
|
|
|
335
469
|
interface OrderRefundRequest {
|
|
336
470
|
reference_id: string;
|
|
337
471
|
amount: number;
|
|
472
|
+
order_item_id?: string;
|
|
473
|
+
order_item_payment_id?: string;
|
|
338
474
|
}
|
|
339
475
|
/**
|
|
340
476
|
* @category Refunds
|
|
@@ -343,23 +479,43 @@ interface OrderRefundRequest {
|
|
|
343
479
|
* @interface OrderRefundResponse
|
|
344
480
|
*/
|
|
345
481
|
interface OrderRefundResponse {
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
482
|
+
is_success?: boolean;
|
|
483
|
+
message?: string;
|
|
484
|
+
refundId?: string;
|
|
485
|
+
referenceId?: string;
|
|
486
|
+
status?: string;
|
|
487
|
+
amount?: number;
|
|
488
|
+
currency?: Currency;
|
|
489
|
+
createdAt?: string;
|
|
352
490
|
}
|
|
353
491
|
/**
|
|
354
492
|
* @category Order Management
|
|
355
493
|
* @summary Order status information
|
|
356
|
-
* @description
|
|
494
|
+
* @description Swagger-aligned response payload for GET /order/{id}/status
|
|
357
495
|
* @interface OrderStatusResponse
|
|
358
496
|
*/
|
|
359
497
|
interface OrderStatusResponse {
|
|
360
|
-
|
|
361
|
-
status
|
|
362
|
-
|
|
498
|
+
error_code?: string;
|
|
499
|
+
status?: string;
|
|
500
|
+
}
|
|
501
|
+
/**
|
|
502
|
+
* @category System
|
|
503
|
+
* @summary System order status item
|
|
504
|
+
* @description Represents a single status entry returned by the system order statuses endpoint
|
|
505
|
+
* @interface SystemOrderStatus
|
|
506
|
+
*/
|
|
507
|
+
interface SystemOrderStatus {
|
|
508
|
+
code?: number;
|
|
509
|
+
message?: string;
|
|
510
|
+
}
|
|
511
|
+
/**
|
|
512
|
+
* @category System
|
|
513
|
+
* @summary Response for system order statuses
|
|
514
|
+
* @description API response payload for listing available system order statuses
|
|
515
|
+
* @interface GetSystemOrderStatusesResponse
|
|
516
|
+
*/
|
|
517
|
+
interface GetSystemOrderStatusesResponse {
|
|
518
|
+
rows?: SystemOrderStatus[];
|
|
363
519
|
}
|
|
364
520
|
/**
|
|
365
521
|
* @category Payment Processing
|
|
@@ -380,6 +536,58 @@ interface OrderPaymentDetail {
|
|
|
380
536
|
cardAssociation: string;
|
|
381
537
|
};
|
|
382
538
|
}
|
|
539
|
+
interface OrderPaymentDetailInfoResponse {
|
|
540
|
+
id?: string;
|
|
541
|
+
paid_date?: string;
|
|
542
|
+
paid_date_timestamp?: number;
|
|
543
|
+
reference_id?: string;
|
|
544
|
+
refunded_amount?: number;
|
|
545
|
+
status?: string;
|
|
546
|
+
}
|
|
547
|
+
interface OrderPaymentDetailOrderPaymentStatusResponse {
|
|
548
|
+
acquirere_response?: string;
|
|
549
|
+
code?: string;
|
|
550
|
+
expiry_month?: string;
|
|
551
|
+
expiry_year?: string;
|
|
552
|
+
is_error?: boolean;
|
|
553
|
+
masked_pan?: string;
|
|
554
|
+
message?: string;
|
|
555
|
+
}
|
|
556
|
+
interface OrderPaymentDetailsResponse {
|
|
557
|
+
auth_code?: string;
|
|
558
|
+
batch_no?: string;
|
|
559
|
+
card_holder_name?: string;
|
|
560
|
+
card_number?: string;
|
|
561
|
+
is_three_ds?: boolean;
|
|
562
|
+
mdstatus?: string;
|
|
563
|
+
order_id?: string;
|
|
564
|
+
payment_id?: string;
|
|
565
|
+
payment_transaction_id?: string;
|
|
566
|
+
reference_id?: string;
|
|
567
|
+
rrn?: string;
|
|
568
|
+
}
|
|
569
|
+
interface OrderPaymentDetailRuleResponse {
|
|
570
|
+
id?: string;
|
|
571
|
+
name?: string;
|
|
572
|
+
}
|
|
573
|
+
interface OrderPaymentDetailVposResponse {
|
|
574
|
+
acquirer?: string;
|
|
575
|
+
bank_code?: string;
|
|
576
|
+
commission_rate?: string;
|
|
577
|
+
id?: string;
|
|
578
|
+
name?: string;
|
|
579
|
+
}
|
|
580
|
+
interface GetOrderPaymentDetailsResponse {
|
|
581
|
+
conversation_id?: string;
|
|
582
|
+
id?: string;
|
|
583
|
+
order?: OrderPaymentDetailInfoResponse;
|
|
584
|
+
order_payment_status?: OrderPaymentDetailOrderPaymentStatusResponse;
|
|
585
|
+
organization_id?: string;
|
|
586
|
+
paymentDetails?: OrderPaymentDetailsResponse;
|
|
587
|
+
rule?: OrderPaymentDetailRuleResponse;
|
|
588
|
+
vpos?: OrderPaymentDetailVposResponse;
|
|
589
|
+
vposResponse?: string;
|
|
590
|
+
}
|
|
383
591
|
/**
|
|
384
592
|
* @category API DTOs
|
|
385
593
|
* @summary API representation of buyer information
|
|
@@ -402,6 +610,9 @@ interface BuyerDTO {
|
|
|
402
610
|
registration_date?: string;
|
|
403
611
|
title?: string;
|
|
404
612
|
zip_code?: string;
|
|
613
|
+
income_type?: string;
|
|
614
|
+
education?: string;
|
|
615
|
+
occupation?: string;
|
|
405
616
|
}
|
|
406
617
|
/**
|
|
407
618
|
* @category API DTOs
|
|
@@ -416,6 +627,30 @@ interface BasketItemPayerDTO {
|
|
|
416
627
|
title?: string;
|
|
417
628
|
type?: string;
|
|
418
629
|
vat?: string;
|
|
630
|
+
name?: string;
|
|
631
|
+
surname?: string;
|
|
632
|
+
identity_number?: string;
|
|
633
|
+
email?: string;
|
|
634
|
+
phone?: string;
|
|
635
|
+
}
|
|
636
|
+
/**
|
|
637
|
+
* @category API DTOs
|
|
638
|
+
* @summary Payment record for a basket item
|
|
639
|
+
* @description Payment details attached to a specific basket item
|
|
640
|
+
* @interface BasketItemPaymentDTO
|
|
641
|
+
*/
|
|
642
|
+
interface BasketItemPaymentDTO {
|
|
643
|
+
amount?: number;
|
|
644
|
+
card_brand?: string;
|
|
645
|
+
id?: string;
|
|
646
|
+
masked_bin?: string;
|
|
647
|
+
paid_date?: string;
|
|
648
|
+
refundable_amount?: number;
|
|
649
|
+
refunded?: boolean;
|
|
650
|
+
refunded_amount?: number;
|
|
651
|
+
refunded_date?: string;
|
|
652
|
+
status?: number;
|
|
653
|
+
type?: string;
|
|
419
654
|
}
|
|
420
655
|
/**
|
|
421
656
|
* @category API DTOs
|
|
@@ -431,14 +666,20 @@ interface BasketItemDTO {
|
|
|
431
666
|
coupon_discount?: number;
|
|
432
667
|
data?: string;
|
|
433
668
|
id?: string;
|
|
669
|
+
item_payments?: BasketItemPaymentDTO[];
|
|
434
670
|
item_type?: string;
|
|
671
|
+
mcc?: string;
|
|
435
672
|
name?: string;
|
|
436
673
|
paid_amount?: number;
|
|
674
|
+
paidable_amount?: number;
|
|
437
675
|
payer?: BasketItemPayerDTO;
|
|
438
676
|
price?: number;
|
|
439
677
|
quantity?: number;
|
|
440
678
|
quantity_float?: number;
|
|
441
679
|
quantity_unit?: string;
|
|
680
|
+
refundable_amount?: number;
|
|
681
|
+
refunded_amount?: number;
|
|
682
|
+
status?: number;
|
|
442
683
|
sub_merchant_key?: string;
|
|
443
684
|
sub_merchant_price?: string;
|
|
444
685
|
}
|
|
@@ -457,6 +698,10 @@ interface BillingAddressDTO {
|
|
|
457
698
|
contact_phone?: string;
|
|
458
699
|
country?: string;
|
|
459
700
|
district?: string;
|
|
701
|
+
neighbourhood?: string;
|
|
702
|
+
street1?: string;
|
|
703
|
+
street2?: string;
|
|
704
|
+
street3?: string;
|
|
460
705
|
tax_office?: string;
|
|
461
706
|
title?: string;
|
|
462
707
|
vat_number?: string;
|
|
@@ -530,10 +775,12 @@ interface OrderPFSubMerchantDTO {
|
|
|
530
775
|
id?: string;
|
|
531
776
|
mcc?: string;
|
|
532
777
|
name?: string;
|
|
778
|
+
national_id?: string;
|
|
533
779
|
org_id?: string;
|
|
534
780
|
postal_code?: string;
|
|
535
781
|
submerchant_nin?: string;
|
|
536
782
|
submerchant_url?: string;
|
|
783
|
+
switch_id?: string;
|
|
537
784
|
terminal_no?: string;
|
|
538
785
|
}
|
|
539
786
|
/**
|
|
@@ -615,15 +862,18 @@ interface OrderCreateDTO {
|
|
|
615
862
|
enabled_installments?: number[];
|
|
616
863
|
external_reference_id?: string;
|
|
617
864
|
metadata?: MetadataDTO[];
|
|
618
|
-
order_cards?: OrderCardDTO;
|
|
865
|
+
order_cards?: OrderCardDTO[];
|
|
619
866
|
paid_amount?: number;
|
|
620
867
|
partial_payment?: boolean;
|
|
621
868
|
payment_failure_url?: string;
|
|
869
|
+
payment_mode?: string;
|
|
622
870
|
payment_methods?: boolean;
|
|
623
871
|
payment_options?: string[];
|
|
624
872
|
payment_success_url?: string;
|
|
625
873
|
payment_terms?: PaymentTermDTO[];
|
|
626
874
|
pf_sub_merchant?: OrderPFSubMerchantDTO;
|
|
875
|
+
redirect_failure_url?: string;
|
|
876
|
+
redirect_success_url?: string;
|
|
627
877
|
shipping_address?: ShippingAddressDTO;
|
|
628
878
|
sub_organization?: SubOrganizationDTO;
|
|
629
879
|
submerchants?: SubmerchantDTO[];
|
|
@@ -642,6 +892,25 @@ interface RefundOrderDTO {
|
|
|
642
892
|
order_item_id?: string;
|
|
643
893
|
order_item_payment_id?: string;
|
|
644
894
|
}
|
|
895
|
+
/**
|
|
896
|
+
* @category Refunds
|
|
897
|
+
* @summary Data structure for requesting a full refund
|
|
898
|
+
* @description Contains the order reference required to fully refund an order
|
|
899
|
+
* @interface RefundAllOrderDTO
|
|
900
|
+
*/
|
|
901
|
+
interface RefundAllOrderDTO {
|
|
902
|
+
reference_id: string;
|
|
903
|
+
}
|
|
904
|
+
/**
|
|
905
|
+
* @category Payment Processing
|
|
906
|
+
* @summary Data structure for order payment detail query
|
|
907
|
+
* @description Request payload for POST /order/payment-details
|
|
908
|
+
* @interface OrderPaymentDetailDTO
|
|
909
|
+
*/
|
|
910
|
+
interface OrderPaymentDetailDTO {
|
|
911
|
+
conversation_id?: string;
|
|
912
|
+
reference_id?: string;
|
|
913
|
+
}
|
|
645
914
|
/**
|
|
646
915
|
* @category Payment Terms
|
|
647
916
|
* @summary Data for creating a payment term
|
|
@@ -716,6 +985,34 @@ interface PaymentTermResponse {
|
|
|
716
985
|
paid_date?: string;
|
|
717
986
|
data?: string;
|
|
718
987
|
}
|
|
988
|
+
/**
|
|
989
|
+
* @category Payment Terms
|
|
990
|
+
* @summary Protobuf timestamp payload
|
|
991
|
+
* @description Timestamp structure used by term APIs (`seconds` + `nanos`)
|
|
992
|
+
* @interface TimestampDTO
|
|
993
|
+
*/
|
|
994
|
+
interface TimestampDTO {
|
|
995
|
+
nanos?: number;
|
|
996
|
+
seconds?: number;
|
|
997
|
+
}
|
|
998
|
+
/**
|
|
999
|
+
* @category Payment Terms
|
|
1000
|
+
* @summary Response payload for order term retrieval
|
|
1001
|
+
* @description Swagger-aligned response schema for GET /order/term
|
|
1002
|
+
* @interface GetOrderTermResponse
|
|
1003
|
+
*/
|
|
1004
|
+
interface GetOrderTermResponse {
|
|
1005
|
+
amount?: number;
|
|
1006
|
+
due_date?: TimestampDTO;
|
|
1007
|
+
paid_date?: TimestampDTO;
|
|
1008
|
+
required?: boolean;
|
|
1009
|
+
status?: string;
|
|
1010
|
+
term_sequence?: number;
|
|
1011
|
+
}
|
|
1012
|
+
interface OrderPaymentTermActionResponse {
|
|
1013
|
+
code?: number;
|
|
1014
|
+
message?: string;
|
|
1015
|
+
}
|
|
719
1016
|
/**
|
|
720
1017
|
* @category Payment Terms
|
|
721
1018
|
* @summary Request data for deleting a payment term
|
|
@@ -723,6 +1020,7 @@ interface PaymentTermResponse {
|
|
|
723
1020
|
* @interface PaymentTermDeleteRequest
|
|
724
1021
|
*/
|
|
725
1022
|
interface PaymentTermDeleteRequest {
|
|
1023
|
+
order_id?: string;
|
|
726
1024
|
term_reference_id: string;
|
|
727
1025
|
}
|
|
728
1026
|
/**
|
|
@@ -732,11 +1030,14 @@ interface PaymentTermDeleteRequest {
|
|
|
732
1030
|
* @interface PaymentTermRefundResponse
|
|
733
1031
|
*/
|
|
734
1032
|
interface PaymentTermRefundResponse {
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
1033
|
+
code?: number;
|
|
1034
|
+
is_success?: boolean;
|
|
1035
|
+
message?: string;
|
|
1036
|
+
refund_id?: string;
|
|
1037
|
+
term_reference_id?: string;
|
|
1038
|
+
amount?: number;
|
|
1039
|
+
status?: string;
|
|
1040
|
+
created_at?: string;
|
|
740
1041
|
refund_reference_id?: string;
|
|
741
1042
|
}
|
|
742
1043
|
/**
|
|
@@ -766,9 +1067,11 @@ interface OrderTerminateRequest {
|
|
|
766
1067
|
* @interface OrderTerminateResponse
|
|
767
1068
|
*/
|
|
768
1069
|
interface OrderTerminateResponse {
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
1070
|
+
code?: number;
|
|
1071
|
+
message?: string;
|
|
1072
|
+
reference_id?: string;
|
|
1073
|
+
status?: string;
|
|
1074
|
+
terminated_at?: string;
|
|
772
1075
|
reason?: string;
|
|
773
1076
|
}
|
|
774
1077
|
/**
|
|
@@ -803,6 +1106,10 @@ interface SubscriptionCancelRequest {
|
|
|
803
1106
|
external_reference_id?: string;
|
|
804
1107
|
reference_id?: string;
|
|
805
1108
|
}
|
|
1109
|
+
interface CancelSubscriptionResponse {
|
|
1110
|
+
code?: number;
|
|
1111
|
+
message?: string;
|
|
1112
|
+
}
|
|
806
1113
|
interface SubscriptionBilling {
|
|
807
1114
|
address?: string;
|
|
808
1115
|
city?: string;
|
|
@@ -865,6 +1172,29 @@ interface SubscriptionDetail {
|
|
|
865
1172
|
period?: number;
|
|
866
1173
|
title?: string;
|
|
867
1174
|
}
|
|
1175
|
+
interface SubscriptionListItem {
|
|
1176
|
+
amount?: string;
|
|
1177
|
+
currency?: string;
|
|
1178
|
+
external_reference_id?: string;
|
|
1179
|
+
is_active?: boolean;
|
|
1180
|
+
payment_date?: number;
|
|
1181
|
+
payment_status?: string;
|
|
1182
|
+
period?: number;
|
|
1183
|
+
reference_id?: string;
|
|
1184
|
+
title?: string;
|
|
1185
|
+
}
|
|
1186
|
+
interface ListSubscriptionsRequest {
|
|
1187
|
+
page?: number;
|
|
1188
|
+
per_page?: number;
|
|
1189
|
+
[key: string]: unknown;
|
|
1190
|
+
}
|
|
1191
|
+
interface ListSubscriptionsResponse {
|
|
1192
|
+
page?: number;
|
|
1193
|
+
per_page?: number;
|
|
1194
|
+
rows?: SubscriptionListItem[];
|
|
1195
|
+
total?: number;
|
|
1196
|
+
total_pages?: number;
|
|
1197
|
+
}
|
|
868
1198
|
interface SubscriptionCreateResponse {
|
|
869
1199
|
code?: number;
|
|
870
1200
|
message?: string;
|
|
@@ -885,18 +1215,43 @@ interface OrganizationSettings {
|
|
|
885
1215
|
subscription_domain?: string;
|
|
886
1216
|
}
|
|
887
1217
|
interface OrderTransaction {
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
1218
|
+
amount?: string;
|
|
1219
|
+
amount_float?: number;
|
|
1220
|
+
currency?: string;
|
|
1221
|
+
date?: string;
|
|
1222
|
+
id?: string;
|
|
1223
|
+
receiver?: string;
|
|
1224
|
+
reference_id?: string;
|
|
1225
|
+
sender?: string;
|
|
1226
|
+
status?: string;
|
|
893
1227
|
[key: string]: unknown;
|
|
894
1228
|
}
|
|
1229
|
+
interface GetOrderTransactionsResponse {
|
|
1230
|
+
orderTX?: OrderTransaction[];
|
|
1231
|
+
}
|
|
895
1232
|
interface OrderSubmerchant {
|
|
896
|
-
|
|
897
|
-
|
|
1233
|
+
acquirer?: string;
|
|
1234
|
+
email?: string;
|
|
1235
|
+
id?: string;
|
|
1236
|
+
labels?: string;
|
|
1237
|
+
name?: string;
|
|
1238
|
+
status?: string;
|
|
1239
|
+
submerchant_key?: string;
|
|
1240
|
+
submerchant_type?: string;
|
|
1241
|
+
[key: string]: unknown;
|
|
1242
|
+
}
|
|
1243
|
+
interface GetOrderSubmerchantsRequest {
|
|
1244
|
+
page?: number;
|
|
1245
|
+
per_page?: number;
|
|
898
1246
|
[key: string]: unknown;
|
|
899
1247
|
}
|
|
1248
|
+
interface GetOrderSubmerchantsResponse {
|
|
1249
|
+
page?: number;
|
|
1250
|
+
per_page?: number;
|
|
1251
|
+
row?: OrderSubmerchant[];
|
|
1252
|
+
total?: number;
|
|
1253
|
+
total_pages?: number;
|
|
1254
|
+
}
|
|
900
1255
|
/**
|
|
901
1256
|
* @category Order Management
|
|
902
1257
|
* @summary Request for order accounting
|
|
@@ -906,6 +1261,16 @@ interface OrderSubmerchant {
|
|
|
906
1261
|
interface OrderAccountingRequest {
|
|
907
1262
|
order_reference_id: string;
|
|
908
1263
|
}
|
|
1264
|
+
/**
|
|
1265
|
+
* @category Order Management
|
|
1266
|
+
* @summary Response for order accounting
|
|
1267
|
+
* @description API response payload returned after order accounting operation
|
|
1268
|
+
* @interface OrderAccountingResponse
|
|
1269
|
+
*/
|
|
1270
|
+
interface OrderAccountingResponse {
|
|
1271
|
+
code?: number;
|
|
1272
|
+
message?: string;
|
|
1273
|
+
}
|
|
909
1274
|
/**
|
|
910
1275
|
* @category Order Management
|
|
911
1276
|
* @summary Request to add an item to the basket
|
|
@@ -936,6 +1301,35 @@ interface UpdateBasketItemRequest {
|
|
|
936
1301
|
order_reference_id: string;
|
|
937
1302
|
basket_item: BasketItemDTO;
|
|
938
1303
|
}
|
|
1304
|
+
interface AddBasketItemResponse {
|
|
1305
|
+
code?: number;
|
|
1306
|
+
message?: string;
|
|
1307
|
+
}
|
|
1308
|
+
interface RemoveBasketItemResponse {
|
|
1309
|
+
code?: number;
|
|
1310
|
+
message?: string;
|
|
1311
|
+
}
|
|
1312
|
+
interface UpdateBasketItemResponse {
|
|
1313
|
+
code?: number;
|
|
1314
|
+
message?: string;
|
|
1315
|
+
}
|
|
1316
|
+
interface OrderManualCallbackRequest {
|
|
1317
|
+
conversation_id?: string;
|
|
1318
|
+
reference_id: string;
|
|
1319
|
+
}
|
|
1320
|
+
interface OrderManualCallbackResponse {
|
|
1321
|
+
code?: number;
|
|
1322
|
+
message?: string;
|
|
1323
|
+
}
|
|
1324
|
+
interface OrderRelatedUpdateRequest {
|
|
1325
|
+
reference_id: string;
|
|
1326
|
+
related_reference_id: string;
|
|
1327
|
+
}
|
|
1328
|
+
interface OrderRelatedUpdateResponse {
|
|
1329
|
+
code?: number;
|
|
1330
|
+
is_success?: boolean;
|
|
1331
|
+
message?: string;
|
|
1332
|
+
}
|
|
939
1333
|
/**
|
|
940
1334
|
* @category Organization
|
|
941
1335
|
* @summary Webhook callback URL configuration
|
|
@@ -955,7 +1349,10 @@ interface CallbackURLDTO {
|
|
|
955
1349
|
*/
|
|
956
1350
|
declare enum BusinessType {
|
|
957
1351
|
INDIVIDUAL = 0,
|
|
958
|
-
CORPORATE = 1
|
|
1352
|
+
CORPORATE = 1,
|
|
1353
|
+
NON_PROFIT = 2,
|
|
1354
|
+
GOVERNMENT = 3,
|
|
1355
|
+
UNKNOWN = 4
|
|
959
1356
|
}
|
|
960
1357
|
/**
|
|
961
1358
|
* @category Organization
|
|
@@ -976,6 +1373,39 @@ interface OrgCreateBusinessRequest {
|
|
|
976
1373
|
tax_office: string;
|
|
977
1374
|
zip_code: string;
|
|
978
1375
|
}
|
|
1376
|
+
interface OrgCreateBusinessResponse {
|
|
1377
|
+
code?: number;
|
|
1378
|
+
message?: string;
|
|
1379
|
+
}
|
|
1380
|
+
interface OrganizationResponse {
|
|
1381
|
+
message?: string;
|
|
1382
|
+
}
|
|
1383
|
+
interface OrganizationCurrency {
|
|
1384
|
+
code?: string;
|
|
1385
|
+
currency_unit?: string;
|
|
1386
|
+
id?: string;
|
|
1387
|
+
name?: string;
|
|
1388
|
+
symbol?: string;
|
|
1389
|
+
}
|
|
1390
|
+
interface GetOrganizationCurrenciesResponse {
|
|
1391
|
+
currencies?: OrganizationCurrency[];
|
|
1392
|
+
}
|
|
1393
|
+
interface UserLimit {
|
|
1394
|
+
currency?: string;
|
|
1395
|
+
id?: string;
|
|
1396
|
+
max_daily_transaction_amount?: number;
|
|
1397
|
+
max_daily_transaction_count?: number;
|
|
1398
|
+
max_expense_amount?: number;
|
|
1399
|
+
max_income_amount?: number;
|
|
1400
|
+
max_monthly_transaction_amount?: number;
|
|
1401
|
+
max_monthly_transaction_count?: number;
|
|
1402
|
+
max_topup_amount?: number;
|
|
1403
|
+
max_wallet_balance?: number;
|
|
1404
|
+
max_withdrawal_amount?: number;
|
|
1405
|
+
}
|
|
1406
|
+
interface GetUserLimitResponse {
|
|
1407
|
+
user_limits?: UserLimit[];
|
|
1408
|
+
}
|
|
979
1409
|
/**
|
|
980
1410
|
* @category Organization
|
|
981
1411
|
* @summary Request for user limit information
|
|
@@ -996,6 +1426,44 @@ interface SetLimitUserRequest {
|
|
|
996
1426
|
limit_id: string;
|
|
997
1427
|
user_id: string;
|
|
998
1428
|
}
|
|
1429
|
+
interface SetLimitUserResponse {
|
|
1430
|
+
code?: number;
|
|
1431
|
+
message?: string;
|
|
1432
|
+
}
|
|
1433
|
+
interface OrganizationLimit extends UserLimit {
|
|
1434
|
+
name?: string;
|
|
1435
|
+
}
|
|
1436
|
+
interface GetOrganizationLimitsResponse {
|
|
1437
|
+
limits?: OrganizationLimit[];
|
|
1438
|
+
}
|
|
1439
|
+
interface GetMetaResponse {
|
|
1440
|
+
data?: string;
|
|
1441
|
+
}
|
|
1442
|
+
interface OrganizationScope {
|
|
1443
|
+
create?: boolean;
|
|
1444
|
+
delete?: boolean;
|
|
1445
|
+
entity?: string;
|
|
1446
|
+
read?: boolean;
|
|
1447
|
+
update?: boolean;
|
|
1448
|
+
}
|
|
1449
|
+
interface GetOrganizationScopesResponse {
|
|
1450
|
+
scopes?: OrganizationScope[];
|
|
1451
|
+
}
|
|
1452
|
+
interface GetSuborganizationsRequest {
|
|
1453
|
+
page?: number;
|
|
1454
|
+
per_page?: number;
|
|
1455
|
+
}
|
|
1456
|
+
interface OrganizationSuborganization {
|
|
1457
|
+
id?: string;
|
|
1458
|
+
name?: string;
|
|
1459
|
+
}
|
|
1460
|
+
interface GetSubOrganizationListResponse {
|
|
1461
|
+
page?: number;
|
|
1462
|
+
per_page?: number;
|
|
1463
|
+
rows?: OrganizationSuborganization[];
|
|
1464
|
+
total?: number;
|
|
1465
|
+
total_pages?: number;
|
|
1466
|
+
}
|
|
999
1467
|
/**
|
|
1000
1468
|
* @category Organization
|
|
1001
1469
|
* @summary Request for VPOS list
|
|
@@ -1006,13 +1474,20 @@ interface GetVposRequest {
|
|
|
1006
1474
|
currency_id: string;
|
|
1007
1475
|
[key: string]: unknown;
|
|
1008
1476
|
}
|
|
1477
|
+
interface OrganizationVpos {
|
|
1478
|
+
id?: string;
|
|
1479
|
+
name?: string;
|
|
1480
|
+
}
|
|
1481
|
+
interface GetVposResponse {
|
|
1482
|
+
organization_vpos?: OrganizationVpos[];
|
|
1483
|
+
}
|
|
1009
1484
|
/**
|
|
1010
1485
|
* @category Organization
|
|
1011
1486
|
* @summary Request to create an organization user
|
|
1012
1487
|
* @description Comprehensive data for creating a new user within an organization
|
|
1013
|
-
* @interface
|
|
1488
|
+
* @interface OrgCreateUserRequest
|
|
1014
1489
|
*/
|
|
1015
|
-
interface
|
|
1490
|
+
interface OrgCreateUserRequest {
|
|
1016
1491
|
conversation_id: string;
|
|
1017
1492
|
email: string;
|
|
1018
1493
|
first_name: string;
|
|
@@ -1022,24 +1497,40 @@ interface OrgCreateUserReq {
|
|
|
1022
1497
|
phone: string;
|
|
1023
1498
|
reference_id: string;
|
|
1024
1499
|
}
|
|
1500
|
+
interface OrgCreateUserResponse {
|
|
1501
|
+
code?: number;
|
|
1502
|
+
message?: string;
|
|
1503
|
+
user_id?: string;
|
|
1504
|
+
}
|
|
1505
|
+
type OrgCreateUserReq = OrgCreateUserRequest;
|
|
1025
1506
|
/**
|
|
1026
1507
|
* @category Organization
|
|
1027
1508
|
* @summary Request to verify a user
|
|
1028
1509
|
* @description Data required to verify a user's account
|
|
1029
|
-
* @interface
|
|
1510
|
+
* @interface OrgUserVerifyRequest
|
|
1030
1511
|
*/
|
|
1031
|
-
interface
|
|
1512
|
+
interface OrgUserVerifyRequest {
|
|
1032
1513
|
user_id: string;
|
|
1033
1514
|
}
|
|
1515
|
+
interface OrgUserVerifyResponse {
|
|
1516
|
+
code?: number;
|
|
1517
|
+
message?: string;
|
|
1518
|
+
}
|
|
1519
|
+
type OrgUserVerifyReq = OrgUserVerifyRequest;
|
|
1034
1520
|
/**
|
|
1035
1521
|
* @category Organization
|
|
1036
1522
|
* @summary Request to verify user's mobile number
|
|
1037
1523
|
* @description Data required to initiate or complete mobile number verification
|
|
1038
|
-
* @interface
|
|
1524
|
+
* @interface OrgUserMobileVerifyRequest
|
|
1039
1525
|
*/
|
|
1040
|
-
interface
|
|
1526
|
+
interface OrgUserMobileVerifyRequest {
|
|
1041
1527
|
user_id: string;
|
|
1042
1528
|
}
|
|
1529
|
+
interface OrgUserMobileVerifyResponse {
|
|
1530
|
+
code?: number;
|
|
1531
|
+
message?: string;
|
|
1532
|
+
}
|
|
1533
|
+
type OrgUserMobileVerifyReq = OrgUserMobileVerifyRequest;
|
|
1043
1534
|
/**
|
|
1044
1535
|
* @category Order Management
|
|
1045
1536
|
* @summary Request for order post-authorization
|
|
@@ -1050,6 +1541,157 @@ interface OrderPostAuthRequest {
|
|
|
1050
1541
|
amount: number;
|
|
1051
1542
|
reference_id: string;
|
|
1052
1543
|
}
|
|
1544
|
+
/**
|
|
1545
|
+
* @category Order Management
|
|
1546
|
+
* @summary Response for order post-authorization
|
|
1547
|
+
* @description API response payload returned after post-authorization operation
|
|
1548
|
+
* @interface OrderPostAuthResponse
|
|
1549
|
+
*/
|
|
1550
|
+
interface OrderPostAuthResponse {
|
|
1551
|
+
code?: number;
|
|
1552
|
+
is_success?: boolean;
|
|
1553
|
+
message?: string;
|
|
1554
|
+
}
|
|
1555
|
+
interface OrderPaymentOptionsUpdateDTO {
|
|
1556
|
+
payment_options: string[];
|
|
1557
|
+
reference_id: string;
|
|
1558
|
+
}
|
|
1559
|
+
interface SplitOrderItemPaymentDTO {
|
|
1560
|
+
amount: number;
|
|
1561
|
+
order_id: string;
|
|
1562
|
+
order_item_payment_id: string;
|
|
1563
|
+
}
|
|
1564
|
+
interface OrderCallbackResponse {
|
|
1565
|
+
[key: string]: unknown;
|
|
1566
|
+
}
|
|
1567
|
+
interface OrderVposQueryResponse {
|
|
1568
|
+
[key: string]: unknown;
|
|
1569
|
+
}
|
|
1570
|
+
interface OrganizationCurrencyPreset {
|
|
1571
|
+
id?: string;
|
|
1572
|
+
name?: string;
|
|
1573
|
+
code?: string;
|
|
1574
|
+
[key: string]: unknown;
|
|
1575
|
+
}
|
|
1576
|
+
interface GetOrganizationCurrencyPresetsResponse {
|
|
1577
|
+
presets?: OrganizationCurrencyPreset[];
|
|
1578
|
+
}
|
|
1579
|
+
interface GetSuborganizationDetailsResponse {
|
|
1580
|
+
[key: string]: unknown;
|
|
1581
|
+
}
|
|
1582
|
+
interface GetSuborganizationSubmerchantsResponse {
|
|
1583
|
+
[key: string]: unknown;
|
|
1584
|
+
}
|
|
1585
|
+
interface SystemBasketItemType {
|
|
1586
|
+
code?: string | number;
|
|
1587
|
+
message?: string;
|
|
1588
|
+
}
|
|
1589
|
+
interface GetSystemBasketItemTypesResponse {
|
|
1590
|
+
rows?: SystemBasketItemType[];
|
|
1591
|
+
}
|
|
1592
|
+
interface SystemErrorCode {
|
|
1593
|
+
code?: string | number;
|
|
1594
|
+
message?: string;
|
|
1595
|
+
}
|
|
1596
|
+
interface GetSystemErrorCodesResponse {
|
|
1597
|
+
rows?: SystemErrorCode[];
|
|
1598
|
+
}
|
|
1599
|
+
interface SystemPaymentTermStatus {
|
|
1600
|
+
code?: string | number;
|
|
1601
|
+
message?: string;
|
|
1602
|
+
}
|
|
1603
|
+
interface GetSystemPaymentTermStatusesResponse {
|
|
1604
|
+
rows?: SystemPaymentTermStatus[];
|
|
1605
|
+
}
|
|
1606
|
+
interface SystemProductType {
|
|
1607
|
+
code?: string | number;
|
|
1608
|
+
message?: string;
|
|
1609
|
+
}
|
|
1610
|
+
interface GetSystemProductTypesResponse {
|
|
1611
|
+
rows?: SystemProductType[];
|
|
1612
|
+
}
|
|
1613
|
+
interface SystemShortcutType {
|
|
1614
|
+
code?: string | number;
|
|
1615
|
+
message?: string;
|
|
1616
|
+
}
|
|
1617
|
+
interface GetSystemShortcutTypesResponse {
|
|
1618
|
+
rows?: SystemShortcutType[];
|
|
1619
|
+
}
|
|
1620
|
+
interface SystemTransactionPaymentType {
|
|
1621
|
+
code?: string | number;
|
|
1622
|
+
message?: string;
|
|
1623
|
+
}
|
|
1624
|
+
interface GetSystemTransactionPaymentTypesResponse {
|
|
1625
|
+
rows?: SystemTransactionPaymentType[];
|
|
1626
|
+
}
|
|
1627
|
+
interface SystemTransactionPurpose {
|
|
1628
|
+
code?: string | number;
|
|
1629
|
+
message?: string;
|
|
1630
|
+
}
|
|
1631
|
+
interface GetSystemTransactionPurposesResponse {
|
|
1632
|
+
rows?: SystemTransactionPurpose[];
|
|
1633
|
+
}
|
|
1634
|
+
interface SystemTransactionStatus {
|
|
1635
|
+
code?: string | number;
|
|
1636
|
+
message?: string;
|
|
1637
|
+
}
|
|
1638
|
+
interface GetSystemTransactionStatusesResponse {
|
|
1639
|
+
rows?: SystemTransactionStatus[];
|
|
1640
|
+
}
|
|
1641
|
+
interface GetOrderPaymentsRequest {
|
|
1642
|
+
order_id: string;
|
|
1643
|
+
}
|
|
1644
|
+
interface GetOrderPaymentsResponse {
|
|
1645
|
+
[key: string]: unknown;
|
|
1646
|
+
}
|
|
1647
|
+
interface OrderOIPDTO {
|
|
1648
|
+
amount: number;
|
|
1649
|
+
type: number;
|
|
1650
|
+
basket_item_id?: string;
|
|
1651
|
+
order_id?: string;
|
|
1652
|
+
order_item_id?: string;
|
|
1653
|
+
}
|
|
1654
|
+
interface OrderOIPResponse {
|
|
1655
|
+
[key: string]: unknown;
|
|
1656
|
+
}
|
|
1657
|
+
interface SubmerchantCreateDTO {
|
|
1658
|
+
address: string;
|
|
1659
|
+
city: string;
|
|
1660
|
+
country: string;
|
|
1661
|
+
email: string;
|
|
1662
|
+
gsm_number: string;
|
|
1663
|
+
iban: string;
|
|
1664
|
+
identity_number: string;
|
|
1665
|
+
name: string;
|
|
1666
|
+
contact_name: string;
|
|
1667
|
+
contact_surname: string;
|
|
1668
|
+
sub_merchant_type: string;
|
|
1669
|
+
tax_office: string;
|
|
1670
|
+
zip_code: string;
|
|
1671
|
+
district?: string;
|
|
1672
|
+
iban_name?: string;
|
|
1673
|
+
}
|
|
1674
|
+
type SubmerchantUpdateDTO = Partial<SubmerchantCreateDTO>;
|
|
1675
|
+
interface GetSubmerchantResponse {
|
|
1676
|
+
[key: string]: unknown;
|
|
1677
|
+
}
|
|
1678
|
+
interface ListSubmerchantsResponse {
|
|
1679
|
+
data?: unknown[];
|
|
1680
|
+
total?: number;
|
|
1681
|
+
page?: number;
|
|
1682
|
+
per_page?: number;
|
|
1683
|
+
}
|
|
1684
|
+
interface OrgUserTokenCreateReq {
|
|
1685
|
+
email: string;
|
|
1686
|
+
expire?: number;
|
|
1687
|
+
language?: string;
|
|
1688
|
+
metadata?: Record<string, unknown>;
|
|
1689
|
+
title?: string;
|
|
1690
|
+
type?: string;
|
|
1691
|
+
}
|
|
1692
|
+
interface OrgUserTokenCreateResponse {
|
|
1693
|
+
[key: string]: unknown;
|
|
1694
|
+
}
|
|
1053
1695
|
|
|
1054
1696
|
/**
|
|
1055
1697
|
* @category Configuration
|
|
@@ -1185,6 +1827,14 @@ declare class TapsilatSDK {
|
|
|
1185
1827
|
* Access to organization operations
|
|
1186
1828
|
*/
|
|
1187
1829
|
get organization(): any;
|
|
1830
|
+
/**
|
|
1831
|
+
* Access to submerchant operations
|
|
1832
|
+
*/
|
|
1833
|
+
get submerchant(): any;
|
|
1834
|
+
/**
|
|
1835
|
+
* Access to system operations
|
|
1836
|
+
*/
|
|
1837
|
+
get system(): any;
|
|
1188
1838
|
/**
|
|
1189
1839
|
* Access to webhook operations
|
|
1190
1840
|
*/
|
|
@@ -1220,10 +1870,10 @@ declare class TapsilatSDK {
|
|
|
1220
1870
|
* @param {string} [orderRequest.payment_success_url] - URL to redirect after successful payment
|
|
1221
1871
|
* @param {string} [orderRequest.payment_failure_url] - URL to redirect after failed payment
|
|
1222
1872
|
* @param {number[]} [orderRequest.enabled_installments] - Allowed installment counts
|
|
1223
|
-
* @param {
|
|
1873
|
+
* @param {OrderMetadata[]} [orderRequest.metadata] - Additional custom key/value data
|
|
1224
1874
|
*
|
|
1225
1875
|
* @returns {Promise<OrderCreateResponse>} Promise resolving to order creation response
|
|
1226
|
-
* @returns {string} OrderCreateResponse.
|
|
1876
|
+
* @returns {string} [OrderCreateResponse.id] - Internal order identifier
|
|
1227
1877
|
* @returns {string} OrderCreateResponse.reference_id - Unique order reference for tracking
|
|
1228
1878
|
* @returns {string} [OrderCreateResponse.checkout_url] - Payment page URL for customer
|
|
1229
1879
|
* @returns {string} [OrderCreateResponse.conversation_id] - Echo of provided conversation ID
|
|
@@ -1248,11 +1898,11 @@ declare class TapsilatSDK {
|
|
|
1248
1898
|
* @description Handles accounting operations for a specific order using its reference ID.
|
|
1249
1899
|
*
|
|
1250
1900
|
* @param {OrderAccountingRequest} request - Accounting request details
|
|
1251
|
-
* @returns {Promise<
|
|
1901
|
+
* @returns {Promise<OrderAccountingResponse>} Promise resolving to the accounting response
|
|
1252
1902
|
* @throws {TapsilatValidationError} When input validation fails
|
|
1253
1903
|
* @throws {TapsilatError} When API returns an error response
|
|
1254
1904
|
*/
|
|
1255
|
-
orderAccounting(request: OrderAccountingRequest): Promise<
|
|
1905
|
+
orderAccounting(request: OrderAccountingRequest): Promise<OrderAccountingResponse>;
|
|
1256
1906
|
/**
|
|
1257
1907
|
* Process post-authorization for an order
|
|
1258
1908
|
*
|
|
@@ -1260,21 +1910,61 @@ declare class TapsilatSDK {
|
|
|
1260
1910
|
* @description Handles post-authorization operations for a specific order.
|
|
1261
1911
|
*
|
|
1262
1912
|
* @param {OrderPostAuthRequest} request - Post-authorization request details
|
|
1263
|
-
* @returns {Promise<
|
|
1913
|
+
* @returns {Promise<OrderPostAuthResponse>} Promise resolving to the post-auth response
|
|
1264
1914
|
* @throws {TapsilatValidationError} When input validation fails
|
|
1265
1915
|
* @throws {TapsilatError} When API returns an error response
|
|
1266
1916
|
*/
|
|
1267
|
-
orderPostAuth(request: OrderPostAuthRequest): Promise<
|
|
1917
|
+
orderPostAuth(request: OrderPostAuthRequest): Promise<OrderPostAuthResponse>;
|
|
1268
1918
|
/**
|
|
1269
1919
|
* Retrieve system order statuses
|
|
1270
1920
|
*
|
|
1271
1921
|
* @summary Retrieve system order statuses
|
|
1272
1922
|
* @description Gets a list of all possible order statuses in the system.
|
|
1273
1923
|
*
|
|
1274
|
-
* @returns {Promise<
|
|
1924
|
+
* @returns {Promise<GetSystemOrderStatusesResponse>} Promise resolving to system order statuses
|
|
1275
1925
|
* @throws {TapsilatError} When API returns an error response
|
|
1276
1926
|
*/
|
|
1277
|
-
getSystemOrderStatuses(): Promise<
|
|
1927
|
+
getSystemOrderStatuses(): Promise<GetSystemOrderStatusesResponse>;
|
|
1928
|
+
/**
|
|
1929
|
+
* Retrieves system basket item types.
|
|
1930
|
+
* Based on `get_system_basket_item_types` from Python SDK.
|
|
1931
|
+
*/
|
|
1932
|
+
getSystemBasketItemTypes(): Promise<GetSystemBasketItemTypesResponse>;
|
|
1933
|
+
/**
|
|
1934
|
+
* Retrieves system error codes.
|
|
1935
|
+
* Based on `get_system_error_codes` from Python SDK.
|
|
1936
|
+
*/
|
|
1937
|
+
getSystemErrorCodes(): Promise<GetSystemErrorCodesResponse>;
|
|
1938
|
+
/**
|
|
1939
|
+
* Retrieves system payment term statuses.
|
|
1940
|
+
* Based on `get_system_payment_term_statuses` from Python SDK.
|
|
1941
|
+
*/
|
|
1942
|
+
getSystemPaymentTermStatuses(): Promise<GetSystemPaymentTermStatusesResponse>;
|
|
1943
|
+
/**
|
|
1944
|
+
* Retrieves system product types.
|
|
1945
|
+
* Based on `get_system_product_types` from Python SDK.
|
|
1946
|
+
*/
|
|
1947
|
+
getSystemProductTypes(): Promise<GetSystemProductTypesResponse>;
|
|
1948
|
+
/**
|
|
1949
|
+
* Retrieves system shortcut types.
|
|
1950
|
+
* Based on `get_system_shortcut_types` from Python SDK.
|
|
1951
|
+
*/
|
|
1952
|
+
getSystemShortcutTypes(): Promise<GetSystemShortcutTypesResponse>;
|
|
1953
|
+
/**
|
|
1954
|
+
* Retrieves system transaction payment types.
|
|
1955
|
+
* Based on `get_system_transaction_payment_types` from Python SDK.
|
|
1956
|
+
*/
|
|
1957
|
+
getSystemTransactionPaymentTypes(): Promise<GetSystemTransactionPaymentTypesResponse>;
|
|
1958
|
+
/**
|
|
1959
|
+
* Retrieves system transaction purposes.
|
|
1960
|
+
* Based on `get_system_transaction_purposes` from Python SDK.
|
|
1961
|
+
*/
|
|
1962
|
+
getSystemTransactionPurposes(): Promise<GetSystemTransactionPurposesResponse>;
|
|
1963
|
+
/**
|
|
1964
|
+
* Retrieves system transaction statuses.
|
|
1965
|
+
* Based on `get_system_transaction_statuses` from Python SDK.
|
|
1966
|
+
*/
|
|
1967
|
+
getSystemTransactionStatuses(): Promise<GetSystemTransactionStatusesResponse>;
|
|
1278
1968
|
/**
|
|
1279
1969
|
* Gets an order by reference ID.
|
|
1280
1970
|
*
|
|
@@ -1287,7 +1977,7 @@ declare class TapsilatSDK {
|
|
|
1287
1977
|
* @throws {TapsilatNetworkError} When API request fails due to network issues
|
|
1288
1978
|
* @throws {TapsilatError} When API returns an error response
|
|
1289
1979
|
*/
|
|
1290
|
-
getOrder(referenceId: string): Promise<
|
|
1980
|
+
getOrder(referenceId: string): Promise<GetOrderResponse>;
|
|
1291
1981
|
/**
|
|
1292
1982
|
* Lists orders with pagination support.
|
|
1293
1983
|
*
|
|
@@ -1299,15 +1989,7 @@ declare class TapsilatSDK {
|
|
|
1299
1989
|
* @throws {TapsilatNetworkError} When API request fails due to network issues
|
|
1300
1990
|
* @throws {TapsilatError} When API returns an error response
|
|
1301
1991
|
*/
|
|
1302
|
-
getOrders(params?:
|
|
1303
|
-
page?: number;
|
|
1304
|
-
per_page?: number;
|
|
1305
|
-
start_date?: string;
|
|
1306
|
-
end_date?: string;
|
|
1307
|
-
status?: string;
|
|
1308
|
-
organization_id?: string;
|
|
1309
|
-
related_reference_id?: string;
|
|
1310
|
-
}): Promise<PaginatedResponse<Order>>;
|
|
1992
|
+
getOrders(params?: GetOrdersRequest): Promise<GetOrdersResponse>;
|
|
1311
1993
|
/**
|
|
1312
1994
|
* Cancels an order by reference_id.
|
|
1313
1995
|
*
|
|
@@ -1319,19 +2001,19 @@ declare class TapsilatSDK {
|
|
|
1319
2001
|
* @throws {TapsilatValidationError} When referenceId is invalid
|
|
1320
2002
|
* @throws {TapsilatError} When API returns an error response or order cannot be canceled
|
|
1321
2003
|
*/
|
|
1322
|
-
cancelOrder(referenceId: string): Promise<
|
|
2004
|
+
cancelOrder(referenceId: string): Promise<CancelOrderResponse>;
|
|
1323
2005
|
/**
|
|
1324
2006
|
* Gets the current status of an order by reference ID
|
|
1325
2007
|
*
|
|
1326
2008
|
* @summary Retrieves real-time payment status and tracking information for a specific order
|
|
1327
2009
|
* @description
|
|
1328
2010
|
* Queries the Tapsilat payment platform to retrieve the current status of an order using its
|
|
1329
|
-
* unique reference ID. This method provides real-time information about payment
|
|
1330
|
-
*
|
|
2011
|
+
* unique reference ID. This method provides real-time information about payment processing
|
|
2012
|
+
* status and error code (if returned by the API). It's essential for tracking payment flow
|
|
1331
2013
|
* and implementing proper order state management in your application.
|
|
1332
2014
|
*
|
|
1333
|
-
* The status information includes payment state
|
|
1334
|
-
*
|
|
2015
|
+
* The status information includes payment state and API-level error code metadata.
|
|
2016
|
+
* This method should be used to:
|
|
1335
2017
|
* - Check if a payment has been completed after redirecting from checkout
|
|
1336
2018
|
* - Monitor payment status for pending transactions
|
|
1337
2019
|
* - Verify order state before fulfilling goods/services
|
|
@@ -1340,13 +2022,11 @@ declare class TapsilatSDK {
|
|
|
1340
2022
|
* @param {string} referenceId - Unique order reference identifier from order creation
|
|
1341
2023
|
*
|
|
1342
2024
|
* @returns {Promise<OrderStatusResponse>} Promise resolving to current order status information
|
|
1343
|
-
* @returns {string} OrderStatusResponse.
|
|
1344
|
-
* @returns {string} OrderStatusResponse.status - Current payment status
|
|
1345
|
-
* @returns {string} OrderStatusResponse.lastUpdatedAt - ISO 8601 timestamp of last status change
|
|
2025
|
+
* @returns {string} [OrderStatusResponse.error_code] - API-level error code when present
|
|
2026
|
+
* @returns {string} [OrderStatusResponse.status] - Current payment processing status
|
|
1346
2027
|
*
|
|
1347
2028
|
* @throws {TapsilatValidationError} When input validation fails:
|
|
1348
2029
|
* - Reference ID is null, undefined, or empty string
|
|
1349
|
-
* - Reference ID format is invalid (should match order ID pattern)
|
|
1350
2030
|
* @throws {TapsilatNetworkError} When network request fails:
|
|
1351
2031
|
* - Connection timeout during status check
|
|
1352
2032
|
* - DNS resolution failure
|
|
@@ -1382,19 +2062,35 @@ declare class TapsilatSDK {
|
|
|
1382
2062
|
*/
|
|
1383
2063
|
refundAllOrder(referenceId: string): Promise<OrderRefundResponse>;
|
|
1384
2064
|
/**
|
|
1385
|
-
* Retrieves the payment details for an order.
|
|
2065
|
+
* Retrieves the payment details for an order via POST request.
|
|
1386
2066
|
* Based on `get_order_payment_details` from the Python SDK.
|
|
1387
|
-
*
|
|
1388
|
-
* @summary Retrieve detailed payment transaction information for an order
|
|
1389
|
-
* @description Gets payment method, amount, status, and card info for order transactions.
|
|
1390
|
-
*
|
|
1391
|
-
* @param referenceId - The unique identifier of the order.
|
|
1392
|
-
* @param conversationId - Optional conversation ID for more specific querying.
|
|
1393
|
-
* @returns Promise resolving to a list of payment details.
|
|
1394
|
-
* @throws {TapsilatValidationError} When referenceId is invalid
|
|
1395
|
-
* @throws {TapsilatError} When API returns an error response or payment details are missing
|
|
1396
2067
|
*/
|
|
1397
|
-
getOrderPaymentDetails(
|
|
2068
|
+
getOrderPaymentDetails(request: OrderPaymentDetailDTO): Promise<GetOrderPaymentDetailsResponse>;
|
|
2069
|
+
/**
|
|
2070
|
+
* Retrieves the payment details for an order by ID.
|
|
2071
|
+
* Based on `get_order_payment_details_by_id` from the Python SDK.
|
|
2072
|
+
*/
|
|
2073
|
+
getOrderPaymentDetailsById(referenceId: string): Promise<GetOrderPaymentDetailsResponse>;
|
|
2074
|
+
/**
|
|
2075
|
+
* Retrieves the order callback via GET request.
|
|
2076
|
+
* Based on `order_callback` from the Python SDK.
|
|
2077
|
+
*/
|
|
2078
|
+
orderCallback(id: string): Promise<OrderCallbackResponse>;
|
|
2079
|
+
/**
|
|
2080
|
+
* Updates payment options for an order.
|
|
2081
|
+
* Based on `update_payment_options` from the Python SDK.
|
|
2082
|
+
*/
|
|
2083
|
+
updatePaymentOptions(request: OrderPaymentOptionsUpdateDTO): Promise<OrderRelatedUpdateResponse>;
|
|
2084
|
+
/**
|
|
2085
|
+
* Splits order item payment.
|
|
2086
|
+
* Based on `split_order_item_payment` from the Python SDK.
|
|
2087
|
+
*/
|
|
2088
|
+
splitOrderItemPayment(request: SplitOrderItemPaymentDTO): Promise<OrderRelatedUpdateResponse>;
|
|
2089
|
+
/**
|
|
2090
|
+
* Queries vpos for an order.
|
|
2091
|
+
* Based on `order_vpos_query` from the Python SDK.
|
|
2092
|
+
*/
|
|
2093
|
+
orderVposQuery(id: string): Promise<OrderVposQueryResponse>;
|
|
1398
2094
|
/**
|
|
1399
2095
|
* Gets an order by conversation_id.
|
|
1400
2096
|
* Based on `get_order_by_conversation_id` from the Python SDK.
|
|
@@ -1407,7 +2103,7 @@ declare class TapsilatSDK {
|
|
|
1407
2103
|
* @throws {TapsilatValidationError} When conversationId is invalid
|
|
1408
2104
|
* @throws {TapsilatError} When API returns an error response
|
|
1409
2105
|
*/
|
|
1410
|
-
getOrderByConversationId(conversationId: string): Promise<
|
|
2106
|
+
getOrderByConversationId(conversationId: string): Promise<GetOrderResponse>;
|
|
1411
2107
|
/**
|
|
1412
2108
|
* Gets order transactions by reference_id.
|
|
1413
2109
|
* Based on `get_order_transactions` from the Python SDK.
|
|
@@ -1420,7 +2116,7 @@ declare class TapsilatSDK {
|
|
|
1420
2116
|
* @throws {TapsilatValidationError} When referenceId is invalid
|
|
1421
2117
|
* @throws {TapsilatError} When API returns an error response
|
|
1422
2118
|
*/
|
|
1423
|
-
getOrderTransactions(referenceId: string): Promise<
|
|
2119
|
+
getOrderTransactions(referenceId: string): Promise<GetOrderTransactionsResponse>;
|
|
1424
2120
|
/**
|
|
1425
2121
|
* Gets order submerchants with pagination.
|
|
1426
2122
|
* Based on `get_order_submerchants` from the Python SDK.
|
|
@@ -1432,10 +2128,7 @@ declare class TapsilatSDK {
|
|
|
1432
2128
|
* @returns Promise resolving to paginated list of submerchants
|
|
1433
2129
|
* @throws {TapsilatError} When API returns an error response
|
|
1434
2130
|
*/
|
|
1435
|
-
getOrderSubmerchants(params?:
|
|
1436
|
-
page?: number;
|
|
1437
|
-
per_page?: number;
|
|
1438
|
-
}): Promise<PaginatedResponse<OrderSubmerchant>>;
|
|
2131
|
+
getOrderSubmerchants(params?: GetOrderSubmerchantsRequest): Promise<GetOrderSubmerchantsResponse>;
|
|
1439
2132
|
/**
|
|
1440
2133
|
* Gets checkout URL for an order.
|
|
1441
2134
|
* Based on `get_checkout_url` from the Python SDK.
|
|
@@ -1521,7 +2214,7 @@ declare class TapsilatSDK {
|
|
|
1521
2214
|
* @throws {TapsilatValidationError} When input validation fails
|
|
1522
2215
|
* @throws {TapsilatError} When API returns an error response
|
|
1523
2216
|
*/
|
|
1524
|
-
createOrderTerm(termData: OrderPaymentTermCreateDTO): Promise<
|
|
2217
|
+
createOrderTerm(termData: OrderPaymentTermCreateDTO): Promise<OrderPaymentTermActionResponse>;
|
|
1525
2218
|
/**
|
|
1526
2219
|
* Updates an existing payment term
|
|
1527
2220
|
*
|
|
@@ -1544,7 +2237,7 @@ declare class TapsilatSDK {
|
|
|
1544
2237
|
* @throws {TapsilatValidationError} When input validation fails
|
|
1545
2238
|
* @throws {TapsilatError} When API returns an error response
|
|
1546
2239
|
*/
|
|
1547
|
-
updateOrderTerm(updateData: OrderPaymentTermUpdateDTO): Promise<
|
|
2240
|
+
updateOrderTerm(updateData: OrderPaymentTermUpdateDTO): Promise<OrderPaymentTermActionResponse>;
|
|
1548
2241
|
/**
|
|
1549
2242
|
* Deletes a payment term
|
|
1550
2243
|
*
|
|
@@ -1560,7 +2253,7 @@ declare class TapsilatSDK {
|
|
|
1560
2253
|
* @throws {TapsilatValidationError} When input validation fails
|
|
1561
2254
|
* @throws {TapsilatError} When API returns an error response
|
|
1562
2255
|
*/
|
|
1563
|
-
deleteOrderTerm(deleteData: PaymentTermDeleteRequest): Promise<
|
|
2256
|
+
deleteOrderTerm(deleteData: PaymentTermDeleteRequest): Promise<OrderPaymentTermActionResponse>;
|
|
1564
2257
|
/**
|
|
1565
2258
|
* Refunds a specific payment term
|
|
1566
2259
|
*
|
|
@@ -1615,86 +2308,232 @@ declare class TapsilatSDK {
|
|
|
1615
2308
|
* @throws {TapsilatError} When API returns an error response
|
|
1616
2309
|
*/
|
|
1617
2310
|
terminateOrder(terminateData: OrderTerminateRequest): Promise<OrderTerminateResponse>;
|
|
1618
|
-
orderManualCallback(referenceId: string, conversationId?: string): Promise<
|
|
1619
|
-
orderRelatedUpdate(referenceId: string, relatedReferenceId: string): Promise<
|
|
2311
|
+
orderManualCallback(referenceId: string, conversationId?: string): Promise<OrderManualCallbackResponse>;
|
|
2312
|
+
orderRelatedUpdate(referenceId: string, relatedReferenceId: string): Promise<OrderRelatedUpdateResponse>;
|
|
1620
2313
|
getOrganizationSettings(): Promise<OrganizationSettings>;
|
|
1621
|
-
getOrderTerm(termReferenceId: string): Promise<
|
|
2314
|
+
getOrderTerm(termReferenceId: string): Promise<GetOrderTermResponse>;
|
|
1622
2315
|
/**
|
|
1623
2316
|
* Add a new item to an existing order basket
|
|
1624
2317
|
*/
|
|
1625
|
-
addBasketItem(request: AddBasketItemRequest): Promise<
|
|
2318
|
+
addBasketItem(request: AddBasketItemRequest): Promise<AddBasketItemResponse>;
|
|
1626
2319
|
/**
|
|
1627
2320
|
* Remove an item from an existing order basket
|
|
1628
2321
|
*/
|
|
1629
|
-
removeBasketItem(request: RemoveBasketItemRequest): Promise<
|
|
2322
|
+
removeBasketItem(request: RemoveBasketItemRequest): Promise<RemoveBasketItemResponse>;
|
|
1630
2323
|
/**
|
|
1631
2324
|
* Update an existing item in an order basket
|
|
1632
2325
|
*/
|
|
1633
|
-
updateBasketItem(request: UpdateBasketItemRequest): Promise<
|
|
2326
|
+
updateBasketItem(request: UpdateBasketItemRequest): Promise<UpdateBasketItemResponse>;
|
|
1634
2327
|
/**
|
|
1635
2328
|
* Retrieve organization callback (webhook) settings
|
|
1636
2329
|
*/
|
|
1637
|
-
getOrganizationCallback(): Promise<
|
|
2330
|
+
getOrganizationCallback(): Promise<CallbackURLDTO>;
|
|
1638
2331
|
/**
|
|
1639
2332
|
* Update organization callback (webhook) settings
|
|
1640
2333
|
*/
|
|
1641
|
-
updateOrganizationCallback(request: CallbackURLDTO): Promise<
|
|
2334
|
+
updateOrganizationCallback(request: CallbackURLDTO): Promise<OrganizationResponse>;
|
|
1642
2335
|
/**
|
|
1643
2336
|
* Create a new business entity within the organization
|
|
1644
2337
|
*/
|
|
1645
|
-
createOrganizationBusiness(request: OrgCreateBusinessRequest): Promise<
|
|
2338
|
+
createOrganizationBusiness(request: OrgCreateBusinessRequest): Promise<OrgCreateBusinessResponse>;
|
|
1646
2339
|
/**
|
|
1647
2340
|
* Retrieve supported currencies for the organization
|
|
1648
2341
|
*/
|
|
1649
|
-
getOrganizationCurrencies(): Promise<
|
|
2342
|
+
getOrganizationCurrencies(): Promise<GetOrganizationCurrenciesResponse>;
|
|
2343
|
+
/**
|
|
2344
|
+
* Retrieves organization currency presets.
|
|
2345
|
+
* Based on `get_organization_currency_presets` from Python SDK.
|
|
2346
|
+
*/
|
|
2347
|
+
getOrganizationCurrencyPresets(): Promise<GetOrganizationCurrencyPresetsResponse>;
|
|
2348
|
+
/**
|
|
2349
|
+
* Retrieves organization suborganization details.
|
|
2350
|
+
* Based on `get_organization_suborganization_details` from Python SDK.
|
|
2351
|
+
*/
|
|
2352
|
+
getOrganizationSuborganizationDetails(id: string): Promise<GetSuborganizationDetailsResponse>;
|
|
2353
|
+
/**
|
|
2354
|
+
* Retrieves organization suborganization submerchants.
|
|
2355
|
+
* Based on `get_organization_suborganization_submerchants` from Python SDK.
|
|
2356
|
+
*/
|
|
2357
|
+
getOrganizationSuborganizationSubmerchants(id: string): Promise<GetSuborganizationSubmerchantsResponse>;
|
|
1650
2358
|
/**
|
|
1651
2359
|
* Retrieve limit information for a specific organization user
|
|
1652
2360
|
*/
|
|
1653
|
-
getOrganizationLimitUser(request: GetUserLimitRequest): Promise<
|
|
2361
|
+
getOrganizationLimitUser(request: GetUserLimitRequest): Promise<GetUserLimitResponse>;
|
|
1654
2362
|
/**
|
|
1655
2363
|
* Set limit for a specific organization user
|
|
1656
2364
|
*/
|
|
1657
|
-
setOrganizationLimitUser(request: SetLimitUserRequest): Promise<
|
|
2365
|
+
setOrganizationLimitUser(request: SetLimitUserRequest): Promise<SetLimitUserResponse>;
|
|
1658
2366
|
/**
|
|
1659
2367
|
* Retrieve organization overall limits
|
|
1660
2368
|
*/
|
|
1661
|
-
getOrganizationLimits(): Promise<
|
|
2369
|
+
getOrganizationLimits(): Promise<GetOrganizationLimitsResponse>;
|
|
1662
2370
|
/**
|
|
1663
2371
|
* Retrieve meta information for the organization
|
|
1664
2372
|
*/
|
|
1665
|
-
getOrganizationMeta(): Promise<
|
|
2373
|
+
getOrganizationMeta(name: string): Promise<GetMetaResponse>;
|
|
1666
2374
|
/**
|
|
1667
2375
|
* Retrieve supported scopes for the organization
|
|
1668
2376
|
*/
|
|
1669
|
-
getOrganizationScopes(): Promise<
|
|
2377
|
+
getOrganizationScopes(): Promise<GetOrganizationScopesResponse>;
|
|
1670
2378
|
/**
|
|
1671
2379
|
* Retrieve list of sub-organizations
|
|
1672
2380
|
*/
|
|
1673
|
-
getOrganizationSuborganizations(): Promise<
|
|
2381
|
+
getOrganizationSuborganizations(params?: GetSuborganizationsRequest): Promise<GetSubOrganizationListResponse>;
|
|
1674
2382
|
/**
|
|
1675
2383
|
* Create a new user within the organization
|
|
1676
2384
|
*/
|
|
1677
|
-
createOrganizationUser(request:
|
|
2385
|
+
createOrganizationUser(request: OrgCreateUserRequest): Promise<OrgCreateUserResponse>;
|
|
1678
2386
|
/**
|
|
1679
2387
|
* Verify an organization user
|
|
1680
2388
|
*/
|
|
1681
|
-
verifyOrganizationUser(request:
|
|
2389
|
+
verifyOrganizationUser(request: OrgUserVerifyRequest): Promise<OrgUserVerifyResponse>;
|
|
1682
2390
|
/**
|
|
1683
2391
|
* Verify an organization user via mobile
|
|
1684
2392
|
*/
|
|
1685
|
-
verifyOrganizationUserMobile(request:
|
|
2393
|
+
verifyOrganizationUserMobile(request: OrgUserMobileVerifyRequest): Promise<OrgUserMobileVerifyResponse>;
|
|
1686
2394
|
/**
|
|
1687
2395
|
* List virtual POS terminals for the organization
|
|
1688
2396
|
*/
|
|
1689
|
-
listOrganizationVpos(request: GetVposRequest): Promise<
|
|
2397
|
+
listOrganizationVpos(request: GetVposRequest): Promise<GetVposResponse>;
|
|
1690
2398
|
createSubscription(request: SubscriptionCreateRequest): Promise<SubscriptionCreateResponse>;
|
|
1691
2399
|
getSubscription(request: SubscriptionGetRequest): Promise<SubscriptionDetail>;
|
|
1692
|
-
listSubscriptions(params?:
|
|
1693
|
-
|
|
1694
|
-
per_page?: number;
|
|
1695
|
-
}): Promise<PaginatedResponse<SubscriptionDetail>>;
|
|
1696
|
-
cancelSubscription(request: SubscriptionCancelRequest): Promise<APIResponse<unknown>>;
|
|
2400
|
+
listSubscriptions(params?: ListSubscriptionsRequest): Promise<ListSubscriptionsResponse>;
|
|
2401
|
+
cancelSubscription(request: SubscriptionCancelRequest): Promise<CancelSubscriptionResponse>;
|
|
1697
2402
|
redirectSubscription(request: SubscriptionRedirectRequest): Promise<SubscriptionRedirectResponse>;
|
|
2403
|
+
/**
|
|
2404
|
+
* Gets payments for an order.
|
|
2405
|
+
* Based on `get_order_payments` from the Python SDK.
|
|
2406
|
+
*
|
|
2407
|
+
* @summary Get order payments
|
|
2408
|
+
* @description Retrieve a list of payments made for a specific order.
|
|
2409
|
+
*
|
|
2410
|
+
* @param request - Order payments request containing order_id
|
|
2411
|
+
* @returns Promise resolving to order payments
|
|
2412
|
+
*/
|
|
2413
|
+
getOrderPayments(request: GetOrderPaymentsRequest): Promise<GetOrderPaymentsResponse>;
|
|
2414
|
+
/**
|
|
2415
|
+
* Downloads order PDF.
|
|
2416
|
+
* Based on `get_order_pdf` from the Python SDK.
|
|
2417
|
+
*
|
|
2418
|
+
* @summary Download order PDF
|
|
2419
|
+
* @description Download order as a PDF file.
|
|
2420
|
+
*
|
|
2421
|
+
* @param id - Order reference ID
|
|
2422
|
+
* @returns Promise resolving to a Blob representing the PDF
|
|
2423
|
+
*/
|
|
2424
|
+
getOrderPdf(id: string): Promise<Blob>;
|
|
2425
|
+
/**
|
|
2426
|
+
* Downloads order Excel.
|
|
2427
|
+
* Based on `get_order_excel` from the Python SDK.
|
|
2428
|
+
*
|
|
2429
|
+
* @summary Download order Excel
|
|
2430
|
+
* @description Download order as an Excel file.
|
|
2431
|
+
*
|
|
2432
|
+
* @param id - Order reference ID
|
|
2433
|
+
* @returns Promise resolving to a Blob representing the Excel file
|
|
2434
|
+
*/
|
|
2435
|
+
getOrderExcel(id: string): Promise<Blob>;
|
|
2436
|
+
/**
|
|
2437
|
+
* Creates an order refund request.
|
|
2438
|
+
* Based on `create_order_refund_request` from the Python SDK.
|
|
2439
|
+
*
|
|
2440
|
+
* @summary Create order refund request
|
|
2441
|
+
* @description Request a refund for an order.
|
|
2442
|
+
*
|
|
2443
|
+
* @param request - Order refund request payload
|
|
2444
|
+
* @returns Promise resolving to refund response
|
|
2445
|
+
*/
|
|
2446
|
+
createOrderRefundRequest(request: RefundOrderDTO): Promise<OrderRefundResponse>;
|
|
2447
|
+
/**
|
|
2448
|
+
* Adds an order item payment.
|
|
2449
|
+
* Based on `add_order_oip` from the Python SDK.
|
|
2450
|
+
*
|
|
2451
|
+
* @summary Add Order OIP
|
|
2452
|
+
* @description Adds an order item payment to a specific order.
|
|
2453
|
+
*
|
|
2454
|
+
* @param request - Order OIP request payload containing order_id and other details
|
|
2455
|
+
* @returns Promise resolving to OIP response
|
|
2456
|
+
*/
|
|
2457
|
+
addOrderOip(request: OrderOIPDTO): Promise<OrderOIPResponse>;
|
|
2458
|
+
/**
|
|
2459
|
+
* Creates a submerchant.
|
|
2460
|
+
* Based on `create_submerchant` from the Python SDK.
|
|
2461
|
+
*
|
|
2462
|
+
* @summary Create submerchant
|
|
2463
|
+
* @description Creates a new submerchant.
|
|
2464
|
+
*
|
|
2465
|
+
* @param request - Submerchant creation payload
|
|
2466
|
+
* @returns Promise resolving to the created submerchant details
|
|
2467
|
+
*/
|
|
2468
|
+
createSubmerchant(request: SubmerchantCreateDTO): Promise<GetSubmerchantResponse>;
|
|
2469
|
+
/**
|
|
2470
|
+
* Gets a submerchant.
|
|
2471
|
+
* Based on `get_submerchant` from the Python SDK.
|
|
2472
|
+
*
|
|
2473
|
+
* @summary Get submerchant
|
|
2474
|
+
* @description Retrieves submerchant details.
|
|
2475
|
+
*
|
|
2476
|
+
* @param id - Submerchant ID
|
|
2477
|
+
* @returns Promise resolving to submerchant details
|
|
2478
|
+
*/
|
|
2479
|
+
getSubmerchant(id: string): Promise<GetSubmerchantResponse>;
|
|
2480
|
+
/**
|
|
2481
|
+
* Gets suborganization by submerchant.
|
|
2482
|
+
* Based on `get_suborganization_by_submerchant` from the Python SDK.
|
|
2483
|
+
*
|
|
2484
|
+
* @summary Get suborganization by submerchant
|
|
2485
|
+
* @description Retrieves the suborganization details associated with a submerchant.
|
|
2486
|
+
*
|
|
2487
|
+
* @param id - Submerchant ID
|
|
2488
|
+
* @returns Promise resolving to suborganization details
|
|
2489
|
+
*/
|
|
2490
|
+
getSuborganizationBySubmerchant(id: string): Promise<unknown>;
|
|
2491
|
+
/**
|
|
2492
|
+
* Updates a submerchant.
|
|
2493
|
+
* Based on `update_submerchant` from the Python SDK.
|
|
2494
|
+
*
|
|
2495
|
+
* @summary Update submerchant
|
|
2496
|
+
* @description Updates submerchant details.
|
|
2497
|
+
*
|
|
2498
|
+
* @param id - Submerchant ID
|
|
2499
|
+
* @param request - Update payload
|
|
2500
|
+
* @returns Promise resolving to updated submerchant details
|
|
2501
|
+
*/
|
|
2502
|
+
updateSubmerchant(id: string, request: SubmerchantUpdateDTO): Promise<GetSubmerchantResponse>;
|
|
2503
|
+
/**
|
|
2504
|
+
* Deletes a submerchant.
|
|
2505
|
+
* Based on `delete_submerchant` from the Python SDK.
|
|
2506
|
+
*
|
|
2507
|
+
* @summary Delete submerchant
|
|
2508
|
+
* @description Deletes a submerchant.
|
|
2509
|
+
*
|
|
2510
|
+
* @param id - Submerchant ID
|
|
2511
|
+
* @returns Promise resolving to deletion status
|
|
2512
|
+
*/
|
|
2513
|
+
deleteSubmerchant(id: string): Promise<unknown>;
|
|
2514
|
+
/**
|
|
2515
|
+
* Lists submerchants.
|
|
2516
|
+
* Based on `list_submerchants` from the Python SDK.
|
|
2517
|
+
*
|
|
2518
|
+
* @summary List submerchants
|
|
2519
|
+
* @description Retrieves a paginated list of submerchants.
|
|
2520
|
+
*
|
|
2521
|
+
* @param page - Page number
|
|
2522
|
+
* @param perPage - Items per page
|
|
2523
|
+
* @returns Promise resolving to list of submerchants
|
|
2524
|
+
*/
|
|
2525
|
+
listSubmerchants(page?: number, perPage?: number): Promise<ListSubmerchantsResponse>;
|
|
2526
|
+
/**
|
|
2527
|
+
* Creates an organization user token.
|
|
2528
|
+
* Based on `create_organization_user_token` from the Python SDK.
|
|
2529
|
+
*
|
|
2530
|
+
* @summary Create organization user token
|
|
2531
|
+
* @description Creates a token for an organization user.
|
|
2532
|
+
*
|
|
2533
|
+
* @param request - Token creation payload
|
|
2534
|
+
* @returns Promise resolving to the created token details
|
|
2535
|
+
*/
|
|
2536
|
+
createOrganizationUserToken(request: OrgUserTokenCreateReq): Promise<OrgUserTokenCreateResponse>;
|
|
1698
2537
|
}
|
|
1699
2538
|
|
|
1700
2539
|
/**
|
|
@@ -1901,5 +2740,5 @@ declare function validateGsmNumber(gsmNumber: string | number): GsmValidationRes
|
|
|
1901
2740
|
*/
|
|
1902
2741
|
declare function validateInstallments(installments: string | number | number[]): InstallmentsValidationResult;
|
|
1903
2742
|
|
|
1904
|
-
export { ConfigManager, TapsilatAuthenticationError, TapsilatError, TapsilatNetworkError, TapsilatRateLimitError, TapsilatSDK, TapsilatValidationError, isValidCurrency, isValidPaymentMethod, isValidUrl, sanitizeMetadata, validateEmail, validateGsmNumber, validateInstallments, validatePaymentRequest };
|
|
1905
|
-
export type { APIError, APIResponse, AddBasketItemRequest, Address, BasketItem, BasketItemDTO, BasketItemPayerDTO, BillingAddress, BillingAddressDTO, Buyer, BuyerDTO, CallbackURLDTO, CheckoutDesignDTO, Currency, Customer, GetUserLimitRequest, GetVposRequest, GsmValidationResult, InstallmentsValidationResult, Locale, MetadataDTO, Order, OrderAccountingRequest, OrderCardDTO, OrderCreateDTO, OrderCreateRequest, OrderCreateResponse, OrderPFSubMerchantDTO, OrderPaymentDetail, OrderPaymentTermCreateDTO, OrderPaymentTermUpdateDTO, OrderPostAuthRequest, OrderRefundRequest, OrderRefundResponse, OrderResponse, OrderStatusResponse, OrderSubmerchant, OrderTermRefundRequest, OrderTerminateRequest, OrderTerminateResponse, OrderTransaction, OrgCreateBusinessRequest, OrgCreateUserReq, OrgUserMobileVerifyReq, OrgUserVerifyReq, OrganizationSettings, PaginatedResponse, PaginationParams, PaymentMethod, PaymentOption, PaymentRequest, PaymentResponse, PaymentStatus, PaymentTermDTO, PaymentTermDeleteRequest, PaymentTermRefundResponse, PaymentTermResponse, PaymentTermTerminateRequest, RefundOrderDTO, RefundRequest, RefundResponse, RemoveBasketItemRequest, SetLimitUserRequest, ShippingAddressDTO, SubOrganizationDTO, SubmerchantDTO, SubscriptionBilling, SubscriptionCancelRequest, SubscriptionCreateRequest, SubscriptionCreateResponse, SubscriptionDetail, SubscriptionGetRequest, SubscriptionOrder, SubscriptionRedirectRequest, SubscriptionRedirectResponse, SubscriptionUser, TapsilatConfig, UpdateBasketItemRequest, WebhookEvent };
|
|
2743
|
+
export { BusinessType, ConfigManager, TapsilatAuthenticationError, TapsilatError, TapsilatNetworkError, TapsilatRateLimitError, TapsilatSDK, TapsilatValidationError, isValidCurrency, isValidPaymentMethod, isValidUrl, sanitizeMetadata, validateEmail, validateGsmNumber, validateInstallments, validatePaymentRequest };
|
|
2744
|
+
export type { APIError, APIResponse, AddBasketItemRequest, AddBasketItemResponse, Address, BasketItem, BasketItemDTO, BasketItemPayerDTO, BasketItemPaymentDTO, BillingAddress, BillingAddressDTO, Buyer, BuyerDTO, CallbackURLDTO, CancelOrderRequest, CancelOrderResponse, CancelSubscriptionResponse, CheckoutDesignDTO, Currency, Customer, GetMetaResponse, GetOrderPaymentDetailsResponse, GetOrderPaymentsRequest, GetOrderPaymentsResponse, GetOrderResponse, GetOrderSubmerchantsRequest, GetOrderSubmerchantsResponse, GetOrderTermResponse, GetOrderTransactionsResponse, GetOrdersListItem, GetOrdersRequest, GetOrdersResponse, GetOrganizationCurrenciesResponse, GetOrganizationLimitsResponse, GetOrganizationScopesResponse, GetSubOrganizationListResponse, GetSubmerchantResponse, GetSuborganizationsRequest, GetSystemOrderStatusesResponse, GetUserLimitRequest, GetUserLimitResponse, GetVposRequest, GetVposResponse, GsmValidationResult, InstallmentsValidationResult, ListSubmerchantsResponse, ListSubscriptionsRequest, ListSubscriptionsResponse, Locale, MetadataDTO, Order, OrderAccountingRequest, OrderAccountingResponse, OrderCardDTO, OrderCreateDTO, OrderCreateRequest, OrderCreateResponse, OrderManualCallbackRequest, OrderManualCallbackResponse, OrderOIPDTO, OrderOIPResponse, OrderPFSubMerchantDTO, OrderPaymentDetail, OrderPaymentDetailDTO, OrderPaymentTermActionResponse, OrderPaymentTermCreateDTO, OrderPaymentTermUpdateDTO, OrderPostAuthRequest, OrderPostAuthResponse, OrderRefundRequest, OrderRefundResponse, OrderRelatedUpdateRequest, OrderRelatedUpdateResponse, OrderResponse, OrderStatusResponse, OrderSubmerchant, OrderTermRefundRequest, OrderTerminateRequest, OrderTerminateResponse, OrderTransaction, OrgCreateBusinessRequest, OrgCreateBusinessResponse, OrgCreateUserReq, OrgCreateUserRequest, OrgCreateUserResponse, OrgUserMobileVerifyReq, OrgUserMobileVerifyRequest, OrgUserMobileVerifyResponse, OrgUserTokenCreateReq, OrgUserTokenCreateResponse, OrgUserVerifyReq, OrgUserVerifyRequest, OrgUserVerifyResponse, OrganizationResponse, OrganizationSettings, PaginatedResponse, PaginationParams, PaymentMethod, PaymentOption, PaymentRequest, PaymentResponse, PaymentStatus, PaymentTermDTO, PaymentTermDeleteRequest, PaymentTermRefundResponse, PaymentTermResponse, PaymentTermTerminateRequest, RefundAllOrderDTO, RefundOrderDTO, RefundRequest, RefundResponse, RemoveBasketItemRequest, RemoveBasketItemResponse, SetLimitUserRequest, SetLimitUserResponse, ShippingAddressDTO, SubOrganizationDTO, SubmerchantCreateDTO, SubmerchantDTO, SubmerchantUpdateDTO, SubscriptionBilling, SubscriptionCancelRequest, SubscriptionCreateRequest, SubscriptionCreateResponse, SubscriptionDetail, SubscriptionGetRequest, SubscriptionListItem, SubscriptionOrder, SubscriptionRedirectRequest, SubscriptionRedirectResponse, SubscriptionUser, SystemOrderStatus, TapsilatConfig, TimestampDTO, UpdateBasketItemRequest, UpdateBasketItemResponse, WebhookEvent };
|