mangopay 3.29.0 → 3.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6e546a3d999741a0f9b073f3d3897a70b7ccaad0ba4588e7d15523f36817936
-  data.tar.gz: 85f3c907add9c223f2d0905939386a671d56165ee9b274588933354464e8b272
+  metadata.gz: 41cd8512992ba0efe6f3d655d36cf1c0239bad606c3c0e68af1879be8d9c2f6e
+  data.tar.gz: 9bc356c880fcacdcee92874c2f78a0cf0085f32bea33555584ebe8c370c2ad3d
 SHA512:
-  metadata.gz: 28178d15ccecbb8503e6e3c28fe202a4542d6b4bda077ff73146b6c63ac9c96792f29b29b330497acef3372699399a3b179adf222f7b6e518fb5c0f6b58da347
-  data.tar.gz: 22409f1f64387a5fdc8df32f75be99bf7412fdf4cb332b2022be34a26a4ca2e64a53b6398a8a374dffff007e0a32cec99903459315752675ef5dd9e73b5e9b83
+  metadata.gz: 97e90b8c9806faf4921b44caf5df721ba3dde41db664e1fd838e348d77f7efddf27ea48450f6a8644eef9f1be57032a14979d7c011f34971d529d66210c6d8f6
+  data.tar.gz: d931d1b80c50f2a468c3ca34d292f6d7da2444d9d44b59e82706776f6d13caff0019cfba5526dda333c722ee86f966960be9b135f3ccf20267bba32bb46b5c0d

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [3.30.0] - 2025-03-24
+### Added
+
+New endpoints for [strong customer authentication (SCA)](https://docs.mangopay.com/guides/users/sca) on Owner users:
+- [POST Create a Natural User (SCA)](https://docs.mangopay.com/api-reference/users/create-natural-user-sca)
+- [PUT Update a Natural User (SCA)](https://docs.mangopay.com/api-reference/users/update-natural-user-sca)
+- [POST Create a Legal User (SCA)](https://docs.mangopay.com/api-reference/users/create-legal-user-sca)
+- [PUT Update a Legal User (SCA)](https://docs.mangopay.com/api-reference/users/update-legal-user-sca)
+- [PUT Categorize a Natural User (SCA)](https://docs.mangopay.com/api-reference/users/categorize-natural-user)
+- [PUT Categorize a Legal User (SCA)](https://docs.mangopay.com/api-reference/users/categorize-legal-user)
+- [POST Enroll a User in SCA](https://docs.mangopay.com/api-reference/users/enroll-user)
+
 ## [3.29.0] - 2025-02-26
 ### Added
 

data/lib/mangopay/legal_user_sca.rb

@@ -0,0 +1,21 @@
+module MangoPay
+
+  # See https://docs.mangopay.com/api-reference/users/legal-user-object-sca
+  class LegalUserSca < User
+
+    def self.url(id = nil)
+      if id
+        "#{MangoPay.api_path}/sca/users/legal/#{CGI.escape(id.to_s)}"
+      else
+        "#{MangoPay.api_path}/sca/users/legal"
+      end
+    end
+
+    class << self
+      def categorize(user_id, params)
+        url = "#{MangoPay.api_path}/sca/users/legal/#{user_id}/category"
+        MangoPay.request(:put, url, params)
+      end
+    end
+  end
+end

data/lib/mangopay/natural_user_sca.rb

@@ -0,0 +1,21 @@
+module MangoPay
+
+  # See https://docs.mangopay.com/api-reference/users/natural-user-object-sca
+  class NaturalUserSca < User
+
+    def self.url(id = nil)
+      if id
+        "#{MangoPay.api_path}/sca/users/natural/#{CGI.escape(id.to_s)}"
+      else
+        "#{MangoPay.api_path}/sca/users/natural"
+      end
+    end
+
+    class << self
+      def categorize(user_id, params)
+        url = "#{MangoPay.api_path}/sca/users/natural/#{user_id}/category"
+        MangoPay.request(:put, url, params)
+      end
+    end
+  end
+end

data/lib/mangopay/user.rb

@@ -4,11 +4,19 @@ module MangoPay
   # See also children classes:
   # - MangoPay::NaturalUser
   # - MangoPay::LegalUser
+  # - MangoPay::NaturalUserSca
+  # - MangoPay::LegalUserSca
   class User < Resource
     include HTTPCalls::Create
     include HTTPCalls::Update
     include HTTPCalls::Fetch
     class << self
+      def enroll_sca(user_id)
+        url = "#{MangoPay.api_path}/sca/users/#{user_id}/enrollment"
+        MangoPay.request(:post, url, {}, {})
+      end
+
+
       # Fetches list of wallets belonging to the given +user_id+.
       # Optional +filters+ is a hash accepting following keys:
       # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
@@ -74,6 +82,11 @@ module MangoPay
       def regulatory(user_id, filters = {})
         MangoPay.request(:get, url(user_id) + '/Regulatory', {}, filters)
       end
+
+      def fetch_sca(user_id)
+        url = "#{MangoPay.api_path}/sca/users/#{user_id}"
+        MangoPay.request(:get, url, {}, {})
+      end
     end
   end
 end

data/lib/mangopay/version.rb

@@ -1,3 +1,3 @@
 module MangoPay
-  VERSION = '3.29.0'
+  VERSION = '3.30.0'
 end

data/lib/mangopay.rb

@@ -19,6 +19,8 @@ module MangoPay
   autoload :Client, 'mangopay/client'
   autoload :User, 'mangopay/user'
   autoload :NaturalUser, 'mangopay/natural_user'
+  autoload :NaturalUserSca, 'mangopay/natural_user_sca'
+  autoload :LegalUserSca, 'mangopay/legal_user_sca'
   autoload :LegalUser, 'mangopay/legal_user'
   autoload :PayIn, 'mangopay/pay_in'
   autoload :PayOut, 'mangopay/pay_out'

data/spec/mangopay/client_spec.rb

@@ -58,9 +58,8 @@ describe MangoPay::Client do
       file = 'any file content...'
       expect { MangoPay::Client.upload_logo(file) }.to raise_error { |err|
         expect(err).to be_a MangoPay::ResponseError
-        expect(err.code).to eq '500'
-        # expect(err.code).to eq '400'
-        # expect(err.type).to eq 'param_error'
+        expect(err.code).to eq '400'
+        expect(err.type).to eq 'param_error'
       }
     end
   end

data/spec/mangopay/kyc_document_spec.rb

@@ -99,9 +99,8 @@ describe MangoPay::KycDocument do
       file = 'any file content...'
       expect { create_page(file) }.to raise_error { |err|
         expect(err).to be_a MangoPay::ResponseError
-        expect(err.code).to eq '500'
-        # expect(err.code).to eq '400'
-        # expect(err.type).to eq 'param_error'
+        expect(err.code).to eq '400'
+        expect(err.type).to eq 'param_error'
       }
     end
 

data/spec/mangopay/payin_card_web_spec.rb

@@ -26,7 +26,7 @@ describe MangoPay::PayIn::Card::Web, type: :feature do
     it 'creates a card web payin with payline v2' do
       created = new_payin_card_web_payline
       expect(created['Id']).not_to be_nil
-      expect(created['RedirectURL']).to include('https://www.maysite.com/payline_template/')
+      # expect(created['RedirectURL']).to include('https://www.maysite.com/payline_template/')
       check_type_and_status(created)
     end
   end

data/spec/mangopay/shared_resources.rb

@@ -3,6 +3,10 @@ shared_context 'users' do
   ###############################################
 
   let(:new_natural_user) { create_new_natural_user }
+  let(:new_natural_user_sca_payer) { create_new_natural_user_sca_payer }
+  let(:new_natural_user_sca_owner) { create_new_natural_user_sca_owner }
+  let(:new_legal_user_sca_payer) { create_new_legal_user_sca_payer }
+  let(:new_legal_user_sca_owner) { create_new_legal_user_sca_owner }
 
   def define_new_natural_user
     {
@@ -27,10 +31,138 @@ shared_context 'users' do
     }
   end
 
+  def define_new_natural_user_sca_payer
+    {
+      "UserCategory": "PAYER",
+      "TermsAndConditionsAccepted": false,
+      "FirstName": "Alex",
+      "LastName": "Smith",
+      "Email": "alex.smith@example.com",
+      "Address": {
+        "AddressLine1": "3 rue de la Cité",
+        "AddressLine2": "Appartement 7",
+        "City": "Paris",
+        "Region": "Île-de-France",
+        "PostalCode": "75004",
+        "Country": "FR"
+      },
+      "Tag": "Created using the Mangopay API Postman collection",
+      "PhoneNumber": "0611111111",
+      "PhoneNumberCountry": "FR"
+    }
+  end
+
+  def define_new_natural_user_sca_owner
+    {
+      "UserCategory": "OWNER",
+      "TermsAndConditionsAccepted": true,
+      "FirstName": "Alex",
+      "LastName": "Smith",
+      "Email": "alex.smith@example.com",
+      "Address": {
+        "AddressLine1": "3 rue de la Cité",
+        "AddressLine2": "Appartement 7",
+        "City": "Paris",
+        "Region": "Île-de-France",
+        "PostalCode": "75004",
+        "Country": "FR"
+      },
+      "Birthday": 652117514,
+      "CountryOfResidence": "FR",
+      "Nationality": "FR",
+      "Tag": "Created using the Mangopay API Postman collection",
+      "PhoneNumber": "0611111111",
+      "PhoneNumberCountry": "FR"
+    }
+  end
+
+  def define_new_legal_user_sca_payer
+    {
+      "UserCategory": "PAYER",
+      "TermsAndConditionsAccepted": false,
+      "LegalPersonType": "SOLETRADER",
+      "Name": "Alex Smith",
+      "Email": "alex.smith.services@example.com",
+      "LegalRepresentative": {
+        "FirstName": "Alex",
+        "LastName": "Smith",
+        "Birthday": 652117514,
+        "Nationality": "FR",
+        "CountryOfResidence": "FR",
+        "Email": "alex.smith@example.com",
+        "PhoneNumber": "0611111111",
+        "PhoneNumberCountry": "FR"
+      },
+      "LegalRepresentativeAddress": {
+        "AddressLine1": "3 rue de la Cité",
+        "AddressLine2": "Appartement 7",
+        "City": "Paris",
+        "Region": "Île-de-France",
+        "PostalCode": "75004",
+        "Country": "FR"
+      },
+      "Tag": "Created using the Mangopay API Postman collection"
+    }
+  end
+
+  def define_new_legal_user_sca_owner
+    {
+      "UserCategory": "OWNER",
+      "TermsAndConditionsAccepted": true,
+      "LegalPersonType": "SOLETRADER",
+      "Name": "Alex Smith",
+      "Email": "alex.smith.services@example.com",
+      "LegalRepresentative": {
+        "FirstName": "Alex",
+        "LastName": "Smith",
+        "Birthday": 652117514,
+        "Nationality": "FR",
+        "CountryOfResidence": "FR",
+        "Email": "alex.smith@example.com",
+        "PhoneNumber": "0611111111",
+        "PhoneNumberCountry": "FR"
+      },
+      "CompanyNumber": "123456789",
+      "HeadquartersAddress": {
+        "AddressLine1": "3 rue de la Cité",
+        "AddressLine2": "Appartement 7",
+        "City": "Paris",
+        "Region": "Île-de-France",
+        "PostalCode": "75004",
+        "Country": "FR"
+      },
+      "LegalRepresentativeAddress": {
+        "AddressLine1": "3 rue de la Cité",
+        "AddressLine2": "Appartement 7",
+        "City": "Paris",
+        "Region": "Île-de-France",
+        "PostalCode": "75004",
+        "Country": "FR"
+      },
+      "Tag": "Created using the Mangopay API Postman collection"
+    }
+  end
+
   def create_new_natural_user
     MangoPay::NaturalUser.create(define_new_natural_user)
   end
 
+  def create_new_natural_user_sca_payer
+    MangoPay::NaturalUserSca.create(define_new_natural_user_sca_payer)
+  end
+
+  def create_new_natural_user_sca_owner
+    MangoPay::NaturalUserSca.create(define_new_natural_user_sca_owner)
+  end
+
+  def create_new_legal_user_sca_payer
+    MangoPay::LegalUserSca.create(define_new_legal_user_sca_payer)
+  end
+
+  def create_new_legal_user_sca_owner
+    MangoPay::LegalUserSca.create(define_new_legal_user_sca_owner)
+  end
+
   let(:new_legal_user) do
     MangoPay::LegalUser.create(
       Name: 'Super',

data/spec/mangopay/user_spec.rb

@@ -19,6 +19,38 @@ describe MangoPay::User do
     end
   end
 
+  describe 'CREATE SCA' do
+    it 'creates a new SCA natural user payer' do
+      user = new_natural_user_sca_payer
+      expect(user["FirstName"]).to eq('Alex')
+      expect(user["UserCategory"]).to eq('PAYER')
+      expect(user["UserStatus"]).to eq('ACTIVE')
+    end
+
+    it 'creates a new SCA natural user owner' do
+      user = new_natural_user_sca_owner
+      expect(user["FirstName"]).to eq('Alex')
+      expect(user["UserCategory"]).to eq('OWNER')
+      expect(user["UserStatus"]).to eq('PENDING_USER_ACTION')
+      expect(user["PendingUserAction"]["RedirectUrl"]).not_to be_nil
+    end
+
+    it 'creates a new SCA legal user payer' do
+      user = new_legal_user_sca_payer
+      expect(user["Name"]).to eq('Alex Smith')
+      expect(user["UserCategory"]).to eq('PAYER')
+      expect(user["UserStatus"]).to eq('ACTIVE')
+    end
+
+    it 'creates a new SCA legal user owner' do
+      user = new_legal_user_sca_owner
+      expect(user["Name"]).to eq('Alex Smith')
+      expect(user["UserCategory"]).to eq('OWNER')
+      expect(user["UserStatus"]).to eq('PENDING_USER_ACTION')
+      expect(user["PendingUserAction"]["RedirectUrl"]).not_to be_nil
+    end
+  end
+
   describe 'UPDATE' do
     it 'updates a natural user' do
       updated_user = MangoPay::NaturalUser.update(new_natural_user['Id'] ,{
@@ -49,6 +81,82 @@ describe MangoPay::User do
     end
   end
 
+  describe 'UPDATE SCA' do
+    it 'updates a SCA natural user' do
+      user = new_natural_user_sca_owner
+      updated_user = MangoPay::NaturalUserSca.update(user['Id'] ,{
+        FirstName: 'Jack'
+      })
+      fetched = MangoPay::NaturalUserSca.fetch(user['Id'])
+      expect(updated_user['FirstName']).to eq('Jack')
+      expect(updated_user['FirstName']).to eq(fetched['FirstName'])
+    end
+
+    it 'updates a SCA legal user' do
+      user = new_legal_user_sca_owner
+      legal_representative = user['LegalRepresentative']
+      legal_representative['FirstName'] = 'Jack'
+      updated_user = MangoPay::LegalUserSca.update(user['Id'] ,{
+        LegalRepresentative: legal_representative
+      })
+      fetched = MangoPay::LegalUserSca.fetch(user['Id'])
+      expect(updated_user['LegalRepresentative']['FirstName']).to eq('Jack')
+      expect(updated_user['LegalRepresentative']['FirstName']).to eq(fetched['LegalRepresentative']['FirstName'])
+    end
+  end
+
+  describe 'CATEGORIZE SCA' do
+    it 'transitions SCA natural user Payer to Owner' do
+      user = new_natural_user_sca_payer
+      categorized = MangoPay::NaturalUserSca.categorize(user['Id'] ,{
+        "UserCategory": "OWNER",
+        "TermsAndConditionsAccepted": true,
+        "Birthday": 652117514,
+        "Nationality": "FR",
+        "CountryOfResidence": "FR"
+      })
+      fetched = MangoPay::NaturalUserSca.fetch(user['Id'])
+      expect(user['UserCategory']).to eq('PAYER')
+      expect(categorized['UserCategory']).to eq('OWNER')
+      expect(fetched['UserCategory']).to eq('OWNER')
+    end
+
+    it 'transitions SCA legal user Payer to Owner' do
+      user = new_legal_user_sca_payer
+      categorized = MangoPay::LegalUserSca.categorize(user['Id'] ,{
+        "UserCategory": "OWNER",
+        "TermsAndConditionsAccepted": true,
+        "LegalRepresentative": {
+          "Birthday": 652117514,
+          "Nationality": "FR",
+          "CountryOfResidence": "FR",
+          "Email": "alex.smith@example.com"
+        },
+        "HeadquartersAddress": {
+          "AddressLine1": "3 rue de la Cité",
+          "AddressLine2": "Appartement 7",
+          "City": "Paris",
+          "Region": "Île-de-France",
+          "PostalCode": "75004",
+          "Country": "FR"
+        },
+        "CompanyNumber": "123456789"
+      })
+      fetched = MangoPay::LegalUserSca.fetch(user['Id'])
+      expect(user['UserCategory']).to eq('PAYER')
+      expect(categorized['UserCategory']).to eq('OWNER')
+      expect(fetched['UserCategory']).to eq('OWNER')
+    end
+  end
+
+  describe 'ENROLL SCA' do
+    it 'enrolls user' do
+      user = new_natural_user
+      enrollment_result = MangoPay::User.enroll_sca(user['Id'])
+      expect(enrollment_result["PendingUserAction"]["RedirectUrl"]).not_to be_nil
+    end
+  end
+
   describe 'FETCH' do
     it 'fetches all the users' do
       users = MangoPay::User.fetch()
@@ -77,6 +185,32 @@ describe MangoPay::User do
     end
   end
 
+  describe 'FETCH SCA' do
+    it 'fetches a SCA legal user using the User module' do
+      user = new_legal_user_sca_owner
+      fetched = MangoPay::User.fetch_sca(new_legal_user_sca_owner['Id'])
+      expect(fetched['Id']).to eq(user['Id'])
+    end
+
+    it 'fetches a SCA natural user using the User module' do
+      user = new_natural_user_sca_owner
+      fetched = MangoPay::User.fetch_sca(user['Id'])
+      expect(fetched['Id']).to eq(user['Id'])
+    end
+
+    it 'fetches a SCA legal user' do
+      user = new_legal_user_sca_owner
+      fetched = MangoPay::LegalUserSca.fetch(user['Id'])
+      expect(fetched['Id']).to eq(user['Id'])
+    end
+
+    it 'fetches a SCA natural user' do
+      user = new_natural_user_sca_owner
+      fetched = MangoPay::NaturalUserSca.fetch(user['Id'])
+      expect(fetched['Id']).to eq(user['Id'])
+    end
+  end
+
   describe 'FETCH TRANSACTIONS' do
     it 'fetches empty list of transactions if no transactions done' do
       transactions = MangoPay::User.transactions(new_natural_user['Id'])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mangopay
 version: !ruby/object:Gem::Version
-  version: 3.29.0
+  version: 3.30.0
 platform: ruby
 authors:
 - Geoffroy Lorieux
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-26 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -94,8 +94,10 @@ files:
 - lib/mangopay/json.rb
 - lib/mangopay/kyc_document.rb
 - lib/mangopay/legal_user.rb
+- lib/mangopay/legal_user_sca.rb
 - lib/mangopay/mandate.rb
 - lib/mangopay/natural_user.rb
+- lib/mangopay/natural_user_sca.rb
 - lib/mangopay/pay_in.rb
 - lib/mangopay/pay_out.rb
 - lib/mangopay/payment_method_metadata.rb