Metadata-Version: 2.4
Name: payzu_pix
Version: 2.0.0
Summary: PayZu Pix API
Home-page: 
Author: Suporte PayZu
Author-email: Suporte PayZu <team@openapitools.org>
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,PayZu Pix API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# payzu-pix
REST API for Pix operations on the PayZu platform, deposits, withdrawals, internal transfers, infractions, reports, and callback inspection. All amounts are in BRL (reais) unless explicitly noted. Authentication uses a Bearer token issued during onboarding.

## SDKs oficiais

- Node.js: `npm install payzu-pix`
- Python: `pip install payzu-pix`
- PHP: `composer require payzu/pix`
- Ruby: `gem install payzu-pix`
- Java: `br.com.payzu:payzu-pix` (Maven Central)
- Go: `go get github.com/PayZuAI/payzu-sdks/go/v2`

Repo: https://github.com/PayZuAI/payzu-sdks


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.8.0
- Package version: 2.0.0
- Generator version: 7.22.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://suporte.payzu.com.br](https://suporte.payzu.com.br)

## Requirements.

Python 3.10+

## 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 payzu_pix
```

### 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 payzu_pix
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import payzu_pix
from payzu_pix.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.payzu.processamento.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = payzu_pix.Configuration(
    host = "https://api.payzu.processamento.com/v1"
)

# 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 = payzu_pix.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


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

    try:
        # Account Info
        api_response = api_instance.get_user()
        print("The response of AccountApi->get_user:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountApi->get_user: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.payzu.processamento.com/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountApi* | [**get_user**](docs/AccountApi.md#get_user) | **GET** /user | Account Info
*AccountApi* | [**get_user_balance**](docs/AccountApi.md#get_user_balance) | **GET** /user/balance | Account Balance
*CallbacksApi* | [**create_user_callback_secret**](docs/CallbacksApi.md#create_user_callback_secret) | **POST** /user/callbacks/secret | Create callback secret
*CallbacksApi* | [**get_user_callback_by_id**](docs/CallbacksApi.md#get_user_callback_by_id) | **GET** /user/callbacks/{id} | Get Callback
*CallbacksApi* | [**get_user_callbacks**](docs/CallbacksApi.md#get_user_callbacks) | **GET** /user/callbacks | List Callbacks
*CallbacksApi* | [**resend_user_callback_single**](docs/CallbacksApi.md#resend_user_callback_single) | **POST** /user/callbacks/resend/{transactionId} | Re-send callback (single)
*CallbacksApi* | [**resend_user_callbacks**](docs/CallbacksApi.md#resend_user_callbacks) | **POST** /user/callbacks/resend | Re-send callbacks (bulk)
*CallbacksApi* | [**resend_user_callbacks_webhook**](docs/CallbacksApi.md#resend_user_callbacks_webhook) | **POST** /user/callbacks/resend/webhook/{webhookId} | Resend callbacks by webhook
*CallbacksApi* | [**resend_user_callbacks_webhooks**](docs/CallbacksApi.md#resend_user_callbacks_webhooks) | **POST** /user/callbacks/resend/webhook | Resend webhook callbacks by filters
*CallbacksApi* | [**rotate_user_callback_secret**](docs/CallbacksApi.md#rotate_user_callback_secret) | **PATCH** /user/callbacks/secret/rotate | Rotate callback secret
*InfractionsApi* | [**get_infractions**](docs/InfractionsApi.md#get_infractions) | **GET** /user/infractions | List Infractions
*InfractionsApi* | [**get_infractions_by_id**](docs/InfractionsApi.md#get_infractions_by_id) | **GET** /user/infractions/{id} | Get Infraction
*InfractionsApi* | [**get_infractions_defense_by_id**](docs/InfractionsApi.md#get_infractions_defense_by_id) | **GET** /user/infractions/{infractionId}/defenses/{defenseId} | Get Defense
*InfractionsApi* | [**get_infractions_defenses**](docs/InfractionsApi.md#get_infractions_defenses) | **GET** /user/infractions/{id}/defenses | List Defenses
*InfractionsApi* | [**post_infractions_defense**](docs/InfractionsApi.md#post_infractions_defense) | **POST** /user/infractions/{id}/defenses | Create Defense
*InternalTransferApi* | [**get_internal_transfer**](docs/InternalTransferApi.md#get_internal_transfer) | **GET** /internal-transfer | Get internal transfer
*InternalTransferApi* | [**post_internal_transfer**](docs/InternalTransferApi.md#post_internal_transfer) | **POST** /internal-transfer | Create internal transfer
*KeysAndDICTApi* | [**get_pix_key**](docs/KeysAndDICTApi.md#get_pix_key) | **GET** /pix/key | Pix key lookup (DICT)
*KeysAndDICTApi* | [**get_user_dict**](docs/KeysAndDICTApi.md#get_user_dict) | **GET** /user/dict | Resolve DICT key
*KeysAndDICTApi* | [**post_pix_qrcode_read**](docs/KeysAndDICTApi.md#post_pix_qrcode_read) | **POST** /pix/qrcode/read | Read QR Code
*PixOperationsApi* | [**get_pix**](docs/PixOperationsApi.md#get_pix) | **GET** /pix | Retrieve Charge
*PixOperationsApi* | [**get_pix_qrcode**](docs/PixOperationsApi.md#get_pix_qrcode) | **GET** /pix/qr-code/{transactionId} | Render Pix QR code (PNG)
*PixOperationsApi* | [**get_proof**](docs/PixOperationsApi.md#get_proof) | **GET** /proof/{id} | Get Transaction Receipt
*PixOperationsApi* | [**post_pix**](docs/PixOperationsApi.md#post_pix) | **POST** /pix | Create Charge (Pix deposit)
*RefundsApi* | [**post_refund**](docs/RefundsApi.md#post_refund) | **POST** /refund/{transactionId} | Refund a Pix
*ReportsApi* | [**download_user_report**](docs/ReportsApi.md#download_user_report) | **POST** /user/report/{id}/download | Download report
*ReportsApi* | [**get_user_bank_statement**](docs/ReportsApi.md#get_user_bank_statement) | **GET** /user/bank-statements/{id} | Get bank statement
*ReportsApi* | [**get_user_bank_statements**](docs/ReportsApi.md#get_user_bank_statements) | **GET** /user/bank-statements | List bank statements
*ReportsApi* | [**get_user_deposit_pending**](docs/ReportsApi.md#get_user_deposit_pending) | **GET** /user/deposit-pending | List pending deposits
*ReportsApi* | [**get_user_deposit_pending_by_id**](docs/ReportsApi.md#get_user_deposit_pending_by_id) | **GET** /user/deposit-pending/{id} | Get pending deposit
*ReportsApi* | [**get_user_report**](docs/ReportsApi.md#get_user_report) | **GET** /user/report/{id} | Get report job status
*ReportsApi* | [**get_user_summary**](docs/ReportsApi.md#get_user_summary) | **GET** /user/summary | Transaction summary
*ReportsApi* | [**get_user_transaction_by_id**](docs/ReportsApi.md#get_user_transaction_by_id) | **GET** /user/transactions/{id} | List transaction details
*ReportsApi* | [**get_user_transactions**](docs/ReportsApi.md#get_user_transactions) | **GET** /user/transactions | List Transactions
*ReportsApi* | [**list_user_reports**](docs/ReportsApi.md#list_user_reports) | **GET** /user/report | List report jobs
*ReportsApi* | [**post_user_report**](docs/ReportsApi.md#post_user_report) | **POST** /user/report | Generate transactions report
*WebhooksApi* | [**delete_user_webhook**](docs/WebhooksApi.md#delete_user_webhook) | **DELETE** /user/webhooks/{id} | Delete webhook
*WebhooksApi* | [**get_user_webhook**](docs/WebhooksApi.md#get_user_webhook) | **GET** /user/webhooks/{id} | Get webhook
*WebhooksApi* | [**get_user_webhook_sent_detail**](docs/WebhooksApi.md#get_user_webhook_sent_detail) | **GET** /user/webhooks/{id}/sent/{callbackId} | Get sent callback detail
*WebhooksApi* | [**get_user_webhooks**](docs/WebhooksApi.md#get_user_webhooks) | **GET** /user/webhooks | List webhooks
*WebhooksApi* | [**get_user_webhooks_sent_quantity**](docs/WebhooksApi.md#get_user_webhooks_sent_quantity) | **GET** /user/webhooks/sent/quantity | Count sent callbacks
*WebhooksApi* | [**patch_user_webhook**](docs/WebhooksApi.md#patch_user_webhook) | **PATCH** /user/webhooks/{id} | Update webhook
*WebhooksApi* | [**post_user_webhook**](docs/WebhooksApi.md#post_user_webhook) | **POST** /user/webhooks | Create webhook
*WebhooksApi* | [**post_user_webhook_rotate_secret**](docs/WebhooksApi.md#post_user_webhook_rotate_secret) | **POST** /user/webhooks/{id}/rotate-secret | Rotate webhook secret
*WithdrawalsApi* | [**get_withdraw**](docs/WithdrawalsApi.md#get_withdraw) | **GET** /withdraw | Retrieve Withdrawal
*WithdrawalsApi* | [**get_withdraw_proof**](docs/WithdrawalsApi.md#get_withdraw_proof) | **GET** /withdraw/proof/{id} | Get Withdrawal Receipt
*WithdrawalsApi* | [**post_withdraw**](docs/WithdrawalsApi.md#post_withdraw) | **POST** /withdraw | Create Withdrawal (Pix key)
*WithdrawalsApi* | [**post_withdraw_qrcode**](docs/WithdrawalsApi.md#post_withdraw_qrcode) | **POST** /withdraw/qrcode | Create Withdrawal using QR Code


## Documentation For Models

 - [ApiError](docs/ApiError.md)
 - [ApiErrorDetailsInner](docs/ApiErrorDetailsInner.md)
 - [BankStatement](docs/BankStatement.md)
 - [BankStatementListResponse](docs/BankStatementListResponse.md)
 - [BankStatementListResponsePagination](docs/BankStatementListResponsePagination.md)
 - [CallbackDetail](docs/CallbackDetail.md)
 - [CallbackListResponse](docs/CallbackListResponse.md)
 - [CallbackListResponsePagination](docs/CallbackListResponsePagination.md)
 - [CallbackSecretResponse](docs/CallbackSecretResponse.md)
 - [Defense](docs/Defense.md)
 - [DefenseFilesInner](docs/DefenseFilesInner.md)
 - [DefenseHistoryEntry](docs/DefenseHistoryEntry.md)
 - [DefenseHistoryEntryFilesInner](docs/DefenseHistoryEntryFilesInner.md)
 - [DepositPending](docs/DepositPending.md)
 - [DepositPendingListResponse](docs/DepositPendingListResponse.md)
 - [DictConsultResponse](docs/DictConsultResponse.md)
 - [DownloadUserReport200Response](docs/DownloadUserReport200Response.md)
 - [EnqueuedCallback](docs/EnqueuedCallback.md)
 - [EnqueuedCallbackEnqueued](docs/EnqueuedCallbackEnqueued.md)
 - [EnqueuedCallbackItem](docs/EnqueuedCallbackItem.md)
 - [GetUser200Response](docs/GetUser200Response.md)
 - [GetUser200ResponseDailyWithdrawLimit](docs/GetUser200ResponseDailyWithdrawLimit.md)
 - [GetUser200ResponseServiceFee](docs/GetUser200ResponseServiceFee.md)
 - [GetUserBalance200Response](docs/GetUserBalance200Response.md)
 - [GetUserTransactionById200Response](docs/GetUserTransactionById200Response.md)
 - [GetUserTransactionById200ResponseAllOfCallbackLogInner](docs/GetUserTransactionById200ResponseAllOfCallbackLogInner.md)
 - [GetUserTransactionById200ResponseAllOfInfractionInner](docs/GetUserTransactionById200ResponseAllOfInfractionInner.md)
 - [GetUserTransactions200Response](docs/GetUserTransactions200Response.md)
 - [InfractionDetail](docs/InfractionDetail.md)
 - [InfractionDetailTransaction](docs/InfractionDetailTransaction.md)
 - [InfractionListResponse](docs/InfractionListResponse.md)
 - [InfractionListResponsePagination](docs/InfractionListResponsePagination.md)
 - [ListUserReports200Response](docs/ListUserReports200Response.md)
 - [PixKeyInfo](docs/PixKeyInfo.md)
 - [PostInternalTransferRequest](docs/PostInternalTransferRequest.md)
 - [PostPixQrcodeReadRequest](docs/PostPixQrcodeReadRequest.md)
 - [PostPixRequest](docs/PostPixRequest.md)
 - [PostUserReportRequest](docs/PostUserReportRequest.md)
 - [PostWithdrawQrcodeRequest](docs/PostWithdrawQrcodeRequest.md)
 - [PostWithdrawRequest](docs/PostWithdrawRequest.md)
 - [ProofResponse](docs/ProofResponse.md)
 - [QRCodeReadResponse](docs/QRCodeReadResponse.md)
 - [Refund](docs/Refund.md)
 - [RefundRequest](docs/RefundRequest.md)
 - [ReportJob](docs/ReportJob.md)
 - [ReportJobAccepted](docs/ReportJobAccepted.md)
 - [ReportJobDetail](docs/ReportJobDetail.md)
 - [ResendUserCallbackSingle200Response](docs/ResendUserCallbackSingle200Response.md)
 - [ResendUserCallbacks200Response](docs/ResendUserCallbacks200Response.md)
 - [ResendUserCallbacksRequest](docs/ResendUserCallbacksRequest.md)
 - [ResendWebhookCallbacksRequest](docs/ResendWebhookCallbacksRequest.md)
 - [RotateCallbackSecretResponse](docs/RotateCallbackSecretResponse.md)
 - [RotateSecretResponse](docs/RotateSecretResponse.md)
 - [SentWebhookDetail](docs/SentWebhookDetail.md)
 - [SentWebhookDetailResponse](docs/SentWebhookDetailResponse.md)
 - [SentWebhooksQuantity](docs/SentWebhooksQuantity.md)
 - [Summary](docs/Summary.md)
 - [SummaryBlock](docs/SummaryBlock.md)
 - [SummaryBlockGroupedInner](docs/SummaryBlockGroupedInner.md)
 - [SummaryBlockStatuses](docs/SummaryBlockStatuses.md)
 - [SummaryStatus](docs/SummaryStatus.md)
 - [Transaction](docs/Transaction.md)
 - [TransactionWithRefunds](docs/TransactionWithRefunds.md)
 - [Webhook](docs/Webhook.md)
 - [WebhookCreateRequest](docs/WebhookCreateRequest.md)
 - [WebhookEventType](docs/WebhookEventType.md)
 - [WebhookListResponse](docs/WebhookListResponse.md)
 - [WebhookUpdateRequest](docs/WebhookUpdateRequest.md)
 - [WebhookWithSecret](docs/WebhookWithSecret.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="BearerAuth"></a>
### BearerAuth

- **Type**: Bearer authentication


## Author




