payzu-pix 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (172) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +231 -0
  4. data/Rakefile +10 -0
  5. data/docs/AccountApi.md +141 -0
  6. data/docs/ApiErrorDetailsInner.md +20 -0
  7. data/docs/BankStatement.md +42 -0
  8. data/docs/BankStatementListResponse.md +20 -0
  9. data/docs/BankStatementListResponsePagination.md +22 -0
  10. data/docs/CallbackDetail.md +34 -0
  11. data/docs/CallbackListResponse.md +20 -0
  12. data/docs/CallbackListResponsePagination.md +22 -0
  13. data/docs/CallbackSecretResponse.md +20 -0
  14. data/docs/CallbacksApi.md +587 -0
  15. data/docs/Defense.md +30 -0
  16. data/docs/DefenseFilesInner.md +24 -0
  17. data/docs/DefenseHistoryEntry.md +28 -0
  18. data/docs/DefenseHistoryEntryFilesInner.md +22 -0
  19. data/docs/DepositPending.md +62 -0
  20. data/docs/DepositPendingListResponse.md +24 -0
  21. data/docs/DictConsultResponse.md +30 -0
  22. data/docs/DownloadUserReport200Response.md +20 -0
  23. data/docs/EnqueuedCallback.md +18 -0
  24. data/docs/EnqueuedCallbackEnqueued.md +22 -0
  25. data/docs/EnqueuedCallbackItem.md +22 -0
  26. data/docs/ErrorResponse.md +32 -0
  27. data/docs/GetUser200Response.md +46 -0
  28. data/docs/GetUser200ResponseDailyWithdrawLimit.md +24 -0
  29. data/docs/GetUser200ResponseServiceFee.md +28 -0
  30. data/docs/GetUserBalance200Response.md +20 -0
  31. data/docs/GetUserTransactionById200Response.md +94 -0
  32. data/docs/GetUserTransactionById200ResponseAllOfCallbackLogInner.md +26 -0
  33. data/docs/GetUserTransactionById200ResponseAllOfInfractionInner.md +24 -0
  34. data/docs/GetUserTransactions200Response.md +22 -0
  35. data/docs/InfractionDetail.md +40 -0
  36. data/docs/InfractionDetailTransaction.md +30 -0
  37. data/docs/InfractionListResponse.md +20 -0
  38. data/docs/InfractionListResponsePagination.md +24 -0
  39. data/docs/InfractionsApi.md +413 -0
  40. data/docs/InternalTransferApi.md +153 -0
  41. data/docs/KeysAndDICTApi.md +217 -0
  42. data/docs/ListUserReports200Response.md +22 -0
  43. data/docs/PixKeyInfo.md +36 -0
  44. data/docs/PixOperationsApi.md +299 -0
  45. data/docs/PostInternalTransferRequest.md +30 -0
  46. data/docs/PostPixQrcodeReadRequest.md +18 -0
  47. data/docs/PostPixRequest.md +32 -0
  48. data/docs/PostUserReportRequest.md +24 -0
  49. data/docs/PostWithdrawQrcodeRequest.md +28 -0
  50. data/docs/PostWithdrawRequest.md +30 -0
  51. data/docs/ProofResponse.md +18 -0
  52. data/docs/QRCodeReadResponse.md +38 -0
  53. data/docs/Refund.md +34 -0
  54. data/docs/RefundRequest.md +22 -0
  55. data/docs/RefundsApi.md +79 -0
  56. data/docs/ReportJob.md +30 -0
  57. data/docs/ReportJobAccepted.md +30 -0
  58. data/docs/ReportJobDetail.md +30 -0
  59. data/docs/ReportsApi.md +881 -0
  60. data/docs/ResendUserCallbackSingle200Response.md +18 -0
  61. data/docs/ResendUserCallbacks200Response.md +20 -0
  62. data/docs/ResendUserCallbacksRequest.md +28 -0
  63. data/docs/ResendWebhookCallbacksRequest.md +30 -0
  64. data/docs/RotateCallbackSecretResponse.md +18 -0
  65. data/docs/RotateSecretResponse.md +18 -0
  66. data/docs/SentWebhookDetail.md +40 -0
  67. data/docs/SentWebhookDetailResponse.md +18 -0
  68. data/docs/SentWebhooksQuantity.md +18 -0
  69. data/docs/Summary.md +26 -0
  70. data/docs/SummaryBlock.md +24 -0
  71. data/docs/SummaryBlockGroupedInner.md +20 -0
  72. data/docs/SummaryBlockStatuses.md +26 -0
  73. data/docs/SummaryStatus.md +22 -0
  74. data/docs/Transaction.md +90 -0
  75. data/docs/TransactionWithRefunds.md +92 -0
  76. data/docs/Webhook.md +30 -0
  77. data/docs/WebhookCreateRequest.md +24 -0
  78. data/docs/WebhookEventType.md +15 -0
  79. data/docs/WebhookListResponse.md +18 -0
  80. data/docs/WebhookUpdateRequest.md +22 -0
  81. data/docs/WebhookWithSecret.md +32 -0
  82. data/docs/WebhooksApi.md +574 -0
  83. data/docs/WithdrawalsApi.md +299 -0
  84. data/git_push.sh +57 -0
  85. data/lib/payzu-pix/api/account_api.rb +136 -0
  86. data/lib/payzu-pix/api/callbacks_api.rb +577 -0
  87. data/lib/payzu-pix/api/infractions_api.rb +452 -0
  88. data/lib/payzu-pix/api/internal_transfer_api.rb +164 -0
  89. data/lib/payzu-pix/api/keys_and_dict_api.rb +234 -0
  90. data/lib/payzu-pix/api/pix_operations_api.rb +300 -0
  91. data/lib/payzu-pix/api/refunds_api.rb +96 -0
  92. data/lib/payzu-pix/api/reports_api.rb +968 -0
  93. data/lib/payzu-pix/api/webhooks_api.rb +542 -0
  94. data/lib/payzu-pix/api/withdrawals_api.rb +305 -0
  95. data/lib/payzu-pix/api_client.rb +441 -0
  96. data/lib/payzu-pix/api_error.rb +58 -0
  97. data/lib/payzu-pix/api_model_base.rb +88 -0
  98. data/lib/payzu-pix/configuration.rb +392 -0
  99. data/lib/payzu-pix/models/api_error_details_inner.rb +192 -0
  100. data/lib/payzu-pix/models/bank_statement.rb +296 -0
  101. data/lib/payzu-pix/models/bank_statement_list_response.rb +159 -0
  102. data/lib/payzu-pix/models/bank_statement_list_response_pagination.rb +169 -0
  103. data/lib/payzu-pix/models/callback_detail.rb +228 -0
  104. data/lib/payzu-pix/models/callback_list_response.rb +159 -0
  105. data/lib/payzu-pix/models/callback_list_response_pagination.rb +169 -0
  106. data/lib/payzu-pix/models/callback_secret_response.rb +158 -0
  107. data/lib/payzu-pix/models/defense.rb +234 -0
  108. data/lib/payzu-pix/models/defense_files_inner.rb +179 -0
  109. data/lib/payzu-pix/models/defense_history_entry.rb +225 -0
  110. data/lib/payzu-pix/models/defense_history_entry_files_inner.rb +168 -0
  111. data/lib/payzu-pix/models/deposit_pending.rb +407 -0
  112. data/lib/payzu-pix/models/deposit_pending_list_response.rb +180 -0
  113. data/lib/payzu-pix/models/dict_consult_response.rb +231 -0
  114. data/lib/payzu-pix/models/download_user_report200_response.rb +158 -0
  115. data/lib/payzu-pix/models/enqueued_callback.rb +147 -0
  116. data/lib/payzu-pix/models/enqueued_callback_enqueued.rb +170 -0
  117. data/lib/payzu-pix/models/enqueued_callback_item.rb +190 -0
  118. data/lib/payzu-pix/models/error_response.rb +336 -0
  119. data/lib/payzu-pix/models/get_user200_response.rb +334 -0
  120. data/lib/payzu-pix/models/get_user200_response_daily_withdraw_limit.rb +180 -0
  121. data/lib/payzu-pix/models/get_user200_response_service_fee.rb +199 -0
  122. data/lib/payzu-pix/models/get_user_balance200_response.rb +158 -0
  123. data/lib/payzu-pix/models/get_user_transaction_by_id200_response.rb +595 -0
  124. data/lib/payzu-pix/models/get_user_transaction_by_id200_response_all_of_callback_log_inner.rb +188 -0
  125. data/lib/payzu-pix/models/get_user_transaction_by_id200_response_all_of_infraction_inner.rb +202 -0
  126. data/lib/payzu-pix/models/get_user_transactions200_response.rb +170 -0
  127. data/lib/payzu-pix/models/infraction_detail.rb +293 -0
  128. data/lib/payzu-pix/models/infraction_detail_transaction.rb +213 -0
  129. data/lib/payzu-pix/models/infraction_list_response.rb +159 -0
  130. data/lib/payzu-pix/models/infraction_list_response_pagination.rb +179 -0
  131. data/lib/payzu-pix/models/list_user_reports200_response.rb +170 -0
  132. data/lib/payzu-pix/models/pix_key_info.rb +263 -0
  133. data/lib/payzu-pix/models/post_internal_transfer_request.rb +377 -0
  134. data/lib/payzu-pix/models/post_pix_qrcode_read_request.rb +174 -0
  135. data/lib/payzu-pix/models/post_pix_request.rb +382 -0
  136. data/lib/payzu-pix/models/post_user_report_request.rb +238 -0
  137. data/lib/payzu-pix/models/post_withdraw_qrcode_request.rb +302 -0
  138. data/lib/payzu-pix/models/post_withdraw_request.rb +350 -0
  139. data/lib/payzu-pix/models/proof_response.rb +148 -0
  140. data/lib/payzu-pix/models/qr_code_read_response.rb +283 -0
  141. data/lib/payzu-pix/models/refund.rb +257 -0
  142. data/lib/payzu-pix/models/refund_request.rb +215 -0
  143. data/lib/payzu-pix/models/report_job.rb +234 -0
  144. data/lib/payzu-pix/models/report_job_accepted.rb +237 -0
  145. data/lib/payzu-pix/models/report_job_detail.rb +237 -0
  146. data/lib/payzu-pix/models/resend_user_callback_single200_response.rb +148 -0
  147. data/lib/payzu-pix/models/resend_user_callbacks200_response.rb +158 -0
  148. data/lib/payzu-pix/models/resend_user_callbacks_request.rb +262 -0
  149. data/lib/payzu-pix/models/resend_webhook_callbacks_request.rb +274 -0
  150. data/lib/payzu-pix/models/rotate_callback_secret_response.rb +148 -0
  151. data/lib/payzu-pix/models/rotate_secret_response.rb +148 -0
  152. data/lib/payzu-pix/models/sent_webhook_detail.rb +261 -0
  153. data/lib/payzu-pix/models/sent_webhook_detail_response.rb +164 -0
  154. data/lib/payzu-pix/models/sent_webhooks_quantity.rb +148 -0
  155. data/lib/payzu-pix/models/summary.rb +188 -0
  156. data/lib/payzu-pix/models/summary_block.rb +179 -0
  157. data/lib/payzu-pix/models/summary_block_grouped_inner.rb +158 -0
  158. data/lib/payzu-pix/models/summary_block_statuses.rb +189 -0
  159. data/lib/payzu-pix/models/summary_status.rb +168 -0
  160. data/lib/payzu-pix/models/transaction.rb +588 -0
  161. data/lib/payzu-pix/models/transaction_with_refunds.rb +583 -0
  162. data/lib/payzu-pix/models/webhook.rb +210 -0
  163. data/lib/payzu-pix/models/webhook_create_request.rb +201 -0
  164. data/lib/payzu-pix/models/webhook_event_type.rb +47 -0
  165. data/lib/payzu-pix/models/webhook_list_response.rb +150 -0
  166. data/lib/payzu-pix/models/webhook_update_request.rb +171 -0
  167. data/lib/payzu-pix/models/webhook_with_secret.rb +220 -0
  168. data/lib/payzu-pix/version.rb +15 -0
  169. data/lib/payzu-pix.rb +119 -0
  170. data/payzu-pix.gemspec +41 -0
  171. data/spec/spec_helper.rb +111 -0
  172. metadata +283 -0
@@ -0,0 +1,18 @@
1
+ # PayZuPix::ResendUserCallbackSingle200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | Fixed text confirming that the resend of the given transaction was queued. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'payzu-pix'
13
+
14
+ instance = PayZuPix::ResendUserCallbackSingle200Response.new(
15
+ message: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # PayZuPix::ResendUserCallbacks200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | Confirmation that the callbacks were queued. | [optional] |
8
+ | **total** | **Integer** | Number of callbacks dispatched | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'payzu-pix'
14
+
15
+ instance = PayZuPix::ResendUserCallbacks200Response.new(
16
+ message: null,
17
+ total: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,28 @@
1
+ # PayZuPix::ResendUserCallbacksRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **created_at_from** | **Time** | Start of the period. At most 30 days ago. | |
8
+ | **created_at_to** | **Time** | End of the period, on or after createdAtFrom. The window between start and end cannot exceed 7 days. | |
9
+ | **transaction_ids** | **Array<String>** | Restrict to specific transaction IDs | [optional] |
10
+ | **transaction_types** | **Array<String>** | Filter by transaction type | [optional] |
11
+ | **transaction_status** | **Array<String>** | Filter by transaction status | [optional] |
12
+ | **transaction_end_to_end_ids** | **Array<String>** | Restrict to specific Pix end-to-end IDs | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'payzu-pix'
18
+
19
+ instance = PayZuPix::ResendUserCallbacksRequest.new(
20
+ created_at_from: 2026-08-05T00:00:00Z,
21
+ created_at_to: 2026-08-11T23:59:59Z,
22
+ transaction_ids: null,
23
+ transaction_types: null,
24
+ transaction_status: null,
25
+ transaction_end_to_end_ids: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,30 @@
1
+ # PayZuPix::ResendWebhookCallbacksRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **created_at_from** | **Time** | Start of the delivery period. At most 30 days ago. | |
8
+ | **created_at_to** | **Time** | End of the delivery period, on or after createdAtFrom. The window cannot exceed 7 days. | |
9
+ | **webhook_ids** | **Array<String>** | Webhooks to resend. Omitted: all active webhooks of the account. | [optional] |
10
+ | **transaction_ids** | **Array<String>** | Restrict to specific transaction IDs. | [optional] |
11
+ | **transaction_types** | **Array<String>** | Filter by transaction type. | [optional] |
12
+ | **transaction_status** | **Array<String>** | Filter by the current transaction status. | [optional] |
13
+ | **transaction_end_to_end_ids** | **Array<String>** | Restrict to specific end-to-end IDs. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'payzu-pix'
19
+
20
+ instance = PayZuPix::ResendWebhookCallbacksRequest.new(
21
+ created_at_from: 2026-08-05T00:00:00Z,
22
+ created_at_to: 2026-08-11T23:59:59Z,
23
+ webhook_ids: null,
24
+ transaction_ids: null,
25
+ transaction_types: null,
26
+ transaction_status: null,
27
+ transaction_end_to_end_ids: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,18 @@
1
+ # PayZuPix::RotateCallbackSecretResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **secret** | **String** | Callback secret, 43 base64url characters. Store it: there is no route to read it again. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'payzu-pix'
13
+
14
+ instance = PayZuPix::RotateCallbackSecretResponse.new(
15
+ secret: Zk8Qk1Yb3nS6xPwT2cVrJ9dLmHgA4eN7uKfR0iXsBqE
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # PayZuPix::RotateSecretResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **secret** | **String** | HMAC signing secret. Shown only on creation and on rotate-secret. Store it now. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'payzu-pix'
13
+
14
+ instance = PayZuPix::RotateSecretResponse.new(
15
+ secret: q7Kx2mV9pL4sR8tW1nB6cY3hJ5dF0gZ-aE_uT7iO2kM
16
+ )
17
+ ```
18
+
@@ -0,0 +1,40 @@
1
+ # PayZuPix::SentWebhookDetail
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Identifier of this delivery attempt. | [optional] |
8
+ | **webhook_id** | **String** | Webhook that originated the delivery. | [optional] |
9
+ | **transaction_id** | **String** | Pix transaction whose event was notified. | [optional] |
10
+ | **url** | **String** | Address this delivery was sent to, recorded at the time of the dispatch. | [optional] |
11
+ | **body** | **String** | Body sent in the delivery, as serialized JSON. | [optional] |
12
+ | **status** | **Integer** | HTTP status returned by your endpoint. | [optional] |
13
+ | **response_headers** | **String** | Response headers, as serialized JSON. | [optional] |
14
+ | **response_body** | **String** | Body of the response received. | [optional] |
15
+ | **error** | **String** | Message of the delivery failure. | [optional] |
16
+ | **response_time** | **Integer** | Response time of your endpoint, in milliseconds. | [optional] |
17
+ | **event_type** | **String** | Event that triggered this delivery, the same value sent in the X-Callback-Event header. | [optional] |
18
+ | **created_at** | **Time** | Moment of the delivery attempt. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'payzu-pix'
24
+
25
+ instance = PayZuPix::SentWebhookDetail.new(
26
+ id: null,
27
+ webhook_id: null,
28
+ transaction_id: null,
29
+ url: null,
30
+ body: null,
31
+ status: 200,
32
+ response_headers: null,
33
+ response_body: null,
34
+ error: null,
35
+ response_time: 342,
36
+ event_type: null,
37
+ created_at: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,18 @@
1
+ # PayZuPix::SentWebhookDetailResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sent_webhook_details** | [**SentWebhookDetail**](SentWebhookDetail.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'payzu-pix'
13
+
14
+ instance = PayZuPix::SentWebhookDetailResponse.new(
15
+ sent_webhook_details: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # PayZuPix::SentWebhooksQuantity
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **quantity** | **Integer** | Total of deliveries recorded. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'payzu-pix'
13
+
14
+ instance = PayZuPix::SentWebhooksQuantity.new(
15
+ quantity: 128
16
+ )
17
+ ```
18
+
data/docs/Summary.md ADDED
@@ -0,0 +1,26 @@
1
+ # PayZuPix::Summary
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **total_transactions** | **Integer** | Number of transactions in the period. | [optional] |
8
+ | **deposit** | [**SummaryBlock**](SummaryBlock.md) | Summary of the account inflows in the period, that is, of the transactions of type DEPOSIT. | [optional] |
9
+ | **withdraw** | [**SummaryBlock**](SummaryBlock.md) | Summary of the account outflows in the period, that is, of the transactions of type WITHDRAW. | [optional] |
10
+ | **commission** | [**SummaryBlock**](SummaryBlock.md) | Summary of the commissions credited to the account in the period (transactions of type COMMISSION). | [optional] |
11
+ | **adjustment** | [**SummaryBlock**](SummaryBlock.md) | Summary of the adjustments in the period (transactions of type ADJUSTMENT). | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'payzu-pix'
17
+
18
+ instance = PayZuPix::Summary.new(
19
+ total_transactions: null,
20
+ deposit: null,
21
+ withdraw: null,
22
+ commission: null,
23
+ adjustment: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,24 @@
1
+ # PayZuPix::SummaryBlock
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **total_amount** | **Float** | Sum of the amounts in the period. | [optional] |
8
+ | **total_transactions** | **Integer** | Number of transactions of that type in the period, also summing all statuses. | [optional] |
9
+ | **statuses** | [**SummaryBlockStatuses**](SummaryBlockStatuses.md) | | [optional] |
10
+ | **grouped** | [**Array<SummaryBlockGroupedInner>**](SummaryBlockGroupedInner.md) | Present only when grouped=true. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'payzu-pix'
16
+
17
+ instance = PayZuPix::SummaryBlock.new(
18
+ total_amount: null,
19
+ total_transactions: null,
20
+ statuses: null,
21
+ grouped: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # PayZuPix::SummaryBlockGroupedInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **date** | **String** | Day (YYYY-MM-DD, America/Sao_Paulo time zone). | [optional] |
8
+ | **amount** | **Float** | Sum of the amounts, in reais, of the completed transactions of the day. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'payzu-pix'
14
+
15
+ instance = PayZuPix::SummaryBlockGroupedInner.new(
16
+ date: null,
17
+ amount: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # PayZuPix::SummaryBlockStatuses
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **pending** | [**SummaryStatus**](SummaryStatus.md) | Count and sum of the amounts, in reais, of the transactions with status PENDING in the queried period. | [optional] |
8
+ | **completed** | [**SummaryStatus**](SummaryStatus.md) | Count and sum of the completed transactions, in reais. | [optional] |
9
+ | **canceled** | [**SummaryStatus**](SummaryStatus.md) | Count and sum of the canceled transactions, in reais. | [optional] |
10
+ | **expired** | [**SummaryStatus**](SummaryStatus.md) | Count and sum of the expired transactions, in reais. | [optional] |
11
+ | **refunded** | [**SummaryStatus**](SummaryStatus.md) | Count and refunded amount in the period, in reais. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'payzu-pix'
17
+
18
+ instance = PayZuPix::SummaryBlockStatuses.new(
19
+ pending: null,
20
+ completed: null,
21
+ canceled: null,
22
+ expired: null,
23
+ refunded: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # PayZuPix::SummaryStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **count** | **Integer** | Number of transactions in that state within the period. | [optional] |
8
+ | **amount** | **Float** | Sum of the amounts of those transactions. | [optional] |
9
+ | **service_fee_charged** | **Float** | Sum of the fees charged on those transactions, in BRL. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'payzu-pix'
15
+
16
+ instance = PayZuPix::SummaryStatus.new(
17
+ count: null,
18
+ amount: null,
19
+ service_fee_charged: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,90 @@
1
+ # PayZuPix::Transaction
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Identifier of the transaction at PayZu. | [optional] |
8
+ | **status** | **String** | PENDING, COMPLETED, CANCELED, WAITING_FOR_REFUND, REFUNDED, EXPIRED, ERROR | [optional] |
9
+ | **amount** | **Float** | Amount of the transaction, before the fee. | [optional] |
10
+ | **type** | **String** | Transaction type: DEPOSIT, WITHDRAW, COMMISSION, LIQUIDATION or ADJUSTMENT. | [optional] |
11
+ | **qr_code_text** | **String** | Copy-and-paste Pix code. | [optional] |
12
+ | **qr_code_base64** | **String** | PNG image of the QR Code in base64, without the data: prefix. | [optional] |
13
+ | **qr_code_url** | **String** | Authenticated route that returns the PNG of the QR Code. | [optional] |
14
+ | **generated_name** | **String** | Name used to build the charge. | [optional] |
15
+ | **generated_document** | **String** | CPF or CNPJ used as the debtor of the charge. | [optional] |
16
+ | **generated_email** | **String** | Email used to build the charge. | [optional] |
17
+ | **payer_name** | **String** | Name of the holder of the account that sent the Pix, as reported by the originating institution. | [optional] |
18
+ | **payer_document** | **String** | CPF or CNPJ of the payer of the Pix, reported by the originating institution. | [optional] |
19
+ | **payer_institution_ispb** | **String** | ISPB code of the institution the Pix was sent from. | [optional] |
20
+ | **payer_institution_name** | **String** | Name of the institution the Pix was sent from. | [optional] |
21
+ | **payer_account_number** | **String** | Payer's PayZu account number (6 digits). Present on withdraw, internal-transfer and commission transactions. | [optional] |
22
+ | **service_fee_charged** | **Float** | PayZu fee charged on the operation, in reais. It may carry more than two decimal places — do not round when reconciling. | [optional] |
23
+ | **withdraw_pix_key** | **String** | Destination Pix key of the withdrawal, already normalized. | [optional] |
24
+ | **withdraw_pix_type** | **String** | Type of the destination key of the withdrawal, with evp being the random key. | [optional] |
25
+ | **receiver_name** | **String** | Name of the holder of the receiving account. | [optional] |
26
+ | **receiver_document** | **String** | CPF or CNPJ of the receiver. | [optional] |
27
+ | **receiver_institution_ispb** | **String** | ISPB code of the institution that receives the Pix. | [optional] |
28
+ | **receiver_institution_name** | **String** | Name of the institution that receives the Pix. | [optional] |
29
+ | **receiver_account_number** | **String** | Receiver's PayZu account number (6 digits). Present on deposit, internal-transfer and commission transactions. | [optional] |
30
+ | **end_to_end_id** | **String** | Identifier of the Pix in the Bacen arrangement, used to track the settlement and request a return. | [optional] |
31
+ | **created_at** | **String** | Date and time the transaction was recorded. | [optional] |
32
+ | **updated_at** | **String** | Date and time of the last change. | [optional] |
33
+ | **paid_at** | **String** | Date and time the Pix was settled, reported by the institution. | [optional] |
34
+ | **client_reference** | **String** | Your identifier of the transaction, returned in queries and callbacks. | [optional] |
35
+ | **refund_end_to_end_id** | **String** | End-to-end ID of the refund transaction | [optional] |
36
+ | **refund_amount** | **Float** | Amount refunded | [optional] |
37
+ | **refund_status** | **String** | Refund status: PENDING, COMPLETED or CANCELED. | [optional] |
38
+ | **refund_reason** | **String** | Reason for the refund | [optional] |
39
+ | **refund_description** | **String** | Description of the refund | [optional] |
40
+ | **refunded_at** | **String** | Date and time when the refund was processed | [optional] |
41
+ | **cancellation_reason** | **String** | Reason for cancellation (if cancelled) | [optional] |
42
+ | **virtual_account** | **String** | Virtual sub-account provided at creation. | [optional] |
43
+ | **method** | **String** | Transaction method/rail. | [optional] |
44
+
45
+ ## Example
46
+
47
+ ```ruby
48
+ require 'payzu-pix'
49
+
50
+ instance = PayZuPix::Transaction.new(
51
+ id: null,
52
+ status: null,
53
+ amount: null,
54
+ type: null,
55
+ qr_code_text: null,
56
+ qr_code_base64: null,
57
+ qr_code_url: null,
58
+ generated_name: null,
59
+ generated_document: null,
60
+ generated_email: null,
61
+ payer_name: null,
62
+ payer_document: null,
63
+ payer_institution_ispb: null,
64
+ payer_institution_name: null,
65
+ payer_account_number: null,
66
+ service_fee_charged: null,
67
+ withdraw_pix_key: null,
68
+ withdraw_pix_type: null,
69
+ receiver_name: null,
70
+ receiver_document: null,
71
+ receiver_institution_ispb: null,
72
+ receiver_institution_name: null,
73
+ receiver_account_number: null,
74
+ end_to_end_id: null,
75
+ created_at: null,
76
+ updated_at: null,
77
+ paid_at: null,
78
+ client_reference: null,
79
+ refund_end_to_end_id: null,
80
+ refund_amount: null,
81
+ refund_status: null,
82
+ refund_reason: null,
83
+ refund_description: null,
84
+ refunded_at: null,
85
+ cancellation_reason: null,
86
+ virtual_account: null,
87
+ method: null
88
+ )
89
+ ```
90
+
@@ -0,0 +1,92 @@
1
+ # PayZuPix::TransactionWithRefunds
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Identifier of the transaction at PayZu. | [optional] |
8
+ | **status** | **String** | PENDING, COMPLETED, CANCELED, WAITING_FOR_REFUND, REFUNDED, EXPIRED, ERROR | [optional] |
9
+ | **amount** | **Float** | Amount of the transaction, before the fee. | [optional] |
10
+ | **type** | **String** | Transaction type: DEPOSIT, WITHDRAW, COMMISSION, LIQUIDATION or ADJUSTMENT. | [optional] |
11
+ | **qr_code_text** | **String** | Copy-and-paste Pix code. | [optional] |
12
+ | **qr_code_base64** | **String** | PNG image of the QR Code in base64, without the data: prefix. | [optional] |
13
+ | **qr_code_url** | **String** | Authenticated route that returns the PNG of the QR Code. | [optional] |
14
+ | **generated_name** | **String** | Name used to build the charge. | [optional] |
15
+ | **generated_document** | **String** | CPF or CNPJ used as the debtor of the charge. | [optional] |
16
+ | **generated_email** | **String** | Email used to build the charge. | [optional] |
17
+ | **payer_name** | **String** | Name of the holder of the account that sent the Pix, as reported by the originating institution. | [optional] |
18
+ | **payer_document** | **String** | CPF or CNPJ of the payer of the Pix, reported by the originating institution. | [optional] |
19
+ | **payer_institution_ispb** | **String** | ISPB code of the institution the Pix was sent from. | [optional] |
20
+ | **payer_institution_name** | **String** | Name of the institution the Pix was sent from. | [optional] |
21
+ | **payer_account_number** | **String** | Payer's PayZu account number (6 digits). Present on withdraw, internal-transfer and commission transactions. | [optional] |
22
+ | **service_fee_charged** | **Float** | PayZu fee charged on the operation, in reais. It may carry more than two decimal places — do not round when reconciling. | [optional] |
23
+ | **withdraw_pix_key** | **String** | Destination Pix key of the withdrawal, already normalized. | [optional] |
24
+ | **withdraw_pix_type** | **String** | Type of the destination key of the withdrawal, with evp being the random key. | [optional] |
25
+ | **receiver_name** | **String** | Name of the holder of the receiving account. | [optional] |
26
+ | **receiver_document** | **String** | CPF or CNPJ of the receiver. | [optional] |
27
+ | **receiver_institution_ispb** | **String** | ISPB code of the institution that receives the Pix. | [optional] |
28
+ | **receiver_institution_name** | **String** | Name of the institution that receives the Pix. | [optional] |
29
+ | **receiver_account_number** | **String** | Receiver's PayZu account number (6 digits). Present on deposit, internal-transfer and commission transactions. | [optional] |
30
+ | **end_to_end_id** | **String** | Identifier of the Pix in the Bacen arrangement, used to track the settlement and request a return. | [optional] |
31
+ | **created_at** | **String** | Date and time the transaction was recorded. | [optional] |
32
+ | **updated_at** | **String** | Date and time of the last change. | [optional] |
33
+ | **paid_at** | **String** | Date and time the Pix was settled, reported by the institution. | [optional] |
34
+ | **client_reference** | **String** | Your identifier of the transaction, returned in queries and callbacks. | [optional] |
35
+ | **refund_end_to_end_id** | **String** | End-to-end ID of the refund transaction | [optional] |
36
+ | **refund_amount** | **Float** | Amount refunded | [optional] |
37
+ | **refund_status** | **String** | Refund status: PENDING, COMPLETED or CANCELED. | [optional] |
38
+ | **refund_reason** | **String** | Reason for the refund | [optional] |
39
+ | **refund_description** | **String** | Description of the refund | [optional] |
40
+ | **refunded_at** | **String** | Date and time when the refund was processed | [optional] |
41
+ | **cancellation_reason** | **String** | Reason for cancellation (if cancelled) | [optional] |
42
+ | **virtual_account** | **String** | Virtual sub-account provided at creation. | [optional] |
43
+ | **method** | **String** | Transaction method/rail. | [optional] |
44
+ | **refunds** | [**Array<Refund>**](Refund.md) | Refunds of the transaction, newest first. | [optional] |
45
+
46
+ ## Example
47
+
48
+ ```ruby
49
+ require 'payzu-pix'
50
+
51
+ instance = PayZuPix::TransactionWithRefunds.new(
52
+ id: null,
53
+ status: null,
54
+ amount: null,
55
+ type: null,
56
+ qr_code_text: null,
57
+ qr_code_base64: null,
58
+ qr_code_url: null,
59
+ generated_name: null,
60
+ generated_document: null,
61
+ generated_email: null,
62
+ payer_name: null,
63
+ payer_document: null,
64
+ payer_institution_ispb: null,
65
+ payer_institution_name: null,
66
+ payer_account_number: null,
67
+ service_fee_charged: null,
68
+ withdraw_pix_key: null,
69
+ withdraw_pix_type: null,
70
+ receiver_name: null,
71
+ receiver_document: null,
72
+ receiver_institution_ispb: null,
73
+ receiver_institution_name: null,
74
+ receiver_account_number: null,
75
+ end_to_end_id: null,
76
+ created_at: null,
77
+ updated_at: null,
78
+ paid_at: null,
79
+ client_reference: null,
80
+ refund_end_to_end_id: null,
81
+ refund_amount: null,
82
+ refund_status: null,
83
+ refund_reason: null,
84
+ refund_description: null,
85
+ refunded_at: null,
86
+ cancellation_reason: null,
87
+ virtual_account: null,
88
+ method: null,
89
+ refunds: null
90
+ )
91
+ ```
92
+
data/docs/Webhook.md ADDED
@@ -0,0 +1,30 @@
1
+ # PayZuPix::Webhook
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Webhook id. | [optional] |
8
+ | **url** | **String** | Address in your system where PayZu sends the event notification. | [optional] |
9
+ | **active** | **Boolean** | Somente webhooks ativos recebem entregas. | [optional] |
10
+ | **events** | [**Array<WebhookEventType>**](WebhookEventType.md) | Subscribed events. Empty means all events. | [optional] |
11
+ | **has_secret** | **Boolean** | Whether the webhook has an HMAC signing secret. | [optional] |
12
+ | **created_at** | **Time** | Date and time the webhook was registered on the account. | [optional] |
13
+ | **updated_at** | **Time** | Date and time of the last change to the webhook. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'payzu-pix'
19
+
20
+ instance = PayZuPix::Webhook.new(
21
+ id: cm3w7k1t40000q8f2r5b9x3ad,
22
+ url: https://sualoja.com.br/webhook,
23
+ active: true,
24
+ events: null,
25
+ has_secret: true,
26
+ created_at: null,
27
+ updated_at: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,24 @@
1
+ # PayZuPix::WebhookCreateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **url** | **String** | URL (http or https) that will receive the notifications. | |
8
+ | **events** | [**Array<WebhookEventType>**](WebhookEventType.md) | Events to subscribe to. Omit or leave empty to receive all events. | [optional] |
9
+ | **generate_secret** | **Boolean** | Generate an HMAC signing secret for this webhook. | [optional][default to false] |
10
+ | **active** | **Boolean** | Whether the webhook starts active. | [optional][default to true] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'payzu-pix'
16
+
17
+ instance = PayZuPix::WebhookCreateRequest.new(
18
+ url: https://sualoja.com.br/webhook,
19
+ events: null,
20
+ generate_secret: null,
21
+ active: true
22
+ )
23
+ ```
24
+
@@ -0,0 +1,15 @@
1
+ # PayZuPix::WebhookEventType
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'payzu-pix'
12
+
13
+ instance = PayZuPix::WebhookEventType.new()
14
+ ```
15
+
@@ -0,0 +1,18 @@
1
+ # PayZuPix::WebhookListResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **webhooks** | [**Array<Webhook>**](Webhook.md) | Webhooks registered on the account. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'payzu-pix'
13
+
14
+ instance = PayZuPix::WebhookListResponse.new(
15
+ webhooks: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,22 @@
1
+ # PayZuPix::WebhookUpdateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **url** | **String** | New delivery address, which applies to the following dispatches. | [optional] |
8
+ | **active** | **Boolean** | Turns the webhook deliveries on or pauses them. | [optional] |
9
+ | **events** | [**Array<WebhookEventType>**](WebhookEventType.md) | New list of subscribed events, which replaces the previous one entirely. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'payzu-pix'
15
+
16
+ instance = PayZuPix::WebhookUpdateRequest.new(
17
+ url: https://sualoja.com.br/webhook,
18
+ active: true,
19
+ events: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,32 @@
1
+ # PayZuPix::WebhookWithSecret
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Webhook identifier. | [optional] |
8
+ | **url** | **String** | Address that receives the notifications. | [optional] |
9
+ | **active** | **Boolean** | Indicates whether the webhook starts out receiving events. | [optional] |
10
+ | **events** | [**Array<WebhookEventType>**](WebhookEventType.md) | Events subscribed by this webhook. | [optional] |
11
+ | **has_secret** | **Boolean** | Indicates whether the webhook has a signing secret. | [optional] |
12
+ | **created_at** | **Time** | | [optional] |
13
+ | **updated_at** | **Time** | Date and time of the last change to the webhook. | [optional] |
14
+ | **secret** | **String** | HMAC signing secret. Shown only on creation and on rotate-secret. Store it now. | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'payzu-pix'
20
+
21
+ instance = PayZuPix::WebhookWithSecret.new(
22
+ id: cm3w7k1t40000q8f2r5b9x3ad,
23
+ url: https://sualoja.com.br/webhook,
24
+ active: true,
25
+ events: null,
26
+ has_secret: true,
27
+ created_at: null,
28
+ updated_at: null,
29
+ secret: q7Kx2mV9pL4sR8tW1nB6cY3hJ5dF0gZ-aE_uT7iO2kM
30
+ )
31
+ ```
32
+