@tapsilat/tapsilat-js 2026.4.2 → 2026.6.17
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 +27 -0
- package/dist/TapsilatSDK.d.ts +132 -73
- package/dist/TapsilatSDK.d.ts.map +1 -1
- package/dist/index.cjs +451 -163
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +750 -111
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +452 -164
- package/dist/index.js.map +1 -1
- package/dist/types/index.d.ts +620 -37
- package/dist/types/index.d.ts.map +1 -1
- package/package.json +1 -1
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
|
|
@@ -417,6 +625,25 @@ interface BasketItemPayerDTO {
|
|
|
417
625
|
type?: string;
|
|
418
626
|
vat?: string;
|
|
419
627
|
}
|
|
628
|
+
/**
|
|
629
|
+
* @category API DTOs
|
|
630
|
+
* @summary Payment record for a basket item
|
|
631
|
+
* @description Payment details attached to a specific basket item
|
|
632
|
+
* @interface BasketItemPaymentDTO
|
|
633
|
+
*/
|
|
634
|
+
interface BasketItemPaymentDTO {
|
|
635
|
+
amount?: number;
|
|
636
|
+
card_brand?: string;
|
|
637
|
+
id?: string;
|
|
638
|
+
masked_bin?: string;
|
|
639
|
+
paid_date?: string;
|
|
640
|
+
refundable_amount?: number;
|
|
641
|
+
refunded?: boolean;
|
|
642
|
+
refunded_amount?: number;
|
|
643
|
+
refunded_date?: string;
|
|
644
|
+
status?: number;
|
|
645
|
+
type?: string;
|
|
646
|
+
}
|
|
420
647
|
/**
|
|
421
648
|
* @category API DTOs
|
|
422
649
|
* @summary Individual item in an order basket
|
|
@@ -431,14 +658,20 @@ interface BasketItemDTO {
|
|
|
431
658
|
coupon_discount?: number;
|
|
432
659
|
data?: string;
|
|
433
660
|
id?: string;
|
|
661
|
+
item_payments?: BasketItemPaymentDTO[];
|
|
434
662
|
item_type?: string;
|
|
663
|
+
mcc?: string;
|
|
435
664
|
name?: string;
|
|
436
665
|
paid_amount?: number;
|
|
666
|
+
paidable_amount?: number;
|
|
437
667
|
payer?: BasketItemPayerDTO;
|
|
438
668
|
price?: number;
|
|
439
669
|
quantity?: number;
|
|
440
670
|
quantity_float?: number;
|
|
441
671
|
quantity_unit?: string;
|
|
672
|
+
refundable_amount?: number;
|
|
673
|
+
refunded_amount?: number;
|
|
674
|
+
status?: number;
|
|
442
675
|
sub_merchant_key?: string;
|
|
443
676
|
sub_merchant_price?: string;
|
|
444
677
|
}
|
|
@@ -457,6 +690,10 @@ interface BillingAddressDTO {
|
|
|
457
690
|
contact_phone?: string;
|
|
458
691
|
country?: string;
|
|
459
692
|
district?: string;
|
|
693
|
+
neighbourhood?: string;
|
|
694
|
+
street1?: string;
|
|
695
|
+
street2?: string;
|
|
696
|
+
street3?: string;
|
|
460
697
|
tax_office?: string;
|
|
461
698
|
title?: string;
|
|
462
699
|
vat_number?: string;
|
|
@@ -530,10 +767,12 @@ interface OrderPFSubMerchantDTO {
|
|
|
530
767
|
id?: string;
|
|
531
768
|
mcc?: string;
|
|
532
769
|
name?: string;
|
|
770
|
+
national_id?: string;
|
|
533
771
|
org_id?: string;
|
|
534
772
|
postal_code?: string;
|
|
535
773
|
submerchant_nin?: string;
|
|
536
774
|
submerchant_url?: string;
|
|
775
|
+
switch_id?: string;
|
|
537
776
|
terminal_no?: string;
|
|
538
777
|
}
|
|
539
778
|
/**
|
|
@@ -615,15 +854,18 @@ interface OrderCreateDTO {
|
|
|
615
854
|
enabled_installments?: number[];
|
|
616
855
|
external_reference_id?: string;
|
|
617
856
|
metadata?: MetadataDTO[];
|
|
618
|
-
order_cards?: OrderCardDTO;
|
|
857
|
+
order_cards?: OrderCardDTO[];
|
|
619
858
|
paid_amount?: number;
|
|
620
859
|
partial_payment?: boolean;
|
|
621
860
|
payment_failure_url?: string;
|
|
861
|
+
payment_mode?: string;
|
|
622
862
|
payment_methods?: boolean;
|
|
623
863
|
payment_options?: string[];
|
|
624
864
|
payment_success_url?: string;
|
|
625
865
|
payment_terms?: PaymentTermDTO[];
|
|
626
866
|
pf_sub_merchant?: OrderPFSubMerchantDTO;
|
|
867
|
+
redirect_failure_url?: string;
|
|
868
|
+
redirect_success_url?: string;
|
|
627
869
|
shipping_address?: ShippingAddressDTO;
|
|
628
870
|
sub_organization?: SubOrganizationDTO;
|
|
629
871
|
submerchants?: SubmerchantDTO[];
|
|
@@ -642,6 +884,25 @@ interface RefundOrderDTO {
|
|
|
642
884
|
order_item_id?: string;
|
|
643
885
|
order_item_payment_id?: string;
|
|
644
886
|
}
|
|
887
|
+
/**
|
|
888
|
+
* @category Refunds
|
|
889
|
+
* @summary Data structure for requesting a full refund
|
|
890
|
+
* @description Contains the order reference required to fully refund an order
|
|
891
|
+
* @interface RefundAllOrderDTO
|
|
892
|
+
*/
|
|
893
|
+
interface RefundAllOrderDTO {
|
|
894
|
+
reference_id: string;
|
|
895
|
+
}
|
|
896
|
+
/**
|
|
897
|
+
* @category Payment Processing
|
|
898
|
+
* @summary Data structure for order payment detail query
|
|
899
|
+
* @description Request payload for POST /order/payment-details
|
|
900
|
+
* @interface OrderPaymentDetailDTO
|
|
901
|
+
*/
|
|
902
|
+
interface OrderPaymentDetailDTO {
|
|
903
|
+
conversation_id?: string;
|
|
904
|
+
reference_id?: string;
|
|
905
|
+
}
|
|
645
906
|
/**
|
|
646
907
|
* @category Payment Terms
|
|
647
908
|
* @summary Data for creating a payment term
|
|
@@ -716,6 +977,34 @@ interface PaymentTermResponse {
|
|
|
716
977
|
paid_date?: string;
|
|
717
978
|
data?: string;
|
|
718
979
|
}
|
|
980
|
+
/**
|
|
981
|
+
* @category Payment Terms
|
|
982
|
+
* @summary Protobuf timestamp payload
|
|
983
|
+
* @description Timestamp structure used by term APIs (`seconds` + `nanos`)
|
|
984
|
+
* @interface TimestampDTO
|
|
985
|
+
*/
|
|
986
|
+
interface TimestampDTO {
|
|
987
|
+
nanos?: number;
|
|
988
|
+
seconds?: number;
|
|
989
|
+
}
|
|
990
|
+
/**
|
|
991
|
+
* @category Payment Terms
|
|
992
|
+
* @summary Response payload for order term retrieval
|
|
993
|
+
* @description Swagger-aligned response schema for GET /order/term
|
|
994
|
+
* @interface GetOrderTermResponse
|
|
995
|
+
*/
|
|
996
|
+
interface GetOrderTermResponse {
|
|
997
|
+
amount?: number;
|
|
998
|
+
due_date?: TimestampDTO;
|
|
999
|
+
paid_date?: TimestampDTO;
|
|
1000
|
+
required?: boolean;
|
|
1001
|
+
status?: string;
|
|
1002
|
+
term_sequence?: number;
|
|
1003
|
+
}
|
|
1004
|
+
interface OrderPaymentTermActionResponse {
|
|
1005
|
+
code?: number;
|
|
1006
|
+
message?: string;
|
|
1007
|
+
}
|
|
719
1008
|
/**
|
|
720
1009
|
* @category Payment Terms
|
|
721
1010
|
* @summary Request data for deleting a payment term
|
|
@@ -723,6 +1012,7 @@ interface PaymentTermResponse {
|
|
|
723
1012
|
* @interface PaymentTermDeleteRequest
|
|
724
1013
|
*/
|
|
725
1014
|
interface PaymentTermDeleteRequest {
|
|
1015
|
+
order_id?: string;
|
|
726
1016
|
term_reference_id: string;
|
|
727
1017
|
}
|
|
728
1018
|
/**
|
|
@@ -732,11 +1022,14 @@ interface PaymentTermDeleteRequest {
|
|
|
732
1022
|
* @interface PaymentTermRefundResponse
|
|
733
1023
|
*/
|
|
734
1024
|
interface PaymentTermRefundResponse {
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
1025
|
+
code?: number;
|
|
1026
|
+
is_success?: boolean;
|
|
1027
|
+
message?: string;
|
|
1028
|
+
refund_id?: string;
|
|
1029
|
+
term_reference_id?: string;
|
|
1030
|
+
amount?: number;
|
|
1031
|
+
status?: string;
|
|
1032
|
+
created_at?: string;
|
|
740
1033
|
refund_reference_id?: string;
|
|
741
1034
|
}
|
|
742
1035
|
/**
|
|
@@ -766,9 +1059,11 @@ interface OrderTerminateRequest {
|
|
|
766
1059
|
* @interface OrderTerminateResponse
|
|
767
1060
|
*/
|
|
768
1061
|
interface OrderTerminateResponse {
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
1062
|
+
code?: number;
|
|
1063
|
+
message?: string;
|
|
1064
|
+
reference_id?: string;
|
|
1065
|
+
status?: string;
|
|
1066
|
+
terminated_at?: string;
|
|
772
1067
|
reason?: string;
|
|
773
1068
|
}
|
|
774
1069
|
/**
|
|
@@ -803,6 +1098,10 @@ interface SubscriptionCancelRequest {
|
|
|
803
1098
|
external_reference_id?: string;
|
|
804
1099
|
reference_id?: string;
|
|
805
1100
|
}
|
|
1101
|
+
interface CancelSubscriptionResponse {
|
|
1102
|
+
code?: number;
|
|
1103
|
+
message?: string;
|
|
1104
|
+
}
|
|
806
1105
|
interface SubscriptionBilling {
|
|
807
1106
|
address?: string;
|
|
808
1107
|
city?: string;
|
|
@@ -865,6 +1164,29 @@ interface SubscriptionDetail {
|
|
|
865
1164
|
period?: number;
|
|
866
1165
|
title?: string;
|
|
867
1166
|
}
|
|
1167
|
+
interface SubscriptionListItem {
|
|
1168
|
+
amount?: string;
|
|
1169
|
+
currency?: string;
|
|
1170
|
+
external_reference_id?: string;
|
|
1171
|
+
is_active?: boolean;
|
|
1172
|
+
payment_date?: number;
|
|
1173
|
+
payment_status?: string;
|
|
1174
|
+
period?: number;
|
|
1175
|
+
reference_id?: string;
|
|
1176
|
+
title?: string;
|
|
1177
|
+
}
|
|
1178
|
+
interface ListSubscriptionsRequest {
|
|
1179
|
+
page?: number;
|
|
1180
|
+
per_page?: number;
|
|
1181
|
+
[key: string]: unknown;
|
|
1182
|
+
}
|
|
1183
|
+
interface ListSubscriptionsResponse {
|
|
1184
|
+
page?: number;
|
|
1185
|
+
per_page?: number;
|
|
1186
|
+
rows?: SubscriptionListItem[];
|
|
1187
|
+
total?: number;
|
|
1188
|
+
total_pages?: number;
|
|
1189
|
+
}
|
|
868
1190
|
interface SubscriptionCreateResponse {
|
|
869
1191
|
code?: number;
|
|
870
1192
|
message?: string;
|
|
@@ -885,18 +1207,43 @@ interface OrganizationSettings {
|
|
|
885
1207
|
subscription_domain?: string;
|
|
886
1208
|
}
|
|
887
1209
|
interface OrderTransaction {
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
1210
|
+
amount?: string;
|
|
1211
|
+
amount_float?: number;
|
|
1212
|
+
currency?: string;
|
|
1213
|
+
date?: string;
|
|
1214
|
+
id?: string;
|
|
1215
|
+
receiver?: string;
|
|
1216
|
+
reference_id?: string;
|
|
1217
|
+
sender?: string;
|
|
1218
|
+
status?: string;
|
|
893
1219
|
[key: string]: unknown;
|
|
894
1220
|
}
|
|
1221
|
+
interface GetOrderTransactionsResponse {
|
|
1222
|
+
orderTX?: OrderTransaction[];
|
|
1223
|
+
}
|
|
895
1224
|
interface OrderSubmerchant {
|
|
896
|
-
|
|
897
|
-
|
|
1225
|
+
acquirer?: string;
|
|
1226
|
+
email?: string;
|
|
1227
|
+
id?: string;
|
|
1228
|
+
labels?: string;
|
|
1229
|
+
name?: string;
|
|
1230
|
+
status?: string;
|
|
1231
|
+
submerchant_key?: string;
|
|
1232
|
+
submerchant_type?: string;
|
|
1233
|
+
[key: string]: unknown;
|
|
1234
|
+
}
|
|
1235
|
+
interface GetOrderSubmerchantsRequest {
|
|
1236
|
+
page?: number;
|
|
1237
|
+
per_page?: number;
|
|
898
1238
|
[key: string]: unknown;
|
|
899
1239
|
}
|
|
1240
|
+
interface GetOrderSubmerchantsResponse {
|
|
1241
|
+
page?: number;
|
|
1242
|
+
per_page?: number;
|
|
1243
|
+
row?: OrderSubmerchant[];
|
|
1244
|
+
total?: number;
|
|
1245
|
+
total_pages?: number;
|
|
1246
|
+
}
|
|
900
1247
|
/**
|
|
901
1248
|
* @category Order Management
|
|
902
1249
|
* @summary Request for order accounting
|
|
@@ -906,6 +1253,16 @@ interface OrderSubmerchant {
|
|
|
906
1253
|
interface OrderAccountingRequest {
|
|
907
1254
|
order_reference_id: string;
|
|
908
1255
|
}
|
|
1256
|
+
/**
|
|
1257
|
+
* @category Order Management
|
|
1258
|
+
* @summary Response for order accounting
|
|
1259
|
+
* @description API response payload returned after order accounting operation
|
|
1260
|
+
* @interface OrderAccountingResponse
|
|
1261
|
+
*/
|
|
1262
|
+
interface OrderAccountingResponse {
|
|
1263
|
+
code?: number;
|
|
1264
|
+
message?: string;
|
|
1265
|
+
}
|
|
909
1266
|
/**
|
|
910
1267
|
* @category Order Management
|
|
911
1268
|
* @summary Request to add an item to the basket
|
|
@@ -936,6 +1293,35 @@ interface UpdateBasketItemRequest {
|
|
|
936
1293
|
order_reference_id: string;
|
|
937
1294
|
basket_item: BasketItemDTO;
|
|
938
1295
|
}
|
|
1296
|
+
interface AddBasketItemResponse {
|
|
1297
|
+
code?: number;
|
|
1298
|
+
message?: string;
|
|
1299
|
+
}
|
|
1300
|
+
interface RemoveBasketItemResponse {
|
|
1301
|
+
code?: number;
|
|
1302
|
+
message?: string;
|
|
1303
|
+
}
|
|
1304
|
+
interface UpdateBasketItemResponse {
|
|
1305
|
+
code?: number;
|
|
1306
|
+
message?: string;
|
|
1307
|
+
}
|
|
1308
|
+
interface OrderManualCallbackRequest {
|
|
1309
|
+
conversation_id?: string;
|
|
1310
|
+
reference_id: string;
|
|
1311
|
+
}
|
|
1312
|
+
interface OrderManualCallbackResponse {
|
|
1313
|
+
code?: number;
|
|
1314
|
+
message?: string;
|
|
1315
|
+
}
|
|
1316
|
+
interface OrderRelatedUpdateRequest {
|
|
1317
|
+
reference_id: string;
|
|
1318
|
+
related_reference_id: string;
|
|
1319
|
+
}
|
|
1320
|
+
interface OrderRelatedUpdateResponse {
|
|
1321
|
+
code?: number;
|
|
1322
|
+
is_success?: boolean;
|
|
1323
|
+
message?: string;
|
|
1324
|
+
}
|
|
939
1325
|
/**
|
|
940
1326
|
* @category Organization
|
|
941
1327
|
* @summary Webhook callback URL configuration
|
|
@@ -955,7 +1341,10 @@ interface CallbackURLDTO {
|
|
|
955
1341
|
*/
|
|
956
1342
|
declare enum BusinessType {
|
|
957
1343
|
INDIVIDUAL = 0,
|
|
958
|
-
CORPORATE = 1
|
|
1344
|
+
CORPORATE = 1,
|
|
1345
|
+
NON_PROFIT = 2,
|
|
1346
|
+
GOVERNMENT = 3,
|
|
1347
|
+
UNKNOWN = 4
|
|
959
1348
|
}
|
|
960
1349
|
/**
|
|
961
1350
|
* @category Organization
|
|
@@ -976,6 +1365,39 @@ interface OrgCreateBusinessRequest {
|
|
|
976
1365
|
tax_office: string;
|
|
977
1366
|
zip_code: string;
|
|
978
1367
|
}
|
|
1368
|
+
interface OrgCreateBusinessResponse {
|
|
1369
|
+
code?: number;
|
|
1370
|
+
message?: string;
|
|
1371
|
+
}
|
|
1372
|
+
interface OrganizationResponse {
|
|
1373
|
+
message?: string;
|
|
1374
|
+
}
|
|
1375
|
+
interface OrganizationCurrency {
|
|
1376
|
+
code?: string;
|
|
1377
|
+
currency_unit?: string;
|
|
1378
|
+
id?: string;
|
|
1379
|
+
name?: string;
|
|
1380
|
+
symbol?: string;
|
|
1381
|
+
}
|
|
1382
|
+
interface GetOrganizationCurrenciesResponse {
|
|
1383
|
+
currencies?: OrganizationCurrency[];
|
|
1384
|
+
}
|
|
1385
|
+
interface UserLimit {
|
|
1386
|
+
currency?: string;
|
|
1387
|
+
id?: string;
|
|
1388
|
+
max_daily_transaction_amount?: number;
|
|
1389
|
+
max_daily_transaction_count?: number;
|
|
1390
|
+
max_expense_amount?: number;
|
|
1391
|
+
max_income_amount?: number;
|
|
1392
|
+
max_monthly_transaction_amount?: number;
|
|
1393
|
+
max_monthly_transaction_count?: number;
|
|
1394
|
+
max_topup_amount?: number;
|
|
1395
|
+
max_wallet_balance?: number;
|
|
1396
|
+
max_withdrawal_amount?: number;
|
|
1397
|
+
}
|
|
1398
|
+
interface GetUserLimitResponse {
|
|
1399
|
+
user_limits?: UserLimit[];
|
|
1400
|
+
}
|
|
979
1401
|
/**
|
|
980
1402
|
* @category Organization
|
|
981
1403
|
* @summary Request for user limit information
|
|
@@ -996,6 +1418,44 @@ interface SetLimitUserRequest {
|
|
|
996
1418
|
limit_id: string;
|
|
997
1419
|
user_id: string;
|
|
998
1420
|
}
|
|
1421
|
+
interface SetLimitUserResponse {
|
|
1422
|
+
code?: number;
|
|
1423
|
+
message?: string;
|
|
1424
|
+
}
|
|
1425
|
+
interface OrganizationLimit extends UserLimit {
|
|
1426
|
+
name?: string;
|
|
1427
|
+
}
|
|
1428
|
+
interface GetOrganizationLimitsResponse {
|
|
1429
|
+
limits?: OrganizationLimit[];
|
|
1430
|
+
}
|
|
1431
|
+
interface GetMetaResponse {
|
|
1432
|
+
data?: string;
|
|
1433
|
+
}
|
|
1434
|
+
interface OrganizationScope {
|
|
1435
|
+
create?: boolean;
|
|
1436
|
+
delete?: boolean;
|
|
1437
|
+
entity?: string;
|
|
1438
|
+
read?: boolean;
|
|
1439
|
+
update?: boolean;
|
|
1440
|
+
}
|
|
1441
|
+
interface GetOrganizationScopesResponse {
|
|
1442
|
+
scopes?: OrganizationScope[];
|
|
1443
|
+
}
|
|
1444
|
+
interface GetSuborganizationsRequest {
|
|
1445
|
+
page?: number;
|
|
1446
|
+
per_page?: number;
|
|
1447
|
+
}
|
|
1448
|
+
interface OrganizationSuborganization {
|
|
1449
|
+
id?: string;
|
|
1450
|
+
name?: string;
|
|
1451
|
+
}
|
|
1452
|
+
interface GetSubOrganizationListResponse {
|
|
1453
|
+
page?: number;
|
|
1454
|
+
per_page?: number;
|
|
1455
|
+
rows?: OrganizationSuborganization[];
|
|
1456
|
+
total?: number;
|
|
1457
|
+
total_pages?: number;
|
|
1458
|
+
}
|
|
999
1459
|
/**
|
|
1000
1460
|
* @category Organization
|
|
1001
1461
|
* @summary Request for VPOS list
|
|
@@ -1006,13 +1466,20 @@ interface GetVposRequest {
|
|
|
1006
1466
|
currency_id: string;
|
|
1007
1467
|
[key: string]: unknown;
|
|
1008
1468
|
}
|
|
1469
|
+
interface OrganizationVpos {
|
|
1470
|
+
id?: string;
|
|
1471
|
+
name?: string;
|
|
1472
|
+
}
|
|
1473
|
+
interface GetVposResponse {
|
|
1474
|
+
organization_vpos?: OrganizationVpos[];
|
|
1475
|
+
}
|
|
1009
1476
|
/**
|
|
1010
1477
|
* @category Organization
|
|
1011
1478
|
* @summary Request to create an organization user
|
|
1012
1479
|
* @description Comprehensive data for creating a new user within an organization
|
|
1013
|
-
* @interface
|
|
1480
|
+
* @interface OrgCreateUserRequest
|
|
1014
1481
|
*/
|
|
1015
|
-
interface
|
|
1482
|
+
interface OrgCreateUserRequest {
|
|
1016
1483
|
conversation_id: string;
|
|
1017
1484
|
email: string;
|
|
1018
1485
|
first_name: string;
|
|
@@ -1022,24 +1489,40 @@ interface OrgCreateUserReq {
|
|
|
1022
1489
|
phone: string;
|
|
1023
1490
|
reference_id: string;
|
|
1024
1491
|
}
|
|
1492
|
+
interface OrgCreateUserResponse {
|
|
1493
|
+
code?: number;
|
|
1494
|
+
message?: string;
|
|
1495
|
+
user_id?: string;
|
|
1496
|
+
}
|
|
1497
|
+
type OrgCreateUserReq = OrgCreateUserRequest;
|
|
1025
1498
|
/**
|
|
1026
1499
|
* @category Organization
|
|
1027
1500
|
* @summary Request to verify a user
|
|
1028
1501
|
* @description Data required to verify a user's account
|
|
1029
|
-
* @interface
|
|
1502
|
+
* @interface OrgUserVerifyRequest
|
|
1030
1503
|
*/
|
|
1031
|
-
interface
|
|
1504
|
+
interface OrgUserVerifyRequest {
|
|
1032
1505
|
user_id: string;
|
|
1033
1506
|
}
|
|
1507
|
+
interface OrgUserVerifyResponse {
|
|
1508
|
+
code?: number;
|
|
1509
|
+
message?: string;
|
|
1510
|
+
}
|
|
1511
|
+
type OrgUserVerifyReq = OrgUserVerifyRequest;
|
|
1034
1512
|
/**
|
|
1035
1513
|
* @category Organization
|
|
1036
1514
|
* @summary Request to verify user's mobile number
|
|
1037
1515
|
* @description Data required to initiate or complete mobile number verification
|
|
1038
|
-
* @interface
|
|
1516
|
+
* @interface OrgUserMobileVerifyRequest
|
|
1039
1517
|
*/
|
|
1040
|
-
interface
|
|
1518
|
+
interface OrgUserMobileVerifyRequest {
|
|
1041
1519
|
user_id: string;
|
|
1042
1520
|
}
|
|
1521
|
+
interface OrgUserMobileVerifyResponse {
|
|
1522
|
+
code?: number;
|
|
1523
|
+
message?: string;
|
|
1524
|
+
}
|
|
1525
|
+
type OrgUserMobileVerifyReq = OrgUserMobileVerifyRequest;
|
|
1043
1526
|
/**
|
|
1044
1527
|
* @category Order Management
|
|
1045
1528
|
* @summary Request for order post-authorization
|
|
@@ -1050,6 +1533,103 @@ interface OrderPostAuthRequest {
|
|
|
1050
1533
|
amount: number;
|
|
1051
1534
|
reference_id: string;
|
|
1052
1535
|
}
|
|
1536
|
+
/**
|
|
1537
|
+
* @category Order Management
|
|
1538
|
+
* @summary Response for order post-authorization
|
|
1539
|
+
* @description API response payload returned after post-authorization operation
|
|
1540
|
+
* @interface OrderPostAuthResponse
|
|
1541
|
+
*/
|
|
1542
|
+
interface OrderPostAuthResponse {
|
|
1543
|
+
code?: number;
|
|
1544
|
+
is_success?: boolean;
|
|
1545
|
+
message?: string;
|
|
1546
|
+
}
|
|
1547
|
+
interface OrderPaymentOptionsUpdateDTO {
|
|
1548
|
+
payment_options: string[];
|
|
1549
|
+
reference_id: string;
|
|
1550
|
+
}
|
|
1551
|
+
interface SplitOrderItemPaymentDTO {
|
|
1552
|
+
amount: number;
|
|
1553
|
+
order_id: string;
|
|
1554
|
+
order_item_payment_id: string;
|
|
1555
|
+
}
|
|
1556
|
+
interface OrderCallbackResponse {
|
|
1557
|
+
[key: string]: unknown;
|
|
1558
|
+
}
|
|
1559
|
+
interface OrderVposQueryResponse {
|
|
1560
|
+
[key: string]: unknown;
|
|
1561
|
+
}
|
|
1562
|
+
interface OrganizationCurrencyPreset {
|
|
1563
|
+
id?: string;
|
|
1564
|
+
name?: string;
|
|
1565
|
+
code?: string;
|
|
1566
|
+
[key: string]: unknown;
|
|
1567
|
+
}
|
|
1568
|
+
interface GetOrganizationCurrencyPresetsResponse {
|
|
1569
|
+
presets?: OrganizationCurrencyPreset[];
|
|
1570
|
+
}
|
|
1571
|
+
interface GetSuborganizationDetailsResponse {
|
|
1572
|
+
[key: string]: unknown;
|
|
1573
|
+
}
|
|
1574
|
+
interface GetSuborganizationSubmerchantsResponse {
|
|
1575
|
+
[key: string]: unknown;
|
|
1576
|
+
}
|
|
1577
|
+
interface SystemBasketItemType {
|
|
1578
|
+
code?: string | number;
|
|
1579
|
+
message?: string;
|
|
1580
|
+
}
|
|
1581
|
+
interface GetSystemBasketItemTypesResponse {
|
|
1582
|
+
rows?: SystemBasketItemType[];
|
|
1583
|
+
}
|
|
1584
|
+
interface SystemErrorCode {
|
|
1585
|
+
code?: string | number;
|
|
1586
|
+
message?: string;
|
|
1587
|
+
}
|
|
1588
|
+
interface GetSystemErrorCodesResponse {
|
|
1589
|
+
rows?: SystemErrorCode[];
|
|
1590
|
+
}
|
|
1591
|
+
interface SystemPaymentTermStatus {
|
|
1592
|
+
code?: string | number;
|
|
1593
|
+
message?: string;
|
|
1594
|
+
}
|
|
1595
|
+
interface GetSystemPaymentTermStatusesResponse {
|
|
1596
|
+
rows?: SystemPaymentTermStatus[];
|
|
1597
|
+
}
|
|
1598
|
+
interface SystemProductType {
|
|
1599
|
+
code?: string | number;
|
|
1600
|
+
message?: string;
|
|
1601
|
+
}
|
|
1602
|
+
interface GetSystemProductTypesResponse {
|
|
1603
|
+
rows?: SystemProductType[];
|
|
1604
|
+
}
|
|
1605
|
+
interface SystemShortcutType {
|
|
1606
|
+
code?: string | number;
|
|
1607
|
+
message?: string;
|
|
1608
|
+
}
|
|
1609
|
+
interface GetSystemShortcutTypesResponse {
|
|
1610
|
+
rows?: SystemShortcutType[];
|
|
1611
|
+
}
|
|
1612
|
+
interface SystemTransactionPaymentType {
|
|
1613
|
+
code?: string | number;
|
|
1614
|
+
message?: string;
|
|
1615
|
+
}
|
|
1616
|
+
interface GetSystemTransactionPaymentTypesResponse {
|
|
1617
|
+
rows?: SystemTransactionPaymentType[];
|
|
1618
|
+
}
|
|
1619
|
+
interface SystemTransactionPurpose {
|
|
1620
|
+
code?: string | number;
|
|
1621
|
+
message?: string;
|
|
1622
|
+
}
|
|
1623
|
+
interface GetSystemTransactionPurposesResponse {
|
|
1624
|
+
rows?: SystemTransactionPurpose[];
|
|
1625
|
+
}
|
|
1626
|
+
interface SystemTransactionStatus {
|
|
1627
|
+
code?: string | number;
|
|
1628
|
+
message?: string;
|
|
1629
|
+
}
|
|
1630
|
+
interface GetSystemTransactionStatusesResponse {
|
|
1631
|
+
rows?: SystemTransactionStatus[];
|
|
1632
|
+
}
|
|
1053
1633
|
|
|
1054
1634
|
/**
|
|
1055
1635
|
* @category Configuration
|
|
@@ -1185,6 +1765,10 @@ declare class TapsilatSDK {
|
|
|
1185
1765
|
* Access to organization operations
|
|
1186
1766
|
*/
|
|
1187
1767
|
get organization(): any;
|
|
1768
|
+
/**
|
|
1769
|
+
* Access to system operations
|
|
1770
|
+
*/
|
|
1771
|
+
get system(): any;
|
|
1188
1772
|
/**
|
|
1189
1773
|
* Access to webhook operations
|
|
1190
1774
|
*/
|
|
@@ -1220,10 +1804,10 @@ declare class TapsilatSDK {
|
|
|
1220
1804
|
* @param {string} [orderRequest.payment_success_url] - URL to redirect after successful payment
|
|
1221
1805
|
* @param {string} [orderRequest.payment_failure_url] - URL to redirect after failed payment
|
|
1222
1806
|
* @param {number[]} [orderRequest.enabled_installments] - Allowed installment counts
|
|
1223
|
-
* @param {
|
|
1807
|
+
* @param {OrderMetadata[]} [orderRequest.metadata] - Additional custom key/value data
|
|
1224
1808
|
*
|
|
1225
1809
|
* @returns {Promise<OrderCreateResponse>} Promise resolving to order creation response
|
|
1226
|
-
* @returns {string} OrderCreateResponse.
|
|
1810
|
+
* @returns {string} [OrderCreateResponse.id] - Internal order identifier
|
|
1227
1811
|
* @returns {string} OrderCreateResponse.reference_id - Unique order reference for tracking
|
|
1228
1812
|
* @returns {string} [OrderCreateResponse.checkout_url] - Payment page URL for customer
|
|
1229
1813
|
* @returns {string} [OrderCreateResponse.conversation_id] - Echo of provided conversation ID
|
|
@@ -1248,11 +1832,11 @@ declare class TapsilatSDK {
|
|
|
1248
1832
|
* @description Handles accounting operations for a specific order using its reference ID.
|
|
1249
1833
|
*
|
|
1250
1834
|
* @param {OrderAccountingRequest} request - Accounting request details
|
|
1251
|
-
* @returns {Promise<
|
|
1835
|
+
* @returns {Promise<OrderAccountingResponse>} Promise resolving to the accounting response
|
|
1252
1836
|
* @throws {TapsilatValidationError} When input validation fails
|
|
1253
1837
|
* @throws {TapsilatError} When API returns an error response
|
|
1254
1838
|
*/
|
|
1255
|
-
orderAccounting(request: OrderAccountingRequest): Promise<
|
|
1839
|
+
orderAccounting(request: OrderAccountingRequest): Promise<OrderAccountingResponse>;
|
|
1256
1840
|
/**
|
|
1257
1841
|
* Process post-authorization for an order
|
|
1258
1842
|
*
|
|
@@ -1260,21 +1844,61 @@ declare class TapsilatSDK {
|
|
|
1260
1844
|
* @description Handles post-authorization operations for a specific order.
|
|
1261
1845
|
*
|
|
1262
1846
|
* @param {OrderPostAuthRequest} request - Post-authorization request details
|
|
1263
|
-
* @returns {Promise<
|
|
1847
|
+
* @returns {Promise<OrderPostAuthResponse>} Promise resolving to the post-auth response
|
|
1264
1848
|
* @throws {TapsilatValidationError} When input validation fails
|
|
1265
1849
|
* @throws {TapsilatError} When API returns an error response
|
|
1266
1850
|
*/
|
|
1267
|
-
orderPostAuth(request: OrderPostAuthRequest): Promise<
|
|
1851
|
+
orderPostAuth(request: OrderPostAuthRequest): Promise<OrderPostAuthResponse>;
|
|
1268
1852
|
/**
|
|
1269
1853
|
* Retrieve system order statuses
|
|
1270
1854
|
*
|
|
1271
1855
|
* @summary Retrieve system order statuses
|
|
1272
1856
|
* @description Gets a list of all possible order statuses in the system.
|
|
1273
1857
|
*
|
|
1274
|
-
* @returns {Promise<
|
|
1858
|
+
* @returns {Promise<GetSystemOrderStatusesResponse>} Promise resolving to system order statuses
|
|
1275
1859
|
* @throws {TapsilatError} When API returns an error response
|
|
1276
1860
|
*/
|
|
1277
|
-
getSystemOrderStatuses(): Promise<
|
|
1861
|
+
getSystemOrderStatuses(): Promise<GetSystemOrderStatusesResponse>;
|
|
1862
|
+
/**
|
|
1863
|
+
* Retrieves system basket item types.
|
|
1864
|
+
* Based on `get_system_basket_item_types` from Python SDK.
|
|
1865
|
+
*/
|
|
1866
|
+
getSystemBasketItemTypes(): Promise<GetSystemBasketItemTypesResponse>;
|
|
1867
|
+
/**
|
|
1868
|
+
* Retrieves system error codes.
|
|
1869
|
+
* Based on `get_system_error_codes` from Python SDK.
|
|
1870
|
+
*/
|
|
1871
|
+
getSystemErrorCodes(): Promise<GetSystemErrorCodesResponse>;
|
|
1872
|
+
/**
|
|
1873
|
+
* Retrieves system payment term statuses.
|
|
1874
|
+
* Based on `get_system_payment_term_statuses` from Python SDK.
|
|
1875
|
+
*/
|
|
1876
|
+
getSystemPaymentTermStatuses(): Promise<GetSystemPaymentTermStatusesResponse>;
|
|
1877
|
+
/**
|
|
1878
|
+
* Retrieves system product types.
|
|
1879
|
+
* Based on `get_system_product_types` from Python SDK.
|
|
1880
|
+
*/
|
|
1881
|
+
getSystemProductTypes(): Promise<GetSystemProductTypesResponse>;
|
|
1882
|
+
/**
|
|
1883
|
+
* Retrieves system shortcut types.
|
|
1884
|
+
* Based on `get_system_shortcut_types` from Python SDK.
|
|
1885
|
+
*/
|
|
1886
|
+
getSystemShortcutTypes(): Promise<GetSystemShortcutTypesResponse>;
|
|
1887
|
+
/**
|
|
1888
|
+
* Retrieves system transaction payment types.
|
|
1889
|
+
* Based on `get_system_transaction_payment_types` from Python SDK.
|
|
1890
|
+
*/
|
|
1891
|
+
getSystemTransactionPaymentTypes(): Promise<GetSystemTransactionPaymentTypesResponse>;
|
|
1892
|
+
/**
|
|
1893
|
+
* Retrieves system transaction purposes.
|
|
1894
|
+
* Based on `get_system_transaction_purposes` from Python SDK.
|
|
1895
|
+
*/
|
|
1896
|
+
getSystemTransactionPurposes(): Promise<GetSystemTransactionPurposesResponse>;
|
|
1897
|
+
/**
|
|
1898
|
+
* Retrieves system transaction statuses.
|
|
1899
|
+
* Based on `get_system_transaction_statuses` from Python SDK.
|
|
1900
|
+
*/
|
|
1901
|
+
getSystemTransactionStatuses(): Promise<GetSystemTransactionStatusesResponse>;
|
|
1278
1902
|
/**
|
|
1279
1903
|
* Gets an order by reference ID.
|
|
1280
1904
|
*
|
|
@@ -1287,7 +1911,7 @@ declare class TapsilatSDK {
|
|
|
1287
1911
|
* @throws {TapsilatNetworkError} When API request fails due to network issues
|
|
1288
1912
|
* @throws {TapsilatError} When API returns an error response
|
|
1289
1913
|
*/
|
|
1290
|
-
getOrder(referenceId: string): Promise<
|
|
1914
|
+
getOrder(referenceId: string): Promise<GetOrderResponse>;
|
|
1291
1915
|
/**
|
|
1292
1916
|
* Lists orders with pagination support.
|
|
1293
1917
|
*
|
|
@@ -1299,15 +1923,7 @@ declare class TapsilatSDK {
|
|
|
1299
1923
|
* @throws {TapsilatNetworkError} When API request fails due to network issues
|
|
1300
1924
|
* @throws {TapsilatError} When API returns an error response
|
|
1301
1925
|
*/
|
|
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>>;
|
|
1926
|
+
getOrders(params?: GetOrdersRequest): Promise<GetOrdersResponse>;
|
|
1311
1927
|
/**
|
|
1312
1928
|
* Cancels an order by reference_id.
|
|
1313
1929
|
*
|
|
@@ -1319,19 +1935,19 @@ declare class TapsilatSDK {
|
|
|
1319
1935
|
* @throws {TapsilatValidationError} When referenceId is invalid
|
|
1320
1936
|
* @throws {TapsilatError} When API returns an error response or order cannot be canceled
|
|
1321
1937
|
*/
|
|
1322
|
-
cancelOrder(referenceId: string): Promise<
|
|
1938
|
+
cancelOrder(referenceId: string): Promise<CancelOrderResponse>;
|
|
1323
1939
|
/**
|
|
1324
1940
|
* Gets the current status of an order by reference ID
|
|
1325
1941
|
*
|
|
1326
1942
|
* @summary Retrieves real-time payment status and tracking information for a specific order
|
|
1327
1943
|
* @description
|
|
1328
1944
|
* 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
|
-
*
|
|
1945
|
+
* unique reference ID. This method provides real-time information about payment processing
|
|
1946
|
+
* status and error code (if returned by the API). It's essential for tracking payment flow
|
|
1331
1947
|
* and implementing proper order state management in your application.
|
|
1332
1948
|
*
|
|
1333
|
-
* The status information includes payment state
|
|
1334
|
-
*
|
|
1949
|
+
* The status information includes payment state and API-level error code metadata.
|
|
1950
|
+
* This method should be used to:
|
|
1335
1951
|
* - Check if a payment has been completed after redirecting from checkout
|
|
1336
1952
|
* - Monitor payment status for pending transactions
|
|
1337
1953
|
* - Verify order state before fulfilling goods/services
|
|
@@ -1340,13 +1956,11 @@ declare class TapsilatSDK {
|
|
|
1340
1956
|
* @param {string} referenceId - Unique order reference identifier from order creation
|
|
1341
1957
|
*
|
|
1342
1958
|
* @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
|
|
1959
|
+
* @returns {string} [OrderStatusResponse.error_code] - API-level error code when present
|
|
1960
|
+
* @returns {string} [OrderStatusResponse.status] - Current payment processing status
|
|
1346
1961
|
*
|
|
1347
1962
|
* @throws {TapsilatValidationError} When input validation fails:
|
|
1348
1963
|
* - Reference ID is null, undefined, or empty string
|
|
1349
|
-
* - Reference ID format is invalid (should match order ID pattern)
|
|
1350
1964
|
* @throws {TapsilatNetworkError} When network request fails:
|
|
1351
1965
|
* - Connection timeout during status check
|
|
1352
1966
|
* - DNS resolution failure
|
|
@@ -1382,19 +1996,35 @@ declare class TapsilatSDK {
|
|
|
1382
1996
|
*/
|
|
1383
1997
|
refundAllOrder(referenceId: string): Promise<OrderRefundResponse>;
|
|
1384
1998
|
/**
|
|
1385
|
-
* Retrieves the payment details for an order.
|
|
1999
|
+
* Retrieves the payment details for an order via POST request.
|
|
1386
2000
|
* 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
2001
|
*/
|
|
1397
|
-
getOrderPaymentDetails(
|
|
2002
|
+
getOrderPaymentDetails(request: OrderPaymentDetailDTO): Promise<GetOrderPaymentDetailsResponse>;
|
|
2003
|
+
/**
|
|
2004
|
+
* Retrieves the payment details for an order by ID.
|
|
2005
|
+
* Based on `get_order_payment_details_by_id` from the Python SDK.
|
|
2006
|
+
*/
|
|
2007
|
+
getOrderPaymentDetailsById(referenceId: string): Promise<GetOrderPaymentDetailsResponse>;
|
|
2008
|
+
/**
|
|
2009
|
+
* Retrieves the order callback via GET request.
|
|
2010
|
+
* Based on `order_callback` from the Python SDK.
|
|
2011
|
+
*/
|
|
2012
|
+
orderCallback(id: string): Promise<OrderCallbackResponse>;
|
|
2013
|
+
/**
|
|
2014
|
+
* Updates payment options for an order.
|
|
2015
|
+
* Based on `update_payment_options` from the Python SDK.
|
|
2016
|
+
*/
|
|
2017
|
+
updatePaymentOptions(request: OrderPaymentOptionsUpdateDTO): Promise<OrderRelatedUpdateResponse>;
|
|
2018
|
+
/**
|
|
2019
|
+
* Splits order item payment.
|
|
2020
|
+
* Based on `split_order_item_payment` from the Python SDK.
|
|
2021
|
+
*/
|
|
2022
|
+
splitOrderItemPayment(request: SplitOrderItemPaymentDTO): Promise<OrderRelatedUpdateResponse>;
|
|
2023
|
+
/**
|
|
2024
|
+
* Queries vpos for an order.
|
|
2025
|
+
* Based on `order_vpos_query` from the Python SDK.
|
|
2026
|
+
*/
|
|
2027
|
+
orderVposQuery(id: string): Promise<OrderVposQueryResponse>;
|
|
1398
2028
|
/**
|
|
1399
2029
|
* Gets an order by conversation_id.
|
|
1400
2030
|
* Based on `get_order_by_conversation_id` from the Python SDK.
|
|
@@ -1407,7 +2037,7 @@ declare class TapsilatSDK {
|
|
|
1407
2037
|
* @throws {TapsilatValidationError} When conversationId is invalid
|
|
1408
2038
|
* @throws {TapsilatError} When API returns an error response
|
|
1409
2039
|
*/
|
|
1410
|
-
getOrderByConversationId(conversationId: string): Promise<
|
|
2040
|
+
getOrderByConversationId(conversationId: string): Promise<GetOrderResponse>;
|
|
1411
2041
|
/**
|
|
1412
2042
|
* Gets order transactions by reference_id.
|
|
1413
2043
|
* Based on `get_order_transactions` from the Python SDK.
|
|
@@ -1420,7 +2050,7 @@ declare class TapsilatSDK {
|
|
|
1420
2050
|
* @throws {TapsilatValidationError} When referenceId is invalid
|
|
1421
2051
|
* @throws {TapsilatError} When API returns an error response
|
|
1422
2052
|
*/
|
|
1423
|
-
getOrderTransactions(referenceId: string): Promise<
|
|
2053
|
+
getOrderTransactions(referenceId: string): Promise<GetOrderTransactionsResponse>;
|
|
1424
2054
|
/**
|
|
1425
2055
|
* Gets order submerchants with pagination.
|
|
1426
2056
|
* Based on `get_order_submerchants` from the Python SDK.
|
|
@@ -1432,10 +2062,7 @@ declare class TapsilatSDK {
|
|
|
1432
2062
|
* @returns Promise resolving to paginated list of submerchants
|
|
1433
2063
|
* @throws {TapsilatError} When API returns an error response
|
|
1434
2064
|
*/
|
|
1435
|
-
getOrderSubmerchants(params?:
|
|
1436
|
-
page?: number;
|
|
1437
|
-
per_page?: number;
|
|
1438
|
-
}): Promise<PaginatedResponse<OrderSubmerchant>>;
|
|
2065
|
+
getOrderSubmerchants(params?: GetOrderSubmerchantsRequest): Promise<GetOrderSubmerchantsResponse>;
|
|
1439
2066
|
/**
|
|
1440
2067
|
* Gets checkout URL for an order.
|
|
1441
2068
|
* Based on `get_checkout_url` from the Python SDK.
|
|
@@ -1521,7 +2148,7 @@ declare class TapsilatSDK {
|
|
|
1521
2148
|
* @throws {TapsilatValidationError} When input validation fails
|
|
1522
2149
|
* @throws {TapsilatError} When API returns an error response
|
|
1523
2150
|
*/
|
|
1524
|
-
createOrderTerm(termData: OrderPaymentTermCreateDTO): Promise<
|
|
2151
|
+
createOrderTerm(termData: OrderPaymentTermCreateDTO): Promise<OrderPaymentTermActionResponse>;
|
|
1525
2152
|
/**
|
|
1526
2153
|
* Updates an existing payment term
|
|
1527
2154
|
*
|
|
@@ -1544,7 +2171,7 @@ declare class TapsilatSDK {
|
|
|
1544
2171
|
* @throws {TapsilatValidationError} When input validation fails
|
|
1545
2172
|
* @throws {TapsilatError} When API returns an error response
|
|
1546
2173
|
*/
|
|
1547
|
-
updateOrderTerm(updateData: OrderPaymentTermUpdateDTO): Promise<
|
|
2174
|
+
updateOrderTerm(updateData: OrderPaymentTermUpdateDTO): Promise<OrderPaymentTermActionResponse>;
|
|
1548
2175
|
/**
|
|
1549
2176
|
* Deletes a payment term
|
|
1550
2177
|
*
|
|
@@ -1560,7 +2187,7 @@ declare class TapsilatSDK {
|
|
|
1560
2187
|
* @throws {TapsilatValidationError} When input validation fails
|
|
1561
2188
|
* @throws {TapsilatError} When API returns an error response
|
|
1562
2189
|
*/
|
|
1563
|
-
deleteOrderTerm(deleteData: PaymentTermDeleteRequest): Promise<
|
|
2190
|
+
deleteOrderTerm(deleteData: PaymentTermDeleteRequest): Promise<OrderPaymentTermActionResponse>;
|
|
1564
2191
|
/**
|
|
1565
2192
|
* Refunds a specific payment term
|
|
1566
2193
|
*
|
|
@@ -1615,85 +2242,97 @@ declare class TapsilatSDK {
|
|
|
1615
2242
|
* @throws {TapsilatError} When API returns an error response
|
|
1616
2243
|
*/
|
|
1617
2244
|
terminateOrder(terminateData: OrderTerminateRequest): Promise<OrderTerminateResponse>;
|
|
1618
|
-
orderManualCallback(referenceId: string, conversationId?: string): Promise<
|
|
1619
|
-
orderRelatedUpdate(referenceId: string, relatedReferenceId: string): Promise<
|
|
2245
|
+
orderManualCallback(referenceId: string, conversationId?: string): Promise<OrderManualCallbackResponse>;
|
|
2246
|
+
orderRelatedUpdate(referenceId: string, relatedReferenceId: string): Promise<OrderRelatedUpdateResponse>;
|
|
1620
2247
|
getOrganizationSettings(): Promise<OrganizationSettings>;
|
|
1621
|
-
getOrderTerm(termReferenceId: string): Promise<
|
|
2248
|
+
getOrderTerm(termReferenceId: string): Promise<GetOrderTermResponse>;
|
|
1622
2249
|
/**
|
|
1623
2250
|
* Add a new item to an existing order basket
|
|
1624
2251
|
*/
|
|
1625
|
-
addBasketItem(request: AddBasketItemRequest): Promise<
|
|
2252
|
+
addBasketItem(request: AddBasketItemRequest): Promise<AddBasketItemResponse>;
|
|
1626
2253
|
/**
|
|
1627
2254
|
* Remove an item from an existing order basket
|
|
1628
2255
|
*/
|
|
1629
|
-
removeBasketItem(request: RemoveBasketItemRequest): Promise<
|
|
2256
|
+
removeBasketItem(request: RemoveBasketItemRequest): Promise<RemoveBasketItemResponse>;
|
|
1630
2257
|
/**
|
|
1631
2258
|
* Update an existing item in an order basket
|
|
1632
2259
|
*/
|
|
1633
|
-
updateBasketItem(request: UpdateBasketItemRequest): Promise<
|
|
2260
|
+
updateBasketItem(request: UpdateBasketItemRequest): Promise<UpdateBasketItemResponse>;
|
|
1634
2261
|
/**
|
|
1635
2262
|
* Retrieve organization callback (webhook) settings
|
|
1636
2263
|
*/
|
|
1637
|
-
getOrganizationCallback(): Promise<
|
|
2264
|
+
getOrganizationCallback(): Promise<CallbackURLDTO>;
|
|
1638
2265
|
/**
|
|
1639
2266
|
* Update organization callback (webhook) settings
|
|
1640
2267
|
*/
|
|
1641
|
-
updateOrganizationCallback(request: CallbackURLDTO): Promise<
|
|
2268
|
+
updateOrganizationCallback(request: CallbackURLDTO): Promise<OrganizationResponse>;
|
|
1642
2269
|
/**
|
|
1643
2270
|
* Create a new business entity within the organization
|
|
1644
2271
|
*/
|
|
1645
|
-
createOrganizationBusiness(request: OrgCreateBusinessRequest): Promise<
|
|
2272
|
+
createOrganizationBusiness(request: OrgCreateBusinessRequest): Promise<OrgCreateBusinessResponse>;
|
|
1646
2273
|
/**
|
|
1647
2274
|
* Retrieve supported currencies for the organization
|
|
1648
2275
|
*/
|
|
1649
|
-
getOrganizationCurrencies(): Promise<
|
|
2276
|
+
getOrganizationCurrencies(): Promise<GetOrganizationCurrenciesResponse>;
|
|
2277
|
+
/**
|
|
2278
|
+
* Retrieves organization currency presets.
|
|
2279
|
+
* Based on `get_organization_currency_presets` from Python SDK.
|
|
2280
|
+
*/
|
|
2281
|
+
getOrganizationCurrencyPresets(): Promise<GetOrganizationCurrencyPresetsResponse>;
|
|
2282
|
+
/**
|
|
2283
|
+
* Retrieves organization suborganization details.
|
|
2284
|
+
* Based on `get_organization_suborganization_details` from Python SDK.
|
|
2285
|
+
*/
|
|
2286
|
+
getOrganizationSuborganizationDetails(id: string): Promise<GetSuborganizationDetailsResponse>;
|
|
2287
|
+
/**
|
|
2288
|
+
* Retrieves organization suborganization submerchants.
|
|
2289
|
+
* Based on `get_organization_suborganization_submerchants` from Python SDK.
|
|
2290
|
+
*/
|
|
2291
|
+
getOrganizationSuborganizationSubmerchants(id: string): Promise<GetSuborganizationSubmerchantsResponse>;
|
|
1650
2292
|
/**
|
|
1651
2293
|
* Retrieve limit information for a specific organization user
|
|
1652
2294
|
*/
|
|
1653
|
-
getOrganizationLimitUser(request: GetUserLimitRequest): Promise<
|
|
2295
|
+
getOrganizationLimitUser(request: GetUserLimitRequest): Promise<GetUserLimitResponse>;
|
|
1654
2296
|
/**
|
|
1655
2297
|
* Set limit for a specific organization user
|
|
1656
2298
|
*/
|
|
1657
|
-
setOrganizationLimitUser(request: SetLimitUserRequest): Promise<
|
|
2299
|
+
setOrganizationLimitUser(request: SetLimitUserRequest): Promise<SetLimitUserResponse>;
|
|
1658
2300
|
/**
|
|
1659
2301
|
* Retrieve organization overall limits
|
|
1660
2302
|
*/
|
|
1661
|
-
getOrganizationLimits(): Promise<
|
|
2303
|
+
getOrganizationLimits(): Promise<GetOrganizationLimitsResponse>;
|
|
1662
2304
|
/**
|
|
1663
2305
|
* Retrieve meta information for the organization
|
|
1664
2306
|
*/
|
|
1665
|
-
getOrganizationMeta(): Promise<
|
|
2307
|
+
getOrganizationMeta(name: string): Promise<GetMetaResponse>;
|
|
1666
2308
|
/**
|
|
1667
2309
|
* Retrieve supported scopes for the organization
|
|
1668
2310
|
*/
|
|
1669
|
-
getOrganizationScopes(): Promise<
|
|
2311
|
+
getOrganizationScopes(): Promise<GetOrganizationScopesResponse>;
|
|
1670
2312
|
/**
|
|
1671
2313
|
* Retrieve list of sub-organizations
|
|
1672
2314
|
*/
|
|
1673
|
-
getOrganizationSuborganizations(): Promise<
|
|
2315
|
+
getOrganizationSuborganizations(params?: GetSuborganizationsRequest): Promise<GetSubOrganizationListResponse>;
|
|
1674
2316
|
/**
|
|
1675
2317
|
* Create a new user within the organization
|
|
1676
2318
|
*/
|
|
1677
|
-
createOrganizationUser(request:
|
|
2319
|
+
createOrganizationUser(request: OrgCreateUserRequest): Promise<OrgCreateUserResponse>;
|
|
1678
2320
|
/**
|
|
1679
2321
|
* Verify an organization user
|
|
1680
2322
|
*/
|
|
1681
|
-
verifyOrganizationUser(request:
|
|
2323
|
+
verifyOrganizationUser(request: OrgUserVerifyRequest): Promise<OrgUserVerifyResponse>;
|
|
1682
2324
|
/**
|
|
1683
2325
|
* Verify an organization user via mobile
|
|
1684
2326
|
*/
|
|
1685
|
-
verifyOrganizationUserMobile(request:
|
|
2327
|
+
verifyOrganizationUserMobile(request: OrgUserMobileVerifyRequest): Promise<OrgUserMobileVerifyResponse>;
|
|
1686
2328
|
/**
|
|
1687
2329
|
* List virtual POS terminals for the organization
|
|
1688
2330
|
*/
|
|
1689
|
-
listOrganizationVpos(request: GetVposRequest): Promise<
|
|
2331
|
+
listOrganizationVpos(request: GetVposRequest): Promise<GetVposResponse>;
|
|
1690
2332
|
createSubscription(request: SubscriptionCreateRequest): Promise<SubscriptionCreateResponse>;
|
|
1691
2333
|
getSubscription(request: SubscriptionGetRequest): Promise<SubscriptionDetail>;
|
|
1692
|
-
listSubscriptions(params?:
|
|
1693
|
-
|
|
1694
|
-
per_page?: number;
|
|
1695
|
-
}): Promise<PaginatedResponse<SubscriptionDetail>>;
|
|
1696
|
-
cancelSubscription(request: SubscriptionCancelRequest): Promise<APIResponse<unknown>>;
|
|
2334
|
+
listSubscriptions(params?: ListSubscriptionsRequest): Promise<ListSubscriptionsResponse>;
|
|
2335
|
+
cancelSubscription(request: SubscriptionCancelRequest): Promise<CancelSubscriptionResponse>;
|
|
1697
2336
|
redirectSubscription(request: SubscriptionRedirectRequest): Promise<SubscriptionRedirectResponse>;
|
|
1698
2337
|
}
|
|
1699
2338
|
|
|
@@ -1901,5 +2540,5 @@ declare function validateGsmNumber(gsmNumber: string | number): GsmValidationRes
|
|
|
1901
2540
|
*/
|
|
1902
2541
|
declare function validateInstallments(installments: string | number | number[]): InstallmentsValidationResult;
|
|
1903
2542
|
|
|
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 };
|
|
2543
|
+
export { BusinessType, ConfigManager, TapsilatAuthenticationError, TapsilatError, TapsilatNetworkError, TapsilatRateLimitError, TapsilatSDK, TapsilatValidationError, isValidCurrency, isValidPaymentMethod, isValidUrl, sanitizeMetadata, validateEmail, validateGsmNumber, validateInstallments, validatePaymentRequest };
|
|
2544
|
+
export type { APIError, APIResponse, AddBasketItemRequest, AddBasketItemResponse, Address, BasketItem, BasketItemDTO, BasketItemPayerDTO, BasketItemPaymentDTO, BillingAddress, BillingAddressDTO, Buyer, BuyerDTO, CallbackURLDTO, CancelOrderRequest, CancelOrderResponse, CancelSubscriptionResponse, CheckoutDesignDTO, Currency, Customer, GetMetaResponse, GetOrderPaymentDetailsResponse, GetOrderResponse, GetOrderSubmerchantsRequest, GetOrderSubmerchantsResponse, GetOrderTermResponse, GetOrderTransactionsResponse, GetOrdersListItem, GetOrdersRequest, GetOrdersResponse, GetOrganizationCurrenciesResponse, GetOrganizationLimitsResponse, GetOrganizationScopesResponse, GetSubOrganizationListResponse, GetSuborganizationsRequest, GetSystemOrderStatusesResponse, GetUserLimitRequest, GetUserLimitResponse, GetVposRequest, GetVposResponse, GsmValidationResult, InstallmentsValidationResult, ListSubscriptionsRequest, ListSubscriptionsResponse, Locale, MetadataDTO, Order, OrderAccountingRequest, OrderAccountingResponse, OrderCardDTO, OrderCreateDTO, OrderCreateRequest, OrderCreateResponse, OrderManualCallbackRequest, OrderManualCallbackResponse, 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, 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, SubmerchantDTO, SubscriptionBilling, SubscriptionCancelRequest, SubscriptionCreateRequest, SubscriptionCreateResponse, SubscriptionDetail, SubscriptionGetRequest, SubscriptionListItem, SubscriptionOrder, SubscriptionRedirectRequest, SubscriptionRedirectResponse, SubscriptionUser, SystemOrderStatus, TapsilatConfig, TimestampDTO, UpdateBasketItemRequest, UpdateBasketItemResponse, WebhookEvent };
|