Skip to content

Commit f638e11

Browse files
committed
edited the README file
1 parent 806d90f commit f638e11

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ thepeer_instance = ThePeerInit("YOUR_API_KEY_HERE")
3030
This describes how to index a user on your account (this is usually the first step before using other methods)
3131

3232
```python
33-
test = thepeer.index_user("Osagie Iyayi", "iyayiemmanuel1@gmail.com", "iyayiemmanuel1@gmail.com")
33+
test = thepeer_instance.index_user("Osagie Iyayi", "iyayiemmanuel1@gmail.com", "iyayiemmanuel1@gmail.com")
3434
```
3535

3636
#### Parameters supported
@@ -47,7 +47,7 @@ This method validates incoming an [hmac](https://www.okta.com/identity-101/hmac/
4747
**Pro Tip:** it is used to verify that an incoming webhook event/response is coming from thepeer's servers
4848

4949
```python
50-
test = thepeer.validate_signature(data,signature)
50+
test = thepeer_instance.validate_signature(data,signature)
5151
```
5252
#### Parameters supported
5353

@@ -60,7 +60,7 @@ test = thepeer.validate_signature(data,signature)
6060
This method gets the information of an indexed user
6161

6262
```python
63-
test = thepeer.view_user("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd")
63+
test = thepeer_instance.view_user("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd")
6464
```
6565

6666
#### Parameters supported
@@ -74,7 +74,7 @@ test = thepeer.view_user("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd")
7474
This method returns all indexed users for a specific account
7575

7676
```python
77-
test = thepeer.all_users(1,15)
77+
test = thepeer_instance.all_users(1,15)
7878
```
7979

8080
#### Parameters supported
@@ -89,7 +89,7 @@ test = thepeer.all_users(1,15)
8989
This methods helps to update the details of an indexed user
9090

9191
```python
92-
test = thepeer.update_user(reference,**data)
92+
test = thepeer_instance.update_user(reference,**data)
9393
```
9494
#### Parameters supported
9595

@@ -100,15 +100,15 @@ test = thepeer.update_user(reference,**data)
100100

101101
### Sample
102102
```python
103-
test = thepeer.update_user("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd", identifier="iyayiemmanuel1@gmail.com",
103+
test = thepeer_instance.update_user("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd", identifier="iyayiemmanuel1@gmail.com",
104104
name="Osagie Iyayi",
105105
email="iyayiemmanuel1@gmail.com")
106106
```
107107
#### ```Remove an Indexed User```
108108
This methods helps to remove the details of an indexed user from a specific account
109109

110110
```python
111-
test = thepeer.delete_user("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd")
111+
test = thepeer_instance.delete_user("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd")
112112
```
113113

114114
#### Parameters supported
@@ -121,7 +121,7 @@ test = thepeer.delete_user("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd")
121121

122122
This method gets all payment links associated to an indexed user
123123
```python
124-
test = thepeer.get_user_links("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd")
124+
test = thepeer_instance.get_user_links("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd")
125125
```
126126
#### Parameters Required
127127

@@ -135,7 +135,7 @@ test = thepeer.get_user_links("3bbb0fbf-82fa-48a0-80eb-d2c0338fe7dd")
135135
This method gets the payment information located in a payment link
136136

137137
```python
138-
test = thepeer.get_single_link("da14a90c-61c2-4cf7-a837-e3112a2d0c3d")
138+
test = thepeer_instance.get_single_link("da14a90c-61c2-4cf7-a837-e3112a2d0c3d")
139139
```
140140

141141
#### Parameters Required
@@ -148,7 +148,7 @@ test = thepeer.get_single_link("da14a90c-61c2-4cf7-a837-e3112a2d0c3d")
148148
### ``` Charge A Link```
149149
This method allows a business to charge a user via their linked account
150150
```python
151-
test = thepeer.charge_link(link_id, amount, remark, currency)
151+
test = thepeer_instance.charge_link(link_id, amount, remark, currency)
152152
```
153153

154154
#### Parameters Required
@@ -164,7 +164,7 @@ test = thepeer.charge_link(link_id, amount, remark, currency)
164164
This method allows a business to authorize a direct charge request made by a user
165165

166166
```python
167-
test = thepeer.authorize_direct_charge(auth_charge_reference, event)
167+
test = thepeer_instance.authorize_direct_charge(auth_charge_reference, event)
168168
```
169169
#### Parameters Required
170170

@@ -179,7 +179,7 @@ test = thepeer.authorize_direct_charge(auth_charge_reference, event)
179179
### ```Get Transaction Detail```
180180
This method gets the details of a transaction
181181
```python
182-
test = thepeer.get_transaction_detail("eda58ee3-4f2c-4aa4-9da7-10a2b8ced453")
182+
test = thepeer_instance.get_transaction_detail("eda58ee3-4f2c-4aa4-9da7-10a2b8ced453")
183183
```
184184

185185
#### Parameters Required
@@ -191,7 +191,7 @@ test = thepeer.get_transaction_detail("eda58ee3-4f2c-4aa4-9da7-10a2b8ced453")
191191
### ```Refund Transaction```
192192
This method allows a business to refund a transaction back to the user for obvious reasons
193193
```python
194-
test = thepeer.refund_transaction("28e52edf-16d9-4921-8a54-ef34d7029707", "possible threat actor"):
194+
test = thepeer_instance.refund_transaction("28e52edf-16d9-4921-8a54-ef34d7029707", "possible threat actor"):
195195
```
196196

197197
#### Parameters Required

0 commit comments

Comments
 (0)