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,62 @@
1
+ # PayZuPix::DepositPending
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Identifier of the pending deposit. | [optional] |
8
+ | **status** | **String** | Deposit status: PENDING, COMPLETED or REJECTED. | [optional] |
9
+ | **amount** | **Float** | Amount received. | [optional] |
10
+ | **payer_document** | **String** | CNPJ of the payer of the Pix. | [optional] |
11
+ | **payer_name** | **String** | Name of the payer of the Pix. | [optional] |
12
+ | **payer_account_number** | **String** | Account number of the payer inside the platform. | [optional] |
13
+ | **payer_institution_ispb** | **String** | ISPB code of the institution the Pix was sent from. | [optional] |
14
+ | **payer_institution_name** | **String** | Name of the institution the Pix was sent from. | [optional] |
15
+ | **receiver_document** | **String** | CPF or CNPJ of the account that received the Pix. | [optional] |
16
+ | **receiver_name** | **String** | Name of the account that received the Pix. | [optional] |
17
+ | **receiver_account_number** | **String** | Number of your PayZu account that receives the credit if the deposit is approved. | [optional] |
18
+ | **receiver_institution_ispb** | **String** | ISPB code of the institution that received the Pix. | [optional] |
19
+ | **receiver_institution_name** | **String** | Name of the institution where the Pix was settled on the receiving side. | [optional] |
20
+ | **end_to_end_id** | **String** | End-to-end identifier of the Pix. | [optional] |
21
+ | **paid_at** | **Time** | Date and time the Pix was settled. | [optional] |
22
+ | **pix_key** | **String** | | [optional] |
23
+ | **description** | **String** | Free text that would accompany the Pix. | [optional] |
24
+ | **approved_at** | **Time** | Date and time the deposit was approved. | [optional] |
25
+ | **rejected_at** | **Time** | Date and time the deposit was rejected. | [optional] |
26
+ | **rejection_reason** | **String** | Reason the deposit was rejected. | [optional] |
27
+ | **transaction_id** | **String** | Deposit transaction created on approval. | [optional] |
28
+ | **created_at** | **Time** | Moment the received Pix was recorded, before the credit. | [optional] |
29
+ | **updated_at** | **Time** | Moment of the last change to the record, which changes when the deposit is approved or rejected. | [optional] |
30
+
31
+ ## Example
32
+
33
+ ```ruby
34
+ require 'payzu-pix'
35
+
36
+ instance = PayZuPix::DepositPending.new(
37
+ id: null,
38
+ status: null,
39
+ amount: null,
40
+ payer_document: null,
41
+ payer_name: null,
42
+ payer_account_number: null,
43
+ payer_institution_ispb: null,
44
+ payer_institution_name: null,
45
+ receiver_document: null,
46
+ receiver_name: null,
47
+ receiver_account_number: null,
48
+ receiver_institution_ispb: null,
49
+ receiver_institution_name: null,
50
+ end_to_end_id: null,
51
+ paid_at: null,
52
+ pix_key: null,
53
+ description: null,
54
+ approved_at: null,
55
+ rejected_at: null,
56
+ rejection_reason: null,
57
+ transaction_id: null,
58
+ created_at: null,
59
+ updated_at: null
60
+ )
61
+ ```
62
+
@@ -0,0 +1,24 @@
1
+ # PayZuPix::DepositPendingListResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **page** | **Integer** | Page returned in this response. | [optional] |
8
+ | **limit** | **Integer** | Maximum number of records per page used in this query. | [optional] |
9
+ | **has_next_page** | **Boolean** | Comes back true when there is still a record after this page. | [optional] |
10
+ | **data** | [**Array<DepositPending>**](DepositPending.md) | Pending deposits of this page, ordered from the most recent creation to the oldest. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'payzu-pix'
16
+
17
+ instance = PayZuPix::DepositPendingListResponse.new(
18
+ page: null,
19
+ limit: null,
20
+ has_next_page: null,
21
+ data: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,30 @@
1
+ # PayZuPix::DictConsultResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **pix_key** | **String** | Normalized Pix key. | [optional] |
8
+ | **name** | **String** | Name of the key holder as returned by the institution queried. | [optional] |
9
+ | **document** | **String** | Masked CPF/CNPJ of the key holder. | [optional] |
10
+ | **person_type** | **String** | Type of person: PF, PJ, or empty when not informed. | [optional] |
11
+ | **account_type** | **String** | | [optional] |
12
+ | **institution_ispb** | **String** | ISPB code of the account institution. | [optional] |
13
+ | **institution_name** | **String** | Name of the institution where the holder account is registered, as the lookup returns it. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'payzu-pix'
19
+
20
+ instance = PayZuPix::DictConsultResponse.new(
21
+ pix_key: null,
22
+ name: null,
23
+ document: null,
24
+ person_type: null,
25
+ account_type: null,
26
+ institution_ispb: null,
27
+ institution_name: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,20 @@
1
+ # PayZuPix::DownloadUserReport200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **url** | **String** | Short-lived signed URL to download the CSV (5 min validity) | [optional] |
8
+ | **expires_at** | **Time** | When the signed URL expires | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'payzu-pix'
14
+
15
+ instance = PayZuPix::DownloadUserReport200Response.new(
16
+ url: null,
17
+ expires_at: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # PayZuPix::EnqueuedCallback
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **enqueued** | [**EnqueuedCallbackEnqueued**](EnqueuedCallbackEnqueued.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'payzu-pix'
13
+
14
+ instance = PayZuPix::EnqueuedCallback.new(
15
+ enqueued: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,22 @@
1
+ # PayZuPix::EnqueuedCallbackEnqueued
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **count** | **Integer** | Total number of callbacks sent for queueing. Not limited by the size of items. | [optional] |
8
+ | **truncated** | **Boolean** | True when items lists only part of the callbacks. The resend still covers all of them. | [optional] |
9
+ | **items** | [**Array<EnqueuedCallbackItem>**](EnqueuedCallbackItem.md) | Queued callbacks, capped at 500 entries. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'payzu-pix'
15
+
16
+ instance = PayZuPix::EnqueuedCallbackEnqueued.new(
17
+ count: 12,
18
+ truncated: false,
19
+ items: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # PayZuPix::EnqueuedCallbackItem
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **transaction_id** | **String** | Transaction whose callback was queued. | [optional] |
8
+ | **webhook_id** | **String** | Webhook that receives the delivery. | [optional] |
9
+ | **event_type** | [**WebhookEventType**](WebhookEventType.md) | Event that triggered the callback, when the log records it. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'payzu-pix'
15
+
16
+ instance = PayZuPix::EnqueuedCallbackItem.new(
17
+ transaction_id: PAYZU20260811K7M2X9QP4T000000,
18
+ webhook_id: cm3w7k1t40000q8f2r5b9x3ad,
19
+ event_type: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,32 @@
1
+ # PayZuPix::ErrorResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | Fixed marker of an error response. | |
8
+ | **error** | **String** | Name of the corresponding HTTP status. | |
9
+ | **error_code** | **String** | Stable machine-readable error code, when available. | |
10
+ | **message** | **String** | Human-readable error message. | |
11
+ | **status_code** | **Integer** | HTTP status code. | |
12
+ | **request_id** | **String** | Unique request correlation ID (cuid). Include it when contacting support. | |
13
+ | **details** | [**Array<ApiErrorDetailsInner>**](ApiErrorDetailsInner.md) | Field-level validation errors, when applicable. | [optional] |
14
+ | **retry_after_seconds** | **Integer** | Seconds to wait before retrying. Present only on 429 responses. | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'payzu-pix'
20
+
21
+ instance = PayZuPix::ErrorResponse.new(
22
+ status: ERROR,
23
+ error: Bad Request,
24
+ error_code: PZV001,
25
+ message: Invalid data. Check the fields provided.,
26
+ status_code: 400,
27
+ request_id: cmbz0f8qk0001js04hp3e2n0f,
28
+ details: null,
29
+ retry_after_seconds: 30
30
+ )
31
+ ```
32
+
@@ -0,0 +1,46 @@
1
+ # PayZuPix::GetUser200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_number** | **String** | Public account identifier (6 digits, unique). Used as destination for internal transfers. | [optional] |
8
+ | **branch** | **String** | Branch number (4 digits). | [optional] |
9
+ | **name** | **String** | Registered name of the account. | [optional] |
10
+ | **role** | **String** | Account role. | [optional] |
11
+ | **balance_available** | **Float** | Balance free for withdrawals and transfers, in reais. | [optional] |
12
+ | **balance_blocked** | **Float** | Part of the balance held, in reais. | [optional] |
13
+ | **status** | **String** | Account status. | [optional] |
14
+ | **allow_withdraw** | **Boolean** | When false, creating withdrawals is refused for lack of permission (PZS200). | [optional] |
15
+ | **allow_deposit** | **Boolean** | When false, creating inbound Pix charges is refused for lack of permission (PZD200). | [optional] |
16
+ | **cash_in_ticket_min** | **Float** | Minimum amount accepted in each inbound charge, in reais; below the floor the creation is refused. | [optional] |
17
+ | **cash_in_ticket_max** | **Float** | Maximum amount accepted in each inbound charge, in reais; above the cap the creation is refused. | [optional] |
18
+ | **cash_out_ticket_min** | **Float** | Minimum amount per withdrawal or internal transfer, in reais; below the floor the request is refused. | [optional] |
19
+ | **cash_out_ticket_max** | **Float** | Maximum amount per withdrawal or internal transfer, in reais; above the cap the request is refused. | [optional] |
20
+ | **service_fee** | [**GetUser200ResponseServiceFee**](GetUser200ResponseServiceFee.md) | | [optional] |
21
+ | **daily_withdraw_limit** | [**GetUser200ResponseDailyWithdrawLimit**](GetUser200ResponseDailyWithdrawLimit.md) | | [optional] |
22
+
23
+ ## Example
24
+
25
+ ```ruby
26
+ require 'payzu-pix'
27
+
28
+ instance = PayZuPix::GetUser200Response.new(
29
+ account_number: null,
30
+ branch: 0001,
31
+ name: null,
32
+ role: null,
33
+ balance_available: null,
34
+ balance_blocked: null,
35
+ status: null,
36
+ allow_withdraw: null,
37
+ allow_deposit: null,
38
+ cash_in_ticket_min: null,
39
+ cash_in_ticket_max: null,
40
+ cash_out_ticket_min: null,
41
+ cash_out_ticket_max: null,
42
+ service_fee: null,
43
+ daily_withdraw_limit: null
44
+ )
45
+ ```
46
+
@@ -0,0 +1,24 @@
1
+ # PayZuPix::GetUser200ResponseDailyWithdrawLimit
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **limit** | **Float** | Daily outbound cap, in reais, summing withdrawals and internal transfers. | [optional] |
8
+ | **used** | **Float** | Total of the cap consumed in the day, in reais, by withdrawals and internal transfers. | [optional] |
9
+ | **updated_at** | **Time** | Date and time of the last change to the daily limit. | [optional] |
10
+ | **last_reset** | **Time** | Moment of the last reset of the daily usage. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'payzu-pix'
16
+
17
+ instance = PayZuPix::GetUser200ResponseDailyWithdrawLimit.new(
18
+ limit: null,
19
+ used: null,
20
+ updated_at: null,
21
+ last_reset: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,28 @@
1
+ # PayZuPix::GetUser200ResponseServiceFee
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **cash_in_minimum** | **Float** | Floor of the cash-in fee, in reais. | [optional] |
8
+ | **cash_in_fixed** | **Float** | Fixed part of the cash-in fee, in reais. | [optional] |
9
+ | **cash_in_percent** | **Float** | Percentage of the cash-in fee. | [optional] |
10
+ | **cash_out_minimum** | **Float** | Floor of the withdrawal fee, in reais. | [optional] |
11
+ | **cash_out_fixed** | **Float** | Fixed part of the withdrawal fee, in reais. | [optional] |
12
+ | **cash_out_percent** | **Float** | Percentage of the withdrawal fee. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'payzu-pix'
18
+
19
+ instance = PayZuPix::GetUser200ResponseServiceFee.new(
20
+ cash_in_minimum: null,
21
+ cash_in_fixed: null,
22
+ cash_in_percent: null,
23
+ cash_out_minimum: null,
24
+ cash_out_fixed: null,
25
+ cash_out_percent: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,20 @@
1
+ # PayZuPix::GetUserBalance200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **balance_available** | **Float** | Balance free for withdrawals and transfers, in reais, of the account that owns the token. | [optional] |
8
+ | **balance_blocked** | **Float** | Balance held and unavailable, in reais. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'payzu-pix'
14
+
15
+ instance = PayZuPix::GetUserBalance200Response.new(
16
+ balance_available: null,
17
+ balance_blocked: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,94 @@
1
+ # PayZuPix::GetUserTransactionById200Response
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
+ | **infraction** | [**Array<GetUserTransactionById200ResponseAllOfInfractionInner>**](GetUserTransactionById200ResponseAllOfInfractionInner.md) | Complete infraction history for this transaction. | [optional] |
45
+ | **callback_log** | [**Array<GetUserTransactionById200ResponseAllOfCallbackLogInner>**](GetUserTransactionById200ResponseAllOfCallbackLogInner.md) | Webhook delivery attempts for this transaction (most recent first) | [optional] |
46
+
47
+ ## Example
48
+
49
+ ```ruby
50
+ require 'payzu-pix'
51
+
52
+ instance = PayZuPix::GetUserTransactionById200Response.new(
53
+ id: null,
54
+ status: null,
55
+ amount: null,
56
+ type: null,
57
+ qr_code_text: null,
58
+ qr_code_base64: null,
59
+ qr_code_url: null,
60
+ generated_name: null,
61
+ generated_document: null,
62
+ generated_email: null,
63
+ payer_name: null,
64
+ payer_document: null,
65
+ payer_institution_ispb: null,
66
+ payer_institution_name: null,
67
+ payer_account_number: null,
68
+ service_fee_charged: null,
69
+ withdraw_pix_key: null,
70
+ withdraw_pix_type: null,
71
+ receiver_name: null,
72
+ receiver_document: null,
73
+ receiver_institution_ispb: null,
74
+ receiver_institution_name: null,
75
+ receiver_account_number: null,
76
+ end_to_end_id: null,
77
+ created_at: null,
78
+ updated_at: null,
79
+ paid_at: null,
80
+ client_reference: null,
81
+ refund_end_to_end_id: null,
82
+ refund_amount: null,
83
+ refund_status: null,
84
+ refund_reason: null,
85
+ refund_description: null,
86
+ refunded_at: null,
87
+ cancellation_reason: null,
88
+ virtual_account: null,
89
+ method: null,
90
+ infraction: null,
91
+ callback_log: null
92
+ )
93
+ ```
94
+
@@ -0,0 +1,26 @@
1
+ # PayZuPix::GetUserTransactionById200ResponseAllOfCallbackLogInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Identifier of the delivery record; there is one record per callback attempt of the transaction. | [optional] |
8
+ | **url** | **String** | Address that received the callback: the callbackUrl of the transaction or the URL of the registered webhook. | [optional] |
9
+ | **status** | **Integer** | HTTP status code returned by the receiver | [optional] |
10
+ | **response_time** | **Float** | Round-trip time in ms | [optional] |
11
+ | **created_at** | **Time** | Date and time the callback delivery attempt was recorded. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'payzu-pix'
17
+
18
+ instance = PayZuPix::GetUserTransactionById200ResponseAllOfCallbackLogInner.new(
19
+ id: null,
20
+ url: null,
21
+ status: null,
22
+ response_time: null,
23
+ created_at: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,24 @@
1
+ # PayZuPix::GetUserTransactionById200ResponseAllOfInfractionInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Identifier of the infraction linked to this transaction. | [optional] |
8
+ | **status** | **String** | Current state of the infraction. | [optional] |
9
+ | **created_at** | **Time** | Date and time the infraction was recorded at PayZu. | [optional] |
10
+ | **updated_at** | **Time** | Date and time of the last change to the infraction record. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'payzu-pix'
16
+
17
+ instance = PayZuPix::GetUserTransactionById200ResponseAllOfInfractionInner.new(
18
+ id: null,
19
+ status: null,
20
+ created_at: null,
21
+ updated_at: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,22 @@
1
+ # PayZuPix::GetUserTransactions200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **total** | **Integer** | Number of transactions that match the query filters. | [optional] |
8
+ | **pages** | **Integer** | Number of pages for the limit provided, computed from total rounded up. | [optional] |
9
+ | **transactions** | [**Array<Transaction>**](Transaction.md) | Items of the requested page, ordered by sortBy and sortDirection. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'payzu-pix'
15
+
16
+ instance = PayZuPix::GetUserTransactions200Response.new(
17
+ total: null,
18
+ pages: null,
19
+ transactions: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,40 @@
1
+ # PayZuPix::InfractionDetail
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Identifier of the infraction inside PayZu, used in the query routes and when sending the defense. | [optional] |
8
+ | **protocol** | **String** | Infraction code at Bacen. | [optional] |
9
+ | **status** | **String** | Current state of the infraction. | [optional] |
10
+ | **type** | **String** | Type of the infraction: REFUND_REQUEST, FRAUD or REFUND_CANCELLED. | [optional] |
11
+ | **reported_by** | **String** | Side that opened the infraction: DEBITED_PARTICIPANT or CREDITED_PARTICIPANT. | [optional] |
12
+ | **report_details** | **String** | Reason given by whoever opened the infraction, in the text sent by the partner bank. | [optional] |
13
+ | **analysis_result** | **String** | Analysis outcome: AGREED or DISAGREED. | [optional] |
14
+ | **analysis_details** | **String** | Additional text about the analysis decision, when the partner bank sends that information. | [optional] |
15
+ | **reported_at** | **Time** | Moment the infraction was opened. | [optional] |
16
+ | **expires_at** | **Time** | Deadline to send the defense of this infraction. | [optional] |
17
+ | **transaction** | [**InfractionDetailTransaction**](InfractionDetailTransaction.md) | | [optional] |
18
+ | **defense_history** | [**Array<DefenseHistoryEntry>**](DefenseHistoryEntry.md) | Defenses already sent for this infraction, each with text, status and files. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'payzu-pix'
24
+
25
+ instance = PayZuPix::InfractionDetail.new(
26
+ id: null,
27
+ protocol: null,
28
+ status: null,
29
+ type: null,
30
+ reported_by: null,
31
+ report_details: null,
32
+ analysis_result: null,
33
+ analysis_details: null,
34
+ reported_at: null,
35
+ expires_at: null,
36
+ transaction: null,
37
+ defense_history: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,30 @@
1
+ # PayZuPix::InfractionDetailTransaction
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **amount** | **Float** | Amount of the disputed transaction, in reais with decimal places. | [optional] |
9
+ | **payer_name** | **String** | Name of the Pix payer, as reported by the provider. | [optional] |
10
+ | **payer_document** | **String** | CPF or CNPJ of the Pix payer, as reported by the provider. | [optional] |
11
+ | **receiver_name** | **String** | Name of the Pix receiver, as reported by the provider. | [optional] |
12
+ | **receiver_document** | **String** | CPF or CNPJ of the Pix receiver, as reported by the provider. | [optional] |
13
+ | **end_to_end_id** | **String** | End-to-end identifier of the Pix, reported by the provider at settlement. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'payzu-pix'
19
+
20
+ instance = PayZuPix::InfractionDetailTransaction.new(
21
+ id: null,
22
+ amount: null,
23
+ payer_name: null,
24
+ payer_document: null,
25
+ receiver_name: null,
26
+ receiver_document: null,
27
+ end_to_end_id: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,20 @@
1
+ # PayZuPix::InfractionListResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **infractions** | [**Array<InfractionDetail>**](InfractionDetail.md) | Infractions of the requested page, each in the same format as the detail. | [optional] |
8
+ | **pagination** | [**InfractionListResponsePagination**](InfractionListResponsePagination.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'payzu-pix'
14
+
15
+ instance = PayZuPix::InfractionListResponse.new(
16
+ infractions: null,
17
+ pagination: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # PayZuPix::InfractionListResponsePagination
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **page** | **Integer** | Page returned, the same as the page parameter sent in the query; when omitted, it is 1. | [optional] |
8
+ | **limit** | **Integer** | Page size applied in the query; when omitted it is 10 and the maximum accepted is 100. | [optional] |
9
+ | **total_items** | **Integer** | Number of infractions that match the filters, counted up to 100,000. | [optional] |
10
+ | **total_pages** | **Integer** | Number of pages for the limit provided, taken from totalItems rounded up. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'payzu-pix'
16
+
17
+ instance = PayZuPix::InfractionListResponsePagination.new(
18
+ page: null,
19
+ limit: null,
20
+ total_items: null,
21
+ total_pages: null
22
+ )
23
+ ```
24
+