paystack_sdk 0.1.1 → 0.2.0

data/lib/paystack_sdk/resources/transactions.rb

@@ -1,296 +1,423 @@
 # frozen_string_literal: true
 
+# Generated by bin/paystack-scaffold from Paystack's OpenAPI spec (PaystackOSS/openapi@d9d444d).
+# Do not edit by hand: regenerate it with `bin/paystack-scaffold Transaction`. Hand-written extras go in lib/paystack_sdk/resources/extensions/transactions.rb.
+# scaffold-digest: c0b49a40a718c09c83eb9a496eb40d1f7cd4c1387b54efa3cfe360906be89f0e
+
 require_relative "base"
 
 module PaystackSdk
   module Resources
-    # The `Transactions` class provides methods for interacting with the Paystack
-    #  Transactions API.
-    # It allows you to initialize transactions, verify payments, list transactions, and fetch transaction details.
-    # The Transactions class provides methods to interact with the Paystack API for managing transactions.
-    # It includes functionalities for initializing, verifying, listing, fetching, and retrieving transaction totals.
-    #
-    # Example usage:
-    # ```ruby
-    #   transactions = PaystackSdk::Resources::Transactions.new(secret_key:)
-    #
-    #   # Initialize a transaction
-    #   payload = { email: "customer@email.com", amount: 10000, currency: "GHS" }
-    #   response = transactions.initiate(payload)
-    #   if response.success?
-    #     puts "Transaction initialized successfully."
-    #     puts "Authorization URL: #{response.authorization_url}"
-    #   else
-    #     puts "Error initializing transaction: #{response.error_message}"
-    #   end
-    #
-    #   # Verify a transaction
-    #   response = transactions.verify(reference: "transaction_reference")
-    #   if response.status == "success"
-    #     puts "The payment with reference '#{response.reference}' is verified"
-    #   else
-    #     puts "Current status: #{response.status}"
-    #   end
-    #
-    #   # List transactions
-    #   response = transactions.list(per_page: 50, page: 1)
-    #
-    #   # Fetch a single transaction
-    #   response = transactions.fetch(transaction_id: 12345)
-    #
-    #   # Get transaction totals
-    #   response = transactions.totals
-    # ```
+    # Transaction operations.
     class Transactions < PaystackSdk::Resources::Base
-      # Initializes a new transaction.
+      # Ruby keyword => the parameter name Paystack documents.
+      WIRE_NAMES = {next_cursor: "next", per_page: "perPage", terminal_id: "terminalid", customer_id: "customer"}.freeze
+
+      # Initialize Transaction.
       #
-      # @param payload [Hash] The payload containing transaction details (e.g., email, amount, currency).
-      # @return [PaystackSdk::Response] The response from the Paystack API.
-      # @raise [PaystackSdk::Error] If the payload is invalid or the API request fails.
+      # Create a new transaction
       #
-      # @example
-      # ```ruby
-      #   payload = { email: "customer@email.com", amount: 10000, currency: "GHS" }
-      #   response = transactions.initiate(payload)
-      # ```
-      def initiate(payload)
-        validate_fields!(
-          payload: payload,
-          validations: {
-            email: {type: :email, required: true},
-            amount: {type: :positive_integer, required: true},
-            currency: {type: :currency, required: false},
-            reference: {type: :reference, required: false},
-            callback_url: {required: false}
-          }
+      # @param email [String] Customer's email address
+      # @param amount [Integer] Amount should be in smallest denomination of the currency.
+      # @param currency [String] List of all support currencies One of: GHS, KES, NGN, ZAR, USD.
+      # @param reference [String] Unique transaction reference.
+      # @param channels [Array] An array of payment channels to control what channels you want to make available to the user to make a payment with
+      # @param callback_url [String] Fully qualified url, e.g.
+      # @param plan [String] If transaction is to create a subscription to a predefined plan, provide plan code here.
+      # @param invoice_limit [Integer] Number of times to charge customer during subscription to plan
+      # @param split_code [String] The split code of the transaction split
+      # @param split [Hash] Split configuration for transactions
+      # @param subaccount [String] The code for the subaccount that owns the payment
+      # @param transaction_charge [String] A flat fee to charge the subaccount for a transaction.
+      # @param bearer [String] The bearer of the transaction charge One of: account, subaccount.
+      # @param label [String] Used to replace the email address shown on the Checkout
+      # @param metadata [Hash] JSON object of custom data
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/transaction/#initialize
+      def initiate(
+        email:,
+        amount:,
+        currency: nil,
+        reference: nil,
+        channels: nil,
+        callback_url: nil,
+        plan: nil,
+        invoice_limit: nil,
+        split_code: nil,
+        split: nil,
+        subaccount: nil,
+        transaction_charge: nil,
+        bearer: nil,
+        label: nil,
+        metadata: nil
+      )
+        validate_presence!(value: email, name: "email")
+        validate_email!(email: email, name: "email")
+        validate_presence!(value: amount, name: "amount")
+        validate_positive_integer!(value: amount, name: "amount")
+        validate_allowed_values!(
+          value: currency,
+          allowed_values: %w[GHS KES NGN ZAR USD],
+          name: "currency"
+        )
+        validate_reference_format!(reference: reference, name: "reference") unless reference.nil?
+        validate_allowed_values!(
+          value: bearer,
+          allowed_values: %w[account subaccount],
+          name: "bearer"
         )
 
-        response = @connection.post("/transaction/initialize", payload)
-        handle_response(response)
+        wire_body = to_wire(
+          {
+            email:,
+            amount:,
+            currency:,
+            reference:,
+            channels:,
+            callback_url:,
+            plan:,
+            invoice_limit:,
+            split_code:,
+            split:,
+            subaccount:,
+            transaction_charge:,
+            bearer:,
+            label:,
+            metadata:
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.post("/transaction/initialize", wire_body))
       end
 
-      # Verifies a transaction using its reference.
+      # Charge Authorization.
       #
-      # @param reference [String] The unique reference for the transaction.
-      # @return [PaystackSdk::Response] The response from the Paystack API.
-      # @raise [PaystackSdk::Error] If the API request fails.
+      # Charge all authorizations marked as reusable with this endpoint whenever you need to receive payments
       #
-      # @example
-      #   response = transactions.verify(reference: "transaction_reference")
-      def verify(reference:)
-        validate_presence!(value: reference, name: "Reference")
+      # @param email [String] Customer's email address
+      # @param amount [Integer] Amount in the lower denomination of your currency
+      # @param authorization_code [String] Valid authorization code to charge
+      # @param reference [String] Unique transaction reference.
+      # @param currency [String] List of all support currencies One of: GHS, KES, NGN, ZAR, USD.
+      # @param split_code [String] The split code of the transaction split
+      # @param split [Hash] Split configuration for transactions
+      # @param subaccount [String] The code for the subaccount that owns the payment
+      # @param transaction_charge [String] A flat fee to charge the subaccount for a transaction.
+      # @param bearer [String] The bearer of the transaction charge One of: account, subaccount.
+      # @param metadata [String] Stringified JSON object of custom data
+      # @param queue [Boolean] If you are making a scheduled charge call, it is a good idea to queue them so the processing system does not get overloaded causing transaction processing errors.
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/transaction/#charge-authorization
+      def charge_authorization(
+        email:,
+        amount:,
+        authorization_code:,
+        reference: nil,
+        currency: nil,
+        split_code: nil,
+        split: nil,
+        subaccount: nil,
+        transaction_charge: nil,
+        bearer: nil,
+        metadata: nil,
+        queue: nil
+      )
+        validate_presence!(value: email, name: "email")
+        validate_email!(email: email, name: "email")
+        validate_presence!(value: amount, name: "amount")
+        validate_positive_integer!(value: amount, name: "amount")
+        validate_presence!(value: authorization_code, name: "authorization_code")
+        validate_reference_format!(reference: reference, name: "reference") unless reference.nil?
+        validate_allowed_values!(
+          value: currency,
+          allowed_values: %w[GHS KES NGN ZAR USD],
+          name: "currency"
+        )
+        validate_allowed_values!(
+          value: bearer,
+          allowed_values: %w[account subaccount],
+          name: "bearer"
+        )
+
+        wire_body = to_wire(
+          {
+            email:,
+            amount:,
+            authorization_code:,
+            reference:,
+            currency:,
+            split_code:,
+            split:,
+            subaccount:,
+            transaction_charge:,
+            bearer:,
+            metadata: stringify_json(metadata),
+            queue:
+          },
+          WIRE_NAMES
+        )
 
-        response = @connection.get("/transaction/verify/#{reference}")
-        handle_response(response)
+        handle_response(@connection.post("/transaction/charge_authorization", wire_body))
       end
 
-      # Lists all transactions.
+      # Partial Debit.
       #
-      # @param per_page [Integer] Number of records per page (default: 50)
-      # @param page [Integer] Page number to retrieve (default: 1)
-      # @param from [String] A timestamp from which to start listing transactions e.g. 2016-09-24T00:00:05.000Z, 2016-09-21
-      # @param to [String] A timestamp at which to stop listing transactions e.g. 2016-09-24T00:00:05.000Z, 2016-09-21
-      # @param status [String] Filter transactions by status ('failed', 'success', 'abandoned')
-      # @param customer [Integer] Specify an ID for the customer whose transactions you want to retrieve
-      # @param currency [String] Specify the transaction currency to filter
-      # @param amount [Integer] Filter by transaction amount
-      # @return [PaystackSdk::Response] The response from the Paystack API containing a
-      # list of transactions.
-      # @raise [PaystackSdk::Error] If the API request fails.
+      # Retrieve part of a payment from a customer
       #
-      # @example
-      #   response = transactions.list(per_page: 20, page: 2)
-      #   # With filters
-      #   response = transactions.list(per_page: 10, from: "2023-01-01", to: "2023-12-31", status: "success")
-      def list(per_page: 50, page: 1, **params)
-        # Create a combined parameter hash for validation
-        all_params = {per_page: per_page, page: page}.merge(params)
+      # @param email [String] Customer's email address
+      # @param amount [Integer] Specified in the lowest denomination of your currency
+      # @param authorization_code [String] Valid authorization code to charge
+      # @param currency [String] List of all support currencies One of: GHS, KES, NGN, ZAR, USD.
+      # @param at_least [String] Minimum amount to charge
+      # @param reference [String] Unique transaction reference.
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/transaction/#partial-debit
+      def partial_debit(
+        email:,
+        amount:,
+        authorization_code:,
+        currency:,
+        at_least: nil,
+        reference: nil
+      )
+        validate_presence!(value: email, name: "email")
+        validate_email!(email: email, name: "email")
+        validate_presence!(value: amount, name: "amount")
+        validate_positive_integer!(value: amount, name: "amount")
+        validate_presence!(value: authorization_code, name: "authorization_code")
+        validate_presence!(value: currency, name: "currency")
+        validate_allowed_values!(
+          value: currency,
+          allowed_values: %w[GHS KES NGN ZAR USD],
+          name: "currency"
+        )
+        validate_reference_format!(reference: reference, name: "reference") unless reference.nil?
 
-        # Validate parameters
-        validate_fields!(
-          payload: all_params,
-          validations: {
-            per_page: {type: :positive_integer, required: false},
-            page: {type: :positive_integer, required: false},
-            from: {type: :date, required: false},
-            to: {type: :date, required: false},
-            status: {type: :inclusion, allowed_values: %w[failed success abandoned], required: false},
-            customer: {type: :positive_integer, required: false},
-            amount: {type: :positive_integer, required: false},
-            currency: {type: :currency, required: false}
-          }
+        wire_body = to_wire(
+          {
+            email:,
+            amount:,
+            authorization_code:,
+            currency:,
+            at_least:,
+            reference:
+          },
+          WIRE_NAMES
         )
 
-        # Prepare request parameters
-        request_params = {perPage: per_page, page: page}.merge(params)
-        response = @connection.get("/transaction", request_params)
-        handle_response(response)
+        handle_response(@connection.post("/transaction/partial_debit", wire_body))
       end
 
-      # Fetches details of a single transaction by its ID.
+      # Verify Transaction.
       #
-      # @param transaction_id [String, Integer] The ID of the transaction to fetch.
-      # @return [PaystackSdk::Response] The response from the Paystack API containing transaction details.
-      # @raise [PaystackSdk::Error] If the API request fails.
+      # Verify a previously initiated transaction using it's reference
       #
-      # @example
-      #   response = transactions.fetch("12345")
-      def fetch(transaction_id)
-        validate_presence!(value: transaction_id, name: "Transaction ID")
+      # @param reference [String] The transaction reference to verify
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/transaction/#verify
+      def verify(reference:)
+        validate_presence!(value: reference, name: "reference")
 
-        response = @connection.get("/transaction/#{transaction_id}")
-        handle_response(response)
+        handle_response(
+          @connection.get("/transaction/verify/#{escape_path(reference, name: "reference")}")
+        )
       end
 
-      # Fetches the totals of all transactions.
+      # List Transactions.
       #
-      # @param from [String] A timestamp from which to start listing transaction totals e.g. 2016-09-24T00:00:05.000Z, 2016-09-21
-      # @param to [String] A timestamp at which to stop listing transaction totals e.g. 2016-09-24T00:00:05.000Z, 2016-09-21
-      # @return [PaystackSdk::Response] The response from the Paystack API containing transaction totals.
-      # @raise [PaystackSdk::Error] If the API request fails.
+      # List transactions that has occurred on your integration
       #
-      # @example
-      #   response = transactions.totals
-      #   # With date filters
-      #   response = transactions.totals(from: "2023-01-01", to: "2023-12-31")
-      def totals(**params)
-        validate_fields!(
-          payload: params,
-          validations: {
-            from: {type: :date, required: false},
-            to: {type: :date, required: false}
-          }
+      # @param use_cursor [Boolean] A flag to indicate if cursor based pagination should be used
+      # @param next_cursor [String] An alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
+      # @param previous [String] An alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
+      # @param per_page [Integer] The number of records to fetch per request
+      # @param page [Integer] The offset to retrieve data from
+      # @param from [String] The start date
+      # @param to [String] The end date
+      # @param status [String] Filter transaction by status One of: success, failed, abandoned, reversed.
+      # @param source [String] The origin of the payment One of: merchantApi, checkout, pos, virtualTerminal.
+      # @param terminal_id [String] Filter transactions by a terminal ID
+      # @param virtual_account_number [String] Filter transactions by a virtual account number
+      # @param customer_id [Integer] Filter transactions by a customer code
+      # @param amount [Integer] Filter transactions by a specific amount
+      # @param settlement [Integer] The settlement ID to filter for settled transactions
+      # @param channel [String] The payment method the customer used to complete the transaction One of: card, pos, bank, dedicated_nuban, ussd, bank_transfer.
+      # @param subaccount_code [String] Filter transaction by subaccount code
+      # @param split_code [String] Filter transaction by split code
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/transaction/#list
+      def list(
+        use_cursor: nil,
+        next_cursor: nil,
+        previous: nil,
+        per_page: nil,
+        page: nil,
+        from: nil,
+        to: nil,
+        status: nil,
+        source: nil,
+        terminal_id: nil,
+        virtual_account_number: nil,
+        customer_id: nil,
+        amount: nil,
+        settlement: nil,
+        channel: nil,
+        subaccount_code: nil,
+        split_code: nil
+      )
+        validate_positive_integer!(value: per_page, name: "perPage")
+        validate_positive_integer!(value: page, name: "page")
+        validate_allowed_values!(
+          value: status,
+          allowed_values: %w[success failed abandoned reversed],
+          name: "status"
+        )
+        validate_allowed_values!(
+          value: source,
+          allowed_values: %w[merchantApi checkout pos virtualTerminal],
+          name: "source"
+        )
+        validate_positive_integer!(value: amount, name: "amount")
+        validate_allowed_values!(
+          value: channel,
+          allowed_values: %w[card pos bank dedicated_nuban ussd bank_transfer],
+          name: "channel"
         )
 
-        response = @connection.get("/transaction/totals", params)
-        handle_response(response)
+        wire_query = to_wire(
+          {
+            use_cursor:,
+            next_cursor:,
+            previous:,
+            per_page:,
+            page:,
+            from: format_datetime(from, name: "from"),
+            to: format_datetime(to, name: "to"),
+            status:,
+            source:,
+            terminal_id:,
+            virtual_account_number:,
+            customer_id:,
+            amount:,
+            settlement:,
+            channel:,
+            subaccount_code:,
+            split_code:
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.get("/transaction", wire_query))
       end
 
-      # Exports transactions as a downloadable file.
+      # Fetch Transaction.
       #
-      # @param from [String] A timestamp from which to start the export e.g. 2016-09-24T00:00:05.000Z, 2016-09-21
-      # @param to [String] A timestamp at which to stop the export e.g. 2016-09-24T00:00:05.000Z, 2016-09-21
-      # @param status [String] Export only transactions with a specific status ('failed', 'success', 'abandoned')
-      # @param currency [String] Specify the transaction currency to export
-      # @param amount [Integer] Filter by transaction amount
-      # @param settled [Boolean] Set to true to export only settled transactions
-      # @param payment_page [Integer] Specify a payment page ID to export only transactions conducted through the page
-      # @param customer [Integer] Specify an ID for the customer whose transactions you want to export
-      # @param settlement [Integer] Specify a settlement ID to export only transactions in the settlement
-      # @return [PaystackSdk::Response] The response from the Paystack API containing the export details.
-      # @raise [PaystackSdk::Error] If the API request fails.
+      # Fetch a transaction to get its details
       #
-      # @example
-      #   response = transactions.export
-      #   # With filters
-      #   response = transactions.export(from: "2023-01-01", to: "2023-12-31", status: "success", currency: "NGN")
-      def export(**params)
-        validate_fields!(
-          payload: params,
-          validations: {
-            from: {type: :date, required: false},
-            to: {type: :date, required: false},
-            status: {type: :inclusion, allowed_values: %w[failed success abandoned], required: false},
-            currency: {type: :currency, required: false},
-            amount: {type: :positive_integer, required: false},
-            payment_page: {type: :positive_integer, required: false},
-            customer: {type: :positive_integer, required: false},
-            settlement: {type: :positive_integer, required: false}
-          }
-        )
+      # @param id [Integer] The ID of the transaction to fetch
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/transaction/#fetch
+      def fetch(id:)
+        validate_presence!(value: id, name: "id")
 
-        response = @connection.get("/transaction/export", params)
-        handle_response(response)
+        handle_response(@connection.get("/transaction/#{escape_path(id, name: "id")}"))
       end
 
-      # Charges an authorization code for subsequent payments.
+      # Fetch Transaction Timeline.
       #
-      # @param payload [Hash] The payload containing charge details.
-      # @option payload [String] :authorization_code Authorization code for the transaction (required)
-      # @option payload [String] :email Customer's email address (required)
-      # @option payload [Integer] :amount Amount in kobo, pesewas, or cents to charge (required)
-      # @option payload [String] :reference Unique transaction reference. Only -, ., = and alphanumeric characters allowed
-      # @option payload [String] :currency Currency in which amount should be charged (default: NGN)
-      # @option payload [Hash] :metadata Additional transaction information
-      # @option payload [Array<Hash>] :split_code Split payment among multiple accounts
-      # @return [PaystackSdk::Response] The response from the Paystack API.
-      # @raise [PaystackSdk::Error] If the payload is invalid or the API request fails.
+      # Fetch the steps taken from the initiation to the completion of a transaction
       #
-      # @example
-      #   payload = {
-      #     authorization_code: "AUTH_72btv547",
-      #     email: "customer@email.com",
-      #     amount: 10000
-      #   }
-      #   response = transactions.charge_authorization(payload)
-      def charge_authorization(payload)
-        validate_fields!(
-          payload: payload,
-          validations: {
-            authorization_code: {required: true},
-            email: {type: :email, required: true},
-            amount: {type: :positive_integer, required: true},
-            reference: {type: :reference, required: false},
-            currency: {type: :currency, required: false}
-          }
-        )
+      # @param id [Integer] The ID of the transaction to fetch
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/transaction/#view-timeline
+      def timeline(id:)
+        validate_presence!(value: id, name: "id")
 
-        response = @connection.post("/transaction/charge_authorization", payload)
-        handle_response(response)
+        handle_response(@connection.get("/transaction/timeline/#{escape_path(id, name: "id")}"))
       end
 
-      # Performs a partial debit on a customer's account.
+      # Transaction Totals.
       #
-      # @param payload [Hash] The payload containing partial debit details.
-      # @option payload [String] :authorization_code Authorization code for the transaction (required)
-      # @option payload [String] :currency Currency in which amount should be charged (required)
-      # @option payload [Integer] :amount Amount in kobo, pesewas, or cents to charge (required)
-      # @option payload [String] :email Customer's email address (required)
-      # @option payload [String] :reference Unique transaction reference. Only -, ., = and alphanumeric characters allowed
-      # @option payload [Hash] :metadata Additional transaction information
-      # @option payload [Array<Hash>] :split_code Split payment among multiple accounts
-      # @return [PaystackSdk::Response] The response from the Paystack API.
-      # @raise [PaystackSdk::Error] If the payload is invalid or the API request fails.
+      # Get the total amount of all transactions
       #
-      # @example
-      #   payload = {
-      #     authorization_code: "AUTH_72btv547",
-      #     currency: "NGN",
-      #     amount: 10000,
-      #     email: "customer@email.com"
-      #   }
-      #   response = transactions.partial_debit(payload)
-      def partial_debit(payload)
-        validate_fields!(
-          payload: payload,
-          validations: {
-            authorization_code: {required: true},
-            currency: {type: :currency, required: true},
-            amount: {type: :positive_integer, required: true},
-            email: {type: :email, required: true},
-            reference: {type: :reference, required: false}
-          }
+      # @param from [String] The start date
+      # @param to [String] The end date
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/transaction/#totals
+      def totals(from: nil, to: nil)
+        wire_query = to_wire(
+          {
+            from: format_datetime(from, name: "from"),
+            to: format_datetime(to, name: "to")
+          },
+          WIRE_NAMES
         )
 
-        response = @connection.post("/transaction/partial_debit", payload)
-        handle_response(response)
+        handle_response(@connection.get("/transaction/totals", wire_query))
       end
 
-      # View the timeline of a transaction
+      # Export Transactions.
       #
-      # @param id_or_reference [String] The ID or reference of the transaction
-      # @return [PaystackSdk::Response] The response from the Paystack API containing timeline details.
-      # @raise [PaystackSdk::Error] If the API request fails.
+      # Download transactions that occurred on your integration for a specific timeframe
       #
-      # @example
-      #   response = transactions.timeline("12345")
-      #   # OR
-      #   response = transactions.timeline("ref_123456789")
-      def timeline(id_or_reference)
-        validate_presence!(value: id_or_reference, name: "Transaction ID or Reference")
+      # @param from [String] The start date
+      # @param to [String] The end date
+      # @param status [String] Filter by the status of the transaction One of: success, failed, abandoned, reversed, all.
+      # @param customer_id [Numeric] Filter by customer ID
+      # @param subaccount_code [String] Filter by subaccount code
+      # @param settlement [Integer] Filter by the settlement ID
+      # @param currency [String] Specify the transaction currency to export.
+      # @param amount [Integer] Filter transactions by amount, using the supported currency subunit.
+      # @param settled [Boolean] Set to true to export only settled transactions, false for pending transactions.
+      # @param payment_page [Integer] Specify a payment page's id to export only transactions conducted on said page.
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/transaction/#export
+      def export(
+        from: nil,
+        to: nil,
+        status: nil,
+        customer_id: nil,
+        subaccount_code: nil,
+        settlement: nil,
+        currency: nil,
+        amount: nil,
+        settled: nil,
+        payment_page: nil
+      )
+        validate_allowed_values!(
+          value: status,
+          allowed_values: %w[success failed abandoned reversed all],
+          name: "status"
+        )
+        validate_positive_integer!(value: amount, name: "amount")
+
+        wire_query = to_wire(
+          {
+            from: format_datetime(from, name: "from"),
+            to: format_datetime(to, name: "to"),
+            status:,
+            customer_id:,
+            subaccount_code:,
+            settlement:,
+            currency:,
+            amount:,
+            settled:,
+            payment_page:
+          },
+          WIRE_NAMES
+        )
 
-        response = @connection.get("/transaction/timeline/#{id_or_reference}")
-        handle_response(response)
+        handle_response(@connection.get("/transaction/export", wire_query))
       end
     end
   end