zai_payment 2.8.1 → 2.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a1b779cc3a64f6f5d53beabacc7eccbf06bc380c0b58f86f989673a5924b6aa
-  data.tar.gz: 5654753fffd844b167c4c10343b34a5d7f6a969ad68c058141647ee20319ea57
+  metadata.gz: b3f20fe256ab69c787f421db039fac49e817c855ca7aa07441380fb1d03ab2ca
+  data.tar.gz: 995f5e6a67dbc86b4ebadd2918c96dd63ba0effe5c8991826fd35e89bfdd6c0c
 SHA512:
-  metadata.gz: c433a00fd122c1bf91a7e112438f1df59dd7b35a4554effeadd380f93cf8bcbb0b6593e87e44727c71994c4327792cf1552320a5d71a3d7a87fc6fff90732796
-  data.tar.gz: dd2d61c6ca97cf1d02f272b985e3cf568592acfe02912b3f877462dde9d89fb812a904d4cc5c5792806f10731ece2a12f2a594f2a3ba802c4f951a9f193dc81f
+  metadata.gz: e7152d67c815e5698d8f61aa4f28fa9957190b7ba97a3dac7fee73248698d04cf1d44acfca6988cd301fcf6e3094420f1b90d135e643af4b5150e8cde796c799
+  data.tar.gz: 811ec3899505dc68601c9432f7c4356f4e5fc3d44703bd156b5ce55daeb5ec90ceede45d9fc1084fa09ec7f5c281856635d9d3f1b1064338094dddf4e93d2e63

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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zai_payment
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 2.8.2
 platform: ruby
 authors:
 - Eddy Jaga
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-07 00:00:00.000000000 Z
+date: 2025-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Ruby gem for Zai payment integration