Skip to main content

Paystack

Project description

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.1
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

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 time
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.ApplePayApi(api_client)
    use_cursor = true # bool | A flag to indicate if cursor based pagination should be used (optional)
    next = 'next_example' # str | An alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data  (optional)
    previous = 'previous_example' # str | An alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data  (optional)

    try:
        # List Domains
        api_response = api_instance.apple_pay_list_domain(use_cursor=use_cursor, next=next, previous=previous)
        print("The response of ApplePayApi->apple_pay_list_domain:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApplePayApi->apple_pay_list_domain: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
ApplePayApi apple_pay_list_domain GET /apple-pay/domain List Domains
ApplePayApi apple_pay_register_domain POST /apple-pay/domain Register Domain
ApplePayApi apple_pay_unregister_domain DELETE /apple-pay/domain Unregister Domain
BalanceApi balance_fetch GET /balance Fetch Balance
BalanceApi balance_ledger GET /balance/ledger Balance Ledger
BankApi bank_list GET /bank List Banks
BankApi bank_resolve_account_number GET /bank/resolve Resolve Account Number
BankApi bank_validate_account_number POST /bank/validate Validate Bank Account
BulkChargeApi bulk_charge_charges GET /bulkcharge/{code}/charges List 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/authorization/deactivate Deactivate Authorization
CustomerApi customer_direct_debit_activation_charge PUT /customer/{id}/directdebit-activation-charge Direct Debit Activation Charge
CustomerApi customer_fetch GET /customer/{code} Fetch Customer
CustomerApi customer_fetch_mandate_authorizations GET /customer/{id}/directdebit-mandate-authorizations Fetch Mandate Authorizations
CustomerApi customer_initialize_authorization POST /customer/authorization/initialize Initialize Authorization
CustomerApi customer_initialize_direct_debit POST /customer/{id}/initialize-direct-debit Initialize Direct Debit
CustomerApi customer_list GET /customer List Customers
CustomerApi customer_risk_action POST /customer/set_risk_action Set Risk Action
CustomerApi customer_update PUT /customer/{code} Update Customer
CustomerApi customer_validate POST /customer/{code}/identification Validate Customer
CustomerApi customer_verify_authorization GET /customer/authorization/verify/{reference} Verify Authorization
DedicatedVirtualAccountApi dedicated_account_add_split POST /dedicated_account/split Split Dedicated Account Transaction
DedicatedVirtualAccountApi dedicated_account_assign POST /dedicated_account/assign Assign Dedicated Account
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/{id} Deactivate Dedicated Account
DedicatedVirtualAccountApi dedicated_account_fetch GET /dedicated_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
DedicatedVirtualAccountApi dedicated_account_requery GET /dedicated_account/requery Requery Dedicated Account
DirectDebitApi directdebit_list_mandate_authorizations GET /directdebit/mandate-authorizations List Mandate Authorizations
DirectDebitApi directdebit_trigger_activation_charge PUT /directdebit/activation-charge Trigger Activation Charge
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 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 Fetch 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
MiscellaneousApi miscellaneous_avs GET /address_verification/states List States (AVS)
MiscellaneousApi miscellaneous_list_countries GET /country List Countries
MiscellaneousApi miscellaneous_resolve_card_bin GET /decision/bin/{bin} Resolve Card BIN
OrderApi order_create POST /order Create Order
OrderApi order_fetch GET /order/{id} Fetch Order
OrderApi order_list GET /order List Orders
OrderApi order_product GET /order/product/{id} Fetch Product Orders
OrderApi order_validate GET /order/{code}/validate Validate Order
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
RefundApi refund_retry POST /refund/retry_with_customer_details/{id} Retry Refund
SettlementApi settlements_fetch GET /settlement List Settlements
SettlementApi settlements_transaction GET /settlement/{id}/transactions Fetch 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 Splits
SplitApi split_remove_subaccount POST /split/{id}/subaccount/remove Remove Subaccount from split
SplitApi split_update PUT /split/{id} Update Split
StorefrontApi storefront_add_products POST /storefront/{id}/product Add Products to Storefront
StorefrontApi storefront_create POST /storefront Create Storefront
StorefrontApi storefront_delete DELETE /storefront/{id} Delete Storefront
StorefrontApi storefront_duplicate POST /storefront/{id}/duplicate Duplicate Storefront
StorefrontApi storefront_fetch GET /storefront/{id} Fetch Storefront
StorefrontApi storefront_fetch_orders GET /storefront/{id}/order Fetch Storefront Orders
StorefrontApi storefront_list GET /storefront List Storefronts
StorefrontApi storefront_list_products GET /storefront/{id}/product List Storefront Products
StorefrontApi storefront_publish POST /storefront/{id}/publish Publish Storefront
StorefrontApi storefront_update PUT /storefront/{id} Update Storefront
StorefrontApi storefront_verify_slug GET /storefront/verify/{slug} Verify Storefront Slug
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
TerminalApi terminal_commission POST /terminal/commission_device Commission Terminal
TerminalApi terminal_decommission POST /terminal/decommission_device Decommission Terminal
TerminalApi terminal_fetch GET /terminal/{terminal_id} Fetch Terminal
TerminalApi terminal_fetch_event_status GET /terminal/{terminal_id}/event/{event_id} Fetch Event Status
TerminalApi terminal_fetch_terminal_status GET /terminal/{terminal_id}/presence Fetch Terminal Status
TerminalApi terminal_list GET /terminal List Terminals
TerminalApi terminal_send_event POST /terminal/{id}/event Send Event
TerminalApi terminal_update PUT /terminal/{terminal_id} Update Terminal
TransactionApi transaction_charge_authorization POST /transaction/charge_authorization Charge Authorization
TransactionApi transaction_check_authorization POST /transaction/check_authorization Check Authorization
TransactionApi transaction_event GET /transaction/{id}/event Get Transaction Event
TransactionApi transaction_export GET /transaction/export Export Transactions
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} 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 for Transfers
TransferApi transfer_disable_otp_finalize POST /transfer/disable_otp_finalize Finalize Disabling OTP for Transfers
TransferApi transfer_enable_otp POST /transfer/enable_otp Enable OTP requirement for Transfers
TransferApi transfer_export_transfer GET /transfer/export Export 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_create POST /transferrecipient Create Transfer Recipient
TransferRecipientApi transferrecipient_delete DELETE /transferrecipient/{code} Delete Transfer Recipient
TransferRecipientApi transferrecipient_fetch GET /transferrecipient/{code} Fetch Transfer recipient
TransferRecipientApi transferrecipient_list GET /transferrecipient List Transfer Recipients
TransferRecipientApi transferrecipient_update PUT /transferrecipient/{code} Update Transfer Recipient
VirtualTerminalApi virtual_terminal_add_split_code PUT /virtual_terminal/{code}/split_code Add Split Code to Virtual Terminal
VirtualTerminalApi virtual_terminal_create POST /virtual_terminal Create Virtual Terminal
VirtualTerminalApi virtual_terminal_deactivate PUT /virtual_terminal/{code}/deactivate Deactivate Virtual Terminal
VirtualTerminalApi virtual_terminal_delete_split_code DELETE /virtual_terminal/{code}/split_code Remove Split Code from Virtual Terminal
VirtualTerminalApi virtual_terminal_destination_assign POST /virtual_terminal/{code}/destination/assign Assign Destination to Virtual Terminal
VirtualTerminalApi virtual_terminal_destination_unassign POST /virtual_terminal/{code}/destination/unassign Unassign Destination from Virtual Terminal
VirtualTerminalApi virtual_terminal_fetch GET /virtual_terminal/{code} Fetch Virtual Terminal
VirtualTerminalApi virtual_terminal_list GET /virtual_terminal List Virtual Terminals
VirtualTerminalApi virtual_terminal_update PUT /virtual_terminal/{code} Update Virtual Terminal

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication

Author

techsupport@paystack.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alexasomba_paystack-1.1.6.tar.gz (320.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

alexasomba_paystack-1.1.6-py3-none-any.whl (728.1 kB view details)

Uploaded Python 3

File details

Details for the file alexasomba_paystack-1.1.6.tar.gz.

File metadata

  • Download URL: alexasomba_paystack-1.1.6.tar.gz
  • Upload date:
  • Size: 320.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for alexasomba_paystack-1.1.6.tar.gz
Algorithm Hash digest
SHA256 c6ad3e09e459c46a4f24f3fcc8b152ba9ac9f0a635e6367609a586c492ecfe94
MD5 9dd6ed86bbe3797b13189c28cc0cd5a5
BLAKE2b-256 6ddc0dad5d0d98e6fbace059ebfc6c2b63510e44fc781ea35d53dbd9e3f30452

See more details on using hashes here.

File details

Details for the file alexasomba_paystack-1.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for alexasomba_paystack-1.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 fd4867b4b134ce5ed4944c9604076cec397cfb80ef64fad20abf77275ee85174
MD5 d39bbb360cd47b8e06695c30e20be992
BLAKE2b-256 f55501fface2d974a740a422e3b1dfb6698159b492321d33b7b7c5c296c3793a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page