braintree 2.24.0 → 2.25.0

data/lib/braintree.rb

@@ -44,6 +44,8 @@ require "braintree/error_result"
 require "braintree/errors"
 require "braintree/gateway"
 require "braintree/http"
+require "braintree/merchant_account"
+require "braintree/merchant_account_gateway"
 require "braintree/plan"
 require "braintree/plan_gateway"
 require "braintree/settlement_batch_summary"
@@ -54,6 +56,7 @@ require "braintree/subscription_gateway"
 require "braintree/subscription_search"
 require "braintree/successful_result"
 require "braintree/test/credit_card"
+require "braintree/test/merchant_account"
 require "braintree/test/venmo_sdk"
 require "braintree/test/transaction_amounts"
 require "braintree/transaction"

data/lib/braintree/error_codes.rb

@@ -5,13 +5,13 @@ module Braintree
   module ErrorCodes
     # See http://www.braintreepayments.com/docs/ruby/addresses/validations
     module Address
-      CannotBeBlank = "81801"
       CompanyIsInvalid = "91821"
-      CompanyIsTooLong = "81802"
-      CountryCodeAlpha2IsNotAccepted  = "91814"
-      CountryCodeAlpha3IsNotAccepted  = "91816"
-      CountryCodeNumericIsNotAccepted = "91817"
       CountryNameIsNotAccepted = "91803"
+      CountryCodeAlpha2IsNotAccepted = "91814"
+      CountryCodeAlpha3IsNotAccepted = "91816"
+      CountryCodeNumericIsNotAccepted = "91817"
+      CannotBeBlank = "81801"
+      CompanyIsTooLong = "81802"
       ExtendedAddressIsInvalid = "91823"
       ExtendedAddressIsTooLong = "81804"
       FirstNameIsInvalid = "91819"
@@ -37,77 +37,68 @@ module Braintree
     module CreditCard
       BillingAddressConflict = "91701"
       BillingAddressIdIsInvalid = "91702"
+      CustomerIdIsRequired = "91704"
+      CustomerIdIsInvalid = "91705"
+      ExpirationDateConflict = "91708"
+      TokenFormatIsInvalid = "91718"
+      TokenIsInUse = "91719"
+      TokenIsTooLong = "91720"
+      TokenIsNotAllowed = "91721"
+      TokenIsRequired = "91722"
       CardholderNameIsTooLong = "81723"
       CreditCardTypeIsNotAccepted = "81703"
       CreditCardTypeIsNotAcceptedBySubscriptionMerchantAccount = "81718"
-      CustomerIdIsInvalid = "91705"
-      CustomerIdIsRequired = "91704"
-      CvvIsInvalid = "81707"
       CvvIsRequired = "81706"
+      CvvIsInvalid = "81707"
       DuplicateCardExists = "81724"
-      ExpirationDateConflict = "91708"
-      ExpirationDateIsInvalid = "81710"
       ExpirationDateIsRequired = "81709"
+      ExpirationDateIsInvalid = "81710"
       ExpirationDateYearIsInvalid = "81711"
       ExpirationMonthIsInvalid = "81712"
       ExpirationYearIsInvalid = "81713"
       InvalidVenmoSDKPaymentMethodCode = "91727"
-      NumberHasInvalidLength = "81716"
-      NumberLengthIsInvalid = "81716"
-      NumberIsInvalid = "81715"
       NumberIsRequired = "81714"
+      NumberIsInvalid = "81715"
+      NumberLengthIsInvalid = "81716"
       NumberMustBeTestNumber = "81717"
       PaymentMethodConflict = "81725"
-      TokenInvalid = "91718"
-      TokenFormatIsInvalid = "91718"
-      TokenIsInUse = "91719"
-      TokenIsNotAllowed = "91721"
-      TokenIsRequired = "91722"
-      TokenIsTooLong = "91720"
       VenmoSDKPaymentMethodCodeCardTypeIsNotAccepted = "91726"
+      VerificationNotSupportedOnThisMerchantAccount = "91730"
 
       module Options
         UpdateExistingTokenIsInvalid = "91723"
         VerificationMerchantAccountIdIsInvalid = "91728"
+        UpdateExistingTokenNotAllowed = "91729"
       end
     end
 
     # See http://www.braintreepayments.com/docs/ruby/customers/validations
     module Customer
-      CompanyIsTooLong = "81601"
       CustomFieldIsInvalid = "91602"
-      CustomFieldIsTooLong = "81603"
-      EmailIsInvalid = "81604"
-      EmailFormatIsInvalid = "81604"
-      EmailIsRequired = "81606"
-      EmailIsTooLong = "81605"
-      FaxIsTooLong = "81607"
-      FirstNameIsTooLong = "81608"
       IdIsInUse = "91609"
-      IdIsInvaild = "91610" # Deprecated
       IdIsInvalid = "91610"
       IdIsNotAllowed = "91611"
       IdIsRequired = "91613"
       IdIsTooLong = "91612"
+      CompanyIsTooLong = "81601"
+      CustomFieldIsTooLong = "81603"
+      EmailFormatIsInvalid = "81604"
+      EmailIsTooLong = "81605"
+      EmailIsRequired = "81606"
+      FaxIsTooLong = "81607"
+      FirstNameIsTooLong = "81608"
       LastNameIsTooLong = "81613"
       PhoneIsTooLong = "81614"
-      WebsiteIsInvalid = "81616"
-      WebsiteFormatIsInvalid = "81616"
       WebsiteIsTooLong = "81615"
+      WebsiteFormatIsInvalid = "81616"
     end
 
     module Descriptor
-      DynamicDescriptorsDisabled = "92203"
-      InternationalPhoneFormatIsInvalid = "92205"
-      InternationalNameFormatIsInvalid = "92204"
       NameFormatIsInvalid = "92201"
       PhoneFormatIsInvalid = "92202"
-    end
-
-    module SettlementBatchSummary
-      CustomFieldIsInvalid = "82303"
-      SettlementDateIsInvalid = "82302"
-      SettlementDateIsRequired = "82301"
+      DynamicDescriptorsDisabled = "92203"
+      InternationalNameFormatIsInvalid = "92204"
+      InternationalPhoneFormatIsInvalid = "92205"
     end
 
     # See http://www.braintreepayments.com/docs/ruby/subscriptions/validations
@@ -173,22 +164,26 @@ module Braintree
     # See http://www.braintreepayments.com/docs/ruby/transactions/validations
     module Transaction
       AmountCannotBeNegative = "81501"
-      AmountIsInvalid = "81503"
-      AmountFormatIsInvalid = "81503"
+      AmountFormatIsInvalid = "81503" # Keep for backwards compatibility
+      AmountIsInvalid = "81503" # Keep for backwards compatibility
       AmountIsRequired = "81502"
       AmountIsTooLarge = "81528"
       AmountMustBeGreaterThanZero = "81531"
       BillingAddressConflict = "91530"
       CannotBeVoided = "91504"
+      CannotCancelRelease = "91562"
       CannotCloneCredit = "91543"
       CannotCloneTransactionWithVaultCreditCard = "91540"
       CannotCloneUnsuccessfulTransaction = "91542"
       CannotCloneVoiceAuthorizations = "91541"
+      CannotHoldInEscrow = "91560"
+      CannotPartiallyRefundEscrowedTransaction = "91563"
       CannotRefundCredit = "91505"
       CannotRefundUnlessSettled = "91506"
+      CannotRefundWithPendingMerchantAccount = "91559"
       CannotRefundWithSuspendedMerchantAccount = "91538"
+      CannotReleaseFromEscrow = "91561"
       CannotSubmitForSettlement = "91507"
-      ChannelIsTooLong = "91550"
       CreditCardIsRequired = "91508"
       CustomFieldIsInvalid = "91526"
       CustomFieldIsTooLong = "81527"
@@ -196,11 +191,12 @@ module Braintree
       CustomerDoesNotHaveCreditCard = "91511"
       CustomerIdIsInvalid = "91510"
       HasAlreadyBeenRefunded = "91512"
+      MerchantAccountDoesNotSupportRefunds = "91547"
+      MerchantAccountDoesNotSupportMOTO = "91558"
       MerchantAccountIdIsInvalid = "91513"
       MerchantAccountIsSuspended = "91514"
-      MerchantAccountDoesNotSupportRefunds = "91547"
-      MerchantAccountNameIsInvalid = "91513" # Deprecated
       OrderIdIsTooLong = "91501"
+      ChannelIsTooLong = "91550"
       PaymentMethodConflict = "91515"
       PaymentMethodConflictWithVenmoSDK = "91549"
       PaymentMethodDoesNotBelongToCustomer = "91516"
@@ -211,10 +207,17 @@ module Braintree
       ProcessorAuthorizationCodeIsInvalid = "81520"
       ProcessorDoesNotSupportCredits = "91546"
       ProcessorDoesNotSupportVoiceAuthorizations = "91545"
-      PurchaseOrderNumberIsTooLong = "91537"
       PurchaseOrderNumberIsInvalid = "91548"
+      PurchaseOrderNumberIsTooLong = "91537"
       RefundAmountIsTooLarge = "91521"
+      ServiceFeeAmountCannotBeNegative = "91554"
+      ServiceFeeAmountFormatIsInvalid = "91555"
+      ServiceFeeAmountIsTooLarge = "91556"
+      ServiceFeeIsNotAllowedOnCredits = "91552"
+      ServiceFeeAmountNotAllowedOnMasterMerchantAccount = "91557"
+      SettlementAmountIsLessThanServiceFeeAmount = "91551"
       SettlementAmountIsTooLarge = "91522"
+      SubMerchantAccountRequiresServiceFeeAmount = "91553"
       SubscriptionDoesNotBelongToCustomer = "91529"
       SubscriptionIdIsInvalid = "91528"
       SubscriptionStatusMustBePastDue = "91531"
@@ -230,5 +233,56 @@ module Braintree
         VaultIsDisabled = "91525"
       end
     end
+
+    module MerchantAccount
+      IdIsTooLong = "82602"
+      IdFormatIsInvalid = "82603"
+      IdIsInUse = "82604"
+      IdIsNotAllowed = "82605"
+      MasterMerchantAccountIdIsRequired = "82606"
+      MasterMerchantAccountIdIsInvalid = "82607"
+      MasterMerchantAccountMustBeActive = "82608"
+      TosAcceptedIsRequired = "82610"
+
+      module ApplicantDetails
+        FirstNameIsRequired = "82609"
+        LastNameIsRequired = "82611"
+        DateOfBirthIsRequired = "82612"
+        RoutingNumberIsRequired = "82613"
+        AccountNumberIsRequired = "82614"
+        SsnIsInvalid = "82615"
+        EmailAddressIsInvalid = "82616"
+        FirstNameIsInvalid = "82627"
+        LastNameIsInvalid = "82628"
+        CompanyNameIsInvalid = "82631"
+        TaxIdIsInvalid = "82632"
+        CompanyNameIsRequiredWithTaxId = "82633"
+        TaxIdIsRequiredWithCompanyName = "82634"
+        RoutingNumberIsInvalid = "82635"
+        DeclinedOFAC = "82621"
+        DeclinedMasterCardMatch = "82622"
+        DeclinedFailedKYC = "82623"
+        DeclinedSsnInvalid = "82624"
+        DeclinedSsnMatchesDeceased = "82625"
+        Declined = "82626"
+        PhoneIsInvalid = "82636"
+
+        module Address
+          StreetAddressIsRequired = "82617"
+          LocalityIsRequired = "82618"
+          PostalCodeIsRequired = "82619"
+          RegionIsRequired = "82620"
+          StreetAddressIsInvalid = "82629"
+          PostalCodeIsInvalid = "82630"
+        end
+      end
+    end
+
+    module SettlementBatchSummary
+      SettlementDateIsRequired = "82301"
+      SettlementDateIsInvalid = "82302"
+      CustomFieldIsInvalid = "82303"
+    end
   end
 end
+

data/lib/braintree/error_result.rb

@@ -2,12 +2,13 @@ module Braintree
   # See http://www.braintreepayments.com/docs/ruby/general/result_objects
   class ErrorResult
 
-    attr_reader :credit_card_verification, :transaction, :subscription, :errors, :params, :message
+    attr_reader :credit_card_verification, :merchant_account, :transaction, :subscription, :errors, :params, :message
 
     def initialize(gateway, data) # :nodoc:
       @gateway = gateway
       @params = data[:params]
       @credit_card_verification = CreditCardVerification._new(data[:verification]) if data[:verification]
+      @merchant_account = MerchantAccount._new(gateway, data[:merchant_account]) if data[:merchant_account]
       @message = data[:message]
       @transaction = Transaction._new(gateway, data[:transaction]) if data[:transaction]
       @subscription = Subscription._new(gateway, data[:subscription]) if data[:subscription]

data/lib/braintree/gateway.rb

@@ -36,6 +36,10 @@ module Braintree
       PlanGateway.new(self)
     end
 
+    def merchant_account
+      MerchantAccountGateway.new(self)
+    end
+
     def settlement_batch_summary
       SettlementBatchSummaryGateway.new(self)
     end

data/lib/braintree/merchant_account.rb

@@ -0,0 +1,38 @@
+module Braintree
+  class MerchantAccount
+    include BaseModule
+
+    module Status
+      Pending = "pending"
+      Active = "active"
+      Suspended = "suspended"
+    end
+
+    attr_reader :status, :id, :master_merchant_account
+
+    def self.create(attributes)
+      Configuration.gateway.merchant_account.create(attributes)
+    end
+
+    def initialize(gateway, attributes) # :nodoc
+      @gateway = gateway
+      @master_merchant_account = MerchantAccount._new(@gateway, attributes.delete(:master_merchant_account)) if attributes[:master_merchant_account]
+      set_instance_variables_from_hash(attributes)
+    end
+
+    class << self
+      protected :new
+      def _new(*args) # :nodoc:
+        self.new *args
+      end
+    end
+
+    def inspect
+      order = [:id, :status, :master_merchant_account]
+      nice_attributes = order.map do |attr|
+        "#{attr}: #{send(attr).inspect}"
+      end
+      "#<#{self.class}: #{nice_attributes.join(', ')}>"
+    end
+  end
+end

data/lib/braintree/merchant_account_gateway.rb

@@ -0,0 +1,33 @@
+module Braintree
+  class MerchantAccountGateway # :nodoc:
+    def initialize(gateway)
+      @gateway = gateway
+      @config = gateway.config
+    end
+
+    def create(attributes)
+      Util.verify_keys(MerchantAccountGateway._create_signature, attributes)
+      _do_create "/merchant_accounts/create_via_api", :merchant_account => attributes
+    end
+
+    def _do_create(url, params=nil) # :nodoc:
+      response = @config.http.post url, params
+      if response[:api_error_response]
+        ErrorResult.new(@gateway, response[:api_error_response])
+      else
+        SuccessfulResult.new(:merchant_account => MerchantAccount._new(@gateway, response[:merchant_account]))
+      end
+    end
+
+    def self._create_signature # :nodoc:
+      [
+        {:applicant_details => [
+          :first_name, :last_name, :email, :date_of_birth, :ssn, :routing_number,
+          :account_number, :tax_id, :company_name, :phone,
+          {:address => [:street_address, :postal_code, :locality, :region]}]
+        },
+        :tos_accepted, :master_merchant_account_id, :id
+      ]
+    end
+  end
+end

data/lib/braintree/test/merchant_account.rb

@@ -0,0 +1,7 @@
+module Braintree
+  module Test # :nodoc:
+    module MerchantAccount
+      Approve = "approve_me"
+    end
+  end
+end

data/lib/braintree/transaction.rb

@@ -8,6 +8,14 @@ module Braintree
       Token = 'token'
     end
 
+    module EscrowStatus
+      HoldPending = 'hold_pending'
+      Held = 'held'
+      ReleasePending = 'release_pending'
+      Released = 'released'
+      Refunded = 'refunded'
+    end
+
     module GatewayRejectionReason
       AVS = "avs"
       AVSAndCVV = "avs_and_cvv"
@@ -44,12 +52,13 @@ module Braintree
     end
 
     attr_reader :avs_error_response_code, :avs_postal_code_response_code, :avs_street_address_response_code
-    attr_reader :amount, :created_at, :credit_card_details, :customer_details, :subscription_details, :id
+    attr_reader :amount, :created_at, :credit_card_details, :customer_details, :subscription_details, :service_fee_amount, :id
     attr_reader :currency_iso_code
     attr_reader :custom_fields
     attr_reader :cvv_response_code
     attr_reader :disbursement_details
     attr_reader :descriptor
+    attr_reader :escrow_status
     attr_reader :gateway_rejection_reason
     attr_reader :merchant_account_id
     attr_reader :order_id
@@ -87,6 +96,14 @@ module Braintree
       return_object_or_raise(:transaction) { create(attributes) }
     end
 
+    def self.cancel_release(transaction_id)
+      Configuration.gateway.transaction.cancel_release(transaction_id)
+    end
+
+    def self.cancel_release!(transaction_id)
+      return_object_or_raise(:transaction) { cancel_release(transaction_id) }
+    end
+
     def self.clone_transaction(transaction_id, attributes)
       Configuration.gateway.transaction.clone_transaction(transaction_id, attributes)
     end
@@ -124,6 +141,14 @@ module Braintree
       Configuration.gateway.transaction.find(id)
     end
 
+    def self.hold_in_escrow(id)
+      Configuration.gateway.transaction.hold_in_escrow(id)
+    end
+
+    def self.hold_in_escrow!(id)
+      return_object_or_raise(:transaction) { hold_in_escrow(id) }
+    end
+
     # See http://www.braintreepayments.com/docs/ruby/transactions/refund
     def self.refund(id, amount = nil)
       Configuration.gateway.transaction.refund(id, amount)
@@ -149,6 +174,14 @@ module Braintree
       Configuration.gateway.transaction.search(&block)
     end
 
+    def self.release_from_escrow(transaction_id)
+      Configuration.gateway.transaction.release_from_escrow(transaction_id)
+    end
+
+    def self.release_from_escrow!(transaction_id)
+      return_object_or_raise(:transaction) { release_from_escrow(transaction_id) }
+    end
+
     # See http://www.braintreepayments.com/docs/ruby/transactions/submit_for_settlement
     def self.submit_for_settlement(transaction_id, amount = nil)
       Configuration.gateway.transaction.submit_for_settlement(transaction_id, amount)
@@ -174,6 +207,7 @@ module Braintree
       set_instance_variables_from_hash(attributes)
       @amount = Util.to_big_decimal(amount)
       @credit_card_details = CreditCardDetails.new(@credit_card)
+      @service_fee_amount = Util.to_big_decimal(service_fee_amount)
       @subscription_details = SubscriptionDetails.new(@subscription)
       @customer_details = CustomerDetails.new(@customer)
       @billing_details = AddressDetails.new(@billing)

data/lib/braintree/transaction/credit_card_details.rb

@@ -27,6 +27,10 @@ module Braintree
       def masked_number
         "#{bin}******#{last_4}"
       end
+
+      def venmo_sdk?
+        @venmo_sdk
+      end
     end
   end
 end