braintree 4.29.0 → 4.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1ad6cd9b340121a0247feb50ad4b05ed7b64508f6362a7712caf94d5eaf0841
-  data.tar.gz: 42204c6e19efec3a657ef9dfa801efbe38d33869f452aa4f16db9806d165c727
+  metadata.gz: 0a1505b44cec85c55cc5237d0fa3d57165dfa809589893774fdecfc972147940
+  data.tar.gz: e92b0f87a02744e0df5db4173aa6a2e237dd5b7817932232e380a160d7df1450
 SHA512:
-  metadata.gz: 960910f8cefb89b65b9463988235e95c1375ecb2401e04df8368fdd63412b9cec5d370832fe92c9d22932bdbe35001e91af6c97bfd37e288b49181cf4fb02c77
-  data.tar.gz: 4ad2f1cb6ad7ba10cec9efe4ab695177e235b7cf1f95d8527a1a13d72533adc12807c7b8019aca7145b8ac6beb74cfa284b134ae8c266451eea1eff0187d2d03
+  metadata.gz: 2d5c303f50bd453a719fc0586593fcf9307fc8a1be02c5307487178bbf368d7e1467bf08ceda4e0b96c421a46f1d43d1f9c17af35206efcb22b5c3d0f0da9094
+  data.tar.gz: 287dadfccf55558b99069ffd42458b67085a68aabeb2d6575765e8f96c281c97158228bf99254a802d84b50e41fc90dc28b06d4c5984fb06e2563e28c108c286

data/lib/braintree/address_gateway.rb

@@ -84,6 +84,11 @@ module Braintree
     def self._update_signature
       _create_signature
     end
+
+    def self._address_attributes
+      [:street_address, :extended_address, :locality, :region, :postal_code, :country_code_alpha2,
+       {:international_phone => [:country_code, :national_number]}]
+    end
   end
 end
 

data/lib/braintree/apple_pay_card.rb

@@ -29,6 +29,7 @@ module Braintree
     attr_reader :expired
     attr_reader :healthcare
     attr_reader :image_url
+    attr_reader :is_device_token
     attr_reader :issuing_bank
     attr_reader :last_4
     attr_reader :merchant_token_identifier

data/lib/braintree/bank_account_instant_verification_gateway.rb

@@ -0,0 +1,38 @@
+module Braintree
+  class BankAccountInstantVerificationGateway
+
+    CREATE_JWT_MUTATION =
+      "mutation CreateBankAccountInstantVerificationJwt($input: CreateBankAccountInstantVerificationJwtInput!) { " +
+      "  createBankAccountInstantVerificationJwt(input: $input) {" +
+      "    jwt" +
+      "  }" +
+      "}"
+
+    def initialize(gateway)
+      @gateway = gateway
+      @config = gateway.config
+    end
+
+    def create_jwt(request)
+      variables = request.to_graphql_variables
+      response = @gateway.graphql_client.query(CREATE_JWT_MUTATION, variables)
+      errors = Braintree::GraphQLClient.get_validation_errors(response)
+
+      if errors
+        ErrorResult.new(@gateway, {errors: errors})
+      else
+        data = response.dig(:data, :createBankAccountInstantVerificationJwt)
+
+        if data.nil?
+          raise UnexpectedError, "expected :createBankAccountInstantVerificationJwt"
+        end
+
+        jwt_attrs = {
+          :jwt => data[:jwt]
+        }
+
+        SuccessfulResult.new(:bank_account_instant_verification_jwt => BankAccountInstantVerificationJwt._new(jwt_attrs))
+      end
+    end
+  end
+end

data/lib/braintree/bank_account_instant_verification_jwt.rb

@@ -0,0 +1,23 @@
+module Braintree
+  class BankAccountInstantVerificationJwt
+    include BaseModule
+
+    attr_reader :jwt
+
+    def initialize(attributes)
+      set_instance_variables_from_hash(attributes)
+    end
+
+    def self._new(*args)
+      self.new(*args)
+    end
+
+    def inspect
+      attr_order = [:jwt]
+      formatted_attrs = attr_order.map do |attr|
+        "#{attr}: #{send(attr).inspect}"
+      end
+      "#<#{self.class} #{formatted_attrs.join(', ')}>"
+    end
+  end
+end

data/lib/braintree/bank_account_instant_verification_jwt_request.rb

@@ -0,0 +1,21 @@
+module Braintree
+  class BankAccountInstantVerificationJwtRequest
+    include BaseModule
+
+    attr_accessor :business_name, :return_url, :cancel_url
+
+    def initialize(attributes = {})
+      set_instance_variables_from_hash(attributes)
+    end
+
+    def to_graphql_variables
+      variables = {:input => {}}
+
+      variables[:input][:businessName] = business_name if business_name
+      variables[:input][:returnUrl] = return_url if return_url
+      variables[:input][:cancelUrl] = cancel_url if cancel_url
+
+      variables
+    end
+  end
+end

data/lib/braintree/dispute.rb

@@ -32,6 +32,7 @@ module Braintree
     attr_reader :reply_by_date
     attr_reader :status
     attr_reader :status_history
+    attr_reader :remaining_file_evidence_storage
     attr_reader :transaction
     attr_reader :transaction_details
     attr_reader :updated_at

data/lib/braintree/error_codes.rb

@@ -459,6 +459,8 @@ module Braintree
       TransactionIsNotEligibleForAdjustment = "915219"
       TransactionMustBeInStateAuthorized = "915218"
       TransactionSourceIsInvalid = "915133"
+      TransactionTransferDetailsAreMandatory = "97510"
+      TransactionTransferTypeIsInvalid = "97501"
       TypeIsInvalid = "91523"
       TypeIsRequired = "91524"
       UnsupportedVoiceAuthorization = "91539"

data/lib/braintree/gateway.rb

@@ -26,6 +26,10 @@ module Braintree
       ApplePayGateway.new(self)
     end
 
+    def bank_account_instant_verification
+      BankAccountInstantVerificationGateway.new(self)
+    end
+
     def client_token
       ClientTokenGateway.new(self)
     end

data/lib/braintree/payment_method_gateway.rb

@@ -201,6 +201,12 @@ module Braintree
           :ds_transaction_id,
         ]
       }
+      signature << {
+        :us_bank_account => [
+          :ach_mandate_text,
+          :ach_mandate_accepted_at,
+        ]
+      }
 
       case type
       when :create

data/lib/braintree/successful_result.rb

@@ -23,6 +23,7 @@ module Braintree
     attr_reader :subscription
     attr_reader :supported_networks
     attr_reader :transaction
+    attr_reader :bank_account_instant_verification_jwt
     attr_reader :us_bank_account_verification
     attr_reader :session_id
     attr_reader :customer_recommendations

data/lib/braintree/transaction/apple_pay_details.rb

@@ -18,6 +18,7 @@ module Braintree
       attr_reader :global_id
       attr_reader :healthcare
       attr_reader :image_url
+      attr_reader :is_device_token
       attr_reader :issuing_bank
       attr_reader :last_4
       attr_reader :merchant_token_identifier

data/lib/braintree/transaction.rb

@@ -82,6 +82,8 @@ module Braintree
       end
     end
 
+    attr_reader :account_funding_transaction
+    attr_reader :ach_reject_reason
     attr_reader :ach_return_code
     attr_reader :ach_return_responses
     attr_reader :acquirer_reference_number
@@ -171,6 +173,7 @@ module Braintree
     attr_reader :tax_exempt
     attr_reader :three_d_secure_info
     attr_reader :type
+    attr_reader :upcoming_retry_date
     attr_reader :updated_at
     attr_reader :us_bank_account_details
     attr_reader :venmo_account_details

data/lib/braintree/transaction_gateway.rb

@@ -280,6 +280,35 @@ module Braintree
             :ds_transaction_id,
           ]
         },
+        {
+          :transfer => [
+            :type,
+            {
+              :sender => [
+                :first_name,
+                :last_name,
+                :account_reference_number,
+                :tax_id,
+                {:address => AddressGateway._address_attributes}
+              ]
+            },
+            {
+              :receiver => [
+                :first_name,
+                :last_name,
+                :account_reference_number,
+                :tax_id,
+                {:address => AddressGateway._address_attributes}
+              ]
+            },
+          ]
+        },
+        {
+          :us_bank_account => [
+            :ach_mandate_text,
+            :ach_mandate_accepted_at,
+          ]
+        },
       ]
     end
 

data/lib/braintree/us_bank_account_verification.rb

@@ -15,11 +15,12 @@ module Braintree
 
     module VerificationMethod
       IndependentCheck = "independent_check"
+      InstantVerificationAccountValidation = "instant_verification_account_validation"
       NetworkCheck = "network_check"
       TokenizedCheck = "tokenized_check"
       MicroTransfers = "micro_transfers"
 
-      All = [IndependentCheck, NetworkCheck, TokenizedCheck, MicroTransfers]
+      All = [IndependentCheck, InstantVerificationAccountValidation, NetworkCheck, TokenizedCheck, MicroTransfers]
     end
 
     module VerificationAddOns
@@ -42,6 +43,7 @@ module Braintree
 
     def initialize(attributes)
       set_instance_variables_from_hash(attributes)
+      @us_bank_account = UsBankAccount._new(nil, attributes[:us_bank_account]) if attributes[:us_bank_account]
     end
 
     def inspect

data/lib/braintree/version.rb

@@ -1,7 +1,7 @@
 module Braintree
   module Version
     Major = 4
-    Minor = 29
+    Minor = 31
     Tiny = 0
 
     String = "#{Major}.#{Minor}.#{Tiny}"

data/lib/braintree/webhook_notification.rb

@@ -57,6 +57,7 @@ module Braintree
       SubscriptionWentPastDue = "subscription_went_past_due"
 
       TransactionDisbursed = "transaction_disbursed"
+      TransactionRetried = "transaction_retried"
       TransactionReviewed = "transaction_reviewed"
       TransactionSettlementDeclined = "transaction_settlement_declined"
       TransactionSettled = "transaction_settled"

data/lib/braintree/webhook_testing_gateway.rb

@@ -60,6 +60,8 @@ module Braintree
         _oauth_access_revoked_sample_xml(id)
       when Braintree::WebhookNotification::Kind::TransactionDisbursed
         _transaction_disbursed_sample_xml(id)
+      when Braintree::WebhookNotification::Kind::TransactionRetried
+        _transaction_retried_sample_xml(id)
       when Braintree::WebhookNotification::Kind::TransactionReviewed
         _transaction_reviewed_sample_xml(id)
       when Braintree::WebhookNotification::Kind::TransactionSettled
@@ -269,6 +271,20 @@ module Braintree
       XML
     end
 
+    def _transaction_retried_sample_xml(id)
+
+      <<-XML
+        <transaction>
+          <id>#{id}</id>
+          <amount>100</amount>
+          <status>submitted_for_settlement</status>
+          <type>sale</type>
+          <currency-iso-code>USD</currency-iso-code>
+          <retried-transaction-id>original_txn_id</retried-transaction-id>
+        </transaction>
+      XML
+    end
+
     def _transaction_reviewed_sample_xml(id)
 
       <<-XML

data/lib/braintree.rb

@@ -35,6 +35,9 @@ require "braintree/apple_pay_card"
 require "braintree/apple_pay_gateway"
 require "braintree/apple_pay_options"
 require "braintree/authorization_adjustment"
+require "braintree/bank_account_instant_verification_gateway"
+require "braintree/bank_account_instant_verification_jwt"
+require "braintree/bank_account_instant_verification_jwt_request"
 require "braintree/bin_data"
 require "braintree/client_token"
 require "braintree/client_token_gateway"

data/spec/integration/braintree/bank_account_instant_verification_spec.rb

@@ -0,0 +1,191 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+require File.expand_path(File.dirname(__FILE__) + "/client_api/spec_helper")
+
+describe Braintree::BankAccountInstantVerificationGateway do
+  before do
+    @gateway = Braintree::Gateway.new(
+      :environment => :development,
+      :merchant_id => "integration2_merchant_id",
+      :public_key => "integration2_public_key",
+      :private_key => "integration2_private_key",
+    )
+
+    @us_bank_gateway = Braintree::Gateway.new(
+      :environment => :development,
+      :merchant_id => "integration_merchant_id",
+      :public_key => "integration_public_key",
+      :private_key => "integration_private_key",
+    )
+  end
+
+  describe "create_jwt" do
+    it "creates a jwt with valid request" do
+      request = Braintree::BankAccountInstantVerificationJwtRequest.new(
+        :business_name => "15Ladders",
+        :return_url => "https://example.com/success",
+        :cancel_url => "https://example.com/cancel",
+      )
+
+      result = @gateway.bank_account_instant_verification.create_jwt(request)
+
+      unless result.success?
+        puts "DEBUG: Result failed!"
+        puts "DEBUG: Errors: #{result.errors.inspect}" if result.respond_to?(:errors)
+      end
+
+      expect(result.success?).to eq(true)
+      expect(result.bank_account_instant_verification_jwt).to have_attributes(
+        jwt: a_string_matching(/.+/),
+      )
+    end
+
+    it "fails with invalid business name" do
+      request = Braintree::BankAccountInstantVerificationJwtRequest.new(
+        :business_name => "", # Empty business name should cause validation error
+        :return_url => "https://example.com/return",
+        :cancel_url => "https://example.com/cancel",
+      )
+
+      result = @gateway.bank_account_instant_verification.create_jwt(request)
+
+      expect(result.success?).to eq(false)
+      expect(result.errors).not_to be_nil
+    end
+
+    it "fails with invalid URLs" do
+      request = Braintree::BankAccountInstantVerificationJwtRequest.new(
+        :business_name => "15Ladders",
+        :return_url => "not-a-valid-url",
+        :cancel_url => "also-not-valid",
+      )
+
+      result = @us_bank_gateway.bank_account_instant_verification.create_jwt(request)
+
+      expect(result.success?).to eq(false)
+      expect(result.errors).not_to be_nil
+    end
+  end
+
+  describe "charge US bank with ACH mandate" do
+    it "creates transaction directly with nonce and provides ACH mandate at transaction time (instant verification)" do
+      nonce = generate_us_bank_account_nonce_via_open_banking
+
+      mandate_accepted_at = Time.now - 300 # 5 minutes ago
+
+      # Create transaction directly with nonce and provide ACH mandate at transaction time (instant verification)
+      transaction_request = {
+        :amount => "12.34",
+        :payment_method_nonce => nonce,
+        :merchant_account_id => SpecHelper::UsBankMerchantAccountId, # could it be?
+        :us_bank_account => {
+          :ach_mandate_text => "I authorize this transaction and future debits",
+          :ach_mandate_accepted_at => mandate_accepted_at
+        },
+        :options => {
+          :submit_for_settlement => true
+        }
+      }
+
+      transaction_result = @us_bank_gateway.transaction.sale(transaction_request)
+
+      expect(transaction_result.success?).to eq(true), "Expected transaction success but got failure with validation errors (see console output)"
+      transaction = transaction_result.transaction
+
+      expected_transaction = {
+        id: a_string_matching(/.+/),
+        amount: BigDecimal("12.34"),
+        us_bank_account_details: have_attributes(
+          ach_mandate: have_attributes(
+            text: "I authorize this transaction and future debits",
+            accepted_at: be_a(Time),
+          ),
+          account_holder_name: "Dan Schulman",
+          last_4: "1234",
+          routing_number: "021000021",
+          account_type: "checking",
+        )
+      }
+
+      expect(transaction).to have_attributes(expected_transaction)
+    end
+  end
+
+  describe "Open Finance flow with INSTANT_VERIFICATION_ACCOUNT_VALIDATION" do
+    it "tokenizes bank account via Open Finance API, vaults with and charges" do
+
+      nonce = generate_us_bank_account_nonce_via_open_banking
+
+      customer_result = @us_bank_gateway.customer.create({})
+      expect(customer_result.success?).to eq(true)
+      customer = customer_result.customer
+
+      mandate_accepted_at = Time.now - 300
+
+      payment_method_request = {
+        :customer_id => customer.id,
+        :payment_method_nonce => nonce,
+        :us_bank_account => {
+          :ach_mandate_text => "I authorize this transaction and future debits",
+          :ach_mandate_accepted_at => mandate_accepted_at
+        },
+        :options => {
+          :verification_merchant_account_id => SpecHelper::UsBankMerchantAccountId,
+          :us_bank_account_verification_method => Braintree::UsBankAccountVerification::VerificationMethod::InstantVerificationAccountValidation
+        }
+      }
+
+      payment_method_result = @us_bank_gateway.payment_method.create(payment_method_request)
+      expect(payment_method_result.success?).to eq(true), "Expected payment method creation success but got failure with validation errors"
+
+      us_bank_account = payment_method_result.payment_method
+
+      expected_us_bank_account = {
+        verifications: a_collection_containing_exactly(
+          have_attributes(
+            verification_method: Braintree::UsBankAccountVerification::VerificationMethod::InstantVerificationAccountValidation,
+            status: "verified",
+          ),
+        ),
+        ach_mandate: have_attributes(
+          text: "I authorize this transaction and future debits",
+          accepted_at: be_a(Time),
+        )
+      }
+
+      expect(us_bank_account).to have_attributes(expected_us_bank_account)
+
+      verification = us_bank_account.verifications.first
+      expect(verification.verification_method).to eq(Braintree::UsBankAccountVerification::VerificationMethod::InstantVerificationAccountValidation)
+
+      transaction_request = {
+        :amount => "12.34",
+        :payment_method_token => us_bank_account.token,
+        :merchant_account_id => SpecHelper::UsBankMerchantAccountId,
+        :options => {
+          :submit_for_settlement => true
+        }
+      }
+
+      transaction_result = @us_bank_gateway.transaction.sale(transaction_request)
+      expect(transaction_result.success?).to eq(true), "Expected transaction success but got failure"
+      transaction = transaction_result.transaction
+
+      expected_transaction = {
+        id: a_string_matching(/.+/),
+        amount: BigDecimal("12.34"),
+        us_bank_account_details: have_attributes(
+          token: us_bank_account.token,
+          ach_mandate: have_attributes(
+            text: "I authorize this transaction and future debits",
+            accepted_at: be_a(Time),
+          ),
+          last_4: "1234",
+          routing_number: "021000021",
+          account_type: "checking",
+        )
+      }
+
+      expect(transaction).to have_attributes(expected_transaction)
+    end
+  end
+end

data/spec/integration/braintree/client_api/spec_helper.rb

@@ -147,6 +147,87 @@ def generate_invalid_us_bank_account_nonce
   nonce + "_xxx"
 end
 
+def generate_us_bank_account_nonce_via_open_banking
+
+  config = Braintree::Configuration.new(
+    :environment => :development,
+    :merchant_id => "integration_merchant_id",
+    :public_key => "integration_public_key",
+    :private_key => "integration_private_key",
+  )
+
+  request_body = {
+    :account_details => {
+      :account_number => "567891234",
+      :account_type => "CHECKING",
+      :classification => "PERSONAL",
+      :tokenized_account => true,
+      :last_4 => "1234"
+    },
+    :institution_details => {
+      :bank_id => {
+        :bank_code => "021000021",
+        :country_code => "US"
+      }
+    },
+    :account_holders => [
+      {
+        :ownership => "PRIMARY",
+        :full_name => {
+          :name => "Dan Schulman"
+        },
+        :name => {
+          :given_name => "Dan",
+          :surname => "Schulman",
+          :full_name => "Dan Schulman"
+        }
+      }
+    ]
+  }
+
+  graphql_base_url = config.graphql_base_url
+  atmosphere_base_url = graphql_base_url.gsub("/graphql", "")
+  url = "#{atmosphere_base_url}/v1/open-finance/tokenize-bank-account-details"
+
+  uri = URI.parse(url)
+  connection = Net::HTTP.new(uri.host, uri.port)
+
+  if uri.scheme == "https"
+    connection.use_ssl = true
+    connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    connection.ca_file = config.ca_file if config.ca_file
+  end
+
+  response = connection.start do |http|
+    request = Net::HTTP::Post.new(uri.path)
+    request["Content-Type"] = "application/json"
+    request["Accept"] = "application/json"
+    request["Braintree-Version"] = "2019-01-01"
+    request["User-Agent"] = "Braintree Ruby Library #{Braintree::Version::String}"
+    request["X-ApiVersion"] = config.api_version
+
+    # Basic auth like Node.js
+    auth_string = "#{config.public_key}:#{config.private_key}"
+    request["Authorization"] = "Basic #{Base64.strict_encode64(auth_string)}"
+
+    request.body = request_body.to_json
+
+    http.request(request)
+  end
+
+  if response.code.to_i != 200
+    raise "HTTP #{response.code}: #{response.body}"
+  end
+
+  result = JSON.parse(response.body)
+
+  unless result["tenant_token"]
+    raise "Open Banking tokenization failed: #{result.inspect}"
+  end
+
+  result["tenant_token"]
+end
+
 def _cosmos_post(token, url, payload)
   uri = URI::parse(url)
   connection = Net::HTTP.new(uri.host, uri.port)

data/spec/integration/braintree/dispute_spec.rb

@@ -32,8 +32,8 @@ describe Braintree::Dispute do
 
       expect(result.success?).to eq(true)
 
-      refreshed_dispute = Braintree::Dispute.find(dispute.id)
-      expect(refreshed_dispute.status).to eq(Braintree::Dispute::Status::Accepted)
+      updated_dispute = Braintree::Dispute.find(dispute.id)
+      expect(updated_dispute.status).to eq(Braintree::Dispute::Status::Accepted)
 
       dispute_from_transaction = Braintree::Transaction.find(dispute.transaction.id).disputes[0]
       expect(dispute_from_transaction.status).to eq(Braintree::Dispute::Status::Accepted)
@@ -99,6 +99,17 @@ describe Braintree::Dispute do
       expect(result.evidence.category).to eq("GENERAL")
       expect(result.evidence.url).to include("bt_logo.png")
     end
+
+    it "reflects the updated remaining_file_evidence_storage" do
+      initial_storage = dispute.remaining_file_evidence_storage
+      expect(initial_storage).not_to be_nil
+
+      Braintree::Dispute.add_file_evidence(dispute.id, document_upload.id)
+
+      refreshed_dispute = Braintree::Dispute.find(dispute.id)
+      updated_storage = refreshed_dispute.remaining_file_evidence_storage
+      expect(updated_storage).to be < initial_storage
+    end
   end
 
   describe "self.add_text_evidence" do

data/spec/integration/braintree/payment_method_spec.rb

@@ -108,6 +108,7 @@ describe Braintree::PaymentMethod do
       expect(apple_pay_card.payroll).not_to be_nil
       expect(apple_pay_card.prepaid).not_to be_nil
       expect(apple_pay_card.product_id).not_to be_nil
+      expect(apple_pay_card.is_device_token).to eq(true)
     end
 
     it "creates a payment method from a fake apple pay mpan nonce" do
@@ -143,6 +144,7 @@ describe Braintree::PaymentMethod do
       expect(apple_pay_card.prepaid).not_to be_nil
       expect(apple_pay_card.product_id).not_to be_nil
       expect(apple_pay_card.merchant_token_identifier).not_to be_nil
+      expect(apple_pay_card.is_device_token).not_to be_nil
       expect(apple_pay_card.source_card_last4).not_to be_nil
     end
 
@@ -1254,6 +1256,7 @@ describe Braintree::PaymentMethod do
         expect(apple_pay_card.expiration_year.to_i).to be > 0
         expect(apple_pay_card.source_description).to eq("Visa 2006")
         expect(apple_pay_card.customer_id).to eq(customer.id)
+        expect(apple_pay_card.is_device_token).to eq(false)
         apple_pay_card.merchant_token_identifier == "DNITHE302308980427388297"
         apple_pay_card.source_card_last4 == "2006"
       end