Thepeer Python SDK
Python SDK for Thepeer.
Quick Start
- Install thepeer-sdk
pip install thepeer-sdk
- Signup to get your API keys here
Usage
Initiate
from thepeer_sdk import ThepeerSdkClient
thepeer_sdk_client = ThepeerSdkClient(
secret_key="SECRET_KEY_GOES_HERE"
)
# Get the list of all indexed users
thepeer_sdk_client.list_users()
Available Methods
User
-
index_user : Index a particular user on Thepeer
parameters:
- name(str)
- identifier(str) : unique user identifier
- email(str)
returns: dict
-
list_users : Get the list of all indexed users
parameters:
- page(int) : page number to return
- perPage(int) : amount of records to return per page
returns: dict
-
update_user : Update your user's identifier when they make a profile update to their identifier on your platform.
parameters:
- user_ref(str) : the reference returned when the user was indexed
- user_identifier(str) : unique user identifier
returns: dict
-
delete_user : Delete a user in the event that a user deactivates their account on your platform
parameters:
- user_ref(str) : the reference returned when the user was indexed
returns: dict
Link
-
get_user_links : This returns all linked accounts associated with a user.
parameters:
- user_ref(str) : the reference returned when the user was indexed
returns: dict
-
get_link : Get a linked account details
parameters:
- link_id(str) : link ID
returns: dict
Send
-
verify_receipt : Verify a particular receipt.
parameters:
- receipt_ref(str) : reference of the receipt to process
returns: dict
-
process_receipt : Process receipts generated from Thepeer inline.
parameters:
- receipt_ref(str) : reference of the receipt to process
- event(str)
returns: dict
Direct Charge
-
charge_link : Charge your user's linked account at any time
parameters:
- link_id(str) : id of the link to charge
- amount(int) : amount to charge
- remark(str) : narration of the charge
returns: dict
-
authorize_charge : authorize direct charge request via webhooks
parameters:
- charge_ref(str) : direct charge reference
- event(str)
returns: dict
Upgrade
pip install --upgrade thepeer-sdk
Extra
Visit the official Thepeer documentation for more information.
License
See LICENSE.
238 Sep 21, 2022
114 Dec 11, 2022
118 Sep 23, 2022
3.3k Dec 26, 2022
48 May 4, 2022
72 Aug 22, 2022
24 Dec 5, 2022
5 Oct 28, 2022
381 Dec 30, 2022
95 Dec 20, 2022
2 Feb 27, 2022
11 May 15, 2022
756 Jan 06, 2023
20 Sep 20, 2022
85 Jan 03, 2023
1 Dec 19, 2021
0 Sep 29, 2022
8 Aug 15, 2022
2 Jan 04, 2023
3 Dec 26, 2021
10 Oct 26, 2021
9 Dec 30, 2021
1 Dec 21, 2021
1 Dec 23, 2021
2 Jan 07, 2022
73 Jan 08, 2023
1.7k Dec 30, 2022
240 Jan 06, 2023
2 Jan 06, 2022