mangopay4-ruby-sdk 3.45.0 → 3.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34a20d61f0af4ebbb27b23462855b1e3245dea990232708c2cadf541388a1d3e
-  data.tar.gz: 0c60b1686a83da66bbc35eff7d79c2dc76669b433d30ade26005fbff5804d6d2
+  metadata.gz: ebeaec3cb872600bd73956fbf11d134bc90c5d4eb858e4a5873ff1dc020bbe56
+  data.tar.gz: 0df0444dd4be33ca5936d3d911250287cddafc339aa9275c35fbfc264e3d2d21
 SHA512:
-  metadata.gz: 401e7578d63593838a3ddd30ccf4f51a7dc954d03a425eddbc3328e872692adf9fc2b16c3ab96310b31de856bdd6e000e63adee0fa5b0aaae8197f3ddd9258ee
-  data.tar.gz: 3f33993df417398540c62ed379f07b00a6a7fafd3115803b18f1fda163138ea7b431577bbcd933de503e45647a523983600cb29de7c7046b6897127254f4e884
+  metadata.gz: 474b4ec9b214ea50d75aec50506818aba748f9b2c279919ba8849d4749b716151411a8a5a0e6240d16744b70ea8341342188c89e6db471269a83c8a93c7e4757
+  data.tar.gz: b9e6f1e6636a116c2f670849a61839964d11a2298304c0ad0be7584a4024a9415f42f5861bf630effca9a964084f8baa0f7a9f49e3848f1c35f1df21663ea6c3

data/CHANGELOG.md

@@ -1,3 +1,55 @@
+## [3.46.0] - 2026-02-12
+### FX
+
+#### Breaking change – Custom fees
+#329
+To support percentage-based FX fees ([API release note](/release-notes/api/2026-02-11)):
+-  Updated tests to check for conversion custom fees
+
+#### Added – User margin
+#329
+To support the FX user margin ([API release note](/release-notes/api/2026-02-11)):
+-  Updated tests to check for conversion user margins
+
+### Echo
+
+#### Breaking change - Settlement upload endpoints
+#325
+To support the new behavior of the [POST Create a Settlement](/api-reference/settlements/create-settlement) endpoint to obtain an `UploadUrl`:
+- Updated `settlement_sample.csv` and tests
+- **Breaking change** – Replaced `upload` method in `Settlement` with `generate_upload_url`:
+- **Breaking change** – Replaced `update` method in `Settlement` with `generate_new_upload_url`:
+
+#### Added - GET validations for a Settlement endpoint
+#325
+To support the [GET View validations for a Settlement](/api-reference/settlements/view-settlement-validations) endpoint:
+- Added `get_validations` method to `Settlement`
+
+#### Added - PUT Cancel a Settlement endpoint
+#325
+To support the [PUT Cancel a Settlement](/api-reference/settlements/cancel-settlement) endpoint:
+- Added `cancel` method to `Settlement`
+
+#### Added – POST Create a Refund of an Intent
+#324
+To support [POST Create a Refund of an Intent](/api-reference/intents/create-intent-refund):
+- Added `create` method to `Refund`
+
+#### Added – POST Reverse the Refund of an Intent
+#324
+To support [POST Reverse the Refund of an Intent](/api-reference/intents/create-intent-refund):
+- Added `reverse` method to `Refund`
+
+#### Added – POST Create a Dispute of an Intent
+#324
+To support [POST Create a Dispute of an Intent](/api-reference/intents/create-intent-refund):
+- Added `create` method to `Dispute`
+
+#### Added - PUT Update an Intent Dispute
+#324
+To support [PUT Update an Intent Dispute](/api-reference/intents/create-intent-dispute):
+- Added `update_outcome` method to `Dispute`
+
 ## [3.45.0] - 2026-01-27
 ### Added
 - Support for new [GET View the SCA status of a User](https://docs.mangopay.com/api-reference/users/view-user-sca-status) endpoint ([API release note](https://docs.mangopay.com/release-notes/api/2026-01-15)) (#326)

data/lib/mangopay/pay_in.rb

@@ -409,6 +409,30 @@ module MangoPay
           end
         end
       end
+
+      class Refund < Resource
+        class << self
+          def create(intent_id, params, idempotency_key = nil)
+            MangoPay.request(:post, "#{MangoPay.api_path_v3}/payins/intents/#{intent_id}/refunds", params, {}, idempotency_key)
+          end
+
+          def reverse(intent_id, refund_id, params, idempotency_key = nil)
+            MangoPay.request(:post, "#{MangoPay.api_path_v3}/payins/intents/#{intent_id}/refunds/#{refund_id}/reverse", params, {}, idempotency_key)
+          end
+        end
+      end
+
+      class Dispute < Resource
+        class << self
+          def create(intent_id, capture_id, params, idempotency_key = nil)
+            MangoPay.request(:post, "#{MangoPay.api_path_v3}/payins/intents/#{intent_id}/captures/#{capture_id}/disputes", params, {}, idempotency_key)
+          end
+
+          def update_outcome(intent_id, capture_id, dispute_id, params, idempotency_key = nil)
+            MangoPay.request(:put, "#{MangoPay.api_path_v3}/payins/intents/#{intent_id}/captures/#{capture_id}/disputes/#{dispute_id}/decision", params, {}, idempotency_key)
+          end
+        end
+      end
     end
 
   end

data/lib/mangopay/settlement.rb

@@ -2,9 +2,9 @@ module MangoPay
 
   class Settlement < Resource
     class << self
-      def upload(file, idempotency_key = nil)
+      def generate_upload_url(settlement, idempotency_key = nil)
         url = "#{MangoPay.api_path_v3}/payins/intents/settlements"
-        MangoPay.request_multipart(:post, url, file, 'settlement_file.csv', idempotency_key)
+        MangoPay.request(:post, url, settlement, {}, idempotency_key)
       end
 
       def get(settlement_id)
@@ -12,9 +12,19 @@ module MangoPay
         MangoPay.request(:get, url)
       end
 
-      def update(settlement_id, file, idempotency_key = nil)
+      def generate_new_upload_url(settlement_id, settlement)
         url = "#{MangoPay.api_path_v3}/payins/intents/settlements/#{settlement_id}"
-        MangoPay.request_multipart(:put, url, file, 'settlement_file.csv', idempotency_key)
+        MangoPay.request(:put, url, settlement, {})
+      end
+
+      def get_validations(settlement_id, filters = {})
+        url = "#{MangoPay.api_path_v3}/payins/intents/settlements/#{settlement_id}/validations"
+        MangoPay.request(:get, url, {}, filters)
+      end
+
+      def cancel(settlement_id, idempotency_key = nil)
+        url = "#{MangoPay.api_path_v3}/payins/intents/settlements/#{settlement_id}/cancel"
+        MangoPay.request(:post, url, {}, {}, idempotency_key)
       end
     end
   end

data/lib/mangopay/version.rb

@@ -1,3 +1,3 @@
 module MangoPay
-  VERSION = '3.45.0'
+  VERSION = '3.46.0'
 end

data/spec/mangopay/conversion_spec.rb

@@ -17,7 +17,10 @@ describe MangoPay::Conversion, type: :feature do
       expect(conversion['DebitedFunds']['Amount']).not_to be_nil
       expect(conversion['CreditedFunds']['Amount']).not_to be_nil
       expect(conversion['Fees']['Amount']).not_to be_nil
+      expect(conversion['RequestedFees']['Value']).not_to be_nil
       expect(conversion['Status']).equal? 'SUCCEEDED'
+      expect(conversion['MarginsResponse']['Mangopay']).not_to be_nil
+      expect(conversion['MarginsResponse']['User']).to be_nil
     end
   end
 
@@ -77,10 +80,14 @@ describe MangoPay::Conversion, type: :feature do
 
   describe 'CREATE CONVERSION QUOTE' do
     it 'create a conversion quote' do
-      conversion_quote = create_conversion_quote
+      conversion_quote = create_conversion_quote_with_fees
       expect(conversion_quote['DebitedFunds']).not_to be_nil
       expect(conversion_quote['CreditedFunds']).not_to be_nil
       expect(conversion_quote['Duration']).equal? 90
+      expect(conversion_quote['Fees']['Amount']).not_to be_nil
+      expect(conversion_quote['RequestedFees']['Value']).not_to be_nil
+      expect(conversion_quote['MarginsResponse']['Mangopay']).not_to be_nil
+      expect(conversion_quote['MarginsResponse']['User']).not_to be_nil
     end
   end
 

data/spec/mangopay/payin_intent_spec.rb

@@ -10,18 +10,7 @@ describe MangoPay::PayIn::PayInIntent, type: :feature do
     end
 
     it 'creates a payin intent full capture' do
-      intent = new_payin_intent_authorization
-      to_create = {
-        "ExternalData": {
-          "ExternalProcessingDate": "01-10-2029",
-          "ExternalProviderReference": SecureRandom.uuid,
-          "ExternalMerchantReference": "Order-xyz-35e8490e-2ec9-4c82-978e-c712a3f5ba16",
-          "ExternalProviderName": "Stripe",
-          "ExternalProviderPaymentMethod": "PAYPAL"
-        }
-      }
-
-      created = MangoPay::PayIn::PayInIntent::Capture.create(intent['Id'], to_create)
+      created = create_new_intent_full_capture
       expect(created['Id']).not_to be_nil
       expect(created['Status']).to eq('CAPTURED')
     end
@@ -122,6 +111,137 @@ describe MangoPay::PayIn::PayInIntent, type: :feature do
     end
   end
 
+  describe 'Intent Refund' do
+    it 'creates a full refund' do
+      created_refund = create_new_intent_full_refund
+      expect(created_refund['Id']).not_to be_nil
+      expect(created_refund['Status']).to eq('REFUNDED')
+    end
+
+    it 'creates a partial refund' do
+      full_capture = create_new_intent_full_capture
+      to_create = {
+        "Amount": 1000,
+        "LineItems": [
+          {
+            "Id": full_capture['LineItems'][0]['Id'],
+            "Amount": 1000
+          }
+        ],
+        "ExternalData": {
+          "ExternalProcessingDate": 1727913600,
+          "ExternalProviderReference": SecureRandom.uuid,
+          "ExternalMerchantReference": SecureRandom.uuid,
+          "ExternalProviderName": "Stripe",
+          "ExternalProviderPaymentMethod": "PAYPAL"
+        }
+      }
+      created_refund = MangoPay::PayIn::PayInIntent::Refund.create(full_capture['Id'], to_create)
+      expect(created_refund['Id']).not_to be_nil
+      expect(created_refund['Status']).to eq('REFUNDED')
+    end
+
+    it 'fully reverses a refund' do
+      created_refund = create_new_intent_full_refund
+      to_create = {
+        "ExternalData": {
+          "ExternalProcessingDate": 1727913600,
+          "ExternalProviderReference": SecureRandom.uuid,
+          "ExternalMerchantReference": SecureRandom.uuid,
+          "ExternalProviderName": "Stripe",
+          "ExternalProviderPaymentMethod": "PAYPAL"
+        }
+      }
+      reversed_refund = MangoPay::PayIn::PayInIntent::Refund.reverse(created_refund['Id'], created_refund['Refund']['Id'], to_create)
+      expect(reversed_refund['Id']).not_to be_nil
+      expect(reversed_refund['Status']).to eq('REFUND_REVERSED')
+    end
+
+    it 'partially reverses a refund' do
+      created_refund = create_new_intent_full_refund
+      to_create = {
+        "Amount": 1000,
+        "LineItems": [
+          {
+            "Id": created_refund['LineItems'][0]['Id'],
+            "Amount": 1000
+          }
+        ],
+        "ExternalData": {
+          "ExternalProcessingDate": 1727913600,
+          "ExternalProviderReference": SecureRandom.uuid,
+          "ExternalMerchantReference": SecureRandom.uuid,
+          "ExternalProviderName": "Stripe",
+          "ExternalProviderPaymentMethod": "PAYPAL"
+        }
+      }
+      reversed_refund = MangoPay::PayIn::PayInIntent::Refund.reverse(created_refund['Id'], created_refund['Refund']['Id'], to_create)
+      expect(reversed_refund['Id']).not_to be_nil
+      expect(reversed_refund['Status']).to eq('REFUND_REVERSED')
+    end
+
+    it 'creates a full dispute' do
+      capture = create_new_intent_full_capture
+      to_create = {
+        "ExternalData": {
+          "ExternalProcessingDate": 1727913600,
+          "ExternalProviderReference": SecureRandom.uuid,
+          "ExternalMerchantReference": SecureRandom.uuid,
+          "ExternalProviderName": "Stripe",
+          "ExternalProviderPaymentMethod": "PAYPAL"
+        }
+      }
+      created_dispute = MangoPay::PayIn::PayInIntent::Dispute.create(capture['Id'], capture['Capture']['Id'], to_create)
+      expect(created_dispute['Id']).not_to be_nil
+      expect(created_dispute['Status']).to eq('DISPUTED')
+    end
+
+    it 'creates a partial dispute' do
+      capture = create_new_intent_full_capture
+      to_create = {
+        "Amount": 1000,
+        "LineItems": [
+          {
+            "Id": capture['LineItems'][0]['Id'],
+            "Amount": 1000
+          }
+        ],
+        "ExternalData": {
+          "ExternalProcessingDate": 1727913600,
+          "ExternalProviderReference": SecureRandom.uuid,
+          "ExternalMerchantReference": SecureRandom.uuid,
+          "ExternalProviderName": "Stripe",
+          "ExternalProviderPaymentMethod": "PAYPAL"
+        }
+      }
+      created_dispute = MangoPay::PayIn::PayInIntent::Dispute.create(capture['Id'], capture['Capture']['Id'], to_create)
+      expect(created_dispute['Id']).not_to be_nil
+      expect(created_dispute['Status']).to eq('DISPUTED')
+    end
+
+    it 'updates dispute outcome' do
+      capture = create_new_intent_full_capture
+      to_create = {
+        "ExternalData": {
+          "ExternalProcessingDate": 1727913600,
+          "ExternalProviderReference": SecureRandom.uuid,
+          "ExternalMerchantReference": SecureRandom.uuid,
+          "ExternalProviderName": "Stripe",
+          "ExternalProviderPaymentMethod": "PAYPAL"
+        }
+      }
+      created_dispute = MangoPay::PayIn::PayInIntent::Dispute.create(capture['Id'], capture['Capture']['Id'], to_create)
+
+      dto = {
+        "Decision": "DEFENDED"
+      }
+      updated = MangoPay::PayIn::PayInIntent::Dispute.update_outcome(capture['Id'], capture['Capture']['Id'], created_dispute['Dispute']['Id'], dto)
+
+      expect(updated['Id']).not_to be_nil
+      expect(updated['Decision']).to eq('DEFENDED')
+    end
+  end
+
   def create_new_splits(intent)
     full_capture = {
       "ExternalData": {
@@ -143,4 +263,33 @@ describe MangoPay::PayIn::PayInIntent, type: :feature do
     }
     return  MangoPay::PayIn::PayInIntent::Split.create(intent['Id'], split)
   end
+
+  def create_new_intent_full_capture
+    intent = new_payin_intent_authorization
+    to_create = {
+      "ExternalData": {
+        "ExternalProcessingDate": "01-10-2029",
+        "ExternalProviderReference": SecureRandom.uuid,
+        "ExternalMerchantReference": "Order-xyz-35e8490e-2ec9-4c82-978e-c712a3f5ba16",
+        "ExternalProviderName": "Stripe",
+        "ExternalProviderPaymentMethod": "PAYPAL"
+      }
+    }
+
+    return MangoPay::PayIn::PayInIntent::Capture.create(intent['Id'], to_create)
+  end
+
+  def create_new_intent_full_refund
+    full_capture = create_new_intent_full_capture
+    to_create = {
+      "ExternalData": {
+        "ExternalProcessingDate": 1727913600,
+        "ExternalProviderReference": SecureRandom.uuid,
+        "ExternalMerchantReference": SecureRandom.uuid,
+        "ExternalProviderName": "Stripe",
+        "ExternalProviderPaymentMethod": "PAYPAL"
+      }
+    }
+    return MangoPay::PayIn::PayInIntent::Refund.create(full_capture['Id'], to_create)
+  end
 end

data/spec/mangopay/settlement_sample.csv

@@ -1,8 +1,8 @@
-IntentId,ExternalProviderReference,ExternalPaymentMethod,ExternalTransactionType,ExternalTransactionStatus,ExternalProcessingDate,Amount,Currency,ExternalInitialReference,ExternalProviderFees
-int_0197b19d-ee51-7b60-84cb-207491cf383a,6TU984332A894613W,PAYPAL,PAYMENT,SETTLED,19-06-2025,1000,EUR,,0
-,,,,,,,,,
-SettlementDate,19-06-2025,,,,,,,,
-ExternalProviderName,Paypal,,,,,,,,
-TotalSettlementFeesAmount,0,,,,,,,,
-TotalSettlementAmount,1000,,,,,,,,
-SettlementCurrency,EUR,,,,,,,,
+ExternalProviderReference,ExternalPaymentMethod,ExternalTransactionType,ExternalTransactionStatus,ExternalProcessingDate,Amount,Currency,ExternalInitialReference,ExternalProviderFees
+6TU984332A894613W,PAYPAL,PAYMENT,SETTLED,19-06-2025,1000,EUR,,0
+,,,,,,,,
+SettlementDate,19-06-2025,,,,,,,
+ExternalProviderName,Paypal,,,,,,,
+TotalSettlementFeesAmount,0,,,,,,,
+TotalNetSettlementAmount,1000,,,,,,,
+SettlementCurrency,EUR,,,,,,,

data/spec/mangopay/settlement_sample_bad.csv

@@ -0,0 +1,8 @@
+ExternalProviderReference,ExternalPaymentMethod,ExternalTransactionType,ExternalTransactionStatus,ExternalProcessingDate,Amount,Currency,ExternalInitialReference,ExternalProviderFees
+6TU984332A894613W,PAYPAL,PAYMENT,SETTLED,19-06-2025,1000,EUR,,0
+,,,,,,,,
+SettlementDate,19-06-2025,,,,,,,
+ExternalProviderName,Paypal,,,,,,,
+TotalSettlementFeesAmount,0,,,,,,,
+TotalNetSettlementAmount,999999,,,,,,,
+SettlementCurrency,EUR,,,,,,

data/spec/mangopay/settlement_spec.rb

@@ -6,33 +6,60 @@ describe MangoPay::Settlement do
 
   def create_settlement_if_needed
     @settlement ||= begin
-                      file_path = File.expand_path('settlement_sample.csv', __dir__)
-                      file = File.binread(file_path)
-                      MangoPay::Settlement.upload(file)
+                      MangoPay::Settlement.generate_upload_url({FileName: 'settlement_sample.csv'})
                     end
   end
 
+  def upload_file(upload_url, file_name)
+    file_path = File.expand_path(file_name, __dir__)
+    file_content = File.binread(file_path)
+
+    uri = URI(upload_url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = (uri.scheme == 'https')
+
+    request = Net::HTTP::Put.new(uri)
+    request.body = file_content
+    request['Content-Type'] = 'text/csv'
+
+    http.request(request)
+  end
+
   describe 'UPLOAD' do
+    it 'generates the upload URL' do
+      expect(@settlement['SettlementId']).not_to be_nil
+      expect(@settlement['UploadUrl']).not_to be_nil
+    end
+
+    it 'generates a new upload URL' do
+      new_url = MangoPay::Settlement.generate_new_upload_url(@settlement['SettlementId'], {FileName: 'settlement_sample.csv'})
+      expect(new_url['SettlementId']).not_to be_nil
+      expect(new_url['UploadUrl']).not_to be_nil
+    end
+
     it 'uploads the file' do
-      expect(@settlement['Status']).to eq('UPLOADED')
+      response = upload_file(@settlement['UploadUrl'], 'settlement_sample.csv')
+      expect(response.code.to_i).to eq(200)
+    end
+
+    it 'fetches validations' do
+      upload_file(@settlement['UploadUrl'], 'settlement_sample_bad.csv')
+      validations = MangoPay::Settlement.get_validations(@settlement['SettlementId'], {page: 1, per_page: 10})
+      expect(validations).not_to be_nil
     end
   end
 
   describe 'GET' do
     it 'fetches the file' do
       fetched = MangoPay::Settlement.get(@settlement['SettlementId'])
-      expect(fetched['Status']).to eq('UPLOADED')
+      expect(fetched['Status']).to eq('PENDING_UPLOAD')
     end
   end
 
-  describe 'UPDATE' do
-    it 'updates the file' do
-      file_path = File.expand_path('settlement_sample.csv', __dir__)
-      file = File.binread(file_path)
-      before_update = MangoPay::Settlement.upload(file)
-      expect(before_update['Status']).to eq('UPLOADED')
-      updated = MangoPay::Settlement.update(before_update['SettlementId'], file)
-      expect(updated['Status']).to eq('UPLOADED')
+  describe 'CANCEL' do
+    it 'cancels the settlement' do
+      fetched = MangoPay::Settlement.cancel(@settlement['SettlementId'])
+      expect(fetched['Status']).to eq('CANCELLED')
     end
   end
 end

data/spec/mangopay/shared_resources.rb

@@ -1225,7 +1225,8 @@ shared_context 'instant_conversion' do
       },
       Fees: {
         Currency: 'EUR',
-        Amount: 9
+        Amount: 0.01,
+        Type: 'PERCENTAGE'
       },
       Tag: 'Instant conversion test'
     )
@@ -1259,6 +1260,24 @@ shared_context 'instant_conversion' do
     )
   end
 
+  def create_conversion_quote_with_fees
+    MangoPay::Conversion.create_quote(
+      CreditedFunds:  { Currency: 'GBP' },
+      DebitedFunds:  { Currency: 'EUR', Amount: 50 },
+      Duration: 300,
+      Tag: 'Created using the Mangopay Ruby SDK',
+      Fees: {
+        Currency: 'EUR',
+        Amount: 1,
+        Type: 'FIXED'
+      },
+      UserMargin: {
+        Type: "PERCENTAGE",
+        Value: 0.01
+      }
+    )
+  end
+
   def get_conversion(id)
     MangoPay::Conversion.get(id, params = {})
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mangopay4-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 3.45.0
+  version: 3.46.0
 platform: ruby
 authors:
 - Geoffroy Lorieux
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-30 00:00:00.000000000 Z
+date: 2026-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -176,6 +176,7 @@ files:
 - spec/mangopay/report_v2_spec.rb
 - spec/mangopay/report_wallets_spec.rb
 - spec/mangopay/settlement_sample.csv
+- spec/mangopay/settlement_sample_bad.csv
 - spec/mangopay/settlement_spec.rb
 - spec/mangopay/shared_resources.rb
 - spec/mangopay/transaction_spec.rb
@@ -267,6 +268,7 @@ test_files:
 - spec/mangopay/report_v2_spec.rb
 - spec/mangopay/report_wallets_spec.rb
 - spec/mangopay/settlement_sample.csv
+- spec/mangopay/settlement_sample_bad.csv
 - spec/mangopay/settlement_spec.rb
 - spec/mangopay/shared_resources.rb
 - spec/mangopay/transaction_spec.rb