@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/types/index.d.ts
CHANGED
|
@@ -109,7 +109,12 @@ export interface Address {
|
|
|
109
109
|
* @interface BillingAddress
|
|
110
110
|
*/
|
|
111
111
|
export 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 @@ export 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 @@ export interface BasketItem {
|
|
|
138
151
|
* @description Different payment methods that can be enabled for an order
|
|
139
152
|
* @typedef {string} PaymentOption
|
|
140
153
|
*/
|
|
141
|
-
export type PaymentOption = "PAY_WITH_WALLET" | "PAY_WITH_CARD" | "PAY_WITH_LOAN" | "PAY_WITH_CASH" | "PAY_WITH_BANK";
|
|
154
|
+
export 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 @@ export 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 @@ export 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 @@ export interface OrderCreateRequest {
|
|
|
297
322
|
* @interface OrderCreateResponse
|
|
298
323
|
*/
|
|
299
324
|
export 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 @@ export 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
|
+
export 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
|
+
export 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
|
+
export 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
|
+
export 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
|
+
export 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
|
+
export 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 @@ export interface Order extends OrderCreateResponse {
|
|
|
335
469
|
export 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 @@ export interface OrderRefundRequest {
|
|
|
343
479
|
* @interface OrderRefundResponse
|
|
344
480
|
*/
|
|
345
481
|
export 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
|
export 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
|
+
export 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
|
+
export interface GetSystemOrderStatusesResponse {
|
|
518
|
+
rows?: SystemOrderStatus[];
|
|
363
519
|
}
|
|
364
520
|
/**
|
|
365
521
|
* @category Payment Processing
|
|
@@ -380,6 +536,58 @@ export interface OrderPaymentDetail {
|
|
|
380
536
|
cardAssociation: string;
|
|
381
537
|
};
|
|
382
538
|
}
|
|
539
|
+
export 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
|
+
export 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
|
+
export 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
|
+
export interface OrderPaymentDetailRuleResponse {
|
|
570
|
+
id?: string;
|
|
571
|
+
name?: string;
|
|
572
|
+
}
|
|
573
|
+
export interface OrderPaymentDetailVposResponse {
|
|
574
|
+
acquirer?: string;
|
|
575
|
+
bank_code?: string;
|
|
576
|
+
commission_rate?: string;
|
|
577
|
+
id?: string;
|
|
578
|
+
name?: string;
|
|
579
|
+
}
|
|
580
|
+
export 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 @@ export 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
|
+
export 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 @@ export 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 @@ export 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 @@ export 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 @@ export 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 @@ export 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
|
+
export 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
|
+
export 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 @@ export 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
|
+
export 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
|
+
export 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
|
+
export 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 @@ export interface PaymentTermResponse {
|
|
|
723
1012
|
* @interface PaymentTermDeleteRequest
|
|
724
1013
|
*/
|
|
725
1014
|
export interface PaymentTermDeleteRequest {
|
|
1015
|
+
order_id?: string;
|
|
726
1016
|
term_reference_id: string;
|
|
727
1017
|
}
|
|
728
1018
|
/**
|
|
@@ -732,11 +1022,14 @@ export interface PaymentTermDeleteRequest {
|
|
|
732
1022
|
* @interface PaymentTermRefundResponse
|
|
733
1023
|
*/
|
|
734
1024
|
export 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 @@ export interface OrderTerminateRequest {
|
|
|
766
1059
|
* @interface OrderTerminateResponse
|
|
767
1060
|
*/
|
|
768
1061
|
export 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 @@ export interface SubscriptionCancelRequest {
|
|
|
803
1098
|
external_reference_id?: string;
|
|
804
1099
|
reference_id?: string;
|
|
805
1100
|
}
|
|
1101
|
+
export interface CancelSubscriptionResponse {
|
|
1102
|
+
code?: number;
|
|
1103
|
+
message?: string;
|
|
1104
|
+
}
|
|
806
1105
|
export interface SubscriptionBilling {
|
|
807
1106
|
address?: string;
|
|
808
1107
|
city?: string;
|
|
@@ -865,6 +1164,29 @@ export interface SubscriptionDetail {
|
|
|
865
1164
|
period?: number;
|
|
866
1165
|
title?: string;
|
|
867
1166
|
}
|
|
1167
|
+
export 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
|
+
export interface ListSubscriptionsRequest {
|
|
1179
|
+
page?: number;
|
|
1180
|
+
per_page?: number;
|
|
1181
|
+
[key: string]: unknown;
|
|
1182
|
+
}
|
|
1183
|
+
export interface ListSubscriptionsResponse {
|
|
1184
|
+
page?: number;
|
|
1185
|
+
per_page?: number;
|
|
1186
|
+
rows?: SubscriptionListItem[];
|
|
1187
|
+
total?: number;
|
|
1188
|
+
total_pages?: number;
|
|
1189
|
+
}
|
|
868
1190
|
export interface SubscriptionCreateResponse {
|
|
869
1191
|
code?: number;
|
|
870
1192
|
message?: string;
|
|
@@ -885,18 +1207,43 @@ export interface OrganizationSettings {
|
|
|
885
1207
|
subscription_domain?: string;
|
|
886
1208
|
}
|
|
887
1209
|
export 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
|
+
export interface GetOrderTransactionsResponse {
|
|
1222
|
+
orderTX?: OrderTransaction[];
|
|
1223
|
+
}
|
|
895
1224
|
export 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
|
+
export interface GetOrderSubmerchantsRequest {
|
|
1236
|
+
page?: number;
|
|
1237
|
+
per_page?: number;
|
|
898
1238
|
[key: string]: unknown;
|
|
899
1239
|
}
|
|
1240
|
+
export 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 @@ export interface OrderSubmerchant {
|
|
|
906
1253
|
export 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
|
+
export 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 @@ export interface UpdateBasketItemRequest {
|
|
|
936
1293
|
order_reference_id: string;
|
|
937
1294
|
basket_item: BasketItemDTO;
|
|
938
1295
|
}
|
|
1296
|
+
export interface AddBasketItemResponse {
|
|
1297
|
+
code?: number;
|
|
1298
|
+
message?: string;
|
|
1299
|
+
}
|
|
1300
|
+
export interface RemoveBasketItemResponse {
|
|
1301
|
+
code?: number;
|
|
1302
|
+
message?: string;
|
|
1303
|
+
}
|
|
1304
|
+
export interface UpdateBasketItemResponse {
|
|
1305
|
+
code?: number;
|
|
1306
|
+
message?: string;
|
|
1307
|
+
}
|
|
1308
|
+
export interface OrderManualCallbackRequest {
|
|
1309
|
+
conversation_id?: string;
|
|
1310
|
+
reference_id: string;
|
|
1311
|
+
}
|
|
1312
|
+
export interface OrderManualCallbackResponse {
|
|
1313
|
+
code?: number;
|
|
1314
|
+
message?: string;
|
|
1315
|
+
}
|
|
1316
|
+
export interface OrderRelatedUpdateRequest {
|
|
1317
|
+
reference_id: string;
|
|
1318
|
+
related_reference_id: string;
|
|
1319
|
+
}
|
|
1320
|
+
export 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 @@ export interface CallbackURLDTO {
|
|
|
955
1341
|
*/
|
|
956
1342
|
export 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 @@ export interface OrgCreateBusinessRequest {
|
|
|
976
1365
|
tax_office: string;
|
|
977
1366
|
zip_code: string;
|
|
978
1367
|
}
|
|
1368
|
+
export interface OrgCreateBusinessResponse {
|
|
1369
|
+
code?: number;
|
|
1370
|
+
message?: string;
|
|
1371
|
+
}
|
|
1372
|
+
export interface OrganizationResponse {
|
|
1373
|
+
message?: string;
|
|
1374
|
+
}
|
|
1375
|
+
export interface OrganizationCurrency {
|
|
1376
|
+
code?: string;
|
|
1377
|
+
currency_unit?: string;
|
|
1378
|
+
id?: string;
|
|
1379
|
+
name?: string;
|
|
1380
|
+
symbol?: string;
|
|
1381
|
+
}
|
|
1382
|
+
export interface GetOrganizationCurrenciesResponse {
|
|
1383
|
+
currencies?: OrganizationCurrency[];
|
|
1384
|
+
}
|
|
1385
|
+
export 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
|
+
export 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 @@ export interface SetLimitUserRequest {
|
|
|
996
1418
|
limit_id: string;
|
|
997
1419
|
user_id: string;
|
|
998
1420
|
}
|
|
1421
|
+
export interface SetLimitUserResponse {
|
|
1422
|
+
code?: number;
|
|
1423
|
+
message?: string;
|
|
1424
|
+
}
|
|
1425
|
+
export interface OrganizationLimit extends UserLimit {
|
|
1426
|
+
name?: string;
|
|
1427
|
+
}
|
|
1428
|
+
export interface GetOrganizationLimitsResponse {
|
|
1429
|
+
limits?: OrganizationLimit[];
|
|
1430
|
+
}
|
|
1431
|
+
export interface GetMetaResponse {
|
|
1432
|
+
data?: string;
|
|
1433
|
+
}
|
|
1434
|
+
export interface OrganizationScope {
|
|
1435
|
+
create?: boolean;
|
|
1436
|
+
delete?: boolean;
|
|
1437
|
+
entity?: string;
|
|
1438
|
+
read?: boolean;
|
|
1439
|
+
update?: boolean;
|
|
1440
|
+
}
|
|
1441
|
+
export interface GetOrganizationScopesResponse {
|
|
1442
|
+
scopes?: OrganizationScope[];
|
|
1443
|
+
}
|
|
1444
|
+
export interface GetSuborganizationsRequest {
|
|
1445
|
+
page?: number;
|
|
1446
|
+
per_page?: number;
|
|
1447
|
+
}
|
|
1448
|
+
export interface OrganizationSuborganization {
|
|
1449
|
+
id?: string;
|
|
1450
|
+
name?: string;
|
|
1451
|
+
}
|
|
1452
|
+
export 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 @@ export interface GetVposRequest {
|
|
|
1006
1466
|
currency_id: string;
|
|
1007
1467
|
[key: string]: unknown;
|
|
1008
1468
|
}
|
|
1469
|
+
export interface OrganizationVpos {
|
|
1470
|
+
id?: string;
|
|
1471
|
+
name?: string;
|
|
1472
|
+
}
|
|
1473
|
+
export 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
|
-
export interface
|
|
1482
|
+
export interface OrgCreateUserRequest {
|
|
1016
1483
|
conversation_id: string;
|
|
1017
1484
|
email: string;
|
|
1018
1485
|
first_name: string;
|
|
@@ -1022,24 +1489,43 @@ export interface OrgCreateUserReq {
|
|
|
1022
1489
|
phone: string;
|
|
1023
1490
|
reference_id: string;
|
|
1024
1491
|
}
|
|
1492
|
+
export interface OrgCreateUserResponse {
|
|
1493
|
+
code?: number;
|
|
1494
|
+
message?: string;
|
|
1495
|
+
user_id?: string;
|
|
1496
|
+
}
|
|
1497
|
+
export type OrgCreateUserReq = OrgCreateUserRequest;
|
|
1498
|
+
export type OrgCreateUserRes = OrgCreateUserResponse;
|
|
1025
1499
|
/**
|
|
1026
1500
|
* @category Organization
|
|
1027
1501
|
* @summary Request to verify a user
|
|
1028
1502
|
* @description Data required to verify a user's account
|
|
1029
|
-
* @interface
|
|
1503
|
+
* @interface OrgUserVerifyRequest
|
|
1030
1504
|
*/
|
|
1031
|
-
export interface
|
|
1505
|
+
export interface OrgUserVerifyRequest {
|
|
1032
1506
|
user_id: string;
|
|
1033
1507
|
}
|
|
1508
|
+
export interface OrgUserVerifyResponse {
|
|
1509
|
+
code?: number;
|
|
1510
|
+
message?: string;
|
|
1511
|
+
}
|
|
1512
|
+
export type OrgUserVerifyReq = OrgUserVerifyRequest;
|
|
1513
|
+
export type OrgUserVerifyRes = OrgUserVerifyResponse;
|
|
1034
1514
|
/**
|
|
1035
1515
|
* @category Organization
|
|
1036
1516
|
* @summary Request to verify user's mobile number
|
|
1037
1517
|
* @description Data required to initiate or complete mobile number verification
|
|
1038
|
-
* @interface
|
|
1518
|
+
* @interface OrgUserMobileVerifyRequest
|
|
1039
1519
|
*/
|
|
1040
|
-
export interface
|
|
1520
|
+
export interface OrgUserMobileVerifyRequest {
|
|
1041
1521
|
user_id: string;
|
|
1042
1522
|
}
|
|
1523
|
+
export interface OrgUserMobileVerifyResponse {
|
|
1524
|
+
code?: number;
|
|
1525
|
+
message?: string;
|
|
1526
|
+
}
|
|
1527
|
+
export type OrgUserMobileVerifyReq = OrgUserMobileVerifyRequest;
|
|
1528
|
+
export type OrgUserMobileVerifyRes = OrgUserMobileVerifyResponse;
|
|
1043
1529
|
/**
|
|
1044
1530
|
* @category Order Management
|
|
1045
1531
|
* @summary Request for order post-authorization
|
|
@@ -1050,4 +1536,101 @@ export interface OrderPostAuthRequest {
|
|
|
1050
1536
|
amount: number;
|
|
1051
1537
|
reference_id: string;
|
|
1052
1538
|
}
|
|
1539
|
+
/**
|
|
1540
|
+
* @category Order Management
|
|
1541
|
+
* @summary Response for order post-authorization
|
|
1542
|
+
* @description API response payload returned after post-authorization operation
|
|
1543
|
+
* @interface OrderPostAuthResponse
|
|
1544
|
+
*/
|
|
1545
|
+
export interface OrderPostAuthResponse {
|
|
1546
|
+
code?: number;
|
|
1547
|
+
is_success?: boolean;
|
|
1548
|
+
message?: string;
|
|
1549
|
+
}
|
|
1550
|
+
export interface OrderPaymentOptionsUpdateDTO {
|
|
1551
|
+
payment_options: string[];
|
|
1552
|
+
reference_id: string;
|
|
1553
|
+
}
|
|
1554
|
+
export interface SplitOrderItemPaymentDTO {
|
|
1555
|
+
amount: number;
|
|
1556
|
+
order_id: string;
|
|
1557
|
+
order_item_payment_id: string;
|
|
1558
|
+
}
|
|
1559
|
+
export interface OrderCallbackResponse {
|
|
1560
|
+
[key: string]: unknown;
|
|
1561
|
+
}
|
|
1562
|
+
export interface OrderVposQueryResponse {
|
|
1563
|
+
[key: string]: unknown;
|
|
1564
|
+
}
|
|
1565
|
+
export interface OrganizationCurrencyPreset {
|
|
1566
|
+
id?: string;
|
|
1567
|
+
name?: string;
|
|
1568
|
+
code?: string;
|
|
1569
|
+
[key: string]: unknown;
|
|
1570
|
+
}
|
|
1571
|
+
export interface GetOrganizationCurrencyPresetsResponse {
|
|
1572
|
+
presets?: OrganizationCurrencyPreset[];
|
|
1573
|
+
}
|
|
1574
|
+
export interface GetSuborganizationDetailsResponse {
|
|
1575
|
+
[key: string]: unknown;
|
|
1576
|
+
}
|
|
1577
|
+
export interface GetSuborganizationSubmerchantsResponse {
|
|
1578
|
+
[key: string]: unknown;
|
|
1579
|
+
}
|
|
1580
|
+
export interface SystemBasketItemType {
|
|
1581
|
+
code?: string | number;
|
|
1582
|
+
message?: string;
|
|
1583
|
+
}
|
|
1584
|
+
export interface GetSystemBasketItemTypesResponse {
|
|
1585
|
+
rows?: SystemBasketItemType[];
|
|
1586
|
+
}
|
|
1587
|
+
export interface SystemErrorCode {
|
|
1588
|
+
code?: string | number;
|
|
1589
|
+
message?: string;
|
|
1590
|
+
}
|
|
1591
|
+
export interface GetSystemErrorCodesResponse {
|
|
1592
|
+
rows?: SystemErrorCode[];
|
|
1593
|
+
}
|
|
1594
|
+
export interface SystemPaymentTermStatus {
|
|
1595
|
+
code?: string | number;
|
|
1596
|
+
message?: string;
|
|
1597
|
+
}
|
|
1598
|
+
export interface GetSystemPaymentTermStatusesResponse {
|
|
1599
|
+
rows?: SystemPaymentTermStatus[];
|
|
1600
|
+
}
|
|
1601
|
+
export interface SystemProductType {
|
|
1602
|
+
code?: string | number;
|
|
1603
|
+
message?: string;
|
|
1604
|
+
}
|
|
1605
|
+
export interface GetSystemProductTypesResponse {
|
|
1606
|
+
rows?: SystemProductType[];
|
|
1607
|
+
}
|
|
1608
|
+
export interface SystemShortcutType {
|
|
1609
|
+
code?: string | number;
|
|
1610
|
+
message?: string;
|
|
1611
|
+
}
|
|
1612
|
+
export interface GetSystemShortcutTypesResponse {
|
|
1613
|
+
rows?: SystemShortcutType[];
|
|
1614
|
+
}
|
|
1615
|
+
export interface SystemTransactionPaymentType {
|
|
1616
|
+
code?: string | number;
|
|
1617
|
+
message?: string;
|
|
1618
|
+
}
|
|
1619
|
+
export interface GetSystemTransactionPaymentTypesResponse {
|
|
1620
|
+
rows?: SystemTransactionPaymentType[];
|
|
1621
|
+
}
|
|
1622
|
+
export interface SystemTransactionPurpose {
|
|
1623
|
+
code?: string | number;
|
|
1624
|
+
message?: string;
|
|
1625
|
+
}
|
|
1626
|
+
export interface GetSystemTransactionPurposesResponse {
|
|
1627
|
+
rows?: SystemTransactionPurpose[];
|
|
1628
|
+
}
|
|
1629
|
+
export interface SystemTransactionStatus {
|
|
1630
|
+
code?: string | number;
|
|
1631
|
+
message?: string;
|
|
1632
|
+
}
|
|
1633
|
+
export interface GetSystemTransactionStatusesResponse {
|
|
1634
|
+
rows?: SystemTransactionStatus[];
|
|
1635
|
+
}
|
|
1053
1636
|
//# sourceMappingURL=index.d.ts.map
|