pluggy-sdk

Pluggy's main API to review data and execute connectors

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

API version: 1.0.0
Package version: 1.0.0.post42
Generator version: 7.13.0-SNAPSHOT
Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://pluggy.ai

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/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import pluggy_sdk

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 pluggy_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import pluggy_sdk
from pluggy_sdk.rest import ApiException
from pprint import pprint

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

# 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 API key authorization: default
configuration.api_key['default'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['default'] = 'Bearer'


# Enter a context with an instance of the API client
with pluggy_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pluggy_sdk.AccountApi(api_client)
    item_id = 'd0f8a8c0-e8e3-11e9-b210-d663bd873d93' # str | Item primary identifier
    type = 'BANK' # str | Parameter to filter between bank accounts and credit accounts (optional)

    try:
        # List
        api_response = api_instance.accounts_list(item_id, type=type)
        print("The response of AccountApi->accounts_list:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountApi->accounts_list: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.pluggy.ai

Class	Method	HTTP request	Description
AccountApi	accounts_list	GET /accounts	List
AccountApi	accounts_retrieve	GET /accounts/{id}	Retrieve
AuthApi	auth_create	POST /auth	Create API Key
AuthApi	connect_token_create	POST /connect_token	Create Connect Token
BenefitApi	benefit_retrieve_by_id	GET /benefits/{id}	Retrieve
BenefitApi	benefits_list	GET /benefits	List
BillApi	bills_list	GET /bills	List
BillApi	bills_retrieve	GET /bills/{id}	Retrieve
BoletoManagementApi	boleto_cancel	POST /boletos/{id}/cancel	Cancel Boleto
BoletoManagementApi	boleto_connection_create	POST /boleto-connections	Connect boleto credentials
BoletoManagementApi	boleto_connection_create_from_item	POST /boleto-connections/from-item	Create boleto connection from Item
BoletoManagementApi	boleto_create	POST /boletos	Issue Boleto
BoletoManagementApi	boleto_get	GET /boletos/{id}	Get Boleto
BulkPaymentApi	bulk_payment_create	POST /payments/bulk	Create
BulkPaymentApi	bulk_payment_delete	DELETE /payments/bulk/{id}	Delete
BulkPaymentApi	bulk_payment_retrieve	GET /payments/bulk/{id}	Retrieve
BulkPaymentApi	bulk_payments_list	GET /payments/bulk	List
CategoryApi	categories_list	GET /categories	List
CategoryApi	categories_retrieve	GET /categories/{id}	Retrieve
CategoryApi	client_category_rules_create	POST /categories/rules	Create Category Rule
CategoryApi	client_category_rules_list	GET /categories/rules	List Category Rules
ConnectorApi	connector_retrieve	GET /connectors/{id}	Retrieve
ConnectorApi	connectors_list	GET /connectors	List
ConnectorApi	connectors_validate	POST /connectors/{id}/validate	Validate
ConsentApi	consent_retrieve	GET /consents/{id}	Retrieve
ConsentApi	consents_list	GET /consents	List
IdentityApi	identity_find_by_item	GET /identity	Find by item
IdentityApi	identity_retrieve	GET /identity/{id}	Retrieve
InvestmentApi	investment_transactions_list	GET /investments/{id}/transactions	List investment transactions
InvestmentApi	investments_list	GET /investments	List
InvestmentApi	investments_retrieve	GET /investments/{id}	Retrieve
ItemsApi	items_create	POST /items	Create
ItemsApi	items_delete	DELETE /items/{id}	Delete
ItemsApi	items_disable_autosync	PATCH /items/{id}/disable-auto-sync	Disable item auto sync
ItemsApi	items_retrieve	GET /items/{id}	Retrieve
ItemsApi	items_send_mfa	POST /items/{id}/mfa	Send MFA
ItemsApi	items_update	PATCH /items/{id}	Update
LoanApi	loans_list	GET /loans	List
LoanApi	loans_retrieve	GET /loans/{id}	Retrieve
PaymentCustomerApi	payment_customer_create	POST /payments/customers	Create
PaymentCustomerApi	payment_customer_delete	DELETE /payments/customers/{id}	Delete
PaymentCustomerApi	payment_customer_retrieve	GET /payments/customers/{id}	Retrieve
PaymentCustomerApi	payment_customer_update	PATCH /payments/customers/{id}	Update
PaymentCustomerApi	payment_customers_list	GET /payments/customers	List
PaymentIntentApi	payment_intent_create	POST /payments/intents	Create
PaymentIntentApi	payment_intent_retrieve	GET /payments/intents/{id}	Retrieve
PaymentIntentApi	payment_intents_list	GET /payments/intents	List
PaymentRecipientApi	payment_recipient_create	POST /payments/recipients	Create
PaymentRecipientApi	payment_recipient_delete	DELETE /payments/recipients/{id}	Delete
PaymentRecipientApi	payment_recipient_institutions_retrieve	GET /payments/recipients/institutions/{id}	Retrieve Institution
PaymentRecipientApi	payment_recipient_retrieve	GET /payments/recipients/{id}	Retrieve
PaymentRecipientApi	payment_recipient_update	PATCH /payments/recipients/{id}	Update
PaymentRecipientApi	payment_recipients_institution_list	GET /payments/recipients/institutions	List Institutions
PaymentRecipientApi	payment_recipients_list	GET /payments/recipients	List
PaymentRequestApi	payment_request_create	POST /payments/requests	Create
PaymentRequestApi	payment_request_create_boleto	POST /payments/requests/boleto	Create boleto payment request
PaymentRequestApi	payment_request_create_pix_qr	POST /payments/requests/pix-qr	Create PIX QR payment request
PaymentRequestApi	payment_request_delete	DELETE /payments/requests/{id}	Delete
PaymentRequestApi	payment_request_receipt_create	POST /payments/requests/{id}/receipts	Create Payment Receipt
PaymentRequestApi	payment_request_receipt_list	GET /payments/requests/{id}/receipts	List Payment Receipts
PaymentRequestApi	payment_request_receipt_retrieve	GET /payments/requests/{payment-request-id}/receipts/{payment-receipt-id}	Retrieve Payment Receipt
PaymentRequestApi	payment_request_refund	POST /payments/requests/{id}/refund	Refund Payment Request
PaymentRequestApi	payment_request_retrieve	GET /payments/requests/{id}	Retrieve
PaymentRequestApi	payment_request_update	PATCH /payments/requests/{id}	Update
PaymentRequestApi	payment_requests_list	GET /payments/requests	List
PaymentScheduleApi	payment_schedules_cancel	POST /payments/requests/{id}/schedules/cancel	Cancel Payment Schedule Authorization
PaymentScheduleApi	payment_schedules_cancel_specific	POST /payments/requests/{id}/schedules/{scheduleId}/cancel	Cancel Payment Schedule Authorization
PaymentScheduleApi	payment_schedules_list	GET /payments/requests/{id}/schedules	List Schedules
SmartAccountApi	smart_account_balance_retrieve	GET /payments/smart-accounts/{id}/balance	Retrieve Balance
SmartAccountApi	smart_account_create	POST /payments/smart-accounts	Create
SmartAccountApi	smart_account_retrieve	GET /payments/smart-accounts/{id}	Retrieve
SmartAccountApi	smart_account_transfer	GET /payments/smart-accounts/{id}/transfers/{transfer_id}	Retrieve Transfer
SmartAccountApi	smart_account_transfer_create	POST /payments/smart-accounts/{id}/transfers	Create Transfer
SmartAccountApi	smart_accounts_list	GET /payments/smart-accounts	List
SmartTransferApi	smart_tranfers_preauthorizations_list	GET /smart-transfers/preauthorizations	List preauthorizations
SmartTransferApi	smart_transfer_payment_create	POST /smart-transfers/payments	Create payment
SmartTransferApi	smart_transfer_paymentretrieve	GET /smart-transfers/payments/{id}	Retrieve payment
SmartTransferApi	smart_transfer_preauthorization_create	POST /smart-transfers/preauthorizations	Create preauthorization
SmartTransferApi	smart_transfer_preauthorization_retrieve	GET /smart-transfers/preauthorizations/{id}	Retrieve preauthorization
TransactionApi	transactions_list	GET /transactions	List
TransactionApi	transactions_retrieve	GET /transactions/{id}	Retrieve
TransactionApi	transactions_update	PATCH /transactions/{id}	Update
WebhookApi	webhooks_create	POST /webhooks	Create
WebhookApi	webhooks_delete	DELETE /webhooks/{id}	Delete
WebhookApi	webhooks_list	GET /webhooks	List
WebhookApi	webhooks_retrieve	GET /webhooks/{id}	Retrieve
WebhookApi	webhooks_update	PATCH /webhooks/{id}	Update

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

default

Type: API key
API key parameter name: X-API-KEY
Location: HTTP header

Author

hello@pluggy.ai

Release files for pluggy-sdk 1.0.0.post42

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pluggy-sdk 1.0.0.post42
File	Size	Uploaded
pluggy_sdk-1.0.0.post42.tar.gz	177.6 kB	Apr 12, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for pluggy-sdk 1.0.0.post42
File	Interpreter	ABI	Platform	Reset
pluggy_sdk-1.0.0.post42-py3-none-any.whl 419.1 kB Apr 12, 2025	Python 3	none	any	Details

Total release size: 596.8 kB

Release files / pluggy_sdk-1.0.0.post42.tar.gz

Download URL	pluggy_sdk-1.0.0.post42.tar.gz
Size	177.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`8742d89f7c6adaa497797167ba33c0eba447870f76843835ee0b3ec70ecd5cab`
BLAKE2b-256 checksum How to use checksums	`9d30751f5381347336cd01a20151b86a986448dabb101f2feac48c488414616c`
Upload date	Apr 12, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.12.9`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/diraol/pluggy-python
Publishing commit: github.com/diraol/pluggy-python/tree/0951ef5bb56cdb787ca3bc01510bc6e01c515574

Workflow

Publishing configuration: github.com/diraol/pluggy-python/blob/0951ef5bb56cdb787ca3bc01510bc6e01c515574/.github/workflows/update-lib.yaml
Publishing logs: github.com/diraol/pluggy-python/actions/runs/14414867876/attempts/1

Artifact

Subject: pluggy_sdk-1.0.0.post42.tar.gz
SHA-256 checksum: 8742d89f7c6adaa497797167ba33c0eba447870f76843835ee0b3ec70ecd5cab Verifying attestations

Release files / pluggy_sdk-1.0.0.post42-py3-none-any.whl

Download URL	pluggy_sdk-1.0.0.post42-py3-none-any.whl
Size	419.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`21d2e0877ef6cdd8a0deff2b8c564cead33aab5ba82d91f278af058f7831b6f7`
BLAKE2b-256 checksum How to use checksums	`87677ee38f378f49910ccb5e28f75a241c3cf4f100565da2196b4c215f4c50cf`
Upload date	Apr 12, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.12.9`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/diraol/pluggy-python
Publishing commit: github.com/diraol/pluggy-python/tree/0951ef5bb56cdb787ca3bc01510bc6e01c515574

Workflow

Publishing configuration: github.com/diraol/pluggy-python/blob/0951ef5bb56cdb787ca3bc01510bc6e01c515574/.github/workflows/update-lib.yaml
Publishing logs: github.com/diraol/pluggy-python/actions/runs/14414867876/attempts/1

Artifact

Subject: pluggy_sdk-1.0.0.post42-py3-none-any.whl
SHA-256 checksum: 21d2e0877ef6cdd8a0deff2b8c564cead33aab5ba82d91f278af058f7831b6f7 Verifying attestations