Skip to content

Chore: Update documentation #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 22, 2022
Merged

Chore: Update documentation #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs/Balance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,17 @@ You can only transfer from what you have
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'


# Fetch Balance

response = paystack.Balance.fetch()


pprint(response)
```
### Parameters
Expand Down Expand Up @@ -66,18 +69,17 @@ Balance Ledger
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

per_page = 56 # int | Number of records to fetch per page (optional)
page = 56 # int | The section to retrieve (optional)
_from = '2013-10-20T19:20:30+01:00' # datetime | The start date (optional)
to = '2013-10-20T19:20:30+01:00' # datetime | The end date (optional)

# Balance Ledger

response = paystack.Balance.ledger(per_page=per_page, page=page, _from=_from, to=to)
response = paystack.Balance.ledger(
)

pprint(response)
```
### Parameters
Expand Down
48 changes: 33 additions & 15 deletions docs/BulkCharge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,19 @@ Fetch Charges in a Batch
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

code = 'code_example' # str | Batch code

# Fetch Charges in a Batch

response = paystack.BulkCharge.charges(code)
response = paystack.BulkCharge.charges(
code,
)

pprint(response)
```
### Parameters
Expand Down Expand Up @@ -72,15 +76,19 @@ Fetch Bulk Charge Batch
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

code = 'code_example' # str | Batch code

# Fetch Bulk Charge Batch

response = paystack.BulkCharge.fetch(code)
response = paystack.BulkCharge.fetch(
code,
)

pprint(response)
```
### Parameters
Expand Down Expand Up @@ -122,14 +130,17 @@ Initiate Bulk Charge
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'


# Initiate Bulk Charge

response = paystack.BulkCharge.initiate()


pprint(response)
```
### Parameters
Expand Down Expand Up @@ -167,18 +178,17 @@ List Bulk Charge Batches
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

per_page = 56 # int | Number of records to fetch per page (optional)
page = 56 # int | The section to retrieve (optional)
_from = '2013-10-20T19:20:30+01:00' # datetime | The start date (optional)
to = '2013-10-20T19:20:30+01:00' # datetime | The end date (optional)

# List Bulk Charge Batches

response = paystack.BulkCharge.list(per_page=per_page, page=page, _from=_from, to=to)
response = paystack.BulkCharge.list(
)

pprint(response)
```
### Parameters
Expand Down Expand Up @@ -223,15 +233,19 @@ Pause Bulk Charge Batch
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

code = 'code_example' # str | Batch code

# Pause Bulk Charge Batch

response = paystack.BulkCharge.pause(code)
response = paystack.BulkCharge.pause(
code,
)

pprint(response)
```
### Parameters
Expand Down Expand Up @@ -273,15 +287,19 @@ Resume Bulk Charge Batch
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

code = 'code_example' # str | Batch code

# Resume Bulk Charge Batch

response = paystack.BulkCharge.resume(code)
response = paystack.BulkCharge.resume(
code,
)

pprint(response)
```
### Parameters
Expand Down
75 changes: 49 additions & 26 deletions docs/Charge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,19 @@ Check pending charge
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

reference = 'reference_example' # str |

# Check pending charge

response = paystack.Charge.check(reference)
response = paystack.Charge.check(
reference,
)

pprint(response)
```
### Parameters
Expand Down Expand Up @@ -73,26 +77,17 @@ Create Charge
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

email = 'email_example' # str | Customer's email address (optional)
amount = 'amount_example' # str | Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR (optional)
authorization_code = 'authorization_code_example' # str | An authorization code to charge. (optional)
pin = 'pin_example' # str | 4-digit PIN (send with a non-reusable authorization code) (optional)
reference = 'reference_example' # str | Unique transaction reference. Only -, .`, = and alphanumeric characters allowed. (optional)
birthday = '2013-10-20T19:20:30+01:00' # datetime | The customer's birthday in the format YYYY-MM-DD e.g 2017-05-16 (optional)
device_id = 'device_id_example' # str | This is the unique identifier of the device a user uses in making payment. Only -, .`, = and alphanumeric characters are allowed. (optional)
metadata = 'metadata_example' # str | Stringified JSON object of custom data (optional)
bank = paystack.Bank() # Bank | (optional)
mobile_money = paystack.MobileMoney() # MobileMoney | (optional)
ussd = paystack.USSD() # USSD | (optional)
eft = paystack.EFT() # EFT | (optional)

# Create Charge

response = paystack.Charge.create(email=email, amount=amount, authorization_code=authorization_code, pin=pin, reference=reference, birthday=birthday, device_id=device_id, metadata=metadata, bank=bank, mobile_money=mobile_money, ussd=ussd, eft=eft)
response = paystack.Charge.create(
)

pprint(response)
```
### Parameters
Expand Down Expand Up @@ -144,9 +139,10 @@ Submit Address
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

address = 'address_example' # str | Customer's address
city = 'city_example' # str | Customer's city
Expand All @@ -156,7 +152,14 @@ reference = 'reference_example' # str | The reference of the ongoing transaction

# Submit Address

response = paystack.Charge.submit_address(address, city, state, zipcode, reference)
response = paystack.Charge.submit_address(
address,
city,
state,
zipcode,
reference,
)

pprint(response)
```
### Parameters
Expand Down Expand Up @@ -201,16 +204,21 @@ Submit Birthday
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

birthday = 'birthday_example' # str | Customer's birthday in the format YYYY-MM-DD e.g 2016-09-21
reference = 'reference_example' # str | The reference of the ongoing transaction

# Submit Birthday

response = paystack.Charge.submit_birthday(birthday, reference)
response = paystack.Charge.submit_birthday(
birthday,
reference,
)

pprint(response)
```
### Parameters
Expand Down Expand Up @@ -252,16 +260,21 @@ Submit OTP
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

otp = 'otp_example' # str | Customer's OTP
reference = 'reference_example' # str | The reference of the ongoing transaction

# Submit OTP

response = paystack.Charge.submit_otp(otp, reference)
response = paystack.Charge.submit_otp(
otp,
reference,
)

pprint(response)
```
### Parameters
Expand Down Expand Up @@ -303,16 +316,21 @@ Submit Phone
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

phone = 'phone_example' # str | Customer's mobile number
reference = 'reference_example' # str | The reference of the ongoing transaction

# Submit Phone

response = paystack.Charge.submit_phone(phone, reference)
response = paystack.Charge.submit_phone(
phone,
reference,
)

pprint(response)
```
### Parameters
Expand Down Expand Up @@ -354,16 +372,21 @@ Submit PIN
* Bearer Authentication (bearerAuth):
```python
import paystack
from paystack.rest import ApiException
from pprint import pprint

# Set your API key based on domain (test or live mode)
paystack.api_key = 'sk_domain_xxxxxxxx'

pin = 'pin_example' # str | Customer's PIN
reference = 'reference_example' # str | Transaction reference that requires the PIN

# Submit PIN

response = paystack.Charge.submit_pin(pin, reference)
response = paystack.Charge.submit_pin(
pin,
reference,
)

pprint(response)
```
### Parameters
Expand Down
Loading