async-mpesa 0.2.1

A rust library for accessing mpesa apis
Documentation
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
use derive_builder::Builder;
use serde::{Deserialize, Serialize};

use crate::error::MpesaError;

#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "AccountBalanceRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "MpesaError"))]
pub struct AccountBalanceRequest {
    pub CommandID: String,
    pub PartyA: String,
    pub IdentifierType: String,
    pub Remarks: String,
    pub Initiator: String,
    pub SecurityCredential: String,
    pub QueueTimeoutURL: String,
    pub ResultURL: String
}

#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct AccountBalanceResponse {
    pub OriginatorConversationID: String,
    pub ConversationID: String,
    pub ResponseCode: u16,
    pub ResponseDescription: String
}

#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "ExpressPushRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "MpesaError"))]
pub struct ExpressPushRequest {
    pub BusinessShortCode: String,
    pub Password: String,
    pub Timestamp: String,
    pub TransactionType: String,
    pub Amount: String,
    pub PartyA: String,
    pub PartyB: String,
    pub PhoneNumber: String,
    pub CallBackURL: String,
    pub AccountReference: String,
    pub TransactionDesc: String
}

#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct ExpressPushResponse {
    MerchantRequestID: String,
    CheckoutRequestID: String,
    ResponseCode: String,
    ResponseDescription: String,
    CustomerMessage: String
}

#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "B2CRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "MpesaError"))]
pub struct B2CRequest {
    pub InitiatorName: String,
    pub SecurityCredential: String,
    pub CommandID: String,
    pub Amount: String,
    pub PartyA: String,
    pub PartyB: String,
    pub Remarks: String,
    pub QueueTimeOutURL: String,
    pub ResultURL: String,
    pub Occassion: String
}

#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct B2CResponse {
    pub OriginatorConversationID: String,
    pub ConversationID: String,
    pub ResponseDescription: String
}

#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "ExpressQueryRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "MpesaError"))]
pub struct ExpressQueryRequest {
    pub BusinessShortCode: String,
    /// Base64 encoding
    pub Password: String,
    /// Timesatmp of the transaction whose status is being checked 
    pub Timestamp: String,
    pub CheckoutRequestID: String
}

#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct ExpressQueryResponse {
    pub ResponseCode: i16,
    pub ResponseDescription: String,
    pub MerchantRequestID: String,
    pub CheckoutRequestID: String,
    pub ResultCode: i16,
    pub ResultDesc: String
}

#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "QRRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "MpesaError"))]
pub struct QRRequest {
    pub MerchantName: String,
    pub RefNo: String,
    pub Amount: String,
    pub TrxCode: String,
    pub CPI: String,
    pub Size: String
}

#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct QRResponse {
    pub ResponseCode: i16,
    pub RequestID: String,
    pub ResponseDescription: String,
    pub QRCode: String
}

/// Reverses a C2B M-Pesa Transaction
#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "ReversalRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "MpesaError"))]
pub struct ReversalRequest {
    pub Initiator: String,
    pub SecurityCredential: String,
    pub CommandID: String,
    /// Original transaction ID of the transaction being reversed
    pub TransactionID: String,
    pub Amount: String,
    /// The organization that received the funds
    pub ReceiverParty: String,
    pub ReceiverIdentifierType: String,
    pub ResultURL: String,
    pub QueueTimeoutURL: String,
    pub Remarks: String,
    pub Occasion: String
}

#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct ReversalResponse {
    pub OriginatorConversationID: String,
    pub ConversationID: String,
    pub ResponseCode: i16,
    pub ResponseDescription: String
}

#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "TaxRemitRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "MpesaError"))]
pub struct TaxRemitRequest {
    pub Initiator: String,
    pub SecurityCredential: String,
    pub CommandID: String,
    pub SenderIdentifierType: String,
    pub ReceiverIdentifierType: String,
    pub Amount: String,
    pub PartyA: String,
    pub PartyB: String,
    pub AccountReference: String,
    pub Remarks: String,
    pub QueueTimeoutURL: String,
    pub ResultURL: String
}

#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct TaxRemitResponse {
    pub OriginatorConversationID: String,
    pub ConversationID: String,
    pub ResponseCode: i16,
    pub ResponseDescription: String
}

#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "TransactionStatusRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "MpesaError"))]
pub struct TransactionStatusRequest {
    pub Initiator: String,
    pub SecurityCredential: String,
    pub CommandID: String,
    pub TranscationID: String,
    pub OriginatorConversationID: String,
    pub PartyA: i64,
    pub IdentifierType: u16,
    pub ResultURL: String,
    pub QueueTimeoutURL: String,
    pub Remarks: String,
    pub Occasion: String
}

#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct TransactionStatusResponse {
    OriginatorConversationID: String,
    ConversationID: String,
    ResponseCode: u16,
    ResponseDescription: String
}

#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "BusinessBuyGoodsRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "MpesaError"))]
pub struct BusinessBuyGoodsRequest {
    pub Initiator: String,
    pub SecurityCredential: String,
    pub CommandID: String,
    pub SenderIdentifierType: String,
    pub ReceiverIdentifierType: String,
    pub Amount: String,
    pub PartyA: String,
    pub PartyB: String,
    pub AccountReference: String,
    pub Requester: String,
    pub Remarks: String,
    pub QueueTimeoutURL: String,
    pub ResultURL: String,
}

#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct BusinessBuyGoodsResponse {
    OriginatorConversationID: String,
    ConversationID: String,
    ResponseCode: u16,
    ResponseDescription: String
}

#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "BusinessPayBillRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "MpesaError"))]
pub struct BusinessPayBillRequest {
    pub Initiator: String,
    pub SecurityCredential: String,
    pub CommandID: String,
    pub SenderIdentifierType: String,
    pub ReceiverIdentifierType: String,
    pub Amount: String,
    pub PartyA: String,
    pub PartyB: String,
    pub AccountReference: String,
    pub Requester: String,
    pub Remarks: String,
    pub QueueTimeoutURL: String,
    pub ResultURL: String,
}

#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct BusinessPayBillResponse {
    OriginatorConversationID: String,
    ConversationID: String,
    ResponseCode: u16,
    ResponseDescription: String
}

#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "SingleInvoicingRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
#[builder(build_fn(error = "MpesaError"))]
pub struct SingleInvoicingRequest {
    externalReference: String,
    billedFullName: String,
    billedPhoneNumber: String,
    billedPeriod: String,
    invoiceName: String,
    dueDate: String,
    accountReference: String,
    amount: String,
    invoiceItems: Vec<InvoiceItems>
}

#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct SingleInvoicingResponse {
    Status_Message: String,
    resmg: String,
    rescode: i32,
}

#[allow(non_snake_case)]
#[derive(Debug, Serialize, Clone)]
pub struct InvoiceItems {
    itemName: String,
    amount: String,
}


#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "BillOnboardingRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
pub struct BillOnboardingRequest {
    shortcode: String,
    email: String,
    officialContact: String,
    sendReminders: String,
    logo: String,
    Callbackurl: String,
}


#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct BillOnboardingResponse {
    app_key: String,
    resmsg: String,
    rescode: String,
}


#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "ReconciliationRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
pub struct ReconciliationRequest {
    transactionId: String,
    paidAmount: String,
    msisdn: String,
    dateCreated: String,
    accountReference: String,
    shortCode: String,
}


#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct ReconciliationResponse {
    resmsg: String,
    rescode: String,
}


#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "CancelInvoiceRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
pub struct CancelInvoiceRequest {
    externalReference: String,
}


#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct CancelInvoiceResponse {
    Status_Message: String,
    resmsg: String,
    rescode: String,
    error: Vec<String>,
}


#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "BillUpdateRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
pub struct BillUpdateRequest {
    shortcode: String,
    email: String,
    officialContact: String,
    sendReminders: String,
    logo: String,
    Callbackurl: String,
}


#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct BillUpdateResponse {
    resmsg: String,
    rescode: String,
}


#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "B2bExpressRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
pub struct B2bExpressRequest {
    primaryShortCode: String,
    receiverShortCode: String,
    amount: String,
    paymentRef: String,
    CallBackUrl: String,
    partnerName: String,
    RequestRefID: String,
}


#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct B2bExpressResponse {
    code: String,
    status: String,
}


#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "B2cTopUpRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
pub struct B2cTopUpRequest {
    Initiator: String,
    SecurityCredential: String,
    CommandID: String,
    SenderIdentifierType: String,
    ReceiverIdentifierType: String,
    Amount: String,
    PartyA: String,
    PartyB: String,
    AccountReference: String,
    Requester: String,
    Remarks: String,
    QueueTimeOutURL: String,
    ResultURL: String,
}


#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct B2cTopUpResponse {
    OriginatorConversationID: String,
    ConversationID: String,
    ResponseCode: String,
    ResponseDescription: String,
}


#[allow(non_snake_case)]
#[derive(Debug, Builder, Serialize, Clone)]
#[builder(name = "RatibaRequestArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option))]
#[builder(derive(Debug))]
pub struct RatibaRequest {
    StandingOrderName: String,
    StartDate: String,
    EndDate: String,
    BusinessShortCode: String,
    TransactionType: String,
    ReceiverPartyIdentifierType: String,
    Amount: String,
    PartyA: String,
    CallBackURL: String,
    AccountReference: String,
    TransactionDesc: String,
    Frequency: String,
}


#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct RatibaResponse {
    ResponseHeader: ResponseHeaderRatiba,
    ResponseBody: ResponseBodyRatiba,
}

#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct ResponseHeaderRatiba {
    responseRefID: String,
    responseCode: String,
    responseDescription: String,
    ResultDesc: String,
}

#[allow(non_snake_case)]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
pub struct ResponseBodyRatiba {
    responseDescription: String,
    responseCode: String,
}