mangopay 3.31.0 → 3.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0c9bf8de0cc8f9ac13e5c0410679c20e38cf971256a7109c034d06bf5ba07a3
-  data.tar.gz: 4cf8f88da31fcb566bf2bc5892a507e28e0815c75852fc119ae311b492d6c45d
+  metadata.gz: c8e3054c801c2db4879dc5ee322b442204351fd2c96458345b865c7f30a8accf
+  data.tar.gz: e59f212b984b311a3999c1f768532798c072d60f40d692d1a90ae755a81a01d7
 SHA512:
-  metadata.gz: b47ea99f7515a53d86d20bff3dba2291f971065e179d88e071cb18a47920969195a200a93192cce7535cb38bfac727e7fd78a233cc31bb2a0f472b399d802acb
-  data.tar.gz: 52cce07e5c04322c88c01771434ac5df303c1256558e60f4c32d96386272d3c3ea381ccc18a79061813c93c3336299bf75bb784b151e93fc4bb4f38dc8375b7a
+  metadata.gz: 74ce73c93504fbecef0a12d7ff98bd5f192700b90cf0e555063af16fabf88ffbdf6cb88e973e705f642e870c239bf306c624d97f8c8cc021008e88638cd9d6a1
+  data.tar.gz: d48f4c254375d55ddd36e911fb7f84cd18f8eeb96ed28081501ed745249abacad3fd6a35ede4e6be972196c0611675e259fea41cdb8e0cee0687cd5d296e0a86

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [3.32.0] - 2025-04-16
+### Added
+
+#### Recipients
+- [GET View payout methods](/api-reference/recipients/view-payout-methods)
+- [GET View the schema for a Recipient](/api-reference/recipients/view-recipient-schema)
+- [POST Validate data for a Recipient](/api-reference/recipients/validate-recipient-data)
+- [POST Create a Recipient](/api-reference/recipients/create-recipient)
+- [GET View a Recipient](/api-reference/recipients/view-recipient)
+- [GET List Recipients for a user](/api-reference/recipients/list-recipients-user)
+- [PUT Deactivate a Recipient](/api-reference/recipients/deactivate-recipient)
+
+#### Endpoints to close a user account
+- [DELETE Close a Natural User](/api-reference/users/close-natural-user)
+- [DELETE Close a Legal User](/api-reference/users/close-legal-user)
+
 ## [3.31.0] - 2025-04-16
 ### Added
 - [POST Create a Pay by Bank PayIn](https://docs.mangopay.com/api-reference/pay-by-bank/create-pay-by-bank-payin)

data/lib/mangopay/legal_user.rb

@@ -13,6 +13,9 @@ module MangoPay
     end
 
     class << self
+      def close(user_id)
+        MangoPay.request(:delete, url(user_id))
+      end
     end
   end
 end

data/lib/mangopay/legal_user_sca.rb

@@ -16,6 +16,10 @@ module MangoPay
         url = "#{MangoPay.api_path}/sca/users/legal/#{user_id}/category"
         MangoPay.request(:put, url, params)
       end
+
+      def close(user_id)
+        MangoPay.request(:delete, url(user_id))
+      end
     end
   end
 end

data/lib/mangopay/natural_user.rb

@@ -10,5 +10,11 @@ module MangoPay
         "#{MangoPay.api_path}/users/natural"
       end
     end
+
+    class << self
+      def close(user_id)
+        MangoPay.request(:delete, url(user_id))
+      end
+    end
   end
 end

data/lib/mangopay/natural_user_sca.rb

@@ -16,6 +16,10 @@ module MangoPay
         url = "#{MangoPay.api_path}/sca/users/natural/#{user_id}/category"
         MangoPay.request(:put, url, params)
       end
+
+      def close(user_id)
+        MangoPay.request(:delete, url(user_id))
+      end
     end
   end
 end

data/lib/mangopay/recipient.rb

@@ -0,0 +1,35 @@
+module MangoPay
+
+  class Recipient < Resource
+    def self.create(params, user_id, idempotency_key = nil)
+      MangoPay.request(:post, "#{MangoPay.api_path}/users/#{user_id}/recipients", params, {}, idempotency_key)
+    end
+
+    def self.get(recipient_id, filters = {})
+      MangoPay.request(:get, "#{MangoPay.api_path}/recipients/#{recipient_id}", {}, filters)
+    end
+
+    def self.get_user_recipients(user_id, filters = {})
+      MangoPay.request(:get, "#{MangoPay.api_path}/users/#{user_id}/recipients", {}, filters)
+    end
+
+    def self.get_schema(payout_method_type, recipient_type, currency, filters = {})
+      MangoPay.request(:get, "#{MangoPay.api_path}/recipients/schema?payoutMethodType=#{payout_method_type}&recipientType=#{recipient_type}&currency=#{currency}", {}, filters)
+    end
+
+    def self.get_payout_methods(country, currency, filters = {})
+      MangoPay.request(:get, "#{MangoPay.api_path}/recipients/payout-methods?country=#{country}&currency=#{currency}", {}, filters)
+    end
+
+    def self.validate(params, user_id, idempotency_key = nil)
+      MangoPay.request(:post, "#{MangoPay.api_path}/users/#{user_id}/recipients/validate", params, {}, idempotency_key)
+    end
+
+    def self.deactivate(recipient_id)
+      params = {
+        Status: 'DEACTIVATED'
+      }
+      MangoPay.request(:put, "#{MangoPay.api_path}/recipients/#{recipient_id}", params, {})
+    end
+  end
+end

data/lib/mangopay/version.rb

@@ -1,3 +1,3 @@
 module MangoPay
-  VERSION = '3.31.0'
+  VERSION = '3.32.0'
 end

data/lib/mangopay.rb

@@ -51,6 +51,7 @@ module MangoPay
   autoload :PaymentMethodMetadata, 'mangopay/payment_method_metadata'
   autoload :VirtualAccount, 'mangopay/virtual_account'
   autoload :IdentityVerification, 'mangopay/identity_verification'
+  autoload :Recipient, 'mangopay/recipient'
 
   # temporary
   autoload :Temp, 'mangopay/temp'
@@ -232,7 +233,7 @@ module MangoPay
         raise MangoPay::ResponseError.new(uri, res.code, details)
       end
 
-      unless res.is_a?(Net::HTTPOK)
+      unless res.is_a?(Net::HTTPOK) or res.is_a?(Net::HTTPCreated) or res.is_a?(Net::HTTPNoContent)
         raise MangoPay::ResponseError.new(uri, res.code, data)
       end
 

data/spec/mangopay/client_spec.rb

@@ -45,13 +45,13 @@ describe MangoPay::Client do
       bts = File.open(fnm, 'rb') { |f| f.read }
       b64 = Base64.encode64(bts)
       ret = MangoPay::Client.upload_logo(b64)
-      expect(ret).to be_nil
+      expect(ret).to_not be_nil
     end
 
     it 'accepts file path' do
       fnm = __FILE__.sub('.rb', '.png')
       ret = MangoPay::Client.upload_logo(nil, fnm)
-      expect(ret).to be_nil
+      expect(ret).to_not be_nil
     end
 
     it 'fails when input string is not base64-encoded' do

data/spec/mangopay/kyc_document_spec.rb

@@ -86,13 +86,13 @@ describe MangoPay::KycDocument do
       bts = File.open(fnm, 'rb') { |f| f.read }
       b64 = Base64.encode64(bts)
       ret = create_page(b64)
-      expect(ret).to be_nil
+      expect(ret).to_not be_nil
     end
 
     it 'accepts file path' do
       fnm = __FILE__.sub('.rb', '.png')
       ret = MangoPay::KycDocument.create_page(new_natural_user['Id'], new_document['Id'], nil, fnm)
-      expect(ret).to be_nil
+      expect(ret).to_not be_nil
     end
 
     it 'fails when input string is not base64-encoded' do

data/spec/mangopay/recipient_spec.rb

@@ -0,0 +1,113 @@
+describe MangoPay::Recipient do
+  include_context 'recipient'
+
+  describe 'CREATE' do
+    it 'creates a new recipient' do
+      recipient = new_recipient
+      assert_recipient(recipient)
+      expect(recipient['PendingUserAction']).not_to be_nil
+    end
+  end
+
+  describe 'GET' do
+    it 'fetches a recipient' do
+      recipient = new_recipient
+      fetched = MangoPay::Recipient.get(recipient['Id'])
+      assert_recipient(fetched)
+    end
+  end
+
+  describe 'GET User Recipients' do
+    it 'fetches a recipient' do
+      john = create_new_natural_user_sca_owner
+      create_new_recipient(john['Id'])
+      fetched = MangoPay::Recipient.get_user_recipients(john['Id'])
+      expect(fetched).not_to be_nil
+      expect(fetched).to be_kind_of(Array)
+      expect(fetched).not_to be_empty
+    end
+  end
+
+  describe 'GET Schema' do
+    it 'fetches schema for LocalBankTransfer, Individual' do
+      schema = MangoPay::Recipient.get_schema('LocalBankTransfer', 'Individual', 'GBP')
+      expect(schema).not_to be_nil
+      expect(schema['DisplayName']).not_to be_nil
+      expect(schema['Currency']).not_to be_nil
+      expect(schema['RecipientType']).not_to be_nil
+      expect(schema['PayoutMethodType']).not_to be_nil
+      expect(schema['RecipientScope']).not_to be_nil
+      expect(schema['Tag']).not_to be_nil
+      expect(schema['IndividualRecipient']).not_to be_nil
+      expect(schema['LocalBankTransfer']).not_to be_nil
+      expect(schema['BusinessRecipient']).to be_nil
+      expect(schema['InternationalBankTransfer']).to be_nil
+    end
+
+    it 'fetches schema for InternationalBankTransfer, Business' do
+      schema = MangoPay::Recipient.get_schema('InternationalBankTransfer', 'Business', 'GBP')
+      expect(schema).not_to be_nil
+      expect(schema['DisplayName']).not_to be_nil
+      expect(schema['Currency']).not_to be_nil
+      expect(schema['RecipientType']).not_to be_nil
+      expect(schema['PayoutMethodType']).not_to be_nil
+      expect(schema['RecipientScope']).not_to be_nil
+      expect(schema['Tag']).not_to be_nil
+      expect(schema['BusinessRecipient']).not_to be_nil
+      expect(schema['InternationalBankTransfer']).not_to be_nil
+      expect(schema['IndividualRecipient']).to be_nil
+      expect(schema['LocalBankTransfer']).to be_nil
+    end
+  end
+
+  describe 'GET Payout Methods' do
+    it 'fetches payout methods' do
+      payout_methods = MangoPay::Recipient.get_payout_methods('DE', 'EUR')
+      expect(payout_methods).not_to be_nil
+      expect(payout_methods['AvailablePayoutMethods']).to be_kind_of(Array)
+      expect(payout_methods['AvailablePayoutMethods']).not_to be_empty
+    end
+  end
+
+  describe 'VALIDATE' do
+    it 'validates a recipient' do
+      recipient = define_new_recipient
+      john = create_new_natural_user_sca_owner
+      # it should pass
+      MangoPay::Recipient.validate(recipient, john['Id'])
+
+      # it should throw error
+      recipient['Currency'] = nil
+      expect { MangoPay::Recipient.validate(recipient, john['Id']) }.to raise_error { |err|
+        expect(err).to be_a MangoPay::ResponseError
+        expect(err.code).to eq '400'
+        expect(err.type).to eq 'param_error'
+      }
+    end
+  end
+
+  describe 'DEACTIVATE' do
+    it 'deactivates a recipient' do
+      pending("a recipient needs to be manually activated before running the test")
+      john = create_new_natural_user_sca_owner
+      recipient = create_new_recipient(john['Id'])
+      deactivated = MangoPay::Recipient.deactivate(recipient['Id'])
+      fetched = MangoPay::Recipient.get(recipient['Id'])
+      expect(deactivated['Status']).to eq('DEACTIVATED')
+      expect(fetched['Status']).to eq('DEACTIVATED')
+    end
+  end
+end
+
+
+def assert_recipient(recipient)
+  expect(recipient).not_to be_nil
+  expect(recipient['Status']).not_to be_nil
+  expect(recipient['DisplayName']).not_to be_nil
+  expect(recipient['PayoutMethodType']).not_to be_nil
+  expect(recipient['RecipientType']).not_to be_nil
+  expect(recipient['IndividualRecipient']).not_to be_nil
+  expect(recipient['LocalBankTransfer']).not_to be_nil
+  expect(recipient['RecipientScope']).not_to be_nil
+  expect(recipient['UserId']).not_to be_nil
+end

data/spec/mangopay/shared_resources.rb

@@ -1205,4 +1205,39 @@ shared_context 'virtual_account' do
 
     MangoPay::VirtualAccount.create(wallet_id, create_virtual_account)
   end
+end
+
+shared_context 'recipient' do
+  include_context 'users'
+
+  let(:new_recipient) { create_new_recipient(create_new_natural_user_sca_owner['Id']) }
+
+  def create_new_recipient(user_id)
+    MangoPay::Recipient.create(define_new_recipient, user_id)
+  end
+
+  def define_new_recipient
+    {
+      "DisplayName": "Alex Smith GBP account",
+      "PayoutMethodType": "LocalBankTransfer",
+      "RecipientType": "Individual",
+      "Currency": "GBP",
+      "IndividualRecipient": {
+        "FirstName": "Alex",
+        "LastName": "Smith",
+        "Address": {
+          "AddressLine1": "10 Kingsway",
+          "City": "London",
+          "PostalCode": "WC2B 6LH",
+          "Country": "GB"
+        }
+      },
+      "LocalBankTransfer": {
+        "GBP": {
+          "SortCode": "200000",
+          "AccountNumber": "55779911"
+        }
+      }
+    }
+  end
 end

data/spec/mangopay/user_spec.rb

@@ -367,4 +367,20 @@ describe MangoPay::User do
     end
   end
 =end
+
+  describe 'CLOSE' do
+    it 'closes a natural user' do
+      new_user = create_new_natural_user
+      MangoPay::NaturalUser.close(new_user['Id'])
+      closed = MangoPay::User.fetch(new_user['Id'])
+      expect(closed['UserStatus']).to eq('CLOSED')
+    end
+
+    it 'closes a legal user' do
+      new_user = new_legal_user
+      MangoPay::LegalUser.close(new_user['Id'])
+      closed = MangoPay::User.fetch(new_user['Id'])
+      expect(closed['UserStatus']).to eq('CLOSED')
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mangopay
 version: !ruby/object:Gem::Version
-  version: 3.31.0
+  version: 3.32.0
 platform: ruby
 authors:
 - Geoffroy Lorieux
@@ -102,6 +102,7 @@ files:
 - lib/mangopay/pay_out.rb
 - lib/mangopay/payment_method_metadata.rb
 - lib/mangopay/pre_authorization.rb
+- lib/mangopay/recipient.rb
 - lib/mangopay/refund.rb
 - lib/mangopay/regulatory.rb
 - lib/mangopay/report.rb
@@ -160,6 +161,7 @@ files:
 - spec/mangopay/payment_method_metadata_spec.rb
 - spec/mangopay/payout_bankwire_spec.rb
 - spec/mangopay/preauthorization_spec.rb
+- spec/mangopay/recipient_spec.rb
 - spec/mangopay/recurring_payin_spec.rb
 - spec/mangopay/refund_spec.rb
 - spec/mangopay/regulatory_spec.rb
@@ -244,6 +246,7 @@ test_files:
 - spec/mangopay/payment_method_metadata_spec.rb
 - spec/mangopay/payout_bankwire_spec.rb
 - spec/mangopay/preauthorization_spec.rb
+- spec/mangopay/recipient_spec.rb
 - spec/mangopay/recurring_payin_spec.rb
 - spec/mangopay/refund_spec.rb
 - spec/mangopay/regulatory_spec.rb