alexasomba-paystack 1.1.0

Paystack

alexasomba-paystack

The OpenAPI specification of the Paystack API that merchants and developers can harness to build financial solutions in Africa.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.1.0
• Generator version: 7.18.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://paystack.com/docs

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/alexasomba/paystack-openapi.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/alexasomba/paystack-openapi.git)

Then import the package:

import alexasomba_paystack

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import alexasomba_paystack

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import alexasomba_paystack
from alexasomba_paystack.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.paystack.co
# See configuration.py for a list of all supported configuration parameters.
configuration = alexasomba_paystack.Configuration(
    host = "https://api.paystack.co"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = alexasomba_paystack.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with alexasomba_paystack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alexasomba_paystack.BalanceApi(api_client)

    try:
        # Fetch Balance
        api_response = api_instance.balance_fetch()
        print("The response of BalanceApi->balance_fetch:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BalanceApi->balance_fetch: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.paystack.co

Class	Method	HTTP request	Description
BalanceApi	balance_fetch	GET /balance	Fetch Balance
BalanceApi	balance_ledger	GET /balance/ledger	Balance Ledger
BulkChargeApi	bulk_charge_charges	GET /bulkcharge/{code}/charges	Fetch Charges in a Batch
BulkChargeApi	bulk_charge_fetch	GET /bulkcharge/{code}	Fetch Bulk Charge Batch
BulkChargeApi	bulk_charge_initiate	POST /bulkcharge	Initiate Bulk Charge
BulkChargeApi	bulk_charge_list	GET /bulkcharge	List Bulk Charge Batches
BulkChargeApi	bulk_charge_pause	GET /bulkcharge/pause/{code}	Pause Bulk Charge Batch
BulkChargeApi	bulk_charge_resume	GET /bulkcharge/resume/{code}	Resume Bulk Charge Batch
ChargeApi	charge_check	GET /charge/{reference}	Check pending charge
ChargeApi	charge_create	POST /charge	Create Charge
ChargeApi	charge_submit_address	POST /charge/submit_address	Submit Address
ChargeApi	charge_submit_birthday	POST /charge/submit_birthday	Submit Birthday
ChargeApi	charge_submit_otp	POST /charge/submit_otp	Submit OTP
ChargeApi	charge_submit_phone	POST /charge/submit_phone	Submit Phone
ChargeApi	charge_submit_pin	POST /charge/submit_pin	Submit PIN
CustomerApi	customer_create	POST /customer	Create Customer
CustomerApi	customer_deactivate_authorization	POST /customer/deactivate_authorization	Deactivate Authorization
CustomerApi	customer_fetch	GET /customer/{code}	Fetch Customer
CustomerApi	customer_list	GET /customer	List Customers
CustomerApi	customer_risk_action	POST /customer/set_risk_action	White/blacklist Customer
CustomerApi	customer_update	PUT /customer/{code}	Update Customer
CustomerApi	customer_validate	POST /customer/{code}/identification	Validate Customer
DedicatedVirtualAccountApi	dedicated_account_add_split	POST /dedicated_account/split	Split Dedicated Account Transaction
DedicatedVirtualAccountApi	dedicated_account_available_providers	GET /dedicated_account/available_providers	Fetch Bank Providers
DedicatedVirtualAccountApi	dedicated_account_create	POST /dedicated_account	Create Dedicated Account
DedicatedVirtualAccountApi	dedicated_account_deactivate	DELETE /dedicated_account/{account_id}	Deactivate Dedicated Account
DedicatedVirtualAccountApi	dedicated_account_fetch	GET /dedicated_account/{account_id}	Fetch Dedicated Account
DedicatedVirtualAccountApi	dedicated_account_list	GET /dedicated_account	List Dedicated Accounts
DedicatedVirtualAccountApi	dedicated_account_remove_split	DELETE /dedicated_account/split	Remove Split from Dedicated Account
DisputeApi	dispute_download	GET /dispute/export	Export Disputes
DisputeApi	dispute_evidence	POST /dispute/{id}/evidence	Add Evidence
DisputeApi	dispute_fetch	GET /dispute/{id}	Fetch Dispute
DisputeApi	dispute_list	GET /dispute	List Disputes
DisputeApi	dispute_resolve	PUT /dispute/{id}/resolve	Resolve a Dispute
DisputeApi	dispute_transaction	GET /dispute/transaction/{id}	List Transaction Disputes
DisputeApi	dispute_update	PUT /dispute/{id}	Update Dispute
DisputeApi	dispute_upload_url	GET /dispute/{id}/upload_url	Get Upload URL
IntegrationApi	integration_fetch_payment_session_timeout	GET /integration/payment_session_timeout	Fetch Payment Session Timeout
IntegrationApi	integration_update_payment_session_timeout	PUT /integration/payment_session_timeout	Update Payment Session Timeout
PageApi	page_add_products	POST /page/{id}/product	Add Products
PageApi	page_check_slug_availability	GET /page/check_slug_availability/{slug}	Check Slug Availability
PageApi	page_create	POST /page	Create Page
PageApi	page_fetch	GET /page/{id}	Fetch Page
PageApi	page_list	GET /page	List Pages
PageApi	page_update	PUT /page/{id}	Update Page
PaymentRequestApi	payment_request_archive	POST /paymentrequest/archive/{id}	Archive Payment Request
PaymentRequestApi	payment_request_create	POST /paymentrequest	Create Payment Request
PaymentRequestApi	payment_request_fetch	GET /paymentrequest/{id}	Fetch Payment Request
PaymentRequestApi	payment_request_finalize	POST /paymentrequest/finalize/{id}	Finalize Payment Request
PaymentRequestApi	payment_request_list	GET /paymentrequest	List Payment Request
PaymentRequestApi	payment_request_notify	POST /paymentrequest/notify/{id}	Send Notification
PaymentRequestApi	payment_request_totals	GET /paymentrequest/totals	Payment Request Total
PaymentRequestApi	payment_request_update	PUT /paymentrequest/{id}	Update Payment Request
PaymentRequestApi	payment_request_verify	GET /paymentrequest/verify/{id}	Verify Payment Request
PlanApi	plan_create	POST /plan	Create Plan
PlanApi	plan_fetch	GET /plan/{code}	Fetch Plan
PlanApi	plan_list	GET /plan	List Plans
PlanApi	plan_update	PUT /plan/{code}	Update Plan
ProductApi	product_create	POST /product	Create Product
ProductApi	product_delete	DELETE /product/{id}	Delete Product
ProductApi	product_fetch	GET /product/{id}	Fetch Product
ProductApi	product_list	GET /product	List Products
ProductApi	product_update	PUT /product/{id}	Update product
RefundApi	refund_create	POST /refund	Create Refund
RefundApi	refund_fetch	GET /refund/{id}	Fetch Refund
RefundApi	refund_list	GET /refund	List Refunds
SettlementApi	settlements_fetch	GET /settlement	Fetch Settlements
SettlementApi	settlements_transaction	GET /settlement/{id}/transaction	Settlement Transactions
SplitApi	split_add_subaccount	POST /split/{id}/subaccount/add	Add Subaccount to Split
SplitApi	split_create	POST /split	Create Split
SplitApi	split_fetch	GET /split/{id}	Fetch Split
SplitApi	split_list	GET /split	List/Search Splits
SplitApi	split_remove_subaccount	POST /split/{id}/subaccount/remove	Remove Subaccount from split
SplitApi	split_update	PUT /split/{id}	Update Split
SubaccountApi	subaccount_create	POST /subaccount	Create Subaccount
SubaccountApi	subaccount_fetch	GET /subaccount/{code}	Fetch Subaccount
SubaccountApi	subaccount_list	GET /subaccount	List Subaccounts
SubaccountApi	subaccount_update	PUT /subaccount/{code}	Update Subaccount
SubscriptionApi	subscription_create	POST /subscription	Create Subscription
SubscriptionApi	subscription_disable	POST /subscription/disable	Disable Subscription
SubscriptionApi	subscription_enable	POST /subscription/enable	Enable Subscription
SubscriptionApi	subscription_fetch	GET /subscription/{code}	Fetch Subscription
SubscriptionApi	subscription_list	GET /subscription	List Subscriptions
SubscriptionApi	subscription_manage_email	POST /subscription/{code}/manage/email	Send Update Subscription Link
SubscriptionApi	subscription_manage_link	GET /subscription/{code}/manage/link	Generate Update Subscription Link
TransactionApi	transaction_charge_authorization	POST /transaction/charge_authorization	Charge Authorization
TransactionApi	transaction_check_authorization	POST /transaction/check_authorization	Check Authorization
TransactionApi	transaction_download	GET /transaction/export	Export Transactions
TransactionApi	transaction_event	GET /transaction/{id}/event	Get Transaction Event
TransactionApi	transaction_fetch	GET /transaction/{id}	Fetch Transaction
TransactionApi	transaction_initialize	POST /transaction/initialize	Initialize Transaction
TransactionApi	transaction_list	GET /transaction	List Transactions
TransactionApi	transaction_partial_debit	POST /transaction/partial_debit	Partial Debit
TransactionApi	transaction_session	GET /transaction/{id}/session	Get Transaction Session
TransactionApi	transaction_timeline	GET /transaction/timeline/{id_or_reference}	Fetch Transaction Timeline
TransactionApi	transaction_totals	GET /transaction/totals	Transaction Totals
TransactionApi	transaction_verify	GET /transaction/verify/{reference}	Verify Transaction
TransferApi	transfer_bulk	POST /transfer/bulk	Initiate Bulk Transfer
TransferApi	transfer_disable_otp	POST /transfer/disable_otp	Disable OTP requirement for Transfers
TransferApi	transfer_disable_otp_finalize	POST /transfer/disable_otp_finalize	Finalize Disabling of OTP requirement for Transfers
TransferApi	transfer_download	GET /transfer/export	Export Transfers
TransferApi	transfer_enable_otp	POST /transfer/enable_otp	Enable OTP requirement for Transfers
TransferApi	transfer_fetch	GET /transfer/{code}	Fetch Transfer
TransferApi	transfer_finalize	POST /transfer/finalize_transfer	Finalize Transfer
TransferApi	transfer_initiate	POST /transfer	Initiate Transfer
TransferApi	transfer_list	GET /transfer	List Transfers
TransferApi	transfer_resend_otp	POST /transfer/resend_otp	Resend OTP for Transfer
TransferApi	transfer_verify	GET /transfer/verify/{reference}	Verify Transfer
TransferRecipientApi	transferrecipient_bulk	POST /transferrecipient/bulk	Bulk Create Transfer Recipient
TransferRecipientApi	transferrecipient_code_delete	DELETE /transferrecipient/{code}	Delete Transfer Recipient
TransferRecipientApi	transferrecipient_code_put	PUT /transferrecipient/{code}	Update Transfer recipient
TransferRecipientApi	transferrecipient_create	POST /transferrecipient	Create Transfer Recipient
TransferRecipientApi	transferrecipient_fetch	GET /transferrecipient/{code}	Fetch Transfer recipient
TransferRecipientApi	transferrecipient_list	GET /transferrecipient	List Transfer Recipients
VerificationApi	verification_avs	GET /address_verification/states	List States (AVS)
VerificationApi	verification_fetch_banks	GET /bank	Fetch Banks
VerificationApi	verification_list_countries	GET /country	List Countries
VerificationApi	verification_resolve_account_number	GET /bank/resolve	Resolve Account Number
VerificationApi	verification_resolve_card_bin	GET /decision/bin/{bin}	Resolve Card BIN

Documentation For Models

• Accepted
• Bank
• BulkChargeInitiate
• BulkChargeInitiateRequestInner1
• ChargeCreateRequest
• ChargeSubmitAddress
• ChargeSubmitBirthday
• ChargeSubmitOTP
• ChargeSubmitPhone
• ChargeSubmitPin
• CustomerCreate
• CustomerDeactivateAuthorization
• CustomerRiskAction
• CustomerUpdate
• CustomerValidate
• CustomerValidation
• DedicatedVirtualAccountCreate
• DedicatedVirtualAccountSplit
• DisputeEvidence
• DisputeResolve
• DisputeUpdate
• EFT
• Error
• MobileMoney
• PageCreate
• PageProduct
• PageUpdate
• PaymentRequestCreate
• PaymentRequestUpdate
• PlanCreate
• PlanUpdate
• ProductCreate
• ProductUpdate
• RefundCreate
• Response
• SplitCreate
• SplitSubaccounts
• SplitUpdate
• SubaccountCreate
• SubaccountUpdate
• SubscriptionCreate
• SubscriptionToggle
• TransactionChargeAuthorization
• TransactionCheckAuthorization
• TransactionInitialize
• TransactionPartialDebit
• TransferBulk
• TransferFinalize
• TransferFinalizeDisableOTP
• TransferInitiate
• TransferRecipientBulk
• TransferRecipientCreate
• TransferRecipientUpdate
• TransferResendOTP
• USSD
• VerificationBVNMatch

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication

Author

[e-mail]