payzu-pix 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3632d5525284ba961ee6f7c2cd291a2a4983f75b9a9f2cec205aedd4d344f49b
+  data.tar.gz: d269b4c159423ef41822df29d61fdfe3cfb8e7330ad5d3036637009c607b5f24
+SHA512:
+  metadata.gz: 6d5613561d5a1e104acbf7a8569c1cde16ca7dcbe3952a92c47ae54847d20d561bfe35094bc7f69d55f211e2f4d94b09059410812f64974dc4b45ae3fce9f144
+  data.tar.gz: 33e42f0c1fdb0ca08cf02850755cc6c2875d4e6a1d8b05c3ec034ba2249bd12543d1a9266bd3041e0abc906c43a29657feb8fa1e3c270cdb5cca09bb5e1e9d78

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,231 @@
+# payzu-pix
+
+PayZuPix - the Ruby gem for the PayZu Pix API
+
+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 SDK 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.RubyClientCodegen
+For more information, please visit [https://suporte.payzu.com.br](https://suporte.payzu.com.br)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build payzu-pix.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./payzu-pix-2.0.0.gem
+```
+
+(for development, run `gem install --dev ./payzu-pix-2.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'payzu-pix', '~> 2.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/PayZuAI/payzu-sdks, then add the following in the Gemfile:
+
+    gem 'payzu-pix', :git => 'https://github.com/PayZuAI/payzu-sdks.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'payzu-pix'
+
+# Setup authorization
+PayZuPix.configure do |config|
+  # Configure Bearer authorization: BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
+  # Configure faraday connection
+  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
+end
+
+api_instance = PayZuPix::AccountApi.new
+
+begin
+  #Account Info
+  result = api_instance.get_user
+  p result
+rescue PayZuPix::ApiError => e
+  puts "Exception when calling AccountApi->get_user: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.payzu.processamento.com/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*PayZuPix::AccountApi* | [**get_user**](docs/AccountApi.md#get_user) | **GET** /user | Account Info
+*PayZuPix::AccountApi* | [**get_user_balance**](docs/AccountApi.md#get_user_balance) | **GET** /user/balance | Account Balance
+*PayZuPix::CallbacksApi* | [**create_user_callback_secret**](docs/CallbacksApi.md#create_user_callback_secret) | **POST** /user/callbacks/secret | Create callback secret
+*PayZuPix::CallbacksApi* | [**get_user_callback_by_id**](docs/CallbacksApi.md#get_user_callback_by_id) | **GET** /user/callbacks/{id} | Get Callback
+*PayZuPix::CallbacksApi* | [**get_user_callbacks**](docs/CallbacksApi.md#get_user_callbacks) | **GET** /user/callbacks | List Callbacks
+*PayZuPix::CallbacksApi* | [**resend_user_callback_single**](docs/CallbacksApi.md#resend_user_callback_single) | **POST** /user/callbacks/resend/{transactionId} | Re-send callback (single)
+*PayZuPix::CallbacksApi* | [**resend_user_callbacks**](docs/CallbacksApi.md#resend_user_callbacks) | **POST** /user/callbacks/resend | Re-send callbacks (bulk)
+*PayZuPix::CallbacksApi* | [**resend_user_callbacks_webhook**](docs/CallbacksApi.md#resend_user_callbacks_webhook) | **POST** /user/callbacks/resend/webhook/{webhookId} | Resend callbacks by webhook
+*PayZuPix::CallbacksApi* | [**resend_user_callbacks_webhooks**](docs/CallbacksApi.md#resend_user_callbacks_webhooks) | **POST** /user/callbacks/resend/webhook | Resend webhook callbacks by filters
+*PayZuPix::CallbacksApi* | [**rotate_user_callback_secret**](docs/CallbacksApi.md#rotate_user_callback_secret) | **PATCH** /user/callbacks/secret/rotate | Rotate callback secret
+*PayZuPix::InfractionsApi* | [**get_infractions**](docs/InfractionsApi.md#get_infractions) | **GET** /user/infractions | List Infractions
+*PayZuPix::InfractionsApi* | [**get_infractions_by_id**](docs/InfractionsApi.md#get_infractions_by_id) | **GET** /user/infractions/{id} | Get Infraction
+*PayZuPix::InfractionsApi* | [**get_infractions_defense_by_id**](docs/InfractionsApi.md#get_infractions_defense_by_id) | **GET** /user/infractions/{infractionId}/defenses/{defenseId} | Get Defense
+*PayZuPix::InfractionsApi* | [**get_infractions_defenses**](docs/InfractionsApi.md#get_infractions_defenses) | **GET** /user/infractions/{id}/defenses | List Defenses
+*PayZuPix::InfractionsApi* | [**post_infractions_defense**](docs/InfractionsApi.md#post_infractions_defense) | **POST** /user/infractions/{id}/defenses | Create Defense
+*PayZuPix::InternalTransferApi* | [**get_internal_transfer**](docs/InternalTransferApi.md#get_internal_transfer) | **GET** /internal-transfer | Get internal transfer
+*PayZuPix::InternalTransferApi* | [**post_internal_transfer**](docs/InternalTransferApi.md#post_internal_transfer) | **POST** /internal-transfer | Create internal transfer
+*PayZuPix::KeysAndDICTApi* | [**get_pix_key**](docs/KeysAndDICTApi.md#get_pix_key) | **GET** /pix/key | Pix key lookup (DICT)
+*PayZuPix::KeysAndDICTApi* | [**get_user_dict**](docs/KeysAndDICTApi.md#get_user_dict) | **GET** /user/dict | Resolve DICT key
+*PayZuPix::KeysAndDICTApi* | [**post_pix_qrcode_read**](docs/KeysAndDICTApi.md#post_pix_qrcode_read) | **POST** /pix/qrcode/read | Read QR Code
+*PayZuPix::PixOperationsApi* | [**get_pix**](docs/PixOperationsApi.md#get_pix) | **GET** /pix | Retrieve Charge
+*PayZuPix::PixOperationsApi* | [**get_pix_qrcode**](docs/PixOperationsApi.md#get_pix_qrcode) | **GET** /pix/qr-code/{transactionId} | Render Pix QR code (PNG)
+*PayZuPix::PixOperationsApi* | [**get_proof**](docs/PixOperationsApi.md#get_proof) | **GET** /proof/{id} | Get Transaction Receipt
+*PayZuPix::PixOperationsApi* | [**post_pix**](docs/PixOperationsApi.md#post_pix) | **POST** /pix | Create Charge (Pix deposit)
+*PayZuPix::RefundsApi* | [**post_refund**](docs/RefundsApi.md#post_refund) | **POST** /refund/{transactionId} | Refund a Pix
+*PayZuPix::ReportsApi* | [**download_user_report**](docs/ReportsApi.md#download_user_report) | **POST** /user/report/{id}/download | Download report
+*PayZuPix::ReportsApi* | [**get_user_bank_statement**](docs/ReportsApi.md#get_user_bank_statement) | **GET** /user/bank-statements/{id} | Get bank statement
+*PayZuPix::ReportsApi* | [**get_user_bank_statements**](docs/ReportsApi.md#get_user_bank_statements) | **GET** /user/bank-statements | List bank statements
+*PayZuPix::ReportsApi* | [**get_user_deposit_pending**](docs/ReportsApi.md#get_user_deposit_pending) | **GET** /user/deposit-pending | List pending deposits
+*PayZuPix::ReportsApi* | [**get_user_deposit_pending_by_id**](docs/ReportsApi.md#get_user_deposit_pending_by_id) | **GET** /user/deposit-pending/{id} | Get pending deposit
+*PayZuPix::ReportsApi* | [**get_user_report**](docs/ReportsApi.md#get_user_report) | **GET** /user/report/{id} | Get report job status
+*PayZuPix::ReportsApi* | [**get_user_summary**](docs/ReportsApi.md#get_user_summary) | **GET** /user/summary | Transaction summary
+*PayZuPix::ReportsApi* | [**get_user_transaction_by_id**](docs/ReportsApi.md#get_user_transaction_by_id) | **GET** /user/transactions/{id} | List transaction details
+*PayZuPix::ReportsApi* | [**get_user_transactions**](docs/ReportsApi.md#get_user_transactions) | **GET** /user/transactions | List Transactions
+*PayZuPix::ReportsApi* | [**list_user_reports**](docs/ReportsApi.md#list_user_reports) | **GET** /user/report | List report jobs
+*PayZuPix::ReportsApi* | [**post_user_report**](docs/ReportsApi.md#post_user_report) | **POST** /user/report | Generate transactions report
+*PayZuPix::WebhooksApi* | [**delete_user_webhook**](docs/WebhooksApi.md#delete_user_webhook) | **DELETE** /user/webhooks/{id} | Delete webhook
+*PayZuPix::WebhooksApi* | [**get_user_webhook**](docs/WebhooksApi.md#get_user_webhook) | **GET** /user/webhooks/{id} | Get webhook
+*PayZuPix::WebhooksApi* | [**get_user_webhook_sent_detail**](docs/WebhooksApi.md#get_user_webhook_sent_detail) | **GET** /user/webhooks/{id}/sent/{callbackId} | Get sent callback detail
+*PayZuPix::WebhooksApi* | [**get_user_webhooks**](docs/WebhooksApi.md#get_user_webhooks) | **GET** /user/webhooks | List webhooks
+*PayZuPix::WebhooksApi* | [**get_user_webhooks_sent_quantity**](docs/WebhooksApi.md#get_user_webhooks_sent_quantity) | **GET** /user/webhooks/sent/quantity | Count sent callbacks
+*PayZuPix::WebhooksApi* | [**patch_user_webhook**](docs/WebhooksApi.md#patch_user_webhook) | **PATCH** /user/webhooks/{id} | Update webhook
+*PayZuPix::WebhooksApi* | [**post_user_webhook**](docs/WebhooksApi.md#post_user_webhook) | **POST** /user/webhooks | Create webhook
+*PayZuPix::WebhooksApi* | [**post_user_webhook_rotate_secret**](docs/WebhooksApi.md#post_user_webhook_rotate_secret) | **POST** /user/webhooks/{id}/rotate-secret | Rotate webhook secret
+*PayZuPix::WithdrawalsApi* | [**get_withdraw**](docs/WithdrawalsApi.md#get_withdraw) | **GET** /withdraw | Retrieve Withdrawal
+*PayZuPix::WithdrawalsApi* | [**get_withdraw_proof**](docs/WithdrawalsApi.md#get_withdraw_proof) | **GET** /withdraw/proof/{id} | Get Withdrawal Receipt
+*PayZuPix::WithdrawalsApi* | [**post_withdraw**](docs/WithdrawalsApi.md#post_withdraw) | **POST** /withdraw | Create Withdrawal (Pix key)
+*PayZuPix::WithdrawalsApi* | [**post_withdraw_qrcode**](docs/WithdrawalsApi.md#post_withdraw_qrcode) | **POST** /withdraw/qrcode | Create Withdrawal using QR Code
+
+
+## Documentation for Models
+
+ - [PayZuPix::ApiErrorDetailsInner](docs/ApiErrorDetailsInner.md)
+ - [PayZuPix::BankStatement](docs/BankStatement.md)
+ - [PayZuPix::BankStatementListResponse](docs/BankStatementListResponse.md)
+ - [PayZuPix::BankStatementListResponsePagination](docs/BankStatementListResponsePagination.md)
+ - [PayZuPix::CallbackDetail](docs/CallbackDetail.md)
+ - [PayZuPix::CallbackListResponse](docs/CallbackListResponse.md)
+ - [PayZuPix::CallbackListResponsePagination](docs/CallbackListResponsePagination.md)
+ - [PayZuPix::CallbackSecretResponse](docs/CallbackSecretResponse.md)
+ - [PayZuPix::Defense](docs/Defense.md)
+ - [PayZuPix::DefenseFilesInner](docs/DefenseFilesInner.md)
+ - [PayZuPix::DefenseHistoryEntry](docs/DefenseHistoryEntry.md)
+ - [PayZuPix::DefenseHistoryEntryFilesInner](docs/DefenseHistoryEntryFilesInner.md)
+ - [PayZuPix::DepositPending](docs/DepositPending.md)
+ - [PayZuPix::DepositPendingListResponse](docs/DepositPendingListResponse.md)
+ - [PayZuPix::DictConsultResponse](docs/DictConsultResponse.md)
+ - [PayZuPix::DownloadUserReport200Response](docs/DownloadUserReport200Response.md)
+ - [PayZuPix::EnqueuedCallback](docs/EnqueuedCallback.md)
+ - [PayZuPix::EnqueuedCallbackEnqueued](docs/EnqueuedCallbackEnqueued.md)
+ - [PayZuPix::EnqueuedCallbackItem](docs/EnqueuedCallbackItem.md)
+ - [PayZuPix::ErrorResponse](docs/ErrorResponse.md)
+ - [PayZuPix::GetUser200Response](docs/GetUser200Response.md)
+ - [PayZuPix::GetUser200ResponseDailyWithdrawLimit](docs/GetUser200ResponseDailyWithdrawLimit.md)
+ - [PayZuPix::GetUser200ResponseServiceFee](docs/GetUser200ResponseServiceFee.md)
+ - [PayZuPix::GetUserBalance200Response](docs/GetUserBalance200Response.md)
+ - [PayZuPix::GetUserTransactionById200Response](docs/GetUserTransactionById200Response.md)
+ - [PayZuPix::GetUserTransactionById200ResponseAllOfCallbackLogInner](docs/GetUserTransactionById200ResponseAllOfCallbackLogInner.md)
+ - [PayZuPix::GetUserTransactionById200ResponseAllOfInfractionInner](docs/GetUserTransactionById200ResponseAllOfInfractionInner.md)
+ - [PayZuPix::GetUserTransactions200Response](docs/GetUserTransactions200Response.md)
+ - [PayZuPix::InfractionDetail](docs/InfractionDetail.md)
+ - [PayZuPix::InfractionDetailTransaction](docs/InfractionDetailTransaction.md)
+ - [PayZuPix::InfractionListResponse](docs/InfractionListResponse.md)
+ - [PayZuPix::InfractionListResponsePagination](docs/InfractionListResponsePagination.md)
+ - [PayZuPix::ListUserReports200Response](docs/ListUserReports200Response.md)
+ - [PayZuPix::PixKeyInfo](docs/PixKeyInfo.md)
+ - [PayZuPix::PostInternalTransferRequest](docs/PostInternalTransferRequest.md)
+ - [PayZuPix::PostPixQrcodeReadRequest](docs/PostPixQrcodeReadRequest.md)
+ - [PayZuPix::PostPixRequest](docs/PostPixRequest.md)
+ - [PayZuPix::PostUserReportRequest](docs/PostUserReportRequest.md)
+ - [PayZuPix::PostWithdrawQrcodeRequest](docs/PostWithdrawQrcodeRequest.md)
+ - [PayZuPix::PostWithdrawRequest](docs/PostWithdrawRequest.md)
+ - [PayZuPix::ProofResponse](docs/ProofResponse.md)
+ - [PayZuPix::QRCodeReadResponse](docs/QRCodeReadResponse.md)
+ - [PayZuPix::Refund](docs/Refund.md)
+ - [PayZuPix::RefundRequest](docs/RefundRequest.md)
+ - [PayZuPix::ReportJob](docs/ReportJob.md)
+ - [PayZuPix::ReportJobAccepted](docs/ReportJobAccepted.md)
+ - [PayZuPix::ReportJobDetail](docs/ReportJobDetail.md)
+ - [PayZuPix::ResendUserCallbackSingle200Response](docs/ResendUserCallbackSingle200Response.md)
+ - [PayZuPix::ResendUserCallbacks200Response](docs/ResendUserCallbacks200Response.md)
+ - [PayZuPix::ResendUserCallbacksRequest](docs/ResendUserCallbacksRequest.md)
+ - [PayZuPix::ResendWebhookCallbacksRequest](docs/ResendWebhookCallbacksRequest.md)
+ - [PayZuPix::RotateCallbackSecretResponse](docs/RotateCallbackSecretResponse.md)
+ - [PayZuPix::RotateSecretResponse](docs/RotateSecretResponse.md)
+ - [PayZuPix::SentWebhookDetail](docs/SentWebhookDetail.md)
+ - [PayZuPix::SentWebhookDetailResponse](docs/SentWebhookDetailResponse.md)
+ - [PayZuPix::SentWebhooksQuantity](docs/SentWebhooksQuantity.md)
+ - [PayZuPix::Summary](docs/Summary.md)
+ - [PayZuPix::SummaryBlock](docs/SummaryBlock.md)
+ - [PayZuPix::SummaryBlockGroupedInner](docs/SummaryBlockGroupedInner.md)
+ - [PayZuPix::SummaryBlockStatuses](docs/SummaryBlockStatuses.md)
+ - [PayZuPix::SummaryStatus](docs/SummaryStatus.md)
+ - [PayZuPix::Transaction](docs/Transaction.md)
+ - [PayZuPix::TransactionWithRefunds](docs/TransactionWithRefunds.md)
+ - [PayZuPix::Webhook](docs/Webhook.md)
+ - [PayZuPix::WebhookCreateRequest](docs/WebhookCreateRequest.md)
+ - [PayZuPix::WebhookEventType](docs/WebhookEventType.md)
+ - [PayZuPix::WebhookListResponse](docs/WebhookListResponse.md)
+ - [PayZuPix::WebhookUpdateRequest](docs/WebhookUpdateRequest.md)
+ - [PayZuPix::WebhookWithSecret](docs/WebhookWithSecret.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### BearerAuth
+
+- **Type**: Bearer authentication
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AccountApi.md

@@ -0,0 +1,141 @@
+# PayZuPix::AccountApi
+
+All URIs are relative to *https://api.payzu.processamento.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_user**](AccountApi.md#get_user) | **GET** /user | Account Info |
+| [**get_user_balance**](AccountApi.md#get_user_balance) | **GET** /user/balance | Account Balance |
+
+
+## get_user
+
+> <GetUser200Response> get_user
+
+Account Info
+
+Account profile, permissions, limits and fee rules.
+
+### Examples
+
+```ruby
+require 'time'
+require 'payzu-pix'
+# setup authorization
+PayZuPix.configure do |config|
+  # Configure Bearer authorization: BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PayZuPix::AccountApi.new
+
+begin
+  # Account Info
+  result = api_instance.get_user
+  p result
+rescue PayZuPix::ApiError => e
+  puts "Error when calling AccountApi->get_user: #{e}"
+end
+```
+
+#### Using the get_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetUser200Response>, Integer, Hash)> get_user_with_http_info
+
+```ruby
+begin
+  # Account Info
+  data, status_code, headers = api_instance.get_user_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetUser200Response>
+rescue PayZuPix::ApiError => e
+  puts "Error when calling AccountApi->get_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetUser200Response**](GetUser200Response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_user_balance
+
+> <GetUserBalance200Response> get_user_balance
+
+Account Balance
+
+Available and blocked balances.
+
+### Examples
+
+```ruby
+require 'time'
+require 'payzu-pix'
+# setup authorization
+PayZuPix.configure do |config|
+  # Configure Bearer authorization: BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PayZuPix::AccountApi.new
+
+begin
+  # Account Balance
+  result = api_instance.get_user_balance
+  p result
+rescue PayZuPix::ApiError => e
+  puts "Error when calling AccountApi->get_user_balance: #{e}"
+end
+```
+
+#### Using the get_user_balance_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetUserBalance200Response>, Integer, Hash)> get_user_balance_with_http_info
+
+```ruby
+begin
+  # Account Balance
+  data, status_code, headers = api_instance.get_user_balance_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetUserBalance200Response>
+rescue PayZuPix::ApiError => e
+  puts "Error when calling AccountApi->get_user_balance_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetUserBalance200Response**](GetUserBalance200Response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ApiErrorDetailsInner.md

@@ -0,0 +1,20 @@
+# PayZuPix::ApiErrorDetailsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | Path of the field rejected in validation, without the leading slash. |  |
+| **message** | **String** | Reason that field was rejected, in Portuguese. |  |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::ApiErrorDetailsInner.new(
+  field: null,
+  message: null
+)
+```
+

data/docs/BankStatement.md

@@ -0,0 +1,42 @@
+# PayZuPix::BankStatement
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the balance entry. | [optional] |
+| **amount** | **Float** | Amount of the entry. | [optional] |
+| **operation** | **String** | INCREMENT credits the balance, DECREMENT debits it. | [optional] |
+| **reason** | **String** | Reason for the ledger entry. | [optional] |
+| **balance_type** | **String** | Balance moved: AVAILABLE or BLOCKED. | [optional] |
+| **previous_balance_available** | **Float** | Balance free for use that the account had, in reais, immediately before this entry. | [optional] |
+| **previous_balance_blocked** | **Float** | Blocked balance before the entry, in reais. | [optional] |
+| **new_balance_available** | **Float** | Available balance after the entry, in reais. | [optional] |
+| **new_balance_blocked** | **Float** | Blocked balance after the entry, in reais. | [optional] |
+| **transaction_id** | **String** | Transaction that originated the entry. | [optional] |
+| **infraction_id** | **String** | Infraction related to the entry. | [optional] |
+| **created_at** | **Time** | Date and time the balance movement was recorded. | [optional] |
+| **updated_at** | **Time** | Date and time of the last change to the record. | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::BankStatement.new(
+  id: null,
+  amount: null,
+  operation: null,
+  reason: null,
+  balance_type: null,
+  previous_balance_available: null,
+  previous_balance_blocked: null,
+  new_balance_available: null,
+  new_balance_blocked: null,
+  transaction_id: null,
+  infraction_id: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/BankStatementListResponse.md

@@ -0,0 +1,20 @@
+# PayZuPix::BankStatementListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pagination** | [**BankStatementListResponsePagination**](BankStatementListResponsePagination.md) |  | [optional] |
+| **bank_statements** | [**Array<BankStatement>**](BankStatement.md) | Entries of the queried page. | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::BankStatementListResponse.new(
+  pagination: null,
+  bank_statements: null
+)
+```
+

data/docs/BankStatementListResponsePagination.md

@@ -0,0 +1,22 @@
+# PayZuPix::BankStatementListResponsePagination
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page returned, the same as the page parameter sent in the query; when omitted, it is 1. | [optional] |
+| **limit** | **Integer** | Page size applied in the query; when omitted it is 10 and the maximum accepted is 100. | [optional] |
+| **has_next_page** | **Boolean** | Indicates whether there is a next page, detected by fetching one item beyond the limit. | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::BankStatementListResponsePagination.new(
+  page: null,
+  limit: null,
+  has_next_page: null
+)
+```
+

data/docs/CallbackDetail.md

@@ -0,0 +1,34 @@
+# PayZuPix::CallbackDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique callback ID | [optional] |
+| **url** | **String** | Webhook URL that received the callback | [optional] |
+| **status** | **Float** | HTTP response status code | [optional] |
+| **transaction_id** | **String** | Related transaction ID | [optional] |
+| **created_at** | **Time** | Date and time when the callback log was created | [optional] |
+| **body** | **Object** | Request body sent (parsed JSON). When the content is not valid JSON, it comes as `{ \"raw\": \"<text>\" }`. | [optional] |
+| **response_body** | **String** | Response body received (string) | [optional] |
+| **response_headers** | **Object** | Response headers (parsed JSON). When the content is not valid JSON, it comes as `{ \"raw\": \"<text>\" }`. | [optional] |
+| **response_time** | **Float** | Webhook round-trip time in milliseconds | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::CallbackDetail.new(
+  id: null,
+  url: null,
+  status: null,
+  transaction_id: null,
+  created_at: null,
+  body: null,
+  response_body: null,
+  response_headers: null,
+  response_time: null
+)
+```
+

data/docs/CallbackListResponse.md

@@ -0,0 +1,20 @@
+# PayZuPix::CallbackListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pagination** | [**CallbackListResponsePagination**](CallbackListResponsePagination.md) |  | [optional] |
+| **callbacks** | [**Array<CallbackDetail>**](CallbackDetail.md) | Array of callback logs | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::CallbackListResponse.new(
+  pagination: null,
+  callbacks: null
+)
+```
+

data/docs/CallbackListResponsePagination.md

@@ -0,0 +1,22 @@
+# PayZuPix::CallbackListResponsePagination
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Current page | [optional] |
+| **limit** | **Integer** | Items per page | [optional] |
+| **has_next_page** | **Boolean** | Indicates if there is a next page | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::CallbackListResponsePagination.new(
+  page: null,
+  limit: null,
+  has_next_page: null
+)
+```
+

data/docs/CallbackSecretResponse.md

@@ -0,0 +1,20 @@
+# PayZuPix::CallbackSecretResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Confirmation of the created secret. | [optional] |
+| **secret** | **String** | Callback secret, 43 base64url characters. Store it: there is no route to read it again. | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::CallbackSecretResponse.new(
+  message: null,
+  secret: Zk8Qk1Yb3nS6xPwT2cVrJ9dLmHgA4eN7uKfR0iXsBqE
+)
+```
+