# pluggy-sdk
Pluggy's main API to review data and execute connectors
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Package version: 1.0.0.post50
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://pluggy.ai](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:
```sh
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:
```python
import pluggy_sdk
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import pluggy_sdk
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
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**](docs/AccountApi.md#accounts_list) | **GET** /accounts | List
*AccountApi* | [**accounts_retrieve**](docs/AccountApi.md#accounts_retrieve) | **GET** /accounts/{id} | Retrieve
*AuthApi* | [**auth_create**](docs/AuthApi.md#auth_create) | **POST** /auth | Create API Key
*AuthApi* | [**connect_token_create**](docs/AuthApi.md#connect_token_create) | **POST** /connect_token | Create Connect Token
*AutomaticPIXApi* | [**cancel_automatic_pix_schedule**](docs/AutomaticPIXApi.md#cancel_automatic_pix_schedule) | **POST** /payments/requests/{id}/automatic-pix/schedules/{scheduleId}/cancel | Cancel an Automatic PIX schedule
*AutomaticPIXApi* | [**payment_request_cancel_automatic_pix_consent**](docs/AutomaticPIXApi.md#payment_request_cancel_automatic_pix_consent) | **POST** /payments/requests/{id}/automatic-pix/cancel | Cancel an automatic PIX consent
*AutomaticPIXApi* | [**payment_request_create_automatic_pix**](docs/AutomaticPIXApi.md#payment_request_create_automatic_pix) | **POST** /payments/requests/automatic-pix | Create Automatic PIX payment request
*AutomaticPIXApi* | [**payment_request_create_automatic_pix_schedule**](docs/AutomaticPIXApi.md#payment_request_create_automatic_pix_schedule) | **POST** /payments/requests/{id}/automatic-pix/schedule | Schedule Automatic PIX payment
*AutomaticPIXApi* | [**payment_request_get_automatic_pix_schedule**](docs/AutomaticPIXApi.md#payment_request_get_automatic_pix_schedule) | **GET** /payments/requests/{requestId}/automatic-pix/schedules/{paymentId} | Get an automatic PIX scheduled payment
*AutomaticPIXApi* | [**payment_request_get_automatic_pix_schedules**](docs/AutomaticPIXApi.md#payment_request_get_automatic_pix_schedules) | **GET** /payments/requests/{id}/automatic-pix/schedules | List Automatic PIX scheduled payments
*AutomaticPIXApi* | [**retry_automatic_pix_schedule**](docs/AutomaticPIXApi.md#retry_automatic_pix_schedule) | **POST** /payments/requests/{id}/automatic-pix/schedules/{scheduleId}/retry | Retry an Automatic PIX schedule
*BillApi* | [**bills_list**](docs/BillApi.md#bills_list) | **GET** /bills | List
*BillApi* | [**bills_retrieve**](docs/BillApi.md#bills_retrieve) | **GET** /bills/{id} | Retrieve
*BoletoManagementApi* | [**boleto_cancel**](docs/BoletoManagementApi.md#boleto_cancel) | **POST** /boletos/{id}/cancel | Cancel Boleto
*BoletoManagementApi* | [**boleto_connection_create**](docs/BoletoManagementApi.md#boleto_connection_create) | **POST** /boleto-connections | Connect boleto credentials
*BoletoManagementApi* | [**boleto_connection_create_from_item**](docs/BoletoManagementApi.md#boleto_connection_create_from_item) | **POST** /boleto-connections/from-item | Create boleto connection from Item
*BoletoManagementApi* | [**boleto_create**](docs/BoletoManagementApi.md#boleto_create) | **POST** /boletos | Issue Boleto
*BoletoManagementApi* | [**boleto_get**](docs/BoletoManagementApi.md#boleto_get) | **GET** /boletos/{id} | Get Boleto
*CategoryApi* | [**categories_list**](docs/CategoryApi.md#categories_list) | **GET** /categories | List
*CategoryApi* | [**categories_retrieve**](docs/CategoryApi.md#categories_retrieve) | **GET** /categories/{id} | Retrieve
*CategoryApi* | [**client_category_rules_create**](docs/CategoryApi.md#client_category_rules_create) | **POST** /categories/rules | Create Category Rule
*CategoryApi* | [**client_category_rules_list**](docs/CategoryApi.md#client_category_rules_list) | **GET** /categories/rules | List Category Rules
*ConnectorApi* | [**connector_retrieve**](docs/ConnectorApi.md#connector_retrieve) | **GET** /connectors/{id} | Retrieve
*ConnectorApi* | [**connectors_list**](docs/ConnectorApi.md#connectors_list) | **GET** /connectors | List
*ConnectorApi* | [**connectors_validate**](docs/ConnectorApi.md#connectors_validate) | **POST** /connectors/{id}/validate | Validate
*ConsentApi* | [**consent_retrieve**](docs/ConsentApi.md#consent_retrieve) | **GET** /consents/{id} | Retrieve
*ConsentApi* | [**consents_list**](docs/ConsentApi.md#consents_list) | **GET** /consents | List
*IdentityApi* | [**identity_find_by_item**](docs/IdentityApi.md#identity_find_by_item) | **GET** /identity | Find by item
*IdentityApi* | [**identity_retrieve**](docs/IdentityApi.md#identity_retrieve) | **GET** /identity/{id} | Retrieve
*InvestmentApi* | [**investment_transactions_list**](docs/InvestmentApi.md#investment_transactions_list) | **GET** /investments/{id}/transactions | List investment transactions
*InvestmentApi* | [**investments_list**](docs/InvestmentApi.md#investments_list) | **GET** /investments | List
*InvestmentApi* | [**investments_retrieve**](docs/InvestmentApi.md#investments_retrieve) | **GET** /investments/{id} | Retrieve
*ItemsApi* | [**items_create**](docs/ItemsApi.md#items_create) | **POST** /items | Create
*ItemsApi* | [**items_delete**](docs/ItemsApi.md#items_delete) | **DELETE** /items/{id} | Delete
*ItemsApi* | [**items_disable_autosync**](docs/ItemsApi.md#items_disable_autosync) | **PATCH** /items/{id}/disable-auto-sync | Disable item auto sync
*ItemsApi* | [**items_retrieve**](docs/ItemsApi.md#items_retrieve) | **GET** /items/{id} | Retrieve
*ItemsApi* | [**items_send_mfa**](docs/ItemsApi.md#items_send_mfa) | **POST** /items/{id}/mfa | Send MFA
*ItemsApi* | [**items_update**](docs/ItemsApi.md#items_update) | **PATCH** /items/{id} | Update
*LoanApi* | [**loans_list**](docs/LoanApi.md#loans_list) | **GET** /loans | List
*LoanApi* | [**loans_retrieve**](docs/LoanApi.md#loans_retrieve) | **GET** /loans/{id} | Retrieve
*PaymentCustomerApi* | [**payment_customer_create**](docs/PaymentCustomerApi.md#payment_customer_create) | **POST** /payments/customers | Create
*PaymentCustomerApi* | [**payment_customer_delete**](docs/PaymentCustomerApi.md#payment_customer_delete) | **DELETE** /payments/customers/{id} | Delete
*PaymentCustomerApi* | [**payment_customer_retrieve**](docs/PaymentCustomerApi.md#payment_customer_retrieve) | **GET** /payments/customers/{id} | Retrieve
*PaymentCustomerApi* | [**payment_customer_update**](docs/PaymentCustomerApi.md#payment_customer_update) | **PATCH** /payments/customers/{id} | Update
*PaymentCustomerApi* | [**payment_customers_list**](docs/PaymentCustomerApi.md#payment_customers_list) | **GET** /payments/customers | List
*PaymentIntentApi* | [**payment_intent_create**](docs/PaymentIntentApi.md#payment_intent_create) | **POST** /payments/intents | Create
*PaymentIntentApi* | [**payment_intent_retrieve**](docs/PaymentIntentApi.md#payment_intent_retrieve) | **GET** /payments/intents/{id} | Retrieve
*PaymentIntentApi* | [**payment_intents_list**](docs/PaymentIntentApi.md#payment_intents_list) | **GET** /payments/intents | List
*PaymentRecipientApi* | [**payment_recipient_create**](docs/PaymentRecipientApi.md#payment_recipient_create) | **POST** /payments/recipients | Create
*PaymentRecipientApi* | [**payment_recipient_delete**](docs/PaymentRecipientApi.md#payment_recipient_delete) | **DELETE** /payments/recipients/{id} | Delete
*PaymentRecipientApi* | [**payment_recipient_institutions_retrieve**](docs/PaymentRecipientApi.md#payment_recipient_institutions_retrieve) | **GET** /payments/recipients/institutions/{id} | Retrieve Institution
*PaymentRecipientApi* | [**payment_recipient_retrieve**](docs/PaymentRecipientApi.md#payment_recipient_retrieve) | **GET** /payments/recipients/{id} | Retrieve
*PaymentRecipientApi* | [**payment_recipient_update**](docs/PaymentRecipientApi.md#payment_recipient_update) | **PATCH** /payments/recipients/{id} | Update
*PaymentRecipientApi* | [**payment_recipients_institution_list**](docs/PaymentRecipientApi.md#payment_recipients_institution_list) | **GET** /payments/recipients/institutions | List Institutions
*PaymentRecipientApi* | [**payment_recipients_list**](docs/PaymentRecipientApi.md#payment_recipients_list) | **GET** /payments/recipients | List
*PaymentRequestApi* | [**payment_request_create**](docs/PaymentRequestApi.md#payment_request_create) | **POST** /payments/requests | Create
*PaymentRequestApi* | [**payment_request_create_pix_qr**](docs/PaymentRequestApi.md#payment_request_create_pix_qr) | **POST** /payments/requests/pix-qr | Create PIX QR payment request
*PaymentRequestApi* | [**payment_request_delete**](docs/PaymentRequestApi.md#payment_request_delete) | **DELETE** /payments/requests/{id} | Delete
*PaymentRequestApi* | [**payment_request_retrieve**](docs/PaymentRequestApi.md#payment_request_retrieve) | **GET** /payments/requests/{id} | Retrieve
*PaymentRequestApi* | [**payment_request_update**](docs/PaymentRequestApi.md#payment_request_update) | **PATCH** /payments/requests/{id} | Update
*PaymentRequestApi* | [**payment_requests_list**](docs/PaymentRequestApi.md#payment_requests_list) | **GET** /payments/requests | List
*PaymentScheduleApi* | [**payment_schedules_cancel**](docs/PaymentScheduleApi.md#payment_schedules_cancel) | **POST** /payments/requests/{id}/schedules/cancel | Cancel Payment Schedule Authorization
*PaymentScheduleApi* | [**payment_schedules_cancel_specific**](docs/PaymentScheduleApi.md#payment_schedules_cancel_specific) | **POST** /payments/requests/{id}/schedules/{scheduleId}/cancel | Cancel Payment Schedule
*PaymentScheduleApi* | [**payment_schedules_list**](docs/PaymentScheduleApi.md#payment_schedules_list) | **GET** /payments/requests/{id}/schedules | List Schedules
*SmartTransferApi* | [**smart_tranfers_preauthorizations_list**](docs/SmartTransferApi.md#smart_tranfers_preauthorizations_list) | **GET** /smart-transfers/preauthorizations | List preauthorizations
*SmartTransferApi* | [**smart_transfer_payment_create**](docs/SmartTransferApi.md#smart_transfer_payment_create) | **POST** /smart-transfers/payments | Create payment
*SmartTransferApi* | [**smart_transfer_paymentretrieve**](docs/SmartTransferApi.md#smart_transfer_paymentretrieve) | **GET** /smart-transfers/payments/{id} | Retrieve payment
*SmartTransferApi* | [**smart_transfer_preauthorization_create**](docs/SmartTransferApi.md#smart_transfer_preauthorization_create) | **POST** /smart-transfers/preauthorizations | Create preauthorization
*SmartTransferApi* | [**smart_transfer_preauthorization_retrieve**](docs/SmartTransferApi.md#smart_transfer_preauthorization_retrieve) | **GET** /smart-transfers/preauthorizations/{id} | Retrieve preauthorization
*TransactionApi* | [**transactions_list**](docs/TransactionApi.md#transactions_list) | **GET** /transactions | List
*TransactionApi* | [**transactions_retrieve**](docs/TransactionApi.md#transactions_retrieve) | **GET** /transactions/{id} | Retrieve
*TransactionApi* | [**transactions_update**](docs/TransactionApi.md#transactions_update) | **PATCH** /transactions/{id} | Update
*WebhookApi* | [**webhooks_create**](docs/WebhookApi.md#webhooks_create) | **POST** /webhooks | Create
*WebhookApi* | [**webhooks_delete**](docs/WebhookApi.md#webhooks_delete) | **DELETE** /webhooks/{id} | Delete
*WebhookApi* | [**webhooks_list**](docs/WebhookApi.md#webhooks_list) | **GET** /webhooks | List
*WebhookApi* | [**webhooks_retrieve**](docs/WebhookApi.md#webhooks_retrieve) | **GET** /webhooks/{id} | Retrieve
*WebhookApi* | [**webhooks_update**](docs/WebhookApi.md#webhooks_update) | **PATCH** /webhooks/{id} | Update
## Documentation For Models
- [Account](docs/Account.md)
- [AccountsList200Response](docs/AccountsList200Response.md)
- [AdditionalCard](docs/AdditionalCard.md)
- [Address](docs/Address.md)
- [AuthRequest](docs/AuthRequest.md)
- [AuthResponse](docs/AuthResponse.md)
- [AutomaticPixFirstPayment](docs/AutomaticPixFirstPayment.md)
- [AutomaticPixPayment](docs/AutomaticPixPayment.md)
- [BankData](docs/BankData.md)
- [Bill](docs/Bill.md)
- [BillFinanceCharge](docs/BillFinanceCharge.md)
- [BillsList200Response](docs/BillsList200Response.md)
- [Boleto](docs/Boleto.md)
- [BoletoConnection](docs/BoletoConnection.md)
- [BoletoPayer](docs/BoletoPayer.md)
- [BoletoRecipient](docs/BoletoRecipient.md)
- [CUSTOM](docs/CUSTOM.md)
- [Category](docs/Category.md)
- [ClientCategoryRule](docs/ClientCategoryRule.md)
- [Company](docs/Company.md)
- [ConnectTokenRequest](docs/ConnectTokenRequest.md)
- [ConnectTokenResponse](docs/ConnectTokenResponse.md)
- [Connector](docs/Connector.md)
- [ConnectorCredential](docs/ConnectorCredential.md)
- [ConnectorHealth](docs/ConnectorHealth.md)
- [ConnectorHealthDetails](docs/ConnectorHealthDetails.md)
- [ConnectorListResponse](docs/ConnectorListResponse.md)
- [ConnectorUserAction](docs/ConnectorUserAction.md)
- [Consent](docs/Consent.md)
- [CreateAutomaticPixPaymentRequest](docs/CreateAutomaticPixPaymentRequest.md)
- [CreateBoleto](docs/CreateBoleto.md)
- [CreateBoletoBoleto](docs/CreateBoletoBoleto.md)
- [CreateBoletoBoletoFine](docs/CreateBoletoBoletoFine.md)
- [CreateBoletoBoletoInterest](docs/CreateBoletoBoletoInterest.md)
- [CreateBoletoBoletoPayer](docs/CreateBoletoBoletoPayer.md)
- [CreateBoletoConnection](docs/CreateBoletoConnection.md)
- [CreateBoletoConnectionFromItem](docs/CreateBoletoConnectionFromItem.md)
- [CreateClientCategoryRule](docs/CreateClientCategoryRule.md)
- [CreateItem](docs/CreateItem.md)
- [CreateItemParameters](docs/CreateItemParameters.md)
- [CreateOrUpdatePaymentCustomer](docs/CreateOrUpdatePaymentCustomer.md)
- [CreatePaymentCustomerRequestBody](docs/CreatePaymentCustomerRequestBody.md)
- [CreatePaymentIntent](docs/CreatePaymentIntent.md)
- [CreatePaymentRecipient](docs/CreatePaymentRecipient.md)
- [CreatePaymentRequest](docs/CreatePaymentRequest.md)
- [CreatePaymentRequestSchedule](docs/CreatePaymentRequestSchedule.md)
- [CreatePixQrPaymentRequest](docs/CreatePixQrPaymentRequest.md)
- [CreateSmartTransferPayment](docs/CreateSmartTransferPayment.md)
- [CreateSmartTransferPreauthorization](docs/CreateSmartTransferPreauthorization.md)
- [CreateWebhook](docs/CreateWebhook.md)
- [CredentialSelectOption](docs/CredentialSelectOption.md)
- [CreditCardMetadata](docs/CreditCardMetadata.md)
- [CreditData](docs/CreditData.md)
- [DAILY](docs/DAILY.md)
- [DisaggregatedCreditLimit](docs/DisaggregatedCreditLimit.md)
- [Document](docs/Document.md)
- [Email](docs/Email.md)
- [GlobalErrorResponse](docs/GlobalErrorResponse.md)
- [ICountResponse](docs/ICountResponse.md)
- [IdentityRelation](docs/IdentityRelation.md)
- [IdentityResponse](docs/IdentityResponse.md)
- [IdentityResponseFinancialRelationships](docs/IdentityResponseFinancialRelationships.md)
- [IdentityResponseFinancialRelationshipsAccountsInner](docs/IdentityResponseFinancialRelationshipsAccountsInner.md)
- [IdentityResponseFinancialRelationshipsProcuratorsInner](docs/IdentityResponseFinancialRelationshipsProcuratorsInner.md)
- [IdentityResponseQualifications](docs/IdentityResponseQualifications.md)
- [IdentityResponseQualificationsInformedIncome](docs/IdentityResponseQualificationsInformedIncome.md)
- [IdentityResponseQualificationsInformedPatrimony](docs/IdentityResponseQualificationsInformedPatrimony.md)
- [Investment](docs/Investment.md)
- [InvestmentExpenses](docs/InvestmentExpenses.md)
- [InvestmentMetadata](docs/InvestmentMetadata.md)
- [InvestmentTransaction](docs/InvestmentTransaction.md)
- [InvestmentsList200Response](docs/InvestmentsList200Response.md)
- [IssuedBoleto](docs/IssuedBoleto.md)
- [IssuedBoletoFine](docs/IssuedBoletoFine.md)
- [IssuedBoletoInterest](docs/IssuedBoletoInterest.md)
- [IssuedBoletoPayer](docs/IssuedBoletoPayer.md)
- [Item](docs/Item.md)
- [ItemCreationErrorResponse](docs/ItemCreationErrorResponse.md)
- [ItemError](docs/ItemError.md)
- [ItemOptions](docs/ItemOptions.md)
- [Loan](docs/Loan.md)
- [LoanContractedFee](docs/LoanContractedFee.md)
- [LoanContractedFinanceCharge](docs/LoanContractedFinanceCharge.md)
- [LoanInstallmentBalloonPayment](docs/LoanInstallmentBalloonPayment.md)
- [LoanInstallmentBalloonPaymentAmount](docs/LoanInstallmentBalloonPaymentAmount.md)
- [LoanInstallments](docs/LoanInstallments.md)
- [LoanInterestRate](docs/LoanInterestRate.md)
- [LoanPaymentRelease](docs/LoanPaymentRelease.md)
- [LoanPaymentReleaseOverParcel](docs/LoanPaymentReleaseOverParcel.md)
- [LoanPaymentReleaseOverParcelCharge](docs/LoanPaymentReleaseOverParcelCharge.md)
- [LoanPaymentReleaseOverParcelFee](docs/LoanPaymentReleaseOverParcelFee.md)
- [LoanPayments](docs/LoanPayments.md)
- [LoanWarranty](docs/LoanWarranty.md)
- [LoansList200Response](docs/LoansList200Response.md)
- [MONTHLY](docs/MONTHLY.md)
- [Merchant](docs/Merchant.md)
- [NotAuthenticatedResponse](docs/NotAuthenticatedResponse.md)
- [PageResponseCategoryRules](docs/PageResponseCategoryRules.md)
- [PageResponseConsents](docs/PageResponseConsents.md)
- [PageResponseInvestmentTransactions](docs/PageResponseInvestmentTransactions.md)
- [PageResponseTransactions](docs/PageResponseTransactions.md)
- [ParameterValidationError](docs/ParameterValidationError.md)
- [ParameterValidationResponse](docs/ParameterValidationResponse.md)
- [PaymentCustomer](docs/PaymentCustomer.md)
- [PaymentCustomersList200Response](docs/PaymentCustomersList200Response.md)
- [PaymentData](docs/PaymentData.md)
- [PaymentDataBoletoMetadata](docs/PaymentDataBoletoMetadata.md)
- [PaymentDataParticipant](docs/PaymentDataParticipant.md)
- [PaymentInstitution](docs/PaymentInstitution.md)
- [PaymentIntent](docs/PaymentIntent.md)
- [PaymentIntentAutomaticPix](docs/PaymentIntentAutomaticPix.md)
- [PaymentIntentErrorDetail](docs/PaymentIntentErrorDetail.md)
- [PaymentIntentParameter](docs/PaymentIntentParameter.md)
- [PaymentIntentsList200Response](docs/PaymentIntentsList200Response.md)
- [PaymentRecipient](docs/PaymentRecipient.md)
- [PaymentRecipientAccount](docs/PaymentRecipientAccount.md)
- [PaymentRecipientsInstitutionList200Response](docs/PaymentRecipientsInstitutionList200Response.md)
- [PaymentRecipientsList200Response](docs/PaymentRecipientsList200Response.md)
- [PaymentRequest](docs/PaymentRequest.md)
- [PaymentRequestCallbackUrls](docs/PaymentRequestCallbackUrls.md)
- [PaymentRequestErrorDetail](docs/PaymentRequestErrorDetail.md)
- [PaymentRequestGetAutomaticPixSchedules200Response](docs/PaymentRequestGetAutomaticPixSchedules200Response.md)
- [PaymentRequestSchedule](docs/PaymentRequestSchedule.md)
- [PaymentRequestsList200Response](docs/PaymentRequestsList200Response.md)
- [PaymentSchedulesList200Response](docs/PaymentSchedulesList200Response.md)
- [PhoneNumber](docs/PhoneNumber.md)
- [PixData](docs/PixData.md)
- [RetryAutomaticPixPaymentRequest](docs/RetryAutomaticPixPaymentRequest.md)
- [SINGLE](docs/SINGLE.md)
- [ScheduleAutomaticPixPaymentRequest](docs/ScheduleAutomaticPixPaymentRequest.md)
- [SchedulePayment](docs/SchedulePayment.md)
- [SchedulePaymentErrorDetail](docs/SchedulePaymentErrorDetail.md)
- [SmartTranfersPreauthorizationsList200Response](docs/SmartTranfersPreauthorizationsList200Response.md)
- [SmartTransferCallbackUrls](docs/SmartTransferCallbackUrls.md)
- [SmartTransferPayment](docs/SmartTransferPayment.md)
- [SmartTransferPreauthorization](docs/SmartTransferPreauthorization.md)
- [SmartTransferPreauthorizationParameter](docs/SmartTransferPreauthorizationParameter.md)
- [StatusDetail](docs/StatusDetail.md)
- [StatusDetailProduct](docs/StatusDetailProduct.md)
- [StatusDetailProductWarning](docs/StatusDetailProductWarning.md)
- [Transaction](docs/Transaction.md)
- [UpdateItem](docs/UpdateItem.md)
- [UpdateItemParameters](docs/UpdateItemParameters.md)
- [UpdatePaymentRecipient](docs/UpdatePaymentRecipient.md)
- [UpdatePaymentRequest](docs/UpdatePaymentRequest.md)
- [UpdateTransaction](docs/UpdateTransaction.md)
- [WEEKLY](docs/WEEKLY.md)
- [Webhook](docs/Webhook.md)
- [WebhookCreationErrorResponse](docs/WebhookCreationErrorResponse.md)
- [WebhooksList200Response](docs/WebhooksList200Response.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="default"></a>
### default
- **Type**: API key
- **API key parameter name**: X-API-KEY
- **Location**: HTTP header
## Author
hello@pluggy.ai
Raw data
{
"_id": null,
"home_page": "https://github.com/diraol/pluggy-python",
"name": "pluggy-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Pluggy API",
"author": "Pluggy",
"author_email": "Pluggy <hello@pluggy.ai>",
"download_url": "https://files.pythonhosted.org/packages/19/d3/95fa3c93c20fa686b6e311257dd15e7961e873194af98364865cd318fc9c/pluggy_sdk-1.0.0.post50.tar.gz",
"platform": null,
"description": "# pluggy-sdk\nPluggy's main API to review data and execute connectors\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 1.0.0.post50\n- Generator version: 7.14.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://pluggy.ai](https://pluggy.ai)\n\n## Requirements.\n\nPython 3.9+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport pluggy_sdk\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport pluggy_sdk\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport pluggy_sdk\nfrom pluggy_sdk.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://api.pluggy.ai\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pluggy_sdk.Configuration(\n host = \"https://api.pluggy.ai\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: default\nconfiguration.api_key['default'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['default'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nwith pluggy_sdk.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pluggy_sdk.AccountApi(api_client)\n item_id = 'd0f8a8c0-e8e3-11e9-b210-d663bd873d93' # str | Item primary identifier\n type = 'BANK' # str | Parameter to filter between bank accounts and credit accounts (optional)\n\n try:\n # List\n api_response = api_instance.accounts_list(item_id, type=type)\n print(\"The response of AccountApi->accounts_list:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling AccountApi->accounts_list: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.pluggy.ai*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AccountApi* | [**accounts_list**](docs/AccountApi.md#accounts_list) | **GET** /accounts | List\n*AccountApi* | [**accounts_retrieve**](docs/AccountApi.md#accounts_retrieve) | **GET** /accounts/{id} | Retrieve\n*AuthApi* | [**auth_create**](docs/AuthApi.md#auth_create) | **POST** /auth | Create API Key\n*AuthApi* | [**connect_token_create**](docs/AuthApi.md#connect_token_create) | **POST** /connect_token | Create Connect Token\n*AutomaticPIXApi* | [**cancel_automatic_pix_schedule**](docs/AutomaticPIXApi.md#cancel_automatic_pix_schedule) | **POST** /payments/requests/{id}/automatic-pix/schedules/{scheduleId}/cancel | Cancel an Automatic PIX schedule\n*AutomaticPIXApi* | [**payment_request_cancel_automatic_pix_consent**](docs/AutomaticPIXApi.md#payment_request_cancel_automatic_pix_consent) | **POST** /payments/requests/{id}/automatic-pix/cancel | Cancel an automatic PIX consent\n*AutomaticPIXApi* | [**payment_request_create_automatic_pix**](docs/AutomaticPIXApi.md#payment_request_create_automatic_pix) | **POST** /payments/requests/automatic-pix | Create Automatic PIX payment request\n*AutomaticPIXApi* | [**payment_request_create_automatic_pix_schedule**](docs/AutomaticPIXApi.md#payment_request_create_automatic_pix_schedule) | **POST** /payments/requests/{id}/automatic-pix/schedule | Schedule Automatic PIX payment\n*AutomaticPIXApi* | [**payment_request_get_automatic_pix_schedule**](docs/AutomaticPIXApi.md#payment_request_get_automatic_pix_schedule) | **GET** /payments/requests/{requestId}/automatic-pix/schedules/{paymentId} | Get an automatic PIX scheduled payment\n*AutomaticPIXApi* | [**payment_request_get_automatic_pix_schedules**](docs/AutomaticPIXApi.md#payment_request_get_automatic_pix_schedules) | **GET** /payments/requests/{id}/automatic-pix/schedules | List Automatic PIX scheduled payments\n*AutomaticPIXApi* | [**retry_automatic_pix_schedule**](docs/AutomaticPIXApi.md#retry_automatic_pix_schedule) | **POST** /payments/requests/{id}/automatic-pix/schedules/{scheduleId}/retry | Retry an Automatic PIX schedule\n*BillApi* | [**bills_list**](docs/BillApi.md#bills_list) | **GET** /bills | List\n*BillApi* | [**bills_retrieve**](docs/BillApi.md#bills_retrieve) | **GET** /bills/{id} | Retrieve\n*BoletoManagementApi* | [**boleto_cancel**](docs/BoletoManagementApi.md#boleto_cancel) | **POST** /boletos/{id}/cancel | Cancel Boleto\n*BoletoManagementApi* | [**boleto_connection_create**](docs/BoletoManagementApi.md#boleto_connection_create) | **POST** /boleto-connections | Connect boleto credentials\n*BoletoManagementApi* | [**boleto_connection_create_from_item**](docs/BoletoManagementApi.md#boleto_connection_create_from_item) | **POST** /boleto-connections/from-item | Create boleto connection from Item\n*BoletoManagementApi* | [**boleto_create**](docs/BoletoManagementApi.md#boleto_create) | **POST** /boletos | Issue Boleto\n*BoletoManagementApi* | [**boleto_get**](docs/BoletoManagementApi.md#boleto_get) | **GET** /boletos/{id} | Get Boleto\n*CategoryApi* | [**categories_list**](docs/CategoryApi.md#categories_list) | **GET** /categories | List\n*CategoryApi* | [**categories_retrieve**](docs/CategoryApi.md#categories_retrieve) | **GET** /categories/{id} | Retrieve\n*CategoryApi* | [**client_category_rules_create**](docs/CategoryApi.md#client_category_rules_create) | **POST** /categories/rules | Create Category Rule\n*CategoryApi* | [**client_category_rules_list**](docs/CategoryApi.md#client_category_rules_list) | **GET** /categories/rules | List Category Rules\n*ConnectorApi* | [**connector_retrieve**](docs/ConnectorApi.md#connector_retrieve) | **GET** /connectors/{id} | Retrieve\n*ConnectorApi* | [**connectors_list**](docs/ConnectorApi.md#connectors_list) | **GET** /connectors | List\n*ConnectorApi* | [**connectors_validate**](docs/ConnectorApi.md#connectors_validate) | **POST** /connectors/{id}/validate | Validate\n*ConsentApi* | [**consent_retrieve**](docs/ConsentApi.md#consent_retrieve) | **GET** /consents/{id} | Retrieve\n*ConsentApi* | [**consents_list**](docs/ConsentApi.md#consents_list) | **GET** /consents | List\n*IdentityApi* | [**identity_find_by_item**](docs/IdentityApi.md#identity_find_by_item) | **GET** /identity | Find by item\n*IdentityApi* | [**identity_retrieve**](docs/IdentityApi.md#identity_retrieve) | **GET** /identity/{id} | Retrieve\n*InvestmentApi* | [**investment_transactions_list**](docs/InvestmentApi.md#investment_transactions_list) | **GET** /investments/{id}/transactions | List investment transactions\n*InvestmentApi* | [**investments_list**](docs/InvestmentApi.md#investments_list) | **GET** /investments | List\n*InvestmentApi* | [**investments_retrieve**](docs/InvestmentApi.md#investments_retrieve) | **GET** /investments/{id} | Retrieve\n*ItemsApi* | [**items_create**](docs/ItemsApi.md#items_create) | **POST** /items | Create\n*ItemsApi* | [**items_delete**](docs/ItemsApi.md#items_delete) | **DELETE** /items/{id} | Delete\n*ItemsApi* | [**items_disable_autosync**](docs/ItemsApi.md#items_disable_autosync) | **PATCH** /items/{id}/disable-auto-sync | Disable item auto sync\n*ItemsApi* | [**items_retrieve**](docs/ItemsApi.md#items_retrieve) | **GET** /items/{id} | Retrieve\n*ItemsApi* | [**items_send_mfa**](docs/ItemsApi.md#items_send_mfa) | **POST** /items/{id}/mfa | Send MFA\n*ItemsApi* | [**items_update**](docs/ItemsApi.md#items_update) | **PATCH** /items/{id} | Update\n*LoanApi* | [**loans_list**](docs/LoanApi.md#loans_list) | **GET** /loans | List\n*LoanApi* | [**loans_retrieve**](docs/LoanApi.md#loans_retrieve) | **GET** /loans/{id} | Retrieve\n*PaymentCustomerApi* | [**payment_customer_create**](docs/PaymentCustomerApi.md#payment_customer_create) | **POST** /payments/customers | Create\n*PaymentCustomerApi* | [**payment_customer_delete**](docs/PaymentCustomerApi.md#payment_customer_delete) | **DELETE** /payments/customers/{id} | Delete\n*PaymentCustomerApi* | [**payment_customer_retrieve**](docs/PaymentCustomerApi.md#payment_customer_retrieve) | **GET** /payments/customers/{id} | Retrieve\n*PaymentCustomerApi* | [**payment_customer_update**](docs/PaymentCustomerApi.md#payment_customer_update) | **PATCH** /payments/customers/{id} | Update\n*PaymentCustomerApi* | [**payment_customers_list**](docs/PaymentCustomerApi.md#payment_customers_list) | **GET** /payments/customers | List\n*PaymentIntentApi* | [**payment_intent_create**](docs/PaymentIntentApi.md#payment_intent_create) | **POST** /payments/intents | Create\n*PaymentIntentApi* | [**payment_intent_retrieve**](docs/PaymentIntentApi.md#payment_intent_retrieve) | **GET** /payments/intents/{id} | Retrieve\n*PaymentIntentApi* | [**payment_intents_list**](docs/PaymentIntentApi.md#payment_intents_list) | **GET** /payments/intents | List\n*PaymentRecipientApi* | [**payment_recipient_create**](docs/PaymentRecipientApi.md#payment_recipient_create) | **POST** /payments/recipients | Create\n*PaymentRecipientApi* | [**payment_recipient_delete**](docs/PaymentRecipientApi.md#payment_recipient_delete) | **DELETE** /payments/recipients/{id} | Delete\n*PaymentRecipientApi* | [**payment_recipient_institutions_retrieve**](docs/PaymentRecipientApi.md#payment_recipient_institutions_retrieve) | **GET** /payments/recipients/institutions/{id} | Retrieve Institution\n*PaymentRecipientApi* | [**payment_recipient_retrieve**](docs/PaymentRecipientApi.md#payment_recipient_retrieve) | **GET** /payments/recipients/{id} | Retrieve\n*PaymentRecipientApi* | [**payment_recipient_update**](docs/PaymentRecipientApi.md#payment_recipient_update) | **PATCH** /payments/recipients/{id} | Update\n*PaymentRecipientApi* | [**payment_recipients_institution_list**](docs/PaymentRecipientApi.md#payment_recipients_institution_list) | **GET** /payments/recipients/institutions | List Institutions\n*PaymentRecipientApi* | [**payment_recipients_list**](docs/PaymentRecipientApi.md#payment_recipients_list) | **GET** /payments/recipients | List\n*PaymentRequestApi* | [**payment_request_create**](docs/PaymentRequestApi.md#payment_request_create) | **POST** /payments/requests | Create\n*PaymentRequestApi* | [**payment_request_create_pix_qr**](docs/PaymentRequestApi.md#payment_request_create_pix_qr) | **POST** /payments/requests/pix-qr | Create PIX QR payment request\n*PaymentRequestApi* | [**payment_request_delete**](docs/PaymentRequestApi.md#payment_request_delete) | **DELETE** /payments/requests/{id} | Delete\n*PaymentRequestApi* | [**payment_request_retrieve**](docs/PaymentRequestApi.md#payment_request_retrieve) | **GET** /payments/requests/{id} | Retrieve\n*PaymentRequestApi* | [**payment_request_update**](docs/PaymentRequestApi.md#payment_request_update) | **PATCH** /payments/requests/{id} | Update\n*PaymentRequestApi* | [**payment_requests_list**](docs/PaymentRequestApi.md#payment_requests_list) | **GET** /payments/requests | List\n*PaymentScheduleApi* | [**payment_schedules_cancel**](docs/PaymentScheduleApi.md#payment_schedules_cancel) | **POST** /payments/requests/{id}/schedules/cancel | Cancel Payment Schedule Authorization\n*PaymentScheduleApi* | [**payment_schedules_cancel_specific**](docs/PaymentScheduleApi.md#payment_schedules_cancel_specific) | **POST** /payments/requests/{id}/schedules/{scheduleId}/cancel | Cancel Payment Schedule\n*PaymentScheduleApi* | [**payment_schedules_list**](docs/PaymentScheduleApi.md#payment_schedules_list) | **GET** /payments/requests/{id}/schedules | List Schedules\n*SmartTransferApi* | [**smart_tranfers_preauthorizations_list**](docs/SmartTransferApi.md#smart_tranfers_preauthorizations_list) | **GET** /smart-transfers/preauthorizations | List preauthorizations\n*SmartTransferApi* | [**smart_transfer_payment_create**](docs/SmartTransferApi.md#smart_transfer_payment_create) | **POST** /smart-transfers/payments | Create payment\n*SmartTransferApi* | [**smart_transfer_paymentretrieve**](docs/SmartTransferApi.md#smart_transfer_paymentretrieve) | **GET** /smart-transfers/payments/{id} | Retrieve payment\n*SmartTransferApi* | [**smart_transfer_preauthorization_create**](docs/SmartTransferApi.md#smart_transfer_preauthorization_create) | **POST** /smart-transfers/preauthorizations | Create preauthorization\n*SmartTransferApi* | [**smart_transfer_preauthorization_retrieve**](docs/SmartTransferApi.md#smart_transfer_preauthorization_retrieve) | **GET** /smart-transfers/preauthorizations/{id} | Retrieve preauthorization\n*TransactionApi* | [**transactions_list**](docs/TransactionApi.md#transactions_list) | **GET** /transactions | List\n*TransactionApi* | [**transactions_retrieve**](docs/TransactionApi.md#transactions_retrieve) | **GET** /transactions/{id} | Retrieve\n*TransactionApi* | [**transactions_update**](docs/TransactionApi.md#transactions_update) | **PATCH** /transactions/{id} | Update\n*WebhookApi* | [**webhooks_create**](docs/WebhookApi.md#webhooks_create) | **POST** /webhooks | Create\n*WebhookApi* | [**webhooks_delete**](docs/WebhookApi.md#webhooks_delete) | **DELETE** /webhooks/{id} | Delete\n*WebhookApi* | [**webhooks_list**](docs/WebhookApi.md#webhooks_list) | **GET** /webhooks | List\n*WebhookApi* | [**webhooks_retrieve**](docs/WebhookApi.md#webhooks_retrieve) | **GET** /webhooks/{id} | Retrieve\n*WebhookApi* | [**webhooks_update**](docs/WebhookApi.md#webhooks_update) | **PATCH** /webhooks/{id} | Update\n\n\n## Documentation For Models\n\n - [Account](docs/Account.md)\n - [AccountsList200Response](docs/AccountsList200Response.md)\n - [AdditionalCard](docs/AdditionalCard.md)\n - [Address](docs/Address.md)\n - [AuthRequest](docs/AuthRequest.md)\n - [AuthResponse](docs/AuthResponse.md)\n - [AutomaticPixFirstPayment](docs/AutomaticPixFirstPayment.md)\n - [AutomaticPixPayment](docs/AutomaticPixPayment.md)\n - [BankData](docs/BankData.md)\n - [Bill](docs/Bill.md)\n - [BillFinanceCharge](docs/BillFinanceCharge.md)\n - [BillsList200Response](docs/BillsList200Response.md)\n - [Boleto](docs/Boleto.md)\n - [BoletoConnection](docs/BoletoConnection.md)\n - [BoletoPayer](docs/BoletoPayer.md)\n - [BoletoRecipient](docs/BoletoRecipient.md)\n - [CUSTOM](docs/CUSTOM.md)\n - [Category](docs/Category.md)\n - [ClientCategoryRule](docs/ClientCategoryRule.md)\n - [Company](docs/Company.md)\n - [ConnectTokenRequest](docs/ConnectTokenRequest.md)\n - [ConnectTokenResponse](docs/ConnectTokenResponse.md)\n - [Connector](docs/Connector.md)\n - [ConnectorCredential](docs/ConnectorCredential.md)\n - [ConnectorHealth](docs/ConnectorHealth.md)\n - [ConnectorHealthDetails](docs/ConnectorHealthDetails.md)\n - [ConnectorListResponse](docs/ConnectorListResponse.md)\n - [ConnectorUserAction](docs/ConnectorUserAction.md)\n - [Consent](docs/Consent.md)\n - [CreateAutomaticPixPaymentRequest](docs/CreateAutomaticPixPaymentRequest.md)\n - [CreateBoleto](docs/CreateBoleto.md)\n - [CreateBoletoBoleto](docs/CreateBoletoBoleto.md)\n - [CreateBoletoBoletoFine](docs/CreateBoletoBoletoFine.md)\n - [CreateBoletoBoletoInterest](docs/CreateBoletoBoletoInterest.md)\n - [CreateBoletoBoletoPayer](docs/CreateBoletoBoletoPayer.md)\n - [CreateBoletoConnection](docs/CreateBoletoConnection.md)\n - [CreateBoletoConnectionFromItem](docs/CreateBoletoConnectionFromItem.md)\n - [CreateClientCategoryRule](docs/CreateClientCategoryRule.md)\n - [CreateItem](docs/CreateItem.md)\n - [CreateItemParameters](docs/CreateItemParameters.md)\n - [CreateOrUpdatePaymentCustomer](docs/CreateOrUpdatePaymentCustomer.md)\n - [CreatePaymentCustomerRequestBody](docs/CreatePaymentCustomerRequestBody.md)\n - [CreatePaymentIntent](docs/CreatePaymentIntent.md)\n - [CreatePaymentRecipient](docs/CreatePaymentRecipient.md)\n - [CreatePaymentRequest](docs/CreatePaymentRequest.md)\n - [CreatePaymentRequestSchedule](docs/CreatePaymentRequestSchedule.md)\n - [CreatePixQrPaymentRequest](docs/CreatePixQrPaymentRequest.md)\n - [CreateSmartTransferPayment](docs/CreateSmartTransferPayment.md)\n - [CreateSmartTransferPreauthorization](docs/CreateSmartTransferPreauthorization.md)\n - [CreateWebhook](docs/CreateWebhook.md)\n - [CredentialSelectOption](docs/CredentialSelectOption.md)\n - [CreditCardMetadata](docs/CreditCardMetadata.md)\n - [CreditData](docs/CreditData.md)\n - [DAILY](docs/DAILY.md)\n - [DisaggregatedCreditLimit](docs/DisaggregatedCreditLimit.md)\n - [Document](docs/Document.md)\n - [Email](docs/Email.md)\n - [GlobalErrorResponse](docs/GlobalErrorResponse.md)\n - [ICountResponse](docs/ICountResponse.md)\n - [IdentityRelation](docs/IdentityRelation.md)\n - [IdentityResponse](docs/IdentityResponse.md)\n - [IdentityResponseFinancialRelationships](docs/IdentityResponseFinancialRelationships.md)\n - [IdentityResponseFinancialRelationshipsAccountsInner](docs/IdentityResponseFinancialRelationshipsAccountsInner.md)\n - [IdentityResponseFinancialRelationshipsProcuratorsInner](docs/IdentityResponseFinancialRelationshipsProcuratorsInner.md)\n - [IdentityResponseQualifications](docs/IdentityResponseQualifications.md)\n - [IdentityResponseQualificationsInformedIncome](docs/IdentityResponseQualificationsInformedIncome.md)\n - [IdentityResponseQualificationsInformedPatrimony](docs/IdentityResponseQualificationsInformedPatrimony.md)\n - [Investment](docs/Investment.md)\n - [InvestmentExpenses](docs/InvestmentExpenses.md)\n - [InvestmentMetadata](docs/InvestmentMetadata.md)\n - [InvestmentTransaction](docs/InvestmentTransaction.md)\n - [InvestmentsList200Response](docs/InvestmentsList200Response.md)\n - [IssuedBoleto](docs/IssuedBoleto.md)\n - [IssuedBoletoFine](docs/IssuedBoletoFine.md)\n - [IssuedBoletoInterest](docs/IssuedBoletoInterest.md)\n - [IssuedBoletoPayer](docs/IssuedBoletoPayer.md)\n - [Item](docs/Item.md)\n - [ItemCreationErrorResponse](docs/ItemCreationErrorResponse.md)\n - [ItemError](docs/ItemError.md)\n - [ItemOptions](docs/ItemOptions.md)\n - [Loan](docs/Loan.md)\n - [LoanContractedFee](docs/LoanContractedFee.md)\n - [LoanContractedFinanceCharge](docs/LoanContractedFinanceCharge.md)\n - [LoanInstallmentBalloonPayment](docs/LoanInstallmentBalloonPayment.md)\n - [LoanInstallmentBalloonPaymentAmount](docs/LoanInstallmentBalloonPaymentAmount.md)\n - [LoanInstallments](docs/LoanInstallments.md)\n - [LoanInterestRate](docs/LoanInterestRate.md)\n - [LoanPaymentRelease](docs/LoanPaymentRelease.md)\n - [LoanPaymentReleaseOverParcel](docs/LoanPaymentReleaseOverParcel.md)\n - [LoanPaymentReleaseOverParcelCharge](docs/LoanPaymentReleaseOverParcelCharge.md)\n - [LoanPaymentReleaseOverParcelFee](docs/LoanPaymentReleaseOverParcelFee.md)\n - [LoanPayments](docs/LoanPayments.md)\n - [LoanWarranty](docs/LoanWarranty.md)\n - [LoansList200Response](docs/LoansList200Response.md)\n - [MONTHLY](docs/MONTHLY.md)\n - [Merchant](docs/Merchant.md)\n - [NotAuthenticatedResponse](docs/NotAuthenticatedResponse.md)\n - [PageResponseCategoryRules](docs/PageResponseCategoryRules.md)\n - [PageResponseConsents](docs/PageResponseConsents.md)\n - [PageResponseInvestmentTransactions](docs/PageResponseInvestmentTransactions.md)\n - [PageResponseTransactions](docs/PageResponseTransactions.md)\n - [ParameterValidationError](docs/ParameterValidationError.md)\n - [ParameterValidationResponse](docs/ParameterValidationResponse.md)\n - [PaymentCustomer](docs/PaymentCustomer.md)\n - [PaymentCustomersList200Response](docs/PaymentCustomersList200Response.md)\n - [PaymentData](docs/PaymentData.md)\n - [PaymentDataBoletoMetadata](docs/PaymentDataBoletoMetadata.md)\n - [PaymentDataParticipant](docs/PaymentDataParticipant.md)\n - [PaymentInstitution](docs/PaymentInstitution.md)\n - [PaymentIntent](docs/PaymentIntent.md)\n - [PaymentIntentAutomaticPix](docs/PaymentIntentAutomaticPix.md)\n - [PaymentIntentErrorDetail](docs/PaymentIntentErrorDetail.md)\n - [PaymentIntentParameter](docs/PaymentIntentParameter.md)\n - [PaymentIntentsList200Response](docs/PaymentIntentsList200Response.md)\n - [PaymentRecipient](docs/PaymentRecipient.md)\n - [PaymentRecipientAccount](docs/PaymentRecipientAccount.md)\n - [PaymentRecipientsInstitutionList200Response](docs/PaymentRecipientsInstitutionList200Response.md)\n - [PaymentRecipientsList200Response](docs/PaymentRecipientsList200Response.md)\n - [PaymentRequest](docs/PaymentRequest.md)\n - [PaymentRequestCallbackUrls](docs/PaymentRequestCallbackUrls.md)\n - [PaymentRequestErrorDetail](docs/PaymentRequestErrorDetail.md)\n - [PaymentRequestGetAutomaticPixSchedules200Response](docs/PaymentRequestGetAutomaticPixSchedules200Response.md)\n - [PaymentRequestSchedule](docs/PaymentRequestSchedule.md)\n - [PaymentRequestsList200Response](docs/PaymentRequestsList200Response.md)\n - [PaymentSchedulesList200Response](docs/PaymentSchedulesList200Response.md)\n - [PhoneNumber](docs/PhoneNumber.md)\n - [PixData](docs/PixData.md)\n - [RetryAutomaticPixPaymentRequest](docs/RetryAutomaticPixPaymentRequest.md)\n - [SINGLE](docs/SINGLE.md)\n - [ScheduleAutomaticPixPaymentRequest](docs/ScheduleAutomaticPixPaymentRequest.md)\n - [SchedulePayment](docs/SchedulePayment.md)\n - [SchedulePaymentErrorDetail](docs/SchedulePaymentErrorDetail.md)\n - [SmartTranfersPreauthorizationsList200Response](docs/SmartTranfersPreauthorizationsList200Response.md)\n - [SmartTransferCallbackUrls](docs/SmartTransferCallbackUrls.md)\n - [SmartTransferPayment](docs/SmartTransferPayment.md)\n - [SmartTransferPreauthorization](docs/SmartTransferPreauthorization.md)\n - [SmartTransferPreauthorizationParameter](docs/SmartTransferPreauthorizationParameter.md)\n - [StatusDetail](docs/StatusDetail.md)\n - [StatusDetailProduct](docs/StatusDetailProduct.md)\n - [StatusDetailProductWarning](docs/StatusDetailProductWarning.md)\n - [Transaction](docs/Transaction.md)\n - [UpdateItem](docs/UpdateItem.md)\n - [UpdateItemParameters](docs/UpdateItemParameters.md)\n - [UpdatePaymentRecipient](docs/UpdatePaymentRecipient.md)\n - [UpdatePaymentRequest](docs/UpdatePaymentRequest.md)\n - [UpdateTransaction](docs/UpdateTransaction.md)\n - [WEEKLY](docs/WEEKLY.md)\n - [Webhook](docs/Webhook.md)\n - [WebhookCreationErrorResponse](docs/WebhookCreationErrorResponse.md)\n - [WebhooksList200Response](docs/WebhooksList200Response.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"default\"></a>\n### default\n\n- **Type**: API key\n- **API key parameter name**: X-API-KEY\n- **Location**: HTTP header\n\n\n## Author\n\nhello@pluggy.ai\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Pluggy API",
"version": "1.0.0.post50",
"project_urls": {
"Homepage": "https://github.com/diraol/pluggy-python",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" pluggy api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2237e1e0ff5466c1a1625a494fb195a72a42b766bad7e5f0a70e28c5d9b4cb2d",
"md5": "cf620a11ad426b8450285ee857019667",
"sha256": "fb6e141ae4e2eddb38dc38c33e7bac97a47a338de0402cc23c0f736a57c5c796"
},
"downloads": -1,
"filename": "pluggy_sdk-1.0.0.post50-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf620a11ad426b8450285ee857019667",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 439640,
"upload_time": "2025-07-19T01:52:38",
"upload_time_iso_8601": "2025-07-19T01:52:38.369176Z",
"url": "https://files.pythonhosted.org/packages/22/37/e1e0ff5466c1a1625a494fb195a72a42b766bad7e5f0a70e28c5d9b4cb2d/pluggy_sdk-1.0.0.post50-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "19d395fa3c93c20fa686b6e311257dd15e7961e873194af98364865cd318fc9c",
"md5": "0d884cc58d408808bc6bebee98dbad2a",
"sha256": "6a2ff738056e879d80b22cae4c44a8dbba8073a86e444782c98475de6ea93165"
},
"downloads": -1,
"filename": "pluggy_sdk-1.0.0.post50.tar.gz",
"has_sig": false,
"md5_digest": "0d884cc58d408808bc6bebee98dbad2a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 187015,
"upload_time": "2025-07-19T01:52:40",
"upload_time_iso_8601": "2025-07-19T01:52:40.441440Z",
"url": "https://files.pythonhosted.org/packages/19/d3/95fa3c93c20fa686b6e311257dd15e7961e873194af98364865cd318fc9c/pluggy_sdk-1.0.0.post50.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-19 01:52:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "diraol",
"github_project": "pluggy-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pluggy-sdk"
}
JSON
