-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathapi_client.py
More file actions
13670 lines (12147 loc) · 657 KB
/
api_client.py
File metadata and controls
13670 lines (12147 loc) · 657 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# coding: utf-8
"""
Cashfree Payment Gateway APIs
Cashfree's Payment Gateway APIs provide developers with a streamlined pathway to integrate advanced payment processing capabilities into their applications, platforms and websites.
The version of the OpenAPI document: 2023-08-01
Contact: developers@cashfree.com
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import re # noqa: F401
import io
import warnings
from pydantic import validate_arguments, ValidationError, Field, StrictStr, StrictBytes
from typing_extensions import Annotated
from cashfree_pg.configuration import Configuration
from cashfree_pg.api_response import ApiResponse
from cashfree_pg.exceptions import ( # noqa: F401
ApiException,
ApiTypeError,
ApiValueError
)
import atexit
import datetime as dt
from dateutil.parser import parse
import json
import mimetypes
from multiprocessing.pool import ThreadPool
import os
import re
import tempfile
import warnings
import base64
import hashlib
import hmac
from typing_extensions import Annotated
from typing import overload, Optional, Union, Awaitable
from cashfree_pg.configuration import Configuration
from cashfree_pg.api_response import ApiResponse
from cashfree_pg.exceptions import ( # noqa: F401
ApiTypeError,
ApiValueError
)
from urllib.parse import quote
from cashfree_pg.configuration import Configuration
from cashfree_pg.api_response import ApiResponse
import cashfree_pg.models
from cashfree_pg import rest
from cashfree_pg.models.address_details import *
from cashfree_pg.models.adjust_vendor_balance_request import *
from cashfree_pg.models.adjust_vendor_balance_response import *
from cashfree_pg.models.api_error import *
from cashfree_pg.models.api_error404 import *
from cashfree_pg.models.api_error409 import *
from cashfree_pg.models.api_error502 import *
from cashfree_pg.models.app import *
from cashfree_pg.models.app_payment_method import *
from cashfree_pg.models.authentication_error import *
from cashfree_pg.models.authorization_details import *
from cashfree_pg.models.authorization_in_payments_entity import *
from cashfree_pg.models.authorize_order_request import *
from cashfree_pg.models.bad_request_error import *
from cashfree_pg.models.balance_details import *
from cashfree_pg.models.bank_details import *
from cashfree_pg.models.banktransfer import *
from cashfree_pg.models.banktransfer_payment_method import *
from cashfree_pg.models.card import *
from cashfree_pg.models.card_emi import *
from cashfree_pg.models.card_emi_payment_method import *
from cashfree_pg.models.card_offer import *
from cashfree_pg.models.card_payment_method import *
from cashfree_pg.models.cardless_emi import *
from cashfree_pg.models.cardless_emi_entity import *
from cashfree_pg.models.cardless_emi_payment_method import *
from cashfree_pg.models.cardless_emi_queries import *
from cashfree_pg.models.cart_details import *
from cashfree_pg.models.cart_details_entity import *
from cashfree_pg.models.cart_item import *
from cashfree_pg.models.cashback_details import *
from cashfree_pg.models.charges_details import *
from cashfree_pg.models.charges_entity import *
from cashfree_pg.models.create_customer_request import *
from cashfree_pg.models.create_link_request import *
from cashfree_pg.models.create_offer_request import *
from cashfree_pg.models.create_order_request import *
from cashfree_pg.models.create_order_settlement_request_body import *
from cashfree_pg.models.create_order_settlement_request_body_meta_data import *
from cashfree_pg.models.create_partner_vpa_request import *
from cashfree_pg.models.create_plan_request import *
from cashfree_pg.models.create_subscription_payment_request import *
from cashfree_pg.models.create_subscription_payment_request_card import *
from cashfree_pg.models.create_subscription_payment_request_enack import *
from cashfree_pg.models.create_subscription_payment_request_payment_method import *
from cashfree_pg.models.create_subscription_payment_request_pnach import *
from cashfree_pg.models.create_subscription_payment_response import *
from cashfree_pg.models.create_subscription_refund_request import *
from cashfree_pg.models.create_subscription_request import *
from cashfree_pg.models.create_subscription_request_authorization_details import *
from cashfree_pg.models.create_subscription_request_plan_details import *
from cashfree_pg.models.create_subscription_request_subscription_meta import *
from cashfree_pg.models.create_subscripton_payment_request_upi import *
from cashfree_pg.models.create_terminal_request import *
from cashfree_pg.models.create_terminal_request_terminal_meta import *
from cashfree_pg.models.create_terminal_transaction_request import *
from cashfree_pg.models.create_vendor_request import *
from cashfree_pg.models.create_vendor_response import *
from cashfree_pg.models.cryptogram_entity import *
from cashfree_pg.models.customer_details import *
from cashfree_pg.models.customer_details_cardless_emi import *
from cashfree_pg.models.customer_details_in_disputes_entity import *
from cashfree_pg.models.customer_details_response import *
from cashfree_pg.models.customer_entity import *
from cashfree_pg.models.demap_soundbox_vpa_request import *
from cashfree_pg.models.discount_details import *
from cashfree_pg.models.disputes_entity import *
from cashfree_pg.models.disputes_entity_merchant_accepted import *
from cashfree_pg.models.emi_offer import *
from cashfree_pg.models.emi_plans_array import *
from cashfree_pg.models.es_order_recon_request import *
from cashfree_pg.models.es_order_recon_request_filters import *
from cashfree_pg.models.es_order_recon_request_pagination import *
from cashfree_pg.models.es_order_recon_response import *
from cashfree_pg.models.es_order_recon_response_data_inner import *
from cashfree_pg.models.es_order_recon_response_data_inner_order_splits_inner import *
from cashfree_pg.models.es_order_recon_response_data_inner_order_splits_inner_split_inner import *
from cashfree_pg.models.eligibility_cardless_emi_entity import *
from cashfree_pg.models.eligibility_fetch_cardless_emi_request import *
from cashfree_pg.models.eligibility_fetch_offers_request import *
from cashfree_pg.models.eligibility_fetch_paylater_request import *
from cashfree_pg.models.eligibility_fetch_payment_methods_request import *
from cashfree_pg.models.eligibility_method_item import *
from cashfree_pg.models.eligibility_method_item_entity_details import *
from cashfree_pg.models.eligibility_method_item_entity_details_available_handles_inner import *
from cashfree_pg.models.eligibility_offer_entity import *
from cashfree_pg.models.eligibility_paylater_entity import *
from cashfree_pg.models.eligibility_payment_methods_entity import *
from cashfree_pg.models.eligibility_payment_methods_entity_entity_details import *
from cashfree_pg.models.entity_simulation_request import *
from cashfree_pg.models.entity_simulation_response import *
from cashfree_pg.models.error_details_in_payments_entity import *
from cashfree_pg.models.evidence import *
from cashfree_pg.models.evidence_submitted_to_contest_dispute import *
from cashfree_pg.models.evidences_to_contest_dispute import *
from cashfree_pg.models.extended_cart_details import *
from cashfree_pg.models.extended_customer_details import *
from cashfree_pg.models.fetch_recon_request import *
from cashfree_pg.models.fetch_recon_request_filters import *
from cashfree_pg.models.fetch_recon_request_pagination import *
from cashfree_pg.models.fetch_settlements_request import *
from cashfree_pg.models.fetch_settlements_request_filters import *
from cashfree_pg.models.fetch_settlements_request_pagination import *
from cashfree_pg.models.fetch_terminal_qr_codes_entity import *
from cashfree_pg.models.idempotency_error import *
from cashfree_pg.models.instrument_entity import *
from cashfree_pg.models.instrument_webhook import *
from cashfree_pg.models.instrument_webhook_data import *
from cashfree_pg.models.instrument_webhook_data_entity import *
from cashfree_pg.models.kyc_details import *
from cashfree_pg.models.link_customer_details_entity import *
from cashfree_pg.models.link_entity import *
from cashfree_pg.models.link_meta_response_entity import *
from cashfree_pg.models.link_notify_entity import *
from cashfree_pg.models.manage_subscription_payment_request import *
from cashfree_pg.models.manage_subscription_payment_request_action_details import *
from cashfree_pg.models.manage_subscription_request import *
from cashfree_pg.models.manage_subscription_request_action_details import *
from cashfree_pg.models.net_banking_payment_method import *
from cashfree_pg.models.netbanking import *
from cashfree_pg.models.offer_all import *
from cashfree_pg.models.offer_card import *
from cashfree_pg.models.offer_details import *
from cashfree_pg.models.offer_emi import *
from cashfree_pg.models.offer_entity import *
from cashfree_pg.models.offer_extended_details import *
from cashfree_pg.models.offer_filters import *
from cashfree_pg.models.offer_meta import *
from cashfree_pg.models.offer_nb import *
from cashfree_pg.models.offer_nb_netbanking import *
from cashfree_pg.models.offer_paylater import *
from cashfree_pg.models.offer_queries import *
from cashfree_pg.models.offer_tnc import *
from cashfree_pg.models.offer_type import *
from cashfree_pg.models.offer_upi import *
from cashfree_pg.models.offer_validations import *
from cashfree_pg.models.offer_validations_payment_method import *
from cashfree_pg.models.offer_wallet import *
from cashfree_pg.models.onboard_soundbox_vpa_request import *
from cashfree_pg.models.order_authenticate_entity import *
from cashfree_pg.models.order_authenticate_payment_request import *
from cashfree_pg.models.order_create_refund_request import *
from cashfree_pg.models.order_delivery_status import *
from cashfree_pg.models.order_details_in_disputes_entity import *
from cashfree_pg.models.order_entity import *
from cashfree_pg.models.order_extended_data_entity import *
from cashfree_pg.models.order_meta import *
from cashfree_pg.models.order_pay_data import *
from cashfree_pg.models.pay_order_entity import *
from cashfree_pg.models.pay_order_request import *
from cashfree_pg.models.pay_order_request_payment_method import *
from cashfree_pg.models.paylater import *
from cashfree_pg.models.paylater_entity import *
from cashfree_pg.models.paylater_offer import *
from cashfree_pg.models.paylater_payment_method import *
from cashfree_pg.models.payment_entity import *
from cashfree_pg.models.payment_link_customer_details import *
from cashfree_pg.models.payment_link_order_entity import *
from cashfree_pg.models.payment_method_app_in_payments_entity import *
from cashfree_pg.models.payment_method_app_in_payments_entity_app import *
from cashfree_pg.models.payment_method_bank_transfer_in_payments_entity import *
from cashfree_pg.models.payment_method_bank_transfer_in_payments_entity_banktransfer import *
from cashfree_pg.models.payment_method_card_emiin_payments_entity import *
from cashfree_pg.models.payment_method_card_emiin_payments_entity_emi import *
from cashfree_pg.models.payment_method_card_emiin_payments_entity_emi_emi_details import *
from cashfree_pg.models.payment_method_card_in_payments_entity import *
from cashfree_pg.models.payment_method_card_in_payments_entity_card import *
from cashfree_pg.models.payment_method_cardless_emiin_payments_entity import *
from cashfree_pg.models.payment_method_net_banking_in_payments_entity import *
from cashfree_pg.models.payment_method_net_banking_in_payments_entity_netbanking import *
from cashfree_pg.models.payment_method_others_in_payments_entity import *
from cashfree_pg.models.payment_method_paylater_in_payments_entity import *
from cashfree_pg.models.payment_method_upiin_payments_entity import *
from cashfree_pg.models.payment_method_upiin_payments_entity_upi import *
from cashfree_pg.models.payment_methods_filters import *
from cashfree_pg.models.payment_methods_queries import *
from cashfree_pg.models.payment_mode_details import *
from cashfree_pg.models.payment_webhook import *
from cashfree_pg.models.payment_webhook_customer_entity import *
from cashfree_pg.models.payment_webhook_data_entity import *
from cashfree_pg.models.payment_webhook_error_entity import *
from cashfree_pg.models.payment_webhook_gateway_details_entity import *
from cashfree_pg.models.payment_webhook_order_entity import *
from cashfree_pg.models.plan_entity import *
from cashfree_pg.models.rate_limit_error import *
from cashfree_pg.models.recon_entity import *
from cashfree_pg.models.recon_entity_data_inner import *
from cashfree_pg.models.refund_entity import *
from cashfree_pg.models.refund_speed import *
from cashfree_pg.models.refund_webhook import *
from cashfree_pg.models.refund_webhook_data_entity import *
from cashfree_pg.models.saved_instrument_meta import *
from cashfree_pg.models.schedule_option import *
from cashfree_pg.models.settlement_entity import *
from cashfree_pg.models.settlement_fetch_recon_request import *
from cashfree_pg.models.settlement_recon_entity import *
from cashfree_pg.models.settlement_recon_entity_data_inner import *
from cashfree_pg.models.settlement_webhook import *
from cashfree_pg.models.settlement_webhook_data_entity import *
from cashfree_pg.models.shipment_details import *
from cashfree_pg.models.simulate_request import *
from cashfree_pg.models.simulation_response import *
from cashfree_pg.models.soundbox_vpa_entity import *
from cashfree_pg.models.split_after_payment_request import *
from cashfree_pg.models.split_after_payment_request_split_inner import *
from cashfree_pg.models.split_after_payment_response import *
from cashfree_pg.models.split_order_recon_success_response import *
from cashfree_pg.models.split_order_recon_success_response_settlement import *
from cashfree_pg.models.split_order_recon_success_response_vendors_inner import *
from cashfree_pg.models.static_qr_response_entity import *
from cashfree_pg.models.static_split_request import *
from cashfree_pg.models.static_split_request_scheme_inner import *
from cashfree_pg.models.static_split_response import *
from cashfree_pg.models.static_split_response_scheme_inner import *
from cashfree_pg.models.subscription_bank_details import *
from cashfree_pg.models.subscription_customer_details import *
from cashfree_pg.models.subscription_eligibility_request import *
from cashfree_pg.models.subscription_eligibility_request_filters import *
from cashfree_pg.models.subscription_eligibility_request_queries import *
from cashfree_pg.models.subscription_eligibility_response import *
from cashfree_pg.models.subscription_entity import *
from cashfree_pg.models.subscription_entity_subscription_meta import *
from cashfree_pg.models.subscription_payment_entity import *
from cashfree_pg.models.subscription_payment_entity_failure_details import *
from cashfree_pg.models.subscription_payment_refund_entity import *
from cashfree_pg.models.subscription_payment_split_item import *
from cashfree_pg.models.terminal_details import *
from cashfree_pg.models.terminal_entity import *
from cashfree_pg.models.terminal_payment_entity import *
from cashfree_pg.models.terminal_payment_entity_payment_method import *
from cashfree_pg.models.terminal_transaction_entity import *
from cashfree_pg.models.terminate_order_request import *
from cashfree_pg.models.transfer_details import *
from cashfree_pg.models.transfer_details_tags_inner import *
from cashfree_pg.models.upi_authorize_details import *
from cashfree_pg.models.upi_payment_method import *
from cashfree_pg.models.update_order_extended_data_entity import *
from cashfree_pg.models.update_order_extended_request import *
from cashfree_pg.models.update_soundbox_vpa_request import *
from cashfree_pg.models.update_terminal_entity import *
from cashfree_pg.models.update_terminal_request import *
from cashfree_pg.models.update_terminal_request_terminal_meta import *
from cashfree_pg.models.update_terminal_status_request import *
from cashfree_pg.models.update_vendor_request import *
from cashfree_pg.models.update_vendor_response import *
from cashfree_pg.models.upi import *
from cashfree_pg.models.upi_details import *
from cashfree_pg.models.upload_pnach_image_response import *
from cashfree_pg.models.upload_terminal_docs import *
from cashfree_pg.models.upload_terminal_docs_entity import *
from cashfree_pg.models.upload_vendor_documents_response import *
from cashfree_pg.models.vendor_adjustment_request import *
from cashfree_pg.models.vendor_adjustment_success_response import *
from cashfree_pg.models.vendor_balance import *
from cashfree_pg.models.vendor_balance_transfer_charges import *
from cashfree_pg.models.vendor_document_download_response import *
from cashfree_pg.models.vendor_documents_response import *
from cashfree_pg.models.vendor_entity import *
from cashfree_pg.models.vendor_entity_related_docs_inner import *
from cashfree_pg.models.vendor_split import *
from cashfree_pg.models.wallet_offer import *
class CFEnvironment(Enum):
SANDBOX = 1
PRODUCTION = 2
class PGWebhookEvent:
def __init__(self, type, rawBody, object):
self.type = type;
self.raw = rawBody
self.object = object;
class Cashfree:
XClientId = None
XClientSecret = None
XPartnerKey = None
XClientSignature = None
XPartnerMerchantId = None
XEnvironment = CFEnvironment.SANDBOX
XProduction = CFEnvironment.PRODUCTION
XSandbox = CFEnvironment.SANDBOX
PRODUCTION = CFEnvironment.PRODUCTION
SANDBOX = CFEnvironment.SANDBOX
XApiVersion = "2023-08-01";
def __init__(self, XEnvironment, XClientId, XClientSecret, XPartnerKey, XPartnerMerchantId, XClientSignature):
if XClientId != None:
self.XClientId = XClientId
if XClientSecret != None:
self.XClientSecret = XClientSecret
if XPartnerKey != None:
self.XPartnerKey = XPartnerKey
if XPartnerMerchantId != None:
self.XPartnerMerchantId = XPartnerMerchantId
if XClientSignature != None:
self.XClientSignature = XClientSignature
self.XEnvironment = XEnvironment;
def PGVerifyWebhookSignature(self, signature, rawBody, timestamp):
signatureData = timestamp+rawBody
message = bytes(signatureData, 'utf-8')
secretkey=bytes(self.XClientSecret,'utf-8')
generatedSignature = base64.b64encode(hmac.new(secretkey, message, digestmod=hashlib.sha256).digest())
computed_signature = str(generatedSignature, encoding='utf8')
if computed_signature == signature:
json_response = json.loads(rawBody)
return PGWebhookEvent(type=json_response['type'], rawBody=rawBody, object=json_response)
raise Exception("Generated signature and received signature did not match.")
@validate_arguments
def PGCreateCustomer(self, x_api_version : Annotated[StrictStr, Field(description="API version to be used. Format is in YYYY-MM-DD")] = None, create_customer_request : Annotated[CreateCustomerRequest, Field(description="Request to create a new customer at Cashfree")] = None, x_request_id : Annotated[Optional[StrictStr], Field(description="Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree")] = None, x_idempotency_key : Annotated[Optional[StrictStr], Field(description="An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. ")] = None, **kwargs) -> ApiResponse: # noqa: E501
"""Create Customer at Cashfree # noqa: E501
Create Customer at Cashfree # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.PGCreateCustomer_with_http_info(x_api_version, create_customer_request, x_request_id, x_idempotency_key, async_req=True)
>>> result = thread.get()
:param x_api_version: API version to be used. Format is in YYYY-MM-DD (required)
:type x_api_version: str
:param create_customer_request: Request to create a new customer at Cashfree (required)
:type create_customer_request: CreateCustomerRequest
:param x_request_id: Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
:type x_request_id: str
:param x_idempotency_key: An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.
:type x_idempotency_key: UUID
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the ApiResponse.data will
be set to none and raw_data will store the
HTTP response body without reading/decoding.
Default is True.
:type _preload_content: bool, optional
:param _return_http_data_only: response data instead of ApiResponse
object with status code, headers, etc
:type _return_http_data_only: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(CustomerEntity, status_code(int), headers(HTTPHeaderDict))
"""
x_api_version = self.XApiVersion
api_client = ApiClient.get_default()
host = "https://api.cashfree.com/pg"
if self.XEnvironment == CFEnvironment.SANDBOX:
host = "https://sandbox.self.com/pg"
configuration = Configuration(
host = host
)
configuration.api_key['XClientID'] = self.XClientId
configuration.api_key['XClientSecret'] = self.XClientSecret
configuration.api_key['XClientSignature'] = self.XClientSignature
configuration.api_key['XPartnerMerchantId'] = self.XPartnerMerchantId
configuration.api_key['XPartnerKey'] = self.XPartnerKey
api_client.configuration = configuration
_params = locals()
_all_params = [
'x_api_version',
'create_customer_request',
'x_request_id',
'x_idempotency_key'
]
_all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth',
'_content_type',
'_headers'
]
)
# validate the arguments
for _key, _val in _params['kwargs'].items():
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method PGCreateCustomer" % _key
)
_params[_key] = _val
del _params['kwargs']
_collection_formats = {}
# process the path parameters
_path_params = {}
# process the query parameters
_query_params = []
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
if x_request_id:
_header_params["x-request-id"] = x_request_id
if x_api_version:
_header_params["x-api-version"] = x_api_version
if x_idempotency_key:
_header_params["x-idempotency-key"] = x_idempotency_key
_header_params["x-sdk-platform"] = "pythonsdk-1.0.0"
# process the form parameters
_form_params = []
_files = {}
# process the body parameter
_body_params = None
if _params['create_customer_request'] is not None:
_body_params = _params['create_customer_request']
# set the HTTP header `Accept`
_header_params['Accept'] = api_client.select_header_accept(
['application/json']) # noqa: E501
# set the HTTP header `Content-Type`
_content_types_list = _params.get('_content_type',
api_client.select_header_content_type(
['application/json']))
if _content_types_list:
_header_params['Content-Type'] = _content_types_list
# authentication setting
_auth_settings = ['XPartnerAPIKey', 'XClientSecret', 'XPartnerMerchantID', 'XClientID', 'XClientSignatureHeader'] # noqa: E501
_response_types_map = {
'200': "CustomerEntity",
'400': "BadRequestError",
'401': "AuthenticationError",
'404': "ApiError404",
'409': "ApiError409",
'422': "IdempotencyError",
'429': "RateLimitError",
'500': "ApiError",
}
return api_client.call_api(
'/customers', 'POST',
_path_params,
_query_params,
_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
response_types_map=_response_types_map,
auth_settings=_auth_settings,
async_req=_params.get('async_req'),
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
_preload_content=_params.get('_preload_content', True),
_request_timeout=_params.get('_request_timeout'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
@validate_arguments
def PGAcceptDisputeById(self, x_api_version : Annotated[StrictStr, Field(description="API version to be used. Format is in YYYY-MM-DD")] = None, dispute_id : StrictInt = None, x_request_id : Annotated[Optional[StrictStr], Field(description="Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree")] = None, x_idempotency_key : Annotated[Optional[StrictStr], Field(description="An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. ")] = None, **kwargs) -> ApiResponse: # noqa: E501
"""Accept Dispute by Dispute ID # noqa: E501
Use this API to get accept the Dispute by specifying the Dispute ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.PGAcceptDisputeById_with_http_info(x_api_version, dispute_id, x_request_id, x_idempotency_key, async_req=True)
>>> result = thread.get()
:param x_api_version: API version to be used. Format is in YYYY-MM-DD (required)
:type x_api_version: str
:param dispute_id: (required)
:type dispute_id: int
:param x_request_id: Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
:type x_request_id: str
:param x_idempotency_key: An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.
:type x_idempotency_key: UUID
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the ApiResponse.data will
be set to none and raw_data will store the
HTTP response body without reading/decoding.
Default is True.
:type _preload_content: bool, optional
:param _return_http_data_only: response data instead of ApiResponse
object with status code, headers, etc
:type _return_http_data_only: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(DisputesEntityMerchantAccepted, status_code(int), headers(HTTPHeaderDict))
"""
x_api_version = self.XApiVersion
api_client = ApiClient.get_default()
host = "https://api.cashfree.com/pg"
if self.XEnvironment == CFEnvironment.SANDBOX:
host = "https://sandbox.self.com/pg"
configuration = Configuration(
host = host
)
configuration.api_key['XClientID'] = self.XClientId
configuration.api_key['XClientSecret'] = self.XClientSecret
configuration.api_key['XClientSignature'] = self.XClientSignature
configuration.api_key['XPartnerMerchantId'] = self.XPartnerMerchantId
configuration.api_key['XPartnerKey'] = self.XPartnerKey
api_client.configuration = configuration
_params = locals()
_all_params = [
'x_api_version',
'dispute_id',
'x_request_id',
'x_idempotency_key'
]
_all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth',
'_content_type',
'_headers'
]
)
# validate the arguments
for _key, _val in _params['kwargs'].items():
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method PGAcceptDisputeById" % _key
)
_params[_key] = _val
del _params['kwargs']
_collection_formats = {}
# process the path parameters
_path_params = {}
if _params['dispute_id']:
_path_params['dispute_id'] = _params['dispute_id']
# process the query parameters
_query_params = []
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
if x_request_id:
_header_params["x-request-id"] = x_request_id
if x_api_version:
_header_params["x-api-version"] = x_api_version
if x_idempotency_key:
_header_params["x-idempotency-key"] = x_idempotency_key
_header_params["x-sdk-platform"] = "pythonsdk-1.0.0"
# process the form parameters
_form_params = []
_files = {}
# process the body parameter
_body_params = None
# set the HTTP header `Accept`
_header_params['Accept'] = api_client.select_header_accept(
['application/json']) # noqa: E501
# authentication setting
_auth_settings = ['XPartnerAPIKey', 'XClientSecret', 'XPartnerMerchantID', 'XClientID', 'XClientSignatureHeader'] # noqa: E501
_response_types_map = {
'200': "DisputesEntityMerchantAccepted",
'400': "BadRequestError",
'401': "AuthenticationError",
'404': "ApiError404",
'409': "ApiError409",
'422': "IdempotencyError",
'429': "RateLimitError",
'500': "ApiError",
}
return api_client.call_api(
'/disputes/{dispute_id}/accept', 'PUT',
_path_params,
_query_params,
_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
response_types_map=_response_types_map,
auth_settings=_auth_settings,
async_req=_params.get('async_req'),
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
_preload_content=_params.get('_preload_content', True),
_request_timeout=_params.get('_request_timeout'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
@validate_arguments
def PGFetchDisputeById(self, x_api_version : Annotated[StrictStr, Field(description="API version to be used. Format is in YYYY-MM-DD")] = None, dispute_id : StrictInt = None, x_request_id : Annotated[Optional[StrictStr], Field(description="Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree")] = None, x_idempotency_key : Annotated[Optional[StrictStr], Field(description="An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. ")] = None, **kwargs) -> ApiResponse: # noqa: E501
"""Get Disputes by Dispute ID # noqa: E501
Use this API to get Dispute details by specifying the Dispute ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.PGFetchDisputeById_with_http_info(x_api_version, dispute_id, x_request_id, x_idempotency_key, async_req=True)
>>> result = thread.get()
:param x_api_version: API version to be used. Format is in YYYY-MM-DD (required)
:type x_api_version: str
:param dispute_id: (required)
:type dispute_id: int
:param x_request_id: Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
:type x_request_id: str
:param x_idempotency_key: An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.
:type x_idempotency_key: UUID
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the ApiResponse.data will
be set to none and raw_data will store the
HTTP response body without reading/decoding.
Default is True.
:type _preload_content: bool, optional
:param _return_http_data_only: response data instead of ApiResponse
object with status code, headers, etc
:type _return_http_data_only: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(DisputesEntity, status_code(int), headers(HTTPHeaderDict))
"""
x_api_version = self.XApiVersion
api_client = ApiClient.get_default()
host = "https://api.cashfree.com/pg"
if self.XEnvironment == CFEnvironment.SANDBOX:
host = "https://sandbox.self.com/pg"
configuration = Configuration(
host = host
)
configuration.api_key['XClientID'] = self.XClientId
configuration.api_key['XClientSecret'] = self.XClientSecret
configuration.api_key['XClientSignature'] = self.XClientSignature
configuration.api_key['XPartnerMerchantId'] = self.XPartnerMerchantId
configuration.api_key['XPartnerKey'] = self.XPartnerKey
api_client.configuration = configuration
_params = locals()
_all_params = [
'x_api_version',
'dispute_id',
'x_request_id',
'x_idempotency_key'
]
_all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth',
'_content_type',
'_headers'
]
)
# validate the arguments
for _key, _val in _params['kwargs'].items():
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method PGFetchDisputeById" % _key
)
_params[_key] = _val
del _params['kwargs']
_collection_formats = {}
# process the path parameters
_path_params = {}
if _params['dispute_id']:
_path_params['dispute_id'] = _params['dispute_id']
# process the query parameters
_query_params = []
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
if x_request_id:
_header_params["x-request-id"] = x_request_id
if x_api_version:
_header_params["x-api-version"] = x_api_version
if x_idempotency_key:
_header_params["x-idempotency-key"] = x_idempotency_key
_header_params["x-sdk-platform"] = "pythonsdk-1.0.0"
# process the form parameters
_form_params = []
_files = {}
# process the body parameter
_body_params = None
# set the HTTP header `Accept`
_header_params['Accept'] = api_client.select_header_accept(
['application/json']) # noqa: E501
# authentication setting
_auth_settings = ['XPartnerAPIKey', 'XClientSecret', 'XPartnerMerchantID', 'XClientID', 'XClientSignatureHeader'] # noqa: E501
_response_types_map = {
'200': "DisputesEntity",
'400': "BadRequestError",
'401': "AuthenticationError",
'404': "ApiError404",
'409': "ApiError409",
'422': "IdempotencyError",
'429': "RateLimitError",
'500': "ApiError",
}
return api_client.call_api(
'/disputes/{dispute_id}', 'GET',
_path_params,
_query_params,
_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
response_types_map=_response_types_map,
auth_settings=_auth_settings,
async_req=_params.get('async_req'),
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
_preload_content=_params.get('_preload_content', True),
_request_timeout=_params.get('_request_timeout'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
@validate_arguments
def PGFetchOrderDisputes(self, x_api_version : Annotated[StrictStr, Field(description="API version to be used. Format is in YYYY-MM-DD")] = None, order_id : StrictStr = None, x_request_id : Annotated[Optional[StrictStr], Field(description="Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree")] = None, x_idempotency_key : Annotated[Optional[StrictStr], Field(description="An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. ")] = None, **kwargs) -> ApiResponse: # noqa: E501
"""Get Disputes by Order Id # noqa: E501
Use this API to get all Dispute details by specifying the Order ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.PGFetchOrderDisputes_with_http_info(x_api_version, order_id, x_request_id, x_idempotency_key, async_req=True)
>>> result = thread.get()
:param x_api_version: API version to be used. Format is in YYYY-MM-DD (required)
:type x_api_version: str
:param order_id: (required)
:type order_id: str
:param x_request_id: Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
:type x_request_id: str
:param x_idempotency_key: An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.
:type x_idempotency_key: UUID
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the ApiResponse.data will
be set to none and raw_data will store the
HTTP response body without reading/decoding.
Default is True.
:type _preload_content: bool, optional
:param _return_http_data_only: response data instead of ApiResponse
object with status code, headers, etc
:type _return_http_data_only: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(List[DisputesEntity], status_code(int), headers(HTTPHeaderDict))
"""
x_api_version = self.XApiVersion
api_client = ApiClient.get_default()
host = "https://api.cashfree.com/pg"
if self.XEnvironment == CFEnvironment.SANDBOX:
host = "https://sandbox.self.com/pg"
configuration = Configuration(
host = host
)
configuration.api_key['XClientID'] = self.XClientId
configuration.api_key['XClientSecret'] = self.XClientSecret
configuration.api_key['XClientSignature'] = self.XClientSignature
configuration.api_key['XPartnerMerchantId'] = self.XPartnerMerchantId
configuration.api_key['XPartnerKey'] = self.XPartnerKey
api_client.configuration = configuration
_params = locals()
_all_params = [
'x_api_version',
'order_id',
'x_request_id',
'x_idempotency_key'
]
_all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth',
'_content_type',
'_headers'
]
)
# validate the arguments
for _key, _val in _params['kwargs'].items():
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method PGFetchOrderDisputes" % _key
)
_params[_key] = _val
del _params['kwargs']
_collection_formats = {}
# process the path parameters
_path_params = {}
if _params['order_id']:
_path_params['order_id'] = _params['order_id']
# process the query parameters
_query_params = []
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
if x_request_id:
_header_params["x-request-id"] = x_request_id
if x_api_version:
_header_params["x-api-version"] = x_api_version
if x_idempotency_key:
_header_params["x-idempotency-key"] = x_idempotency_key
_header_params["x-sdk-platform"] = "pythonsdk-1.0.0"
# process the form parameters
_form_params = []
_files = {}
# process the body parameter
_body_params = None
# set the HTTP header `Accept`
_header_params['Accept'] = api_client.select_header_accept(
['application/json']) # noqa: E501
# authentication setting
_auth_settings = ['XPartnerAPIKey', 'XClientSecret', 'XPartnerMerchantID', 'XClientID', 'XClientSignatureHeader'] # noqa: E501
_response_types_map = {
'200': "List[DisputesEntity]",
'400': "BadRequestError",
'401': "AuthenticationError",
'404': "ApiError404",
'409': "ApiError409",
'422': "IdempotencyError",
'429': "RateLimitError",
'500': "ApiError",
}
return api_client.call_api(
'/orders/{order_id}/disputes', 'GET',
_path_params,
_query_params,
_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
response_types_map=_response_types_map,
auth_settings=_auth_settings,
async_req=_params.get('async_req'),
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
_preload_content=_params.get('_preload_content', True),
_request_timeout=_params.get('_request_timeout'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
@validate_arguments
def PGFetchPaymentDisputes(self, x_api_version : Annotated[StrictStr, Field(description="API version to be used. Format is in YYYY-MM-DD")] = None, cf_payment_id : StrictInt = None, x_request_id : Annotated[Optional[StrictStr], Field(description="Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree")] = None, x_idempotency_key : Annotated[Optional[StrictStr], Field(description="An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. ")] = None, **kwargs) -> ApiResponse: # noqa: E501
"""Get Disputes by Payment ID # noqa: E501
Use this API to get all Dispute details by specifying the Payment ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.PGFetchPaymentDisputes_with_http_info(x_api_version, cf_payment_id, x_request_id, x_idempotency_key, async_req=True)
>>> result = thread.get()
:param x_api_version: API version to be used. Format is in YYYY-MM-DD (required)
:type x_api_version: str
:param cf_payment_id: (required)
:type cf_payment_id: int
:param x_request_id: Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
:type x_request_id: str
:param x_idempotency_key: An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.
:type x_idempotency_key: UUID
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the ApiResponse.data will
be set to none and raw_data will store the
HTTP response body without reading/decoding.