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/v3

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

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

• API version: 1.8.0
• Package version: 3.0.0
• Generator version: 7.22.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit 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:

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 payzu_pix

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 payzu_pix

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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

Documentation For Models

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

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author