-
Notifications
You must be signed in to change notification settings - Fork 0
/
MpesaLib.xml
1496 lines (1495 loc) · 84.5 KB
/
MpesaLib.xml
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>MpesaLib</name>
</assembly>
<members>
<member name="T:MpesaLib.AccountBalanceDto">
<summary>
Accountbalance data transfer object
</summary>
</member>
<member name="P:MpesaLib.AccountBalanceDto.Initiator">
<summary>
This is the credential/username used to authenticate the transaction request.
</summary>
</member>
<member name="P:MpesaLib.AccountBalanceDto.SecurityCredential">
<summary>
Base64 encoded string of the Security Credential, which is encrypted using M-Pesa public key and
validates the transaction on M-Pesa Core system.
</summary>
</member>
<member name="P:MpesaLib.AccountBalanceDto.CommandID">
<summary>
A unique command passed to the M-Pesa system.
</summary>
</member>
<member name="P:MpesaLib.AccountBalanceDto.PartyA">
<summary>
The shortcode of the organisation receiving the transaction.
</summary>
</member>
<member name="P:MpesaLib.AccountBalanceDto.IdentifierType">
<summary>
Type of the organisation receiving the transaction.
</summary>
</member>
<member name="P:MpesaLib.AccountBalanceDto.Remarks">
<summary>
Comments that are sent along with the transaction.
</summary>
</member>
<member name="P:MpesaLib.AccountBalanceDto.QueueTimeOutURL">
<summary>
The timeout end-point that receives a timeout message.
</summary>
</member>
<member name="P:MpesaLib.AccountBalanceDto.ResultURL">
<summary>
The end-point that receives a successful transaction.
</summary>
</member>
<member name="M:MpesaLib.AccountBalanceDto.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String)">
<summary>
Accountbalance data transfer object
</summary>
<param name="intiator">
This is the credential/username used to authenticate the transaction request.
</param>
<param name="securityCredential">
Base64 encoded string of the Security Credential, which is encrypted using M-Pesa public key and
validates the transaction on M-Pesa Core system.
</param>
<param name="commandId">A unique command passed to the M-Pesa system.</param>
<param name="partyA">The shortcode of the organisation receiving the transaction.</param>
<param name="identifierType">Type of the organisation receiving the transaction.</param>
<param name="remarks">Comments that are sent along with the transaction.</param>
<param name="queueTimeoutUrl">The timeout end-point that receives a timeout message.</param>
<param name="resultUrl">The end-point that receives a successful transaction.</param>
</member>
<member name="T:MpesaLib.BusinessToBusinessDto">
<summary>
B2B Data transfer object
</summary>
</member>
<member name="P:MpesaLib.BusinessToBusinessDto.Initiator">
<summary>
This is the credential/username used to authenticate the transaction request.
</summary>
</member>
<member name="P:MpesaLib.BusinessToBusinessDto.SecurityCredential">
<summary>
Base64 encoded string of the Security Credential, which is encrypted using M-Pesa public key and
validates the transaction on M-Pesa Core system.
</summary>
</member>
<member name="P:MpesaLib.BusinessToBusinessDto.CommandID">
<summary>
Unique command for each transaction type, possible values are: BusinessPayBill, MerchantToMerchantTransfer,
MerchantTransferFromMerchantToWorking, MerchantServicesMMFAccountTransfer, AgencyFloatAdvance
</summary>
</member>
<member name="P:MpesaLib.BusinessToBusinessDto.SenderIdentifierType">
<summary>
Type of organization sending the transaction.
</summary>
</member>
<member name="P:MpesaLib.BusinessToBusinessDto.RecieverIdentifierType">
<summary>
Type of organization receiving the funds being transacted.
</summary>
</member>
<member name="P:MpesaLib.BusinessToBusinessDto.Amount">
<summary>
The amount being transacted.
</summary>
</member>
<member name="P:MpesaLib.BusinessToBusinessDto.PartyA">
<summary>
Organization’s short code initiating the transaction.
</summary>
</member>
<member name="P:MpesaLib.BusinessToBusinessDto.PartyB">
<summary>
Organization’s short code receiving the funds being transacted.
</summary>
</member>
<member name="P:MpesaLib.BusinessToBusinessDto.AccountReference">
<summary>
Account Reference mandatory for “BusinessPaybill” CommandID.
</summary>
</member>
<member name="P:MpesaLib.BusinessToBusinessDto.Remarks">
<summary>
Comments that are sent along with the transaction.
</summary>
</member>
<member name="P:MpesaLib.BusinessToBusinessDto.QueueTimeOutURL">
<summary>
The path that stores information of time out transactions. It should be properly validated to
make sure that it contains the port, URI and domain name or publicly available IP.
</summary>
</member>
<member name="P:MpesaLib.BusinessToBusinessDto.ResultURL">
<summary>
The path that receives results from M-Pesa. It should be properly validated to make sure
that it contains the port, URI and domain name or publicly available IP.
</summary>
</member>
<member name="M:MpesaLib.BusinessToBusinessDto.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String)">
<summary>
B2B data transfer object
</summary>
<param name="intiator">This is the credential/username used to authenticate the transaction request.</param>
<param name="securityCredential">
Base64 encoded string of the Security Credential, which is encrypted using M-Pesa public key and
validates the transaction on M-Pesa Core system.
</param>
<param name="commandId">
Unique command for each transaction type, possible values are: BusinessPayBill, MerchantToMerchantTransfer,
MerchantTransferFromMerchantToWorking, MerchantServicesMMFAccountTransfer, AgencyFloatAdvance
</param>
<param name="amount">The amount being transacted.</param>
<param name="partyA">Organization’s short code initiating the transaction.</param>
<param name="partyB">Organization’s short code receiving the funds being transacted.</param>
<param name="senderIdentifierType">Type of organization sending the transaction.</param>
<param name="receiverIdentifierType">Type of organization receiving the transaction.</param>
<param name="accountReference">Account Reference mandatory for “BusinessPaybill” CommandID.</param>
<param name="remarks">Comments that are sent along with the transaction.</param>
<param name="queueTimeoutUrl">
The path that stores information of time out transactions. It should be properly validated to
make sure that it contains the port, URI and domain name or publicly available IP.
</param>
<param name="resultUrl">
The path that receives results from M-Pesa. It should be properly validated to make sure
that it contains the port, URI and domain name or publicly available IP.
</param>
</member>
<member name="T:MpesaLib.BusinessToCustomerDto">
<summary>
B2C data transfer object
</summary>
</member>
<member name="P:MpesaLib.BusinessToCustomerDto.InitiatorName">
<summary>
The username of the M-Pesa B2C account API operator.
NOTE: the access channel for this operator must be API and the account must be in active status.
</summary>
</member>
<member name="P:MpesaLib.BusinessToCustomerDto.SecurityCredential">
<summary>
This is the value obtained after encrypting the API initiator password.
MpesaLib Provides the <c>Credentials.EncryptPassword</c> under MpesaLib.Helpers namespace to help you
with the encryption. You need a public certificate from Safaricom for either sandbox or live APIs for this to work.
</summary>
</member>
<member name="P:MpesaLib.BusinessToCustomerDto.CommandID">
<summary>
This is a unique command that specifies B2C transaction type.
SalaryPayment: This supports sending money to both registered and unregistered M-Pesa customers.
BusinessPayment: This is a normal business to customer payment, supports only M-Pesa registered customers.
PromotionPayment: This is a promotional payment to customers.The M-Pesa notification message is a
congratulatory message. Supports only M-Pesa registered customers.
</summary>
</member>
<member name="P:MpesaLib.BusinessToCustomerDto.Amount">
<summary>
The amount of money being sent to the customer.
</summary>
</member>
<member name="P:MpesaLib.BusinessToCustomerDto.PartyA">
<summary>
This is the B2C organization shortcode from which the money is to be sent.
</summary>
</member>
<member name="P:MpesaLib.BusinessToCustomerDto.PartyB">
<summary>
This is the customer mobile number to receive the amount.
The number should have the country code (254) without the plus sign i.e 2547XXXXXXXX.
</summary>
</member>
<member name="P:MpesaLib.BusinessToCustomerDto.Remarks">
<summary>
Any additional information to be associated with the transaction. (Upto 100 characters)
</summary>
</member>
<member name="P:MpesaLib.BusinessToCustomerDto.QueueTimeOutURL">
<summary>
This is the URL to be specified in your request that will be used by API Proxy to send notification
incase the payment request is timed out while awaiting processing in the queue.
</summary>
</member>
<member name="P:MpesaLib.BusinessToCustomerDto.ResultURL">
<summary>
This is the URL to be specified in your request that will be used by M-Pesa to send notification upon
processing of the payment request.
</summary>
</member>
<member name="P:MpesaLib.BusinessToCustomerDto.Occasion">
<summary>
Any additional information to be associated with the transaction. (Upto 100 characters)
</summary>
</member>
<member name="M:MpesaLib.BusinessToCustomerDto.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String)">
<summary>
B2C data transfer object
</summary>
<param name="intiatorName">
The username of the M-Pesa B2C account API operator.
NOTE: the access channel for this operator must be API and the account must be in active status.
</param>
<param name="securityCredential">
This is the value obtained after encrypting the API initiator password.
MpesaLib Provides the <c>Credentials.EncryptPassword</c> under MpesaLib.Helpers namespace to help you
with the encryption. You need a public certificate from Safaricom for either sandbox or live APIs for this to work.
</param>
<param name="commandId">
This is a unique command that specifies B2C transaction type.
SalaryPayment: This supports sending money to both registered and unregistered M-Pesa customers.
BusinessPayment: This is a normal business to customer payment, supports only M-Pesa registered customers.
PromotionPayment: This is a promotional payment to customers.The M-Pesa notification message is a
congratulatory message. Supports only M-Pesa registered customers.
</param>
<param name="amount">The amount of money being sent to the customer.</param>
<param name="partyA">This is the B2C organization shortcode from which the money is to be sent.</param>
<param name="partyB">
This is the customer mobile number to receive the amount.
The number should have the country code (254) without the plus sign i.e 2547XXXXXXXX.
</param>
<param name="remarks">Any additional information to be associated with the transaction. (Upto 100 characters)</param>
<param name="occasion">Any additional information to be associated with the transaction. (Upto 100 characters)</param>
<param name="queueTimeoutUrl">
This is the URL to be specified in your request that will be used by API Proxy to send notification
incase the payment request is timed out while awaiting processing in the queue.
</param>
<param name="resultUrl">
This is the URL to be specified in your request that will be used by M-Pesa to send notification upon
processing of the payment request.
</param>
</member>
<member name="T:MpesaLib.CustomerToBusinessRegisterUrlDto">
<summary>
C2B Register URLs data transfer object
</summary>
</member>
<member name="P:MpesaLib.CustomerToBusinessRegisterUrlDto.ShortCode">
<summary>
The short code of the organization.
</summary>
</member>
<member name="P:MpesaLib.CustomerToBusinessRegisterUrlDto.ResponseType">
<summary>
This parameter specifies what is to happen if for any reason the validation URL is nor reachable.
Note that, This is the default action value that determines what MPesa will do in the scenario that your
endpoint is unreachable or is unable to respond on time.
Only two values are allowed: Completed or Cancelled.
Completed means MPesa will automatically complete your transaction, in the event MPesa is unable to
reach your Validation URL
Cancelled means MPesa will automatically cancel the transaction, in the event MPesa is unable to
reach your Validation URL.
</summary>
</member>
<member name="P:MpesaLib.CustomerToBusinessRegisterUrlDto.ConfirmationURL">
<summary>
This is the URL that receives the confirmation request from API upon payment completion.
</summary>
</member>
<member name="P:MpesaLib.CustomerToBusinessRegisterUrlDto.ValidationURL">
<summary>
This is the URL that receives the validation request from API upon payment submission.
The validation URL is only called if the external validation on the registered shortcode is enabled.
(By default External Validation is dissabled, contact MPESA API team if you want this enbaled for your app)
</summary>
</member>
<member name="M:MpesaLib.CustomerToBusinessRegisterUrlDto.#ctor(System.String,System.String,System.String,System.String)">
<summary>
C2B Register URLs data transfer object
</summary>
<param name="shortCode">The short code of the organization. </param>
<param name="responseType">
This parameter specifies what is to happen if for any reason the validation URL is nor reachable.
Note that, This is the default action value that determines what MPesa will do in the scenario that your
endpoint is unreachable or is unable to respond on time.
Only two values are allowed: Completed or Cancelled.
Completed means MPesa will automatically complete your transaction, in the event MPesa is unable to
reach your Validation URL
Cancelled means MPesa will automatically cancel the transaction, in the event MPesa is unable to
reach your Validation URL.
</param>
<param name="confirmationUrl">This is the URL that receives the confirmation request from API upon payment completion.</param>
<param name="validationUrl">
This is the URL that receives the validation request from API upon payment submission.
The validation URL is only called if the external validation on the registered shortcode is enabled.
(By default External Validation is dissabled, contact MPESA API team if you want this enbaled for your app)
</param>
</member>
<member name="T:MpesaLib.CustomerToBusinessSimulateDto">
<summary>
C2B Simulate data transfer object
</summary>
</member>
<member name="P:MpesaLib.CustomerToBusinessSimulateDto.ShortCode">
<summary>
This is the Short Code receiving the amount being transacted.
</summary>
</member>
<member name="P:MpesaLib.CustomerToBusinessSimulateDto.CommandID">
<summary>
This is a unique identifier of the transaction type: There are two types of these Identifiers:
CustomerPayBillOnline: This is used for Pay Bills shortcodes.
CustomerBuyGoodsOnline: This is used for Buy Goods shortcodes.
Buy Default this property is set to CustomerPayBillOnline
</summary>
</member>
<member name="P:MpesaLib.CustomerToBusinessSimulateDto.Amount">
<summary>
This is the amount being transacted. The parameter expected is a numeric value.
</summary>
</member>
<member name="P:MpesaLib.CustomerToBusinessSimulateDto.Msisdn">
<summary>
This is the phone number initiating the C2B transaction.(format: 2547XXXXXXXX)
</summary>
</member>
<member name="P:MpesaLib.CustomerToBusinessSimulateDto.BillRefNumber">
<summary>
This is used on CustomerPayBillOnline option only.
This is where a customer is expected to enter a unique bill identifier, e.g an Account Number.
</summary>
</member>
<member name="M:MpesaLib.CustomerToBusinessSimulateDto.#ctor(System.String,System.String,System.String,System.String,System.String)">
<summary>
C2B Simulate data transfer object
</summary>
<param name="shortCode">This is the Short Code receiving the amount being transacted.</param>
<param name="commandId">
This is a unique identifier of the transaction type: There are two types of these Identifiers:
CustomerPayBillOnline: This is used for Pay Bills shortcodes.
CustomerBuyGoodsOnline: This is used for Buy Goods shortcodes.
Buy Default this property is set to CustomerPayBillOnline
</param>
<param name="amount">
This is the amount being transacted. The parameter expected is a numeric value.
</param>
<param name="msisdn">This is the phone number initiating the C2B transaction.(format: 2547XXXXXXXX)</param>
<param name="billReferenceNumber">
This is used on CustomerPayBillOnline option only.
This is where a customer is expected to enter a unique bill identifier, e.g an Account Number.
</param>
</member>
<member name="T:MpesaLib.Helpers.Credentials">
<summary>
Encrypt password helper class for MpesaLib
</summary>
<remarks>
M-Pesa Core authenticates a transaction by decrypting the security credentials.
Security credentials are generated by encrypting the base64 encoded initiator password with M-Pesa’s public key,
a X509 certificate.
The algorithm for generating security credentials is as follows:
1. Write the unencrypted password into a byte array.
2. Encrypt the array with the M-Pesa public key certificate.Use the RSA algorithm,
and use PKCS #1.5 padding (not OAEP), and add the result to the encrypted stream.
3. Convert the resulting encrypted byte array into a string using base64 encoding.
The resulting base64 encoded string is the security credential.
</remarks>
</member>
<member name="M:MpesaLib.Helpers.Credentials.EncryptPassword(System.String,System.String)">
<summary>
Encrypts Mpesa API Security Credential password
</summary>
<param name="certificatePath"></param>
<param name="password"></param>
<returns>
Encrypted password
</returns>
</member>
<member name="M:MpesaLib.Helpers.Credentials.ReadCertificateFile(System.String)">
<summary>
Reads and returns certificate data in bytes
</summary>
<param name="fileName"></param>
<returns>
Certificate data in bytes
</returns>
</member>
<member name="T:MpesaLib.Helpers.Exceptions.MpesaApiException">
<summary>
Mpesa Api Exceptions Helper class
</summary>
</member>
<member name="P:MpesaLib.Helpers.Exceptions.MpesaApiException.StatusCode">
<summary>
Http Status code
</summary>
</member>
<member name="P:MpesaLib.Helpers.Exceptions.MpesaApiException.Content">
<summary>
Content from response body
</summary>
</member>
<member name="T:MpesaLib.Helpers.RSACryptoServiceProviderExtensions">
<summary>
RSACryptoServiceProvider Extensions
</summary>
</member>
<member name="M:MpesaLib.Helpers.RSACryptoServiceProviderExtensions.FromXmlString2(System.Security.Cryptography.RSACryptoServiceProvider,System.String)">
<summary>
Imports the specified XML String into the crypto service provider
</summary>
<remarks>
.NET Core 2.0 doesn't provide an implementation of RSACryptoServiceProvider.FromXmlString/ToXmlString, so we have to do it ourselves.
Source: https://gist.github.com/Jargon64/5b172c452827e15b21882f1d76a94be4/
</remarks>
</member>
<member name="M:MpesaLib.Helpers.RSACryptoServiceProviderExtensions.ToXmlString3(System.Security.Cryptography.RSA,System.Boolean)">
<summary>
ToXmlString extention method for .net standard, netcoreapp
</summary>
<param name="rsa"></param>
<param name="includePrivateParameters"></param>
<returns></returns>
</member>
<member name="M:MpesaLib.Helpers.RSACryptoServiceProviderExtensions.ToXmlString2(System.Security.Cryptography.RSA,System.Boolean)">
<summary>
ToXmlString extention method for .net standard, netcoreapp
</summary>
<param name="rsa">RSA algorithm</param>
<param name="includePrivateParameters"></param>
<returns>XML String</returns>
</member>
<member name="T:MpesaLib.Helpers.Serialization.JSONStreamHelper">
<summary>
JSON Stream Serialization and Deserialization Helper Class
</summary>
</member>
<member name="M:MpesaLib.Helpers.Serialization.JSONStreamHelper.DeserializeFromStream(System.IO.Stream)">
<summary>
Deserializes data from stream into a json object
</summary>
<param name="stream">stream of bytes</param>
<returns></returns>
</member>
<member name="T:MpesaLib.IMpesaClient">
<summary>
IMpesaClient Interface
</summary>
<remarks>
Provides all the Methods implemented by MpesaClient Class.
A developer can create their own implementation for example for tests/mocks by inheriting from this interface.
</remarks>
</member>
<member name="M:MpesaLib.IMpesaClient.GetAuthTokenAsync(System.String,System.String,System.String,System.Threading.CancellationToken)">
<summary>
GetAuthTokenAsync is an asynchronous method that requests for and returns an accesstoken from MPESA API Server.
</summary>
<param name="consumerKey">ConsumerKey provided by Safaricom in Daraja Portal.</param>
<param name="consumerSecret">ConsumerSecret provided by Safaricom in Daraja Portal.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.AuthToken</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A string of characters representing the accesstoken.</returns>
</member>
<member name="M:MpesaLib.IMpesaClient.GetAuthToken(System.String,System.String,System.String,System.Threading.CancellationToken)">
<summary>
GetAuthTokenAsync is an asynchronous method that requests for and returns an accesstoken from MPESA API Server.
</summary>
<param name="consumerKey">ConsumerKey provided by Safaricom in Daraja Portal.</param>
<param name="consumerSecret">ConsumerSecret provided by Safaricom in Daraja Portal.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.AuthToken</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A string of characters representing the accesstoken.</returns>
</member>
<member name="M:MpesaLib.IMpesaClient.MakeLipaNaMpesaOnlinePaymentAsync(MpesaLib.LipaNaMpesaOnlineDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Makes STK Push payment request to MPESA API Server.
</summary>
<param name="mpesaLipaOnlineDto">
Data trnasfer object containing properties for the Lipa Na Mpesa Online API endpoint.
</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.LipaNaMpesaOnline</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing LNMO response data from MPESA API Server</returns>
</member>
<member name="M:MpesaLib.IMpesaClient.MakeLipaNaMpesaOnlinePayment(MpesaLib.LipaNaMpesaOnlineDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Makes an STK Push payment request to MPESA API Server.
</summary>
<param name="mpesaLipaOnlineDto">
Data trnasfer object containing properties for the Lipa Na Mpesa Online API endpoint.
</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.LipaNaMpesaOnline</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API response</returns>
</member>
<member name="M:MpesaLib.IMpesaClient.QueryLipaNaMpesaTransactionAsync(MpesaLib.LipaNaMpesaQueryDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Queries Mpesa Online Transaction Status
</summary>
<param name="mpesaTransactionQueryDto">Transaction Query Data transfer object</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.QueryLipaNaMpesaOnlieTransaction</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>
A JSON string containing data from MPESA API reposnse
</returns>
<remarks>
Use only for transactions initiated with <c>MakeLipaNaMpesaOnlinePayment</c> method.
For Other transaction based methods (C2B,B2C,B2B) use <c>QueryMpesaTransactionStatusAsync</c> method.
</remarks>
</member>
<member name="M:MpesaLib.IMpesaClient.QueryLipaNaMpesaTransaction(MpesaLib.LipaNaMpesaQueryDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Queries Mpesa Online Transaction Status.
</summary>
<param name="mpesaTransactionQueryDto">Transaction Query Data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.QueryLipaNaMpesaOnlieTransaction</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>
A JSON string containing data from MPESA API reposnse.
</returns>
<remarks>
Use only for transactions initiated with <c>MakeLipaNaMpesaOnlinePayment</c> method.
For Other transaction based methods (C2B, B2C, B2B, Accountbalance, Reversal)
use <c>QueryMpesaTransactionStatusAsync</c> method.
</remarks>
</member>
<member name="M:MpesaLib.IMpesaClient.QueryAccountBalanceAsync(MpesaLib.AccountBalanceDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Queries MPESA Paybill Account balance.
</summary>
<param name="accountBalanceQueryDto">Account balance query data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.QueryAccountBalance</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
</member>
<member name="M:MpesaLib.IMpesaClient.QueryAccountBalance(MpesaLib.AccountBalanceDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Queries MPESA Paybill Account balance.
</summary>
<param name="accountBalanceQueryDto">Account balance query data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.QueryAccountBalance</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
</member>
<member name="M:MpesaLib.IMpesaClient.MakeB2BPaymentAsync(MpesaLib.BusinessToBusinessDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Makes a Business to Business payment request between Paybill numbers.
</summary>
<param name="businessToBusinessDto">B2B data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.BusinessToBusiness</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
</member>
<member name="M:MpesaLib.IMpesaClient.MakeB2BPayment(MpesaLib.BusinessToBusinessDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Makes a Business to Business payment request between Paybill numbers.
</summary>
<param name="businessToBusinessDto">B2B data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.BusinessToBusiness</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
</member>
<member name="M:MpesaLib.IMpesaClient.MakeB2CPaymentAsync(MpesaLib.BusinessToCustomerDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Makes a Business to Customer payment request. Paybill to Phone Number.
</summary>
<param name="businessToCustomerDto">B2C data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.BusinessToCustomer</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
<remarks>
Suitable for refunds, rewards or just about any transaction that involves a business paying a customer.
</remarks>
</member>
<member name="M:MpesaLib.IMpesaClient.MakeB2CPayment(MpesaLib.BusinessToCustomerDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Makes a Business to Customer payment request. Paybill to Phone Number.
</summary>
<param name="businessToCustomerDto">B2C data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.BusinessToCustomer</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
<remarks>
Suitable for refunds, rewards or just about any transaction that involves a business paying a customer.
</remarks>
</member>
<member name="M:MpesaLib.IMpesaClient.MakeC2BPaymentAsync(MpesaLib.CustomerToBusinessSimulateDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Simulates a Customer to Business payment request.
</summary>
<param name="customerToBusinessSimulateDto">C2B data transfer object</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.CustomerToBusinessSimulate</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
<remarks>
Use only for Simulation/testing. In production use <c>RegisterC2BUrlAsync</c> method to register
endpoints in your application that receive customer initiated transactions from the MPESA API
for confirmation and/or validation
</remarks>
</member>
<member name="M:MpesaLib.IMpesaClient.MakeC2BPayment(MpesaLib.CustomerToBusinessSimulateDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Simulates a Customer to Business payment request.
</summary>
<param name="customerToBusinessSimulateDto">C2B data transfer object</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.CustomerToBusinessSimulate</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
<remarks>
Use only for Simulation/testing. In production use <c>RegisterC2BUrlAsync</c> method to register
endpoints in your application that receive customer initiated transactions from the MPESA API
for confirmation and/or validation
</remarks>
</member>
<member name="M:MpesaLib.IMpesaClient.RegisterC2BUrlAsync(MpesaLib.CustomerToBusinessRegisterUrlDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Registers Customer to Business Confirmation and Validation URLs.
</summary>
<param name="customerToBusinessRegisterUrlDto">C2B Register URLs data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.RegisterC2BUrl</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
</member>
<member name="M:MpesaLib.IMpesaClient.RegisterC2BUrl(MpesaLib.CustomerToBusinessRegisterUrlDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Registers Customer to Business Confirmation and Validation URLs.
</summary>
<param name="customerToBusinessRegisterUrlDto">C2B Register URLs data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.RegisterC2BUrl</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
</member>
<member name="M:MpesaLib.IMpesaClient.ReverseMpesaTransactionAsync(MpesaLib.ReversalDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Reverses a Mpesa Transaction.
</summary>
<param name="reversalDto">Reversal data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.ReverseMpesaTransaction</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
</member>
<member name="M:MpesaLib.IMpesaClient.ReverseMpesaTransaction(MpesaLib.ReversalDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Reverses a Mpesa Transaction.
</summary>
<param name="reversalDto">Reversal data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.ReverseMpesaTransaction</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
</member>
<member name="M:MpesaLib.IMpesaClient.QueryMpesaTransactionStatusAsync(MpesaLib.MpesaTransactionStatusDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Queries the status of an Mpesa Transaction.
</summary>
<param name="mpesaTransactionStatusDto">Transaction Status data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.QueryMpesaTransactionStatus</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
</member>
<member name="M:MpesaLib.IMpesaClient.QueryMpesaTransactionStatus(MpesaLib.MpesaTransactionStatusDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Queries the status of an Mpesa Transaction.
</summary>
<param name="mpesaTransactionStatusDto">Transaction Status data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.QueryMpesaTransactionStatus</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
</member>
<member name="T:MpesaLib.LipaNaMpesaOnlineDto">
<summary>
STK Push data transfer object
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaOnlineDto.BusinessShortCode">
<summary>
This is organizations shortcode (Paybill or Buygoods - A 5 to 6 digit account number)
used to identify an organization and receive the transaction.
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaOnlineDto.Timestamp">
<summary>
This is the Timestamp of the transaction,
normaly in the formart of YEAR+MONTH+DATE+HOUR+MINUTE+SECOND (YYYYMMDDHHMMSS)
Each part should be atleast two digits apart from the year which takes four digits.
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaOnlineDto.TransactionType">
<summary>
This is the transaction type that is used to identify the transaction when sending the request to M-Pesa.
The transaction type for M-Pesa Express is "CustomerPayBillOnline"
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaOnlineDto.Amount">
<summary>
This is the Amount transacted, normally a numeric value. Money that customer pays to the Shorcode.
Only whole numbers are supported.
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaOnlineDto.PartyA">
<summary>
The phone number sending money. The parameter expected is a Valid Safaricom Mobile Number
that is M-Pesa registered in the format 2547XXXXXXXX
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaOnlineDto.PartyB">
<summary>
The organization receiving the funds. The parameter expected is a 5 to 6 digit.
This can be the same as BusinessShortCode value.
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaOnlineDto.PhoneNumber">
<summary>
The Mobile Number to receive the STK Pin Prompt.
This number can be the same as PartyA value.
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaOnlineDto.CallBackURL">
<summary>
A CallBack URL is a valid secure URL that is used to receive notifications from M-Pesa API.
It is the endpoint to which the results will be sent by M-Pesa API.
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaOnlineDto.AccountReference">
<summary>
Account Reference: This is an Alpha-Numeric parameter that is defined by your system as an Identifier
of the transaction for CustomerPayBillOnline transaction type. Along with the business name,
this value is also displayed to the customer in the STK PIN Prompt message.
Maximum of 12 characters.
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaOnlineDto.TransactionDesc">
<summary>
This is any additional information/comment that can be sent along with the request from your system.
Maximum of 13 Characters.
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaOnlineDto.Passkey">
<summary>
Lipa Na Mpesa Online PassKey
Provide the Passkey only if you want MpesaLib to Encode the Password for you.
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaOnlineDto.Password">
<summary>
This is the password used for encrypting the request sent: A base64 encoded string.
The base64 string is a combination of Shortcode+Passkey+Timestamp
The Defualt value is set by a private method that creates the necessary base64 encoded string
Don't set this property if you have set the passKey property.
</summary>
</member>
<member name="M:MpesaLib.LipaNaMpesaOnlineDto.#ctor(System.String,System.DateTime,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String)">
<summary>
Mpesa Lipa Na Mpesa STK Push data transfer object
</summary>
<param name="businessShortCode">
This is organizations shortcode (Paybill or Buygoods - A 5 to 6 digit account number)
used to identify an organization and receive the transaction.
</param>
<param name="timeStamp">
This is the Timestamp of the transaction,
normaly in the formart of YEAR+MONTH+DATE+HOUR+MINUTE+SECOND (YYYYMMDDHHMMSS)
Each part should be atleast two digits apart from the year which takes four digits.
</param>
<param name="transactionType">
This is the transaction type that is used to identify the transaction when sending the request to M-Pesa.
The transaction type for M-Pesa Express is "CustomerPayBillOnline"
</param>
<param name="amount">
This is the Amount transacted, normally a numeric value. Money that customer pays to the Shorcode.
Only whole numbers are supported.
</param>
<param name="partyA">
The phone number sending money. The parameter expected is a Valid Safaricom Mobile Number
that is M-Pesa registered in the format 2547XXXXXXXX
</param>
<param name="partyB">
The organization receiving the funds. The parameter expected is a 5 to 6 digit.
This can be the same as BusinessShortCode value.
</param>
<param name="phoneNumber">
The Mobile Number to receive the STK Pin Prompt.
This number can be the same as PartyA value.
</param>
<param name="callBackUrl">
A CallBack URL is a valid secure URL that is used to receive notifications from M-Pesa API.
It is the endpoint to which the results will be sent by M-Pesa API.
</param>
<param name="accountReference">
Account Reference: This is an Alpha-Numeric parameter that is defined by your system as an Identifier
of the transaction for CustomerPayBillOnline transaction type. Along with the business name,
this value is also displayed to the customer in the STK PIN Prompt message.
Maximum of 12 characters.
</param>
<param name="transactionDescription">
This is any additional information/comment that can be sent along with the request from your system.
Maximum of 13 Characters.
</param>
<param name="passkey">
Lipa Na Mpesa Online PassKey
Provide the Passkey only if you want MpesaLib to Encode the Password for you.
</param>
</member>
<member name="M:MpesaLib.LipaNaMpesaOnlineDto.CalculatePassword(System.String,System.String,System.String)">
<summary>
This method creates the necessary base64 encoded string that encrypts the request sent
</summary>
</member>
<member name="T:MpesaLib.LipaNaMpesaQueryDto">
<summary>
LipaNaMpesa Query transaction status data transfer object
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaQueryDto.BusinessShortCode">
<summary>
This is organizations shortcode (Paybill or Buygoods - A 5 to 6 digit account number)
used to identify an organization and receive the transaction.
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaQueryDto.Passkey">
<summary>
Lipa Na Mpesa Online PassKey
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaQueryDto.Password">
<summary>
This is the password used for encrypting the request sent: A base64 encoded string.
The base64 string is a combination of Shortcode+Passkey+Timestamp
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaQueryDto.Timestamp">
<summary>
This is the Timestamp of the transaction,
normaly in the formart of YEAR+MONTH+DATE+HOUR+MINUTE+SECOND (YYYYMMDDHHMMSS)
Each part should be atleast two digits apart from the year which takes four digits.
</summary>
</member>
<member name="P:MpesaLib.LipaNaMpesaQueryDto.CheckoutRequestID">
<summary>
This is a global unique identifier of the processed checkout transaction request.
e.g ws_CO_DMZ_123212312_2342347678234
</summary>
</member>
<member name="M:MpesaLib.LipaNaMpesaQueryDto.#ctor(System.String,System.String,System.DateTime,System.String)">
<summary>
LipaNaMpesa Query transaction status data transfer object
</summary>
<param name="businessShortCode">
This is organizations shortcode (Paybill or Buygoods - A 5 to 6 digit account number)
used to identify an organization and receive the transaction.
</param>
<param name="passkey">Lipa Na Mpesa Online PassKey</param>
<param name="timeStamp">
This is the Timestamp of the transaction,
normaly in the formart of YEAR+MONTH+DATE+HOUR+MINUTE+SECOND (YYYYMMDDHHMMSS)
Each part should be atleast two digits apart from the year which takes four digits.
</param>
<param name="checkoutRequestId">
This is a global unique identifier of the processed checkout transaction request.
e.g ws_CO_DMZ_123212312_2342347678234
</param>
</member>
<member name="M:MpesaLib.LipaNaMpesaQueryDto.CalculatePassword(System.String,System.String,System.String)">
<summary>
This method creates the necessary base64 encoded string that encrypts the request sent
</summary>
</member>
<member name="T:MpesaLib.MpesaClient">
<summary>
Mpesa Client Class provides all the methods that make the different API calls to MPESA Server
</summary>
</member>
<member name="M:MpesaLib.MpesaClient.#ctor(System.Net.Http.HttpClient)">
<summary>
MpesaClient takes in an instance of HttpClient
</summary>
<param name="httpClient">HttpClient Instance</param>
</member>
<member name="M:MpesaLib.MpesaClient.GetAuthToken(System.String,System.String,System.String,System.Threading.CancellationToken)">
<summary>
GetAuthTokenAsync is an asynchronous method that requests for and returns an accesstoken from MPESA API Server.
</summary>
<param name="consumerKey">ConsumerKey provided by Safaricom in Daraja Portal.</param>
<param name="consumerSecret">ConsumerSecret provided by Safaricom in Daraja Portal.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.AuthToken</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A string of characters representing the accesstoken.</returns>
</member>
<member name="M:MpesaLib.MpesaClient.GetAuthTokenAsync(System.String,System.String,System.String,System.Threading.CancellationToken)">
<summary>
GetAuthTokenAsync is an asynchronous method that requests for and returns an accesstoken from MPESA API Server.
</summary>
<param name="consumerKey">ConsumerKey provided by Safaricom in Daraja Portal.</param>
<param name="consumerSecret">ConsumerSecret provided by Safaricom in Daraja Portal.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.AuthToken</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A string of characters representing the accesstoken.</returns>
</member>
<member name="M:MpesaLib.MpesaClient.MakeB2BPayment(MpesaLib.BusinessToBusinessDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Makes a Business to Business payment request between Paybill numbers.
</summary>
<param name="businessToBusinessDto">B2B data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.BusinessToBusiness</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
</member>
<member name="M:MpesaLib.MpesaClient.MakeB2BPaymentAsync(MpesaLib.BusinessToBusinessDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Makes a Business to Business payment request between Paybill numbers.
</summary>
<param name="businessToBusinessDto">B2B data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.BusinessToBusiness</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
</member>
<member name="M:MpesaLib.MpesaClient.MakeB2CPayment(MpesaLib.BusinessToCustomerDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Makes a Business to Customer payment request. Paybill to Phone Number.
</summary>
<param name="businessToCustomerDto">B2C data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.BusinessToCustomer</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
<remarks>
Suitable for refunds, rewards or just about any transaction that involves a business paying a customer.
</remarks>
</member>
<member name="M:MpesaLib.MpesaClient.MakeB2CPaymentAsync(MpesaLib.BusinessToCustomerDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Makes a Business to Customer payment request. Paybill to Phone Number.
</summary>
<param name="businessToCustomerDto">B2C data transfer object.</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.BusinessToCustomer</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
<remarks>
Suitable for refunds, rewards or just about any transaction that involves a business paying a customer.
</remarks>
</member>
<member name="M:MpesaLib.MpesaClient.MakeC2BPayment(MpesaLib.CustomerToBusinessSimulateDto,System.String,System.String,System.Threading.CancellationToken)">
<summary>
Simulates a Customer to Business payment request.
</summary>
<param name="customerToBusinessSimulateDto">C2B data transfer object</param>
<param name="accesstoken">Acccesstoken retrieved by the <c>GetAuthTokenAsync</c> method.</param>
<param name="requestEndPoint">Set to <c>RequestEndPoint.CustomerToBusinessSimulate</c></param>
<param name="cancellationToken">Cancellation Token</param>
<returns>A JSON string containing data from MPESA API reposnse.</returns>
<remarks>
Use only for Simulation/testing. In production use <c>RegisterC2BUrlAsync</c> method to register