starkinfra 0.5.2 → 0.7.0

data/lib/pix_chargeback/pix_chargeback.rb

@@ -17,10 +17,10 @@ module StarkInfra
   # ## Parameters (required):
   # - amount [integer]: amount in cents to be reversed. ex: 11234 (= R$ 112.34)
   # - reference_id [string]: end_to_end_id or return_id of the transaction to be reversed. ex: 'E20018183202201201450u34sDGd19lz'
-  # - reason [string]: reason why the reversal was requested. Options: 'fraud', 'flaw', 'reversalChargeback'
+  # - reason [string]: reason why the reversal was requested. Options: 'flaw', 'fraud', 'subscriptionFlaw' (the API also assigns 'reversalChargeback' automatically when a chargeback stems from a closed Pix Infraction, but it cannot be passed on creation).
   #
   # ## Parameters (optional):
-  # - description [string, default nil]: description for the PixChargeback. ex: 'Payment for service #1234'
+  # - description [string, default nil]: description for the PixChargeback. Required when reason is 'flaw'. ex: 'Payment for service #1234'
   # - tags [list of strings, default nil]:  list of strings for tagging. ex: ['travel', 'food']
   #
   # ## Attributes (return-only):
@@ -33,15 +33,26 @@ module StarkInfra
   # - result [string]: result after the analysis of the PixChargeback by the receiving party. Options: 'rejected', 'accepted', 'partiallyAccepted'
   # - flow [string]: direction of the Pix Chargeback. Options: 'in' for received chargebacks, 'out' for chargebacks you requested
   # - status [string]: current PixChargeback status. Options: 'created', 'failed', 'delivered', 'closed', 'canceled'.
+  # - dispute_id [string]: id of the dispute associated with the PixChargeback. ex: '5656565656565656'
+  # - is_monitoring_required [bool]: indicates if monitoring is required for this chargeback. ex: true
+  # - reversal_account_number [string]: account number for the reversal transaction. ex: '876543-2'
+  # - reversal_account_type [string]: account type for the reversal transaction. ex: 'checking'
+  # - reversal_bank_code [string]: bank code for the reversal transaction. ex: '20018183'
+  # - reversal_branch_code [string]: branch code for the reversal transaction. ex: '1357-9'
+  # - reversal_tax_id [string]: tax ID for the reversal transaction. ex: '01234567890'
   # - created [DateTime]: creation datetime for the PixChargeback. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - updated [DateTime]: latest update datetime for the PixChargeback. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - bacen_id [string]: unique transaction id returned from Central Bank. ex: 'ccf9bd9c-e99d-999e-bab9-b999ca999f99'
   class PixChargeback < StarkCore::Utils::Resource
     attr_reader :amount, :reference_id, :reason, :description, :tags, :id, :analysis, :sender_bank_code,
-                :receiver_bank_code, :rejection_reason, :reversal_reference_id, :result, :flow, :status, :created, :updated
+                :receiver_bank_code, :rejection_reason, :reversal_reference_id, :result, :flow, :status,
+                :dispute_id, :is_monitoring_required, :reversal_account_number, :reversal_account_type,
+                :reversal_bank_code, :reversal_branch_code, :reversal_tax_id, :created, :updated, :bacen_id
     def initialize(
       amount:, reference_id:, reason:, description: nil, tags: nil, id: nil, analysis: nil, sender_bank_code: nil,
       receiver_bank_code: nil, rejection_reason: nil, reversal_reference_id: nil, result: nil, flow: nil, status: nil,
-      created: nil, updated: nil
+      dispute_id: nil, is_monitoring_required: nil, reversal_account_number: nil, reversal_account_type: nil,
+      reversal_bank_code: nil, reversal_branch_code: nil, reversal_tax_id: nil, created: nil, updated: nil, bacen_id: nil
     )
       super(id)
       @amount = amount
@@ -57,8 +68,16 @@ module StarkInfra
       @result = result
       @flow = flow
       @status = status
+      @dispute_id = dispute_id
+      @is_monitoring_required = is_monitoring_required
+      @reversal_account_number = reversal_account_number
+      @reversal_account_type = reversal_account_type
+      @reversal_bank_code = reversal_bank_code
+      @reversal_branch_code = reversal_branch_code
+      @reversal_tax_id = reversal_tax_id
       @created = StarkCore::Utils::Checks.check_datetime(created)
       @updated = StarkCore::Utils::Checks.check_datetime(updated)
+      @bacen_id = bacen_id
     end
 
     # # Create PixChargebacks
@@ -167,10 +186,10 @@ module StarkInfra
     #
     # ## Parameters (required):
     # - id [string]: PixChargeback unique id. ex: '5656565656565656'
-    # - result [string]: result after the analysis of the PixChargeback. Options: 'rejected', 'accepted', 'partiallyAccepted'.
+    # - result [string]: result of the chargeback analysis to submit. Options: 'agreed', 'disagreed', 'partiallyAgreed'.
     #
     # ## Parameters (conditionally required):
-    # - rejection_reason [string, default nil]: if the PixChargeback is rejected a reason is required. Options: 'noBalance', 'accountClosed', 'unableToReverse',
+    # - rejection_reason [string, default nil]: if the PixChargeback's result is 'rejected', a reason is required. Options: 'other', 'noBalance', 'accountClosed', 'invalidRequest' ('unableToReverse' is not a valid value).
     # - reversal_reference_id [string, default nil]: return_id of the reversal transaction. ex: 'D20018183202201201450u34sDGd19lz'
     #
     # ## Parameters (optional):
@@ -226,8 +245,16 @@ module StarkInfra
             result: json['result'],
             flow: json['flow'],
             status: json['status'],
+            dispute_id: json['dispute_id'],
+            is_monitoring_required: json['is_monitoring_required'],
+            reversal_account_number: json['reversal_account_number'],
+            reversal_account_type: json['reversal_account_type'],
+            reversal_bank_code: json['reversal_bank_code'],
+            reversal_branch_code: json['reversal_branch_code'],
+            reversal_tax_id: json['reversal_tax_id'],
             created: json['created'],
-            updated: json['updated']
+            updated: json['updated'],
+            bacen_id: json['bacen_id']
           )
         }
       }

data/lib/pix_claim/pix_claim.rb

@@ -8,6 +8,8 @@ module StarkInfra
   #
   # A Pix Claim is a request to transfer a Pix Key from an account hosted at another
   # Pix participant to an account under your bank code. Pix Claims must always be requested by the claimer.
+  # An 'ownership' claim changes the holder of a Pix Key and only applies to phone-type keys; a 'portability'
+  # claim changes the linked account without changing the holder, and applies to phone, email or taxId keys.
   #
   # When you initialize a PixClaim, the entity will not be automatically
   # created in the Stark Infra API. The 'create' function sends the objects
@@ -27,9 +29,10 @@ module StarkInfra
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the PixClaim is created. ex: '5656565656565656'
+  # - bacen_id [string]: unique transaction id returned from Central Bank. ex: 'ccf9bd9c-e99d-999e-bab9-b999ca999f99'
   # - status [string]: current PixClaim status. Options: 'created', 'failed', 'delivered', 'confirmed', 'success', 'canceled'
   # - type [string]: type of Pix Claim. Options: 'ownership', 'portability'.
-  # - key_type [string]: keyType of the claimed Pix Key. Options: 'CPF', 'CNPJ', 'phone' or 'email'
+  # - key_type [string]: keyType of the claimed Pix Key. Options: 'cpf', 'cnpj', 'phone', 'email', 'evp'.
   # - flow [string]: direction of the Pix Claim. Options: 'in' if you received the PixClaim or 'out' if you created the PixClaim.
   # - claimer_bank_code [string]: bank_code of the Pix participant that created the PixClaim. ex: '20018183'.
   # - claimed_bank_code [string]: bank_code of the account donating the PixClaim. ex: '20018183'.
@@ -37,11 +40,12 @@ module StarkInfra
   # - updated [DateTime]: update datetime for the PixClaim. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class PixClaim < StarkCore::Utils::Resource
     attr_reader :account_created, :account_number, :account_type, :branch_code, :name, :tax_id, :key_id,
-                :tags, :id, :status, :type, :key_type, :flow, :claimer_bank_code, :claimed_bank_code, :created, :updated
+                :tags, :id, :status, :type, :key_type, :flow, :claimer_bank_code, :claimed_bank_code, :created, :updated,
+                :bacen_id
     def initialize(
       account_created:, account_number:, account_type:, branch_code:, name:,
       tax_id:, key_id:, tags: nil, id: nil, status: nil, type: nil, key_type: nil, flow: nil,
-      claimer_bank_code: nil, claimed_bank_code: nil, created: nil, updated: nil
+      claimer_bank_code: nil, claimed_bank_code: nil, created: nil, updated: nil, bacen_id: nil
     )
       super(id)
       @account_created = account_created
@@ -60,6 +64,7 @@ module StarkInfra
       @claimed_bank_code = claimed_bank_code
       @created = StarkCore::Utils::Checks.check_datetime(created)
       @updated = StarkCore::Utils::Checks.check_datetime(updated)
+      @bacen_id = bacen_id
     end
 
     # # Create a PixClaim object
@@ -183,11 +188,13 @@ module StarkInfra
 
     # # Update a PixClaim entity
     #
-    # Update a PixClaim parameters by passing id.
+    # Update a PixClaim by passing id. You must answer an inbound PixClaim within 7 days of its status
+    # changing to 'delivered' — if unanswered, a 'portability' claim is rejected by default and an
+    # 'ownership' claim is accepted by default, both with reason 'defaultBehavior'.
     #
     # ## Parameters (required):
     # - id [string]: PixClaim unique id. ex: '5656565656565656'
-    # - status [string]: patched status for Pix Claim. Options: 'confirmed' and 'canceled'
+    # - status [string]: patched status for the PixClaim. Options: 'confirmed' (only allowed from 'delivered' status; deletes the referenced PixKey from Stark Infra and the Central Bank) and 'canceled' (only allowed from 'delivered' or 'confirmed' status).
     #
     # ## Parameters (optional):
     # - reason [string, default 'userRequested']: reason why the PixClaim is being patched. Options: 'fraud', 'userRequested', 'accountClosure'.
@@ -226,7 +233,8 @@ module StarkInfra
             claimer_bank_code: json['claimer_bank_code'],
             claimed_bank_code: json['claimed_bank_code'],
             created: json['created'],
-            updated: json['updated']
+            updated: json['updated'],
+            bacen_id: json['bacen_id']
           )
         }
       }

data/lib/pix_director/pix_director.rb

@@ -23,7 +23,7 @@ module StarkInfra
   # - team_phones [list of strings]: list of phones of the team. ex: ['+5511988889999', '+5511988889998']
   #
   # ## Attributes (return-only):
-  # - status [string]: current PixDirector status. ex: 'success'
+  # - status [string]: current PixDirector status. Options: 'success', 'processing', 'failed'.
   class PixDirector < StarkCore::Utils::SubResource
     attr_reader :name, :tax_id, :phone, :email, :password, :team_email, :team_phones, :status
     def initialize(name:, tax_id:, phone:, email:, password:, team_email:, team_phones:, status: nil)

data/lib/pix_dispute/log.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('pix_dispute')
+require_relative('../utils/rest')
+
+module StarkInfra
+  class PixDispute
+    # # PixDispute::Log object
+    #
+    # Every time a PixDispute entity is modified, a corresponding PixDispute::Log
+    # is generated for the entity. This log is never generated by the user.
+    #
+    # ## Attributes (return-only):
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - dispute [PixDispute]: PixDispute entity to which the log refers to.
+    # - type [string]: type of the PixDispute event which triggered the log creation. ex: 'created', 'delivered', 'analysed'
+    # - errors [list of strings]: list of errors linked to this PixDispute event.
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Log < StarkCore::Utils::Resource
+      attr_reader :id, :dispute, :type, :errors, :created
+      def initialize(id:, dispute:, type:, errors:, created:)
+        super(id)
+        @dispute = dispute
+        @type = type
+        @errors = errors
+        @created = StarkCore::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific PixDispute::Log
+      #
+      # Receive a single PixDispute::Log object previously created by the Stark Infra API by passing its id
+      #
+      # ## Parameters (required):
+      # - id [string]: object unique id. ex: '5656565656565656'
+      #
+      # ## Parameters (optional):
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - PixDispute::Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve PixDispute::Logs
+      #
+      # Receive a generator of PixDispute::Log objects previously created in the Stark Infra API
+      #
+      # ## Parameters (optional):
+      # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+      # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - types [list of strings, default nil]: filter retrieved objects by types. ex: ['analysed', 'delivered']
+      # - dispute_ids [list of strings, default nil]: list of PixDispute ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter PixDispute Logs. ex: ['5656565656565656']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - generator of PixDispute::Log objects with updated attributes
+      def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, dispute_ids: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_stream(
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          dispute_ids: dispute_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged PixDispute::Logs
+      #
+      # Receive a list of up to 100 PixDispute::Log objects previously created in the Stark Infra API and the cursor to the next page.
+      # Use this function instead of query if you want to manually page your logs.
+      #
+      # ## Parameters (optional):
+      # - cursor [string, default nil]: cursor returned on the previous page function call
+      # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
+      # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - types [list of strings, default nil]: filter retrieved objects by types. ex: ['analysed', 'delivered']
+      # - dispute_ids [list of strings, default nil]: list of PixDispute ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter PixDispute Logs. ex: ['5656565656565656']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - list of PixDispute::Log objects with updated attributes
+      # - cursor to retrieve the next page of Log objects
+      def self.page(cursor: nil, ids: nil, limit: nil, after: nil, before: nil, types: nil, dispute_ids: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_page(
+          cursor: cursor,
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          dispute_ids: dispute_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        dispute_maker = StarkInfra::PixDispute.resource[:resource_maker]
+        {
+          resource_name: 'PixDisputeLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              dispute: StarkCore::Utils::API.from_api_json(dispute_maker, json['dispute']),
+              type: json['type'],
+              errors: json['errors'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/pix_dispute/pix_dispute.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+
+module StarkInfra
+  # # PixDispute object
+  #
+  # A PixDispute is a request to investigate a Pix transaction that is suspected of
+  # fraud or that resulted from a system malfunction. It maps the network of
+  # transactions linked to the reported one for analysis.
+  #
+  # When you initialize a PixDispute, the entity will not be automatically
+  # created in the Stark Infra API. The 'create' function sends a list of objects
+  # to the Stark Infra API and returns the list of created objects.
+  #
+  # ## Parameters (required):
+  # - reference_id [string]: end_to_end_id of the transaction being reported. ex: 'E20018183202201201450u34sDGd19lz'
+  # - method [string]: method of the dispute. Options: 'scam', 'unauthorized', 'coercion', 'invasion', 'other', 'unknown'.
+  # - operator_email [string]: contact email of the operator responsible for the PixDispute. ex: 'ruby-sdk@starkinfra.com'
+  # - operator_phone [string]: contact phone number of the operator responsible for the PixDispute. ex: '+5511999999999'
+  #
+  # ## Parameters (conditionally required):
+  # - description [string, default nil]: details for the investigation. Required when method == 'other'; optional otherwise.
+  #
+  # ## Parameters (optional):
+  # - tags [list of strings, default nil]: list of strings for tagging. ex: ['travel', 'food']
+  # - min_transaction_amount [integer, default nil]: minimum transaction amount considered for the graph creation. ex: 100
+  # - max_transaction_count [integer, default nil]: maximum number of transactions considered for the graph creation. ex: 10
+  # - max_hop_interval [integer, default nil]: mean time between transactions considered for the graph creation. ex: 3600
+  # - max_hop_count [integer, default nil]: depth considered for the graph creation. ex: 5
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the PixDispute is created. ex: '5656565656565656'
+  # - bacen_id [string]: central bank's unique PixDispute id. ex: '817fc523-9e9d-40ab-9e53-dacb71454a05'
+  # - flow [string]: direction of the PixDispute. Options: 'in' for received disputes, 'out' for disputes you created.
+  # - status [string]: current PixDispute status. Options: 'created', 'delivered', 'analysed', 'processing', 'closed', 'failed', 'canceled'
+  # - transactions [list of PixDispute::Transaction objects]: list of Transaction objects linked to the PixDispute.
+  # - created [DateTime]: creation datetime for the PixDispute. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the PixDispute. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class PixDispute < StarkCore::Utils::Resource
+    attr_reader :reference_id, :method, :operator_email, :operator_phone, :description, :tags, :min_transaction_amount,
+                :max_transaction_count, :max_hop_interval, :max_hop_count, :id, :bacen_id, :flow, :status,
+                :transactions, :created, :updated
+    def initialize(
+      reference_id:, method:, operator_email:, operator_phone:, description: nil, tags: nil,
+      min_transaction_amount: nil, max_transaction_count: nil, max_hop_interval: nil, max_hop_count: nil,
+      id: nil, bacen_id: nil, flow: nil, status: nil, transactions: nil, created: nil, updated: nil
+    )
+      super(id)
+      @reference_id = reference_id
+      @method = method
+      @operator_email = operator_email
+      @operator_phone = operator_phone
+      @description = description
+      @tags = tags
+      @min_transaction_amount = min_transaction_amount
+      @max_transaction_count = max_transaction_count
+      @max_hop_interval = max_hop_interval
+      @max_hop_count = max_hop_count
+      @bacen_id = bacen_id
+      @flow = flow
+      @status = status
+      @transactions = PixDispute::Transaction.parse_transactions(transactions)
+      @created = StarkCore::Utils::Checks.check_datetime(created)
+      @updated = StarkCore::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create PixDisputes
+    #
+    # Send a list of PixDispute objects for creation in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - disputes [list of PixDispute objects]: list of PixDispute objects to be created in the API.
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of PixDispute objects with updated attributes
+    def self.create(disputes, user: nil)
+      StarkInfra::Utils::Rest.post(entities: disputes, user: user, **resource)
+    end
+
+    # # Retrieve a specific PixDispute
+    #
+    # Receive a single PixDispute object previously created in the Stark Infra API by passing its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - PixDispute object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve PixDisputes
+    #
+    # Receive a generator of PixDispute objects previously created in the Stark Infra API
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['created', 'delivered']
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - tags [list of strings, default nil]: list of strings for tagging. ex: ['travel', 'food']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of PixDispute objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: nil, ids: nil, tags: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_stream(
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        ids: ids,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged PixDisputes
+    #
+    # Receive a list of up to 100 PixDispute objects previously created in the Stark Infra API and the cursor to the next page.
+    # Use this function instead of query if you want to manually page your disputes.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call
+    # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['created', 'delivered']
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - tags [list of strings, default nil]: list of strings for tagging. ex: ['travel', 'food']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of PixDispute objects with updated attributes
+    # - cursor to retrieve the next page of PixDispute objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, ids: nil, tags: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        ids: ids,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Cancel a PixDispute entity
+    #
+    # Cancel a PixDispute entity previously created in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - id [string]: PixDispute unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - canceled PixDispute object
+    def self.cancel(id, user: nil)
+      StarkInfra::Utils::Rest.delete_id(id: id, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'PixDispute',
+        resource_maker: proc { |json|
+          PixDispute.new(
+            id: json['id'],
+            reference_id: json['reference_id'],
+            method: json['method'],
+            operator_email: json['operator_email'],
+            operator_phone: json['operator_phone'],
+            description: json['description'],
+            tags: json['tags'],
+            min_transaction_amount: json['min_transaction_amount'],
+            max_transaction_count: json['max_transaction_count'],
+            max_hop_interval: json['max_hop_interval'],
+            max_hop_count: json['max_hop_count'],
+            bacen_id: json['bacen_id'],
+            flow: json['flow'],
+            status: json['status'],
+            transactions: json['transactions'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end
+
+require_relative('transaction')

data/lib/pix_dispute/transaction.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require('starkcore')
+
+module StarkInfra
+  class PixDispute
+    # # PixDispute::Transaction object
+    #
+    # Transactions linked to a PixDispute as part of the graph analysis. This object
+    # is return-only; it is never created by the user.
+    #
+    # ## Attributes (return-only):
+    # - end_to_end_id [string]: central bank's unique transaction id. ex: 'E20018183202201201450u34sDGd19lz'
+    # - amount [integer]: transaction amount in cents. ex: 11234 (= R$ 112.34)
+    # - nominal_amount [integer]: refundable amount in cents of the transaction. ex: 11234 (= R$ 112.34)
+    # - receiver_type [string]: receiver's type. Options: 'individual', 'business'
+    # - receiver_tax_id_created [string]: receiver's taxId creation date (business type only).
+    # - receiver_account_created [string]: receiver's account creation date.
+    # - receiver_bank_code [string]: receiver's bank code. ex: '20018183'
+    # - receiver_id [string]: Bacen-generated pseudo ID for the receiver, used only for transaction-tracking context (not a real account identifier).
+    # - sender_type [string]: sender's type. Options: 'individual', 'business'
+    # - sender_tax_id_created [string]: sender's taxId creation date (business type only).
+    # - sender_account_created [string]: sender's account creation date.
+    # - sender_bank_code [string]: sender's bank code. ex: '20018183'
+    # - sender_id [string]: Bacen-generated pseudo ID for the sender, used only for transaction-tracking context (not a real account identifier).
+    # - settled [DateTime]: settled datetime of the transaction. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Transaction < StarkCore::Utils::SubResource
+      attr_reader :end_to_end_id, :amount, :nominal_amount, :receiver_type, :receiver_tax_id_created,
+                  :receiver_account_created, :receiver_bank_code, :receiver_id, :sender_type, :sender_tax_id_created,
+                  :sender_account_created, :sender_bank_code, :sender_id, :settled
+      def initialize(
+        end_to_end_id: nil, amount: nil, nominal_amount: nil, receiver_type: nil, receiver_tax_id_created: nil,
+        receiver_account_created: nil, receiver_bank_code: nil, receiver_id: nil, sender_type: nil,
+        sender_tax_id_created: nil, sender_account_created: nil, sender_bank_code: nil, sender_id: nil, settled: nil
+      )
+        @end_to_end_id = end_to_end_id
+        @amount = amount
+        @nominal_amount = nominal_amount
+        @receiver_type = receiver_type
+        @receiver_tax_id_created = receiver_tax_id_created
+        @receiver_account_created = receiver_account_created
+        @receiver_bank_code = receiver_bank_code
+        @receiver_id = receiver_id
+        @sender_type = sender_type
+        @sender_tax_id_created = sender_tax_id_created
+        @sender_account_created = sender_account_created
+        @sender_bank_code = sender_bank_code
+        @sender_id = sender_id
+        @settled = StarkCore::Utils::Checks.check_datetime(settled)
+      end
+
+      def self.parse_transactions(transactions)
+        resource_maker = StarkInfra::PixDispute::Transaction.resource[:resource_maker]
+        return transactions if transactions.nil?
+
+        parsed_transactions = []
+        transactions.each do |transaction|
+          unless transaction.is_a? Transaction
+            transaction = StarkCore::Utils::API.from_api_json(resource_maker, transaction)
+          end
+          parsed_transactions << transaction
+        end
+        parsed_transactions
+      end
+
+      def self.resource
+        {
+          resource_name: 'PixDisputeTransaction',
+          resource_maker: proc { |json|
+            Transaction.new(
+              end_to_end_id: json['end_to_end_id'],
+              amount: json['amount'],
+              nominal_amount: json['nominal_amount'],
+              receiver_type: json['receiver_type'],
+              receiver_tax_id_created: json['receiver_tax_id_created'],
+              receiver_account_created: json['receiver_account_created'],
+              receiver_bank_code: json['receiver_bank_code'],
+              receiver_id: json['receiver_id'],
+              sender_type: json['sender_type'],
+              sender_tax_id_created: json['sender_tax_id_created'],
+              sender_account_created: json['sender_account_created'],
+              sender_bank_code: json['sender_bank_code'],
+              sender_id: json['sender_id'],
+              settled: json['settled']
+            )
+          }
+        }
+      end
+    end
+  end
+end