@tapsilat/tapsilat-js 2026.1.14 → 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.
@@ -94,11 +94,11 @@ export interface Customer {
94
94
  * @interface Address
95
95
  */
96
96
  export interface Address {
97
- address: string;
98
- city: string;
99
- contact_name: string;
100
- country: string;
101
- zip_code: string;
97
+ address?: string;
98
+ city?: string;
99
+ contact_name?: string;
100
+ country?: string;
101
+ zip_code?: string;
102
102
  district?: string;
103
103
  contact_phone?: string;
104
104
  }
@@ -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;
@@ -121,16 +126,24 @@ export interface BillingAddress extends Address {
121
126
  * @interface BasketItem
122
127
  */
123
128
  export interface BasketItem {
124
- id: string;
125
- name: string;
126
- category1: string;
129
+ id?: string;
130
+ name?: string;
131
+ category1?: string;
127
132
  category2?: string;
128
- item_type: string;
129
- price: number;
130
- quantity: number;
133
+ commission_amount?: number;
134
+ coupon?: string;
135
+ mcc?: string;
136
+ item_type?: string;
137
+ paid_amount?: number;
138
+ payer?: BasketItemPayerDTO;
139
+ price?: number;
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,18 +290,30 @@ export interface OrderCreateRequest {
275
290
  locale: Locale;
276
291
  three_d_force?: boolean;
277
292
  currency: Currency;
278
- shipping_address?: Address;
279
- basket_items: BasketItem[];
280
- billing_address: BillingAddress;
293
+ checkout_design?: CheckoutDesignDTO;
294
+ shipping_address?: ShippingAddressDTO;
295
+ basket_items?: BasketItem[];
296
+ billing_address?: BillingAddress;
281
297
  buyer: Buyer;
298
+ consents?: OrderConsent[];
282
299
  conversation_id?: string;
300
+ external_reference_id?: string;
301
+ order_cards?: OrderCardDTO[];
302
+ paid_amount?: number;
283
303
  partial_payment?: boolean;
304
+ payment_mode?: string;
284
305
  payment_methods?: boolean;
285
306
  payment_options?: PaymentOption[];
286
307
  payment_success_url?: string;
287
308
  payment_failure_url?: string;
309
+ payment_terms?: PaymentTermDTO[];
310
+ pf_sub_merchant?: OrderPFSubMerchantDTO;
311
+ redirect_failure_url?: string;
312
+ redirect_success_url?: string;
288
313
  enabled_installments?: number[];
289
314
  metadata?: OrderMetadata[];
315
+ sub_organization?: SubOrganizationDTO;
316
+ submerchants?: SubmerchantDTO[];
290
317
  }
291
318
  /**
292
319
  * @category Order Management
@@ -295,7 +322,11 @@ export interface OrderCreateRequest {
295
322
  * @interface OrderCreateResponse
296
323
  */
297
324
  export interface OrderCreateResponse {
298
- order_id: string;
325
+ code?: number;
326
+ id?: string;
327
+ message?: string;
328
+ organization_id?: string;
329
+ order_id?: string;
299
330
  reference_id: string;
300
331
  checkout_url?: string;
301
332
  conversation_id?: string;
@@ -324,6 +355,111 @@ export interface Order extends OrderCreateResponse {
324
355
  organization?: string;
325
356
  unpaid_amount?: number;
326
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
+ }
327
463
  /**
328
464
  * @category Refunds
329
465
  * @summary Refund request information for an order
@@ -333,6 +469,8 @@ export interface Order extends OrderCreateResponse {
333
469
  export interface OrderRefundRequest {
334
470
  reference_id: string;
335
471
  amount: number;
472
+ order_item_id?: string;
473
+ order_item_payment_id?: string;
336
474
  }
337
475
  /**
338
476
  * @category Refunds
@@ -341,23 +479,43 @@ export interface OrderRefundRequest {
341
479
  * @interface OrderRefundResponse
342
480
  */
343
481
  export interface OrderRefundResponse {
344
- refundId: string;
345
- referenceId: string;
346
- status: string;
347
- amount: number;
348
- currency: Currency;
349
- createdAt: string;
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;
350
490
  }
351
491
  /**
352
492
  * @category Order Management
353
493
  * @summary Order status information
354
- * @description Provides the current status of an order and when it was last updated
494
+ * @description Swagger-aligned response payload for GET /order/{id}/status
355
495
  * @interface OrderStatusResponse
356
496
  */
357
497
  export interface OrderStatusResponse {
358
- referenceId: string;
359
- status: string;
360
- lastUpdatedAt: string;
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[];
361
519
  }
362
520
  /**
363
521
  * @category Payment Processing
@@ -378,6 +536,58 @@ export interface OrderPaymentDetail {
378
536
  cardAssociation: string;
379
537
  };
380
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
+ }
381
591
  /**
382
592
  * @category API DTOs
383
593
  * @summary API representation of buyer information
@@ -415,6 +625,25 @@ export interface BasketItemPayerDTO {
415
625
  type?: string;
416
626
  vat?: string;
417
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
+ }
418
647
  /**
419
648
  * @category API DTOs
420
649
  * @summary Individual item in an order basket
@@ -429,14 +658,20 @@ export interface BasketItemDTO {
429
658
  coupon_discount?: number;
430
659
  data?: string;
431
660
  id?: string;
661
+ item_payments?: BasketItemPaymentDTO[];
432
662
  item_type?: string;
663
+ mcc?: string;
433
664
  name?: string;
434
665
  paid_amount?: number;
666
+ paidable_amount?: number;
435
667
  payer?: BasketItemPayerDTO;
436
668
  price?: number;
437
669
  quantity?: number;
438
670
  quantity_float?: number;
439
671
  quantity_unit?: string;
672
+ refundable_amount?: number;
673
+ refunded_amount?: number;
674
+ status?: number;
440
675
  sub_merchant_key?: string;
441
676
  sub_merchant_price?: string;
442
677
  }
@@ -455,6 +690,10 @@ export interface BillingAddressDTO {
455
690
  contact_phone?: string;
456
691
  country?: string;
457
692
  district?: string;
693
+ neighbourhood?: string;
694
+ street1?: string;
695
+ street2?: string;
696
+ street3?: string;
458
697
  tax_office?: string;
459
698
  title?: string;
460
699
  vat_number?: string;
@@ -528,10 +767,12 @@ export interface OrderPFSubMerchantDTO {
528
767
  id?: string;
529
768
  mcc?: string;
530
769
  name?: string;
770
+ national_id?: string;
531
771
  org_id?: string;
532
772
  postal_code?: string;
533
773
  submerchant_nin?: string;
534
774
  submerchant_url?: string;
775
+ switch_id?: string;
535
776
  terminal_no?: string;
536
777
  }
537
778
  /**
@@ -584,6 +825,16 @@ export interface SubmerchantDTO {
584
825
  merchant_reference_id?: string;
585
826
  order_basket_item_id?: string;
586
827
  }
828
+ /**
829
+ * @category Order Management
830
+ * @summary Order consent information
831
+ * @description Title and URL for legal consents required during order creation
832
+ * @interface OrderConsent
833
+ */
834
+ export interface OrderConsent {
835
+ title?: string;
836
+ url?: string;
837
+ }
587
838
  /**
588
839
  * @category API DTOs
589
840
  * @summary Comprehensive order creation request
@@ -592,25 +843,29 @@ export interface SubmerchantDTO {
592
843
  */
593
844
  export interface OrderCreateDTO {
594
845
  amount: number;
595
- currency: string;
596
- locale: string;
846
+ currency: Currency;
847
+ locale: Locale;
597
848
  buyer: BuyerDTO;
598
849
  basket_items?: BasketItemDTO[];
599
850
  billing_address?: BillingAddressDTO;
600
851
  checkout_design?: CheckoutDesignDTO;
852
+ consents?: OrderConsent[];
601
853
  conversation_id?: string;
602
854
  enabled_installments?: number[];
603
855
  external_reference_id?: string;
604
856
  metadata?: MetadataDTO[];
605
- order_cards?: OrderCardDTO;
857
+ order_cards?: OrderCardDTO[];
606
858
  paid_amount?: number;
607
859
  partial_payment?: boolean;
608
860
  payment_failure_url?: string;
861
+ payment_mode?: string;
609
862
  payment_methods?: boolean;
610
863
  payment_options?: string[];
611
864
  payment_success_url?: string;
612
865
  payment_terms?: PaymentTermDTO[];
613
866
  pf_sub_merchant?: OrderPFSubMerchantDTO;
867
+ redirect_failure_url?: string;
868
+ redirect_success_url?: string;
614
869
  shipping_address?: ShippingAddressDTO;
615
870
  sub_organization?: SubOrganizationDTO;
616
871
  submerchants?: SubmerchantDTO[];
@@ -629,6 +884,25 @@ export interface RefundOrderDTO {
629
884
  order_item_id?: string;
630
885
  order_item_payment_id?: string;
631
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
+ }
632
906
  /**
633
907
  * @category Payment Terms
634
908
  * @summary Data for creating a payment term
@@ -703,6 +977,34 @@ export interface PaymentTermResponse {
703
977
  paid_date?: string;
704
978
  data?: string;
705
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
+ }
706
1008
  /**
707
1009
  * @category Payment Terms
708
1010
  * @summary Request data for deleting a payment term
@@ -710,6 +1012,7 @@ export interface PaymentTermResponse {
710
1012
  * @interface PaymentTermDeleteRequest
711
1013
  */
712
1014
  export interface PaymentTermDeleteRequest {
1015
+ order_id?: string;
713
1016
  term_reference_id: string;
714
1017
  }
715
1018
  /**
@@ -719,11 +1022,14 @@ export interface PaymentTermDeleteRequest {
719
1022
  * @interface PaymentTermRefundResponse
720
1023
  */
721
1024
  export interface PaymentTermRefundResponse {
722
- refund_id: string;
723
- term_reference_id: string;
724
- amount: number;
725
- status: string;
726
- created_at: string;
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;
727
1033
  refund_reference_id?: string;
728
1034
  }
729
1035
  /**
@@ -753,9 +1059,11 @@ export interface OrderTerminateRequest {
753
1059
  * @interface OrderTerminateResponse
754
1060
  */
755
1061
  export interface OrderTerminateResponse {
756
- reference_id: string;
757
- status: string;
758
- terminated_at: string;
1062
+ code?: number;
1063
+ message?: string;
1064
+ reference_id?: string;
1065
+ status?: string;
1066
+ terminated_at?: string;
759
1067
  reason?: string;
760
1068
  }
761
1069
  /**
@@ -790,6 +1098,10 @@ export interface SubscriptionCancelRequest {
790
1098
  external_reference_id?: string;
791
1099
  reference_id?: string;
792
1100
  }
1101
+ export interface CancelSubscriptionResponse {
1102
+ code?: number;
1103
+ message?: string;
1104
+ }
793
1105
  export interface SubscriptionBilling {
794
1106
  address?: string;
795
1107
  city?: string;
@@ -823,6 +1135,11 @@ export interface SubscriptionCreateRequest {
823
1135
  success_url?: string;
824
1136
  title?: string;
825
1137
  user?: SubscriptionUser;
1138
+ price_option?: SubscriptionPriceOption;
1139
+ }
1140
+ export interface SubscriptionPriceOption {
1141
+ count: number;
1142
+ price: number;
826
1143
  }
827
1144
  export interface SubscriptionRedirectRequest {
828
1145
  subscription_id?: string;
@@ -847,6 +1164,29 @@ export interface SubscriptionDetail {
847
1164
  period?: number;
848
1165
  title?: string;
849
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
+ }
850
1190
  export interface SubscriptionCreateResponse {
851
1191
  code?: number;
852
1192
  message?: string;
@@ -867,18 +1207,43 @@ export interface OrganizationSettings {
867
1207
  subscription_domain?: string;
868
1208
  }
869
1209
  export interface OrderTransaction {
870
- id: string;
871
- date: string;
872
- amount: number;
873
- type: string;
874
- status: string;
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;
875
1219
  [key: string]: unknown;
876
1220
  }
1221
+ export interface GetOrderTransactionsResponse {
1222
+ orderTX?: OrderTransaction[];
1223
+ }
877
1224
  export interface OrderSubmerchant {
878
- id: string;
879
- name: string;
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;
880
1233
  [key: string]: unknown;
881
1234
  }
1235
+ export interface GetOrderSubmerchantsRequest {
1236
+ page?: number;
1237
+ per_page?: number;
1238
+ [key: string]: unknown;
1239
+ }
1240
+ export interface GetOrderSubmerchantsResponse {
1241
+ page?: number;
1242
+ per_page?: number;
1243
+ row?: OrderSubmerchant[];
1244
+ total?: number;
1245
+ total_pages?: number;
1246
+ }
882
1247
  /**
883
1248
  * @category Order Management
884
1249
  * @summary Request for order accounting
@@ -888,6 +1253,279 @@ export interface OrderSubmerchant {
888
1253
  export interface OrderAccountingRequest {
889
1254
  order_reference_id: string;
890
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
+ }
1266
+ /**
1267
+ * @category Order Management
1268
+ * @summary Request to add an item to the basket
1269
+ * @description Data required to add a new item to an existing order basket
1270
+ * @interface AddBasketItemRequest
1271
+ */
1272
+ export interface AddBasketItemRequest {
1273
+ order_reference_id: string;
1274
+ basket_item: BasketItemDTO;
1275
+ }
1276
+ /**
1277
+ * @category Order Management
1278
+ * @summary Request to remove an item from the basket
1279
+ * @description Data required to remove an item from an existing order basket
1280
+ * @interface RemoveBasketItemRequest
1281
+ */
1282
+ export interface RemoveBasketItemRequest {
1283
+ order_reference_id: string;
1284
+ basket_item_id: string;
1285
+ }
1286
+ /**
1287
+ * @category Order Management
1288
+ * @summary Request to update a basket item
1289
+ * @description Data required to update an existing item in an order basket
1290
+ * @interface UpdateBasketItemRequest
1291
+ */
1292
+ export interface UpdateBasketItemRequest {
1293
+ order_reference_id: string;
1294
+ basket_item: BasketItemDTO;
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
+ }
1325
+ /**
1326
+ * @category Organization
1327
+ * @summary Webhook callback URL configuration
1328
+ * @description Configuration for various webhook callback endpoints
1329
+ * @interface CallbackURLDTO
1330
+ */
1331
+ export interface CallbackURLDTO {
1332
+ callback_url?: string;
1333
+ cancel_callback_url?: string;
1334
+ fail_callback_url?: string;
1335
+ refund_callback_url?: string;
1336
+ }
1337
+ /**
1338
+ * @category Organization
1339
+ * @summary Organization business types
1340
+ * @enum {number}
1341
+ */
1342
+ export declare enum BusinessType {
1343
+ INDIVIDUAL = 0,
1344
+ CORPORATE = 1,
1345
+ NON_PROFIT = 2,
1346
+ GOVERNMENT = 3,
1347
+ UNKNOWN = 4
1348
+ }
1349
+ /**
1350
+ * @category Organization
1351
+ * @summary Request to create a business entity
1352
+ * @description Comprehensive data for creating a new business entity in an organization
1353
+ * @interface OrgCreateBusinessRequest
1354
+ */
1355
+ export interface OrgCreateBusinessRequest {
1356
+ address: string;
1357
+ business_name: string;
1358
+ business_type: BusinessType;
1359
+ email: string;
1360
+ first_name: string;
1361
+ identity_number: string;
1362
+ last_name: string;
1363
+ phone: string;
1364
+ tax_number: string;
1365
+ tax_office: string;
1366
+ zip_code: string;
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
+ }
1401
+ /**
1402
+ * @category Organization
1403
+ * @summary Request for user limit information
1404
+ * @description Data required to fetch limits for a specific user
1405
+ * @interface GetUserLimitRequest
1406
+ */
1407
+ export interface GetUserLimitRequest {
1408
+ user_id: string;
1409
+ [key: string]: unknown;
1410
+ }
1411
+ /**
1412
+ * @category Organization
1413
+ * @summary Request to set user limits
1414
+ * @description Data required to set a specific limit for a user
1415
+ * @interface SetLimitUserRequest
1416
+ */
1417
+ export interface SetLimitUserRequest {
1418
+ limit_id: string;
1419
+ user_id: string;
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
+ }
1459
+ /**
1460
+ * @category Organization
1461
+ * @summary Request for VPOS list
1462
+ * @description Parameters for filtering and retrieving virtual POS terminals
1463
+ * @interface GetVposRequest
1464
+ */
1465
+ export interface GetVposRequest {
1466
+ currency_id: string;
1467
+ [key: string]: unknown;
1468
+ }
1469
+ export interface OrganizationVpos {
1470
+ id?: string;
1471
+ name?: string;
1472
+ }
1473
+ export interface GetVposResponse {
1474
+ organization_vpos?: OrganizationVpos[];
1475
+ }
1476
+ /**
1477
+ * @category Organization
1478
+ * @summary Request to create an organization user
1479
+ * @description Comprehensive data for creating a new user within an organization
1480
+ * @interface OrgCreateUserRequest
1481
+ */
1482
+ export interface OrgCreateUserRequest {
1483
+ conversation_id: string;
1484
+ email: string;
1485
+ first_name: string;
1486
+ identity_number: string;
1487
+ is_mail_verified: boolean;
1488
+ last_name: string;
1489
+ phone: string;
1490
+ reference_id: string;
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;
1499
+ /**
1500
+ * @category Organization
1501
+ * @summary Request to verify a user
1502
+ * @description Data required to verify a user's account
1503
+ * @interface OrgUserVerifyRequest
1504
+ */
1505
+ export interface OrgUserVerifyRequest {
1506
+ user_id: string;
1507
+ }
1508
+ export interface OrgUserVerifyResponse {
1509
+ code?: number;
1510
+ message?: string;
1511
+ }
1512
+ export type OrgUserVerifyReq = OrgUserVerifyRequest;
1513
+ export type OrgUserVerifyRes = OrgUserVerifyResponse;
1514
+ /**
1515
+ * @category Organization
1516
+ * @summary Request to verify user's mobile number
1517
+ * @description Data required to initiate or complete mobile number verification
1518
+ * @interface OrgUserMobileVerifyRequest
1519
+ */
1520
+ export interface OrgUserMobileVerifyRequest {
1521
+ user_id: string;
1522
+ }
1523
+ export interface OrgUserMobileVerifyResponse {
1524
+ code?: number;
1525
+ message?: string;
1526
+ }
1527
+ export type OrgUserMobileVerifyReq = OrgUserMobileVerifyRequest;
1528
+ export type OrgUserMobileVerifyRes = OrgUserMobileVerifyResponse;
891
1529
  /**
892
1530
  * @category Order Management
893
1531
  * @summary Request for order post-authorization
@@ -898,4 +1536,101 @@ export interface OrderPostAuthRequest {
898
1536
  amount: number;
899
1537
  reference_id: string;
900
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
+ }
901
1636
  //# sourceMappingURL=index.d.ts.map