You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+121
Original file line number
Diff line number
Diff line change
@@ -89,6 +89,8 @@ This is used to facilitate card transactions.
89
89
90
90
*```.verify```
91
91
92
+
*```.refund```
93
+
92
94
*```.getTypeOfArgsRequired```
93
95
94
96
*```.updatePayload```
@@ -318,6 +320,27 @@ except RaveExceptions.CardChargeError as e:
318
320
```
319
321
#### NB: when charging saved cards, you do not need to call rave.card.Validate()
320
322
323
+
324
+
### ```.refund(flwRef, amount)```
325
+
326
+
You can call this to refund a full or partial amount of a transaction that was completed successfully. You have to pass the flw reference generated at the point of verifing the transaction. This is the ```flwRef``` in the ```res``` parameter returned any of the calls (```charge``` or ```validate```).
327
+
328
+
A sample verify call is:
329
+
330
+
```py
331
+
res = rave.Card.refund(data["flwRef"], amount)
332
+
```
333
+
334
+
#### Returns
335
+
336
+
This call returns a dict with ```status```, ```AmountRefunded```, ```disburse_ref``` and ```disburse_status``` which indicates whether the transaction was completed successfully.
@@ -508,6 +531,24 @@ except RaveExceptions.TransactionVerificationError as e:
508
531
print(e.err["flwRef"])
509
532
```
510
533
534
+
### ```.refund(flwRef, amount)```
535
+
536
+
You can call this to refund a full or partial amount of a transaction that was completed successfully. You have to pass the flw reference generated at the point of verifing the transaction. This is the ```flwRef``` in the ```res``` parameter returned any of the calls (```charge``` or ```validate```).
537
+
538
+
A sample verify call is:
539
+
540
+
```py
541
+
res = rave.Account.refund(data["flwRef"], amount)
542
+
```
543
+
544
+
#### Returns
545
+
546
+
This call returns a dict with ```status```, ```AmountRefunded```, ```disburse_ref``` and ```disburse_status``` which indicates whether the transaction was completed successfully.
@@ -634,6 +675,25 @@ This call returns a dict with ```txRef```, ```flwRef``` and ```transactionComple
634
675
635
676
If your call could not be completed successfully, a ```TransactionVerificationError``` is raised.
636
677
678
+
### ```.refund(flwRef, amount)```
679
+
680
+
You can call this to refund a full or partial amount of a transaction that was completed successfully. You have to pass the flw reference generated at the point of verifing the transaction. This is the ```flwRef``` in the ```res``` parameter returned any of the calls (```charge``` or ```validate```).
681
+
682
+
A sample verify call is:
683
+
684
+
```py
685
+
res = rave.GhMobile.refund(data["flwRef"], amount)
686
+
```
687
+
688
+
#### Returns
689
+
690
+
This call returns a dict with ```status```, ```AmountRefunded```, ```disburse_ref``` and ```disburse_status``` which indicates whether the transaction was completed successfully.
@@ -743,6 +803,26 @@ This call returns a dict with ```txRef```, ```flwRef``` and ```transactionComple
743
803
744
804
If your call could not be completed successfully, a ```TransactionVerificationError``` is raised.
745
805
806
+
807
+
### ```.refund(flwRef, amount)```
808
+
809
+
You can call this to refund a full or partial amount of a transaction that was completed successfully. You have to pass the flw reference generated at the point of verifing the transaction. This is the ```flwRef``` in the ```res``` parameter returned any of the calls (```charge``` or ```validate```).
810
+
811
+
A sample verify call is:
812
+
813
+
```py
814
+
res = rave.Mpesa.refund(data["flwRef"], amount)
815
+
```
816
+
817
+
#### Returns
818
+
819
+
This call returns a dict with ```status```, ```AmountRefunded```, ```disburse_ref``` and ```disburse_status``` which indicates whether the transaction was completed successfully.
@@ -853,6 +933,26 @@ This call returns a dict with ```txRef```, ```flwRef``` and ```transactionComple
853
933
854
934
If your call could not be completed successfully, a ```TransactionVerificationError``` is raised.
855
935
936
+
937
+
### ```.refund(flwRef, amount)```
938
+
939
+
You can call this to refund a full or partial amount of a transaction that was completed successfully. You have to pass the flw reference generated at the point of verifing the transaction. This is the ```flwRef``` in the ```res``` parameter returned any of the calls (```charge``` or ```validate```).
940
+
941
+
A sample verify call is:
942
+
943
+
```py
944
+
res = rave.UGMobile.refund(data["flwRef"], amount)
945
+
```
946
+
947
+
#### Returns
948
+
949
+
This call returns a dict with ```status```, ```AmountRefunded```, ```disburse_ref``` and ```disburse_status``` which indicates whether the transaction was completed successfully.
@@ -963,6 +1063,27 @@ This call returns a dict with ```txRef```, ```flwRef``` and ```transactionComple
963
1063
964
1064
If your call could not be completed successfully, a ```TransactionVerificationError``` is raised.
965
1065
1066
+
1067
+
### ```.refund(flwRef, amount)```
1068
+
1069
+
You can call this to refund a full or partial amount of a transaction that was completed successfully. You have to pass the flw reference generated at the point of verifing the transaction. This is the ```flwRef``` in the ```res``` parameter returned any of the calls (```charge``` or ```validate```).
1070
+
1071
+
A sample verify call is:
1072
+
1073
+
```py
1074
+
res = rave.ZBMobile.refund(data["flwRef"], amount)
1075
+
```
1076
+
1077
+
#### Returns
1078
+
1079
+
This call returns a dict with ```status```, ```AmountRefunded```, ```disburse_ref``` and ```disburse_status``` which indicates whether the transaction was completed successfully.
0 commit comments