payzu-pix 2.0.0

data/docs/PostWithdrawQrcodeRequest.md

@@ -0,0 +1,28 @@
+# PayZuPix::PostWithdrawQrcodeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **qr_code** | **String** | Pix QR Code payload (EMV format). |  |
+| **amount** | **Float** | Amount in BRL, with at most 2 decimal places. Optional: if not provided, uses the QR Code's embedded value. | [optional] |
+| **callback_url** | **String** | URL for transaction notifications (http or https). | [optional] |
+| **description** | **String** | Optional description for the payment. | [optional] |
+| **client_reference** | **String** | External reference for this withdrawal. Repeating it with the same amount and QR Code returns the existing withdrawal; with different data, the request is rejected with PZC210. | [optional] |
+| **virtual_account** | **String** | Virtual sub-account (up to 50 characters) to correlate stores, branches, marketplaces. Returned in the callback. | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::PostWithdrawQrcodeRequest.new(
+  qr_code: 00020101021226770014br.gov.bcb.pix2555api.payzu/pix/qr/v2/013318d6-2d7d-479e-8bb3-b5c7b9da688c5204000053039865802BR5916PAYZU 6007SAOPAULO6217051320260118278956304EC55,
+  amount: 20,
+  callback_url: https://webhook.cool/,
+  description: Pagamento via QR Code,
+  client_reference: order-123,
+  virtual_account: loja-centro-01
+)
+```
+

data/docs/PostWithdrawRequest.md

@@ -0,0 +1,30 @@
+# PayZuPix::PostWithdrawRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount in BRL, with at most 2 decimal places. Must be >= 0.01. |  |
+| **pix_key** | **String** | Destination Pix key in the format of pixType: CPF or CNPJ with valid check digits and no punctuation, phone as +55 followed by area code and number, email, or random key (EVP). |  |
+| **pix_type** | **String** | Pix key type. |  |
+| **callback_url** | **String** | URL for transaction notifications (http or https). | [optional] |
+| **client_reference** | **String** | External reference for this withdrawal. Repeating it with the same amount and key returns the existing withdrawal; with different data, the request is rejected with PZC210. | [optional] |
+| **description** | **String** | Optional description. | [optional] |
+| **virtual_account** | **String** | Virtual sub-account (up to 50 characters) to correlate stores, branches, marketplaces. Returned in the callback. | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::PostWithdrawRequest.new(
+  amount: 2,
+  pix_key: teste@teste.com,
+  pix_type: email,
+  callback_url: https://webhook.cool/,
+  client_reference: withdraw_98765,
+  description: Weekly payout,
+  virtual_account: loja-centro-01
+)
+```
+

data/docs/ProofResponse.md

@@ -0,0 +1,18 @@
+# PayZuPix::ProofResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **base64** | **String** | PDF receipt as a base64 data URI (`data:application/pdf;base64,...`), returned when type=base64. | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::ProofResponse.new(
+  base64: null
+)
+```
+

data/docs/QRCodeReadResponse.md

@@ -0,0 +1,38 @@
+# PayZuPix::QRCodeReadResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **qr_code_type** | **String** | Type of QR Code. | [optional] |
+| **name** | **String** | Name of the payment receiver. | [optional] |
+| **document** | **String** | CPF or CNPJ of the receiver. | [optional] |
+| **amount** | **Float** | Amount to be paid (may differ from originalAmount for dynamic QR Codes). | [optional] |
+| **original_amount** | **Float** | Original amount embedded in the QR Code. | [optional] |
+| **txid** | **String** | Transaction identifier. | [optional] |
+| **additional_info** | **String** | Additional information or description. | [optional] |
+| **expires_in** | **Float** | Seconds until QR Code expires (0 for static QR Codes). | [optional] |
+| **created_at** | **Time** | Creation date of the QR Code (for dynamic QR Codes). | [optional] |
+| **amount_editable** | **Boolean** | Whether the payer can change the amount. | [optional] |
+| **due_date** | **String** | Due date of the charge, when the QR Code has one. | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::QRCodeReadResponse.new(
+  qr_code_type: null,
+  name: null,
+  document: null,
+  amount: null,
+  original_amount: null,
+  txid: null,
+  additional_info: null,
+  expires_in: null,
+  created_at: null,
+  amount_editable: null,
+  due_date: null
+)
+```
+

data/docs/Refund.md

@@ -0,0 +1,34 @@
+# PayZuPix::Refund
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Refund identifier. | [optional] |
+| **amount** | **Float** | Refunded amount in BRL. | [optional] |
+| **reason** | **String** | Refund reason. | [optional] |
+| **description** | **String** | Refund description. | [optional] |
+| **status** | **String** | Refund status. | [optional] |
+| **end_to_end_id** | **String** | End-to-end ID of the refund Pix. | [optional] |
+| **refunded_at** | **Time** | When the refund was completed. | [optional] |
+| **created_at** | **Time** | When the refund was requested. | [optional] |
+| **updated_at** | **Time** | Last change to the refund. | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::Refund.new(
+  id: null,
+  amount: null,
+  reason: null,
+  description: null,
+  status: null,
+  end_to_end_id: null,
+  refunded_at: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/RefundRequest.md

@@ -0,0 +1,22 @@
+# PayZuPix::RefundRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount in BRL to refund. Omit to refund the full transaction amount. Partial refunds are allowed up to the original amount. | [optional] |
+| **description** | **String** | Free-text description for the refund. | [optional] |
+| **client_reference** | **String** | Idempotency key. Reusing it with the same amount replays the existing refund; reusing it with a different amount is rejected. | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::RefundRequest.new(
+  amount: 30.5,
+  description: Estorno solicitado pelo cliente,
+  client_reference: refund-2026-0001
+)
+```
+

data/docs/RefundsApi.md

@@ -0,0 +1,79 @@
+# PayZuPix::RefundsApi
+
+All URIs are relative to *https://api.payzu.processamento.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**post_refund**](RefundsApi.md#post_refund) | **POST** /refund/{transactionId} | Refund a Pix |
+
+
+## post_refund
+
+> <TransactionWithRefunds> post_refund(transaction_id, refund_request)
+
+Refund a Pix
+
+Refund a received Pix charge. Provide `amount` for a partial refund, or omit it to refund the full amount. Processing is **asynchronous**: the response returns the transaction with `refundStatus: PENDING`; completion is confirmed later by webhook.  Send `{}` to refund the full amount.  Token permission: `WITHDRAW`.
+
+### 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::RefundsApi.new
+transaction_id = 'PAYZU20260814T6NX1CV9MK000000' # String | ID of the transaction to refund.
+refund_request = PayZuPix::RefundRequest.new # RefundRequest | 
+
+begin
+  # Refund a Pix
+  result = api_instance.post_refund(transaction_id, refund_request)
+  p result
+rescue PayZuPix::ApiError => e
+  puts "Error when calling RefundsApi->post_refund: #{e}"
+end
+```
+
+#### Using the post_refund_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionWithRefunds>, Integer, Hash)> post_refund_with_http_info(transaction_id, refund_request)
+
+```ruby
+begin
+  # Refund a Pix
+  data, status_code, headers = api_instance.post_refund_with_http_info(transaction_id, refund_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionWithRefunds>
+rescue PayZuPix::ApiError => e
+  puts "Error when calling RefundsApi->post_refund_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** | ID of the transaction to refund. |  |
+| **refund_request** | [**RefundRequest**](RefundRequest.md) |  |  |
+
+### Return type
+
+[**TransactionWithRefunds**](TransactionWithRefunds.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ReportJob.md

@@ -0,0 +1,30 @@
+# PayZuPix::ReportJob
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Report identifier (UUID), generated when the report is requested. | [optional] |
+| **status** | **String** | Generation progress: PENDING, RUNNING, COMPLETED or FAILED. | [optional] |
+| **created_at** | **Time** | Date and time the report generation was requested. | [optional] |
+| **updated_at** | **Time** | Date and time of the last change to the report record. | [optional] |
+| **expires_at** | **Time** | When the file expires from storage (typically 7 days after creation) | [optional] |
+| **params** | **Object** | Filters used to generate the report. | [optional] |
+| **written_rows** | **Integer** | Rows written to the file. Null until the report is COMPLETED. | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::ReportJob.new(
+  id: null,
+  status: null,
+  created_at: null,
+  updated_at: null,
+  expires_at: null,
+  params: null,
+  written_rows: null
+)
+```
+

data/docs/ReportJobAccepted.md

@@ -0,0 +1,30 @@
+# PayZuPix::ReportJobAccepted
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Report identifier (UUID), generated when the report is requested. | [optional] |
+| **status** | **String** | Generation progress: PENDING, RUNNING, COMPLETED or FAILED. | [optional] |
+| **created_at** | **Time** | Date and time the report generation was requested. | [optional] |
+| **updated_at** | **Time** | Date and time of the last change to the report record. | [optional] |
+| **params** | **Hash<String, Object>** | Filters used when the report was created. | [optional] |
+| **written_rows** | **Integer** | Rows written to the file. Null until the report is COMPLETED. | [optional] |
+| **storage_expires_at** | **Time** | Date the report file expires. | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::ReportJobAccepted.new(
+  id: null,
+  status: null,
+  created_at: null,
+  updated_at: null,
+  params: null,
+  written_rows: null,
+  storage_expires_at: null
+)
+```
+

data/docs/ReportJobDetail.md

@@ -0,0 +1,30 @@
+# PayZuPix::ReportJobDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Report identifier (UUID), generated when the report is requested. | [optional] |
+| **status** | **String** | Generation progress: PENDING, RUNNING, COMPLETED or FAILED. | [optional] |
+| **created_at** | **Time** | Date and time the report generation was requested. | [optional] |
+| **updated_at** | **Time** | Date and time of the last change to the report record. | [optional] |
+| **expires_at** | **Time** | When the file expires from storage (usually 7 days after creation) | [optional] |
+| **params** | **Hash<String, Object>** | Filters used when the report was created. | [optional] |
+| **written_rows** | **Integer** | Rows written to the file. Null until the report is COMPLETED. | [optional] |
+
+## Example
+
+```ruby
+require 'payzu-pix'
+
+instance = PayZuPix::ReportJobDetail.new(
+  id: null,
+  status: null,
+  created_at: null,
+  updated_at: null,
+  expires_at: null,
+  params: null,
+  written_rows: null
+)
+```
+