zai_payment 2.8.0 → 2.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98109f5cacbac15031860abc6adb10c57f3ff7f232978965afe4c3052c962805
-  data.tar.gz: 126e97d1b18c1fba6e8b98e600727339f949c96e39064e7815832cb2ed5f62de
+  metadata.gz: b3f20fe256ab69c787f421db039fac49e817c855ca7aa07441380fb1d03ab2ca
+  data.tar.gz: 995f5e6a67dbc86b4ebadd2918c96dd63ba0effe5c8991826fd35e89bfdd6c0c
 SHA512:
-  metadata.gz: e319a397758406f149749a2f7a30f8217ba9b58666d311134f16734bee042c52f2d248c91e90ae83ddbd11445f2d6f58609ae5f3c9b09bed14f3f7a8a990d569
-  data.tar.gz: 03fa17ae8f34e051daa8c26ca7d141ff94b0fc712b0f489554cb1636a2c797670c0ae5b4243c9dd851634508599c00979bc98d37dae77ae7032b2453e1e23fa2
+  metadata.gz: e7152d67c815e5698d8f61aa4f28fa9957190b7ba97a3dac7fee73248698d04cf1d44acfca6988cd301fcf6e3094420f1b90d135e643af4b5150e8cde796c799
+  data.tar.gz: 811ec3899505dc68601c9432f7c4356f4e5fc3d44703bd156b5ce55daeb5ec90ceede45d9fc1084fa09ec7f5c281856635d9d3f1b1064338094dddf4e93d2e63

data/changelog.md

@@ -1,5 +1,24 @@
 ## [Released]
 
+## [2.8.1] - 2025-11-07
+
+### Fixed
+- **Response Data Extraction Bug**: Fixed `.data` method returning only `routing_number` value instead of full object 🐛
+  - Removed `routing_number` from `RESPONSE_DATA_KEYS` constant - it's a field within responses, not a collection wrapper key
+  - The `.data` method was incorrectly treating `routing_number` as a top-level data key
+  - This caused `response.data` to return just `"803320"` (the routing number) instead of the complete virtual account object
+  - Now properly returns the full response object when no wrapper key is found
+  - Affected resources: Virtual Accounts (and potentially other resources with `routing_number` field)
+  - Updated test mocks to match actual API response format (flat objects for single resources)
+  
+### Changed
+- **Virtual Account Test Fixtures**: Updated response structure to match actual Zai API format
+  - Single resource responses (show, create, update) now return flat objects without wrapper keys
+  - Collection responses (list) continue to use `virtual_accounts` wrapper key
+  - All 87 virtual account tests passing with corrected response structure
+
+**Full Changelog**: https://github.com/Sentia/zai-payment/compare/v2.8.0...v2.8.1
+
 ## [2.8.0] - 2025-11-07
 
 ### Added

data/docs/bank_accounts.md

@@ -117,7 +117,7 @@ Validate a US bank routing number before creating an account. This can be used t
 response = bank_accounts.validate_routing_number('122235821')
 
 if response.success?
-  routing_info = response.data
+  routing_info = response.data['routing_number']
   puts "Routing Number: #{routing_info['routing_number']}"
   puts "Bank Name: #{routing_info['customer_name']}"
   puts "City: #{routing_info['city']}"
@@ -133,16 +133,18 @@ end
 
 ```ruby
 {
-  "routing_number" => "122235821",
-  "customer_name" => "US BANK NA",
-  "address" => "EP-MN-WN1A",
-  "city" => "ST. PAUL",
-  "state_code" => "MN",
-  "zip" => "55107",
-  "zip_extension" => "1419",
-  "phone_area_code" => "800",
-  "phone_prefix" => "937",
-  "phone_suffix" => "631"
+  "routing_number" => {
+    "routing_number" => "122235821",
+    "customer_name" => "US BANK NA",
+    "address" => "EP-MN-WN1A",
+    "city" => "ST. PAUL",
+    "state_code" => "MN",
+    "zip" => "55107",
+    "zip_extension" => "1419",
+    "phone_area_code" => "800",
+    "phone_prefix" => "937",
+    "phone_suffix" => "631"
+  }
 }
 ```
 

data/examples/bank_accounts.md

@@ -164,7 +164,7 @@ bank_accounts = ZaiPayment::Resources::BankAccount.new
 response = bank_accounts.validate_routing_number('122235821')
 
 if response.success?
-  routing_info = response.data
+  routing_info = response.data['routing_number']
   
   puts "Routing Number Validation Results:"
   puts "  Routing Number: #{routing_info['routing_number']}"
@@ -197,7 +197,7 @@ begin
   validation_response = bank_accounts.validate_routing_number(routing_number)
   
   if validation_response.success?
-    bank_info = validation_response.data
+    bank_info = validation_response.data['routing_number']
     
     # Show user the bank information for confirmation
     puts "You are creating an account with:"
@@ -246,7 +246,7 @@ class BankAccountsController < ApplicationController
       response = bank_accounts.validate_routing_number(routing_number)
       
       if response.success?
-        bank_info = response.data
+        bank_info = response.data['routing_number']
         
         # Return bank info to display in the form
         render json: {

data/lib/zai_payment/resources/wallet_account.rb

@@ -15,6 +15,16 @@ module ZaiPayment
         reference_id: :reference_id
       }.freeze
 
+      # Map of attribute keys to API field names for withdraw
+      WITHDRAW_FIELD_MAPPING = {
+        account_id: :account_id,
+        amount: :amount,
+        custom_descriptor: :custom_descriptor,
+        reference_id: :reference_id,
+        end_to_end_id: :end_to_end_id,
+        ifti_information: :ifti_information
+      }.freeze
+
       def initialize(client: nil)
         @client = client || Client.new
       end
@@ -118,6 +128,58 @@ module ZaiPayment
         client.post("/wallet_accounts/#{wallet_account_id}/bill_payment", body: body)
       end
 
+      # Withdraw funds from a Wallet Account to a specified disbursement account
+      #
+      # @param wallet_account_id [String] the wallet account ID
+      # @param attributes [Hash] withdrawal attributes
+      # @option attributes [String] :account_id (Required) Account ID to withdraw to
+      # @option attributes [Integer] :amount (Required) Amount in cents to withdraw
+      # @option attributes [String] :custom_descriptor Custom descriptor for the withdrawal
+      #   (max 200 chars for NPP, 18 for DE batch)
+      # @option attributes [String] :reference_id Unique reference information (cannot contain '.' character)
+      # @option attributes [String] :end_to_end_id Unique identifier for NPP IFTI payout tracking (mandatory for IFTI)
+      # @option attributess [Hash] :ifti_information IFTI payer information hash (required for IFTI payouts)
+      # @return [Response] the API response containing disbursement details
+      #
+      # @example Basic withdrawal
+      #   wallet_accounts = ZaiPayment::Resources::WalletAccount.new
+      #   response = wallet_accounts.withdraw(
+      #     'wallet_account_id',
+      #     account_id: 'bank_account_id',
+      #     amount: 10000
+      #   )
+      #
+      # @example Withdrawal with custom descriptor and reference
+      #   response = wallet_accounts.withdraw(
+      #     'wallet_account_id',
+      #     account_id: 'bank_account_id',
+      #     amount: 10000,
+      #     custom_descriptor: 'Invoice #12345 Payment',
+      #     reference_id: 'ref-12345'
+      #   )
+      #
+      # @example NPP IFTI withdrawal
+      #   response = wallet_accounts.withdraw(
+      #     'wallet_account_id',
+      #     account_id: 'bank_account_id',
+      #     amount: 10000,
+      #     end_to_end_id: 'E2E-UNIQUE-ID-123',
+      #     ifti_information: {
+      #       payer_name: 'John Doe',
+      #       payer_address: '123 Main St, Sydney NSW 2000',
+      #       payer_country: 'AUS'
+      #     }
+      #   )
+      #
+      # @see https://developer.hellozai.com/reference
+      def withdraw(wallet_account_id, **attributes)
+        validate_id!(wallet_account_id, 'wallet_account_id')
+        validate_withdraw_attributes!(attributes)
+
+        body = build_withdraw_body(attributes)
+        client.post("/wallet_accounts/#{wallet_account_id}/withdraw", body: body)
+      end
+
       private
 
       def validate_id!(value, field_name)
@@ -159,6 +221,40 @@ module ZaiPayment
         raise Errors::ValidationError, "reference_id cannot contain single quote (') character"
       end
 
+      def validate_withdraw_attributes!(attributes)
+        validate_required_withdraw_attributes!(attributes)
+        validate_amount!(attributes[:amount]) if attributes[:amount]
+        validate_withdraw_reference_id!(attributes[:reference_id]) if attributes[:reference_id]
+        validate_custom_descriptor!(attributes[:custom_descriptor]) if attributes[:custom_descriptor]
+      end
+
+      def validate_required_withdraw_attributes!(attributes)
+        required_fields = %i[account_id amount]
+
+        missing_fields = required_fields.select do |field|
+          attributes[field].nil? || (attributes[field].respond_to?(:to_s) && attributes[field].to_s.strip.empty?)
+        end
+
+        return if missing_fields.empty?
+
+        raise Errors::ValidationError,
+              "Missing required fields: #{missing_fields.join(', ')}"
+      end
+
+      def validate_withdraw_reference_id!(reference_id)
+        # Reference ID cannot contain '.' character
+        return unless reference_id.to_s.include?('.')
+
+        raise Errors::ValidationError, "reference_id cannot contain '.' character"
+      end
+
+      def validate_custom_descriptor!(custom_descriptor)
+        # Basic validation - max 200 characters for NPP (API will enforce specific limits)
+        return if custom_descriptor.to_s.length <= 200
+
+        raise Errors::ValidationError, 'custom_descriptor must be 200 characters or less'
+      end
+
       def build_pay_bill_body(attributes)
         body = {}
 
@@ -171,6 +267,19 @@ module ZaiPayment
 
         body
       end
+
+      def build_withdraw_body(attributes)
+        body = {}
+
+        attributes.each do |key, value|
+          next if value.nil? || (value.respond_to?(:empty?) && value.empty?)
+
+          api_field = WITHDRAW_FIELD_MAPPING[key]
+          body[api_field] = value if api_field
+        end
+
+        body
+      end
     end
   end
 end

data/lib/zai_payment/response.rb

@@ -8,7 +8,7 @@ module ZaiPayment
     RESPONSE_DATA_KEYS = %w[
       webhooks users items fees transactions
       batch_transactions batches bpay_accounts bank_accounts card_accounts
-      wallet_accounts virtual_accounts routing_number disbursements pay_ids
+      wallet_accounts virtual_accounts disbursements pay_ids
     ].freeze
 
     def initialize(faraday_response)

data/lib/zai_payment/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZaiPayment
-  VERSION = '2.8.0'
+  VERSION = '2.8.2'
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zai_payment
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.8.2
 platform: ruby
 authors:
 - Eddy Jaga
+autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -129,6 +130,7 @@ metadata:
   code_of_conduct_uri: https://github.com/Sentia/zai-payment/blob/main/code_of_conduct.md
   rubygems_mfa_required: 'true'
   documentation_uri: https://github.com/Sentia/zai-payment#readme
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,7 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Ruby gem for Zai payment integration
 test_files: []