adyen-ruby-api-library 10.3.0 → 11.0.0

data/spec/client_spec.rb

@@ -25,10 +25,10 @@ RSpec.describe Adyen do
   end
 
   it 'fails payments call without WS user and password' do
-    expect { @shared_values[:client].payment.authorise('{}') }
+    expect { @shared_values[:client].payment.payments_api.authorise('{}') }
       .to raise_error(Adyen::AuthenticationError)
     @shared_values[:client].ws_user = @shared_values[:ws_user]
-    expect { @shared_values[:client].payment.authorise('{}') }
+    expect { @shared_values[:client].payment.payments_api.authorise('{}') }
       .to raise_error(Adyen::AuthenticationError)
   end
 
@@ -113,10 +113,20 @@ RSpec.describe Adyen do
     Adyen::Client.new(env: :test, connection_options: connection_options)
   end
 
+  # test with Ruby 3.2+ only (where Faraday requestOptions timeout is supported)
   it 'initiates a Faraday connection with the provided options' do
-    connection_options = Faraday::ConnectionOptions.new
+    skip "Only runs on Ruby >= 3.2" unless RUBY_VERSION >= '3.2'
+    connection_options = Faraday::ConnectionOptions.new(
+      request: {
+        open_timeout: 5,  
+        timeout: 10      
+      }
+    )
     expect(Faraday::ConnectionOptions).not_to receive(:new)
     client = Adyen::Client.new(api_key: 'api_key', env: :mock, connection_options: connection_options)
+    # verify custom options
+    expect(client.connection_options[:request][:open_timeout]).to eq(5)
+    expect(client.connection_options[:request][:timeout]).to eq(10)
 
     mock_faraday_connection = double(Faraday::Connection)
     client.service_url(@shared_values[:service], 'payments/details', client.checkout.version)
@@ -130,6 +140,14 @@ RSpec.describe Adyen do
     client.checkout.payments_api.payments_details(request_body)
   end
 
+  # test with Ruby 3.2+ only (where Faraday requestOptions timeout is supported)
+  it 'initiates a Faraday connection with the expected default timeouts' do
+    skip "Only runs on Ruby >= 3.2" unless RUBY_VERSION >= '3.2'
+    client = Adyen::Client.new(env: :test)
+    expect(client.connection_options[:request][:open_timeout]).to eq(30)
+    expect(client.connection_options[:request][:timeout]).to eq(60)
+  end
+
   it "checks the creation of checkout url" do
     client = Adyen::Client.new(api_key: "api_key", env: :test)
     expect(client.service_url("Checkout", "paymentMethods", "71")).
@@ -284,4 +302,103 @@ RSpec.describe Adyen do
     expect(client.service_url_base('Disputes'))
       .to eq('https://ca-test.adyen.com/ca/services/DisputesService')
   end  
+
+  it 'raises FormatError on 400 response and checks content' do
+    client = Adyen::Client.new(api_key: 'api_key', env: :test)
+    mock_faraday_connection = double(Faraday::Connection)
+    error_body = {
+      status: 400,
+      errorCode: "702",
+      message: "Structure of CreateCheckoutSessionRequest contains the following unknown fields: [paymentMethod]",
+      errorType: "validation"
+    }
+    mock_response = Faraday::Response.new(status: 400, body: error_body)
+
+    allow(Faraday).to receive(:new).and_return(mock_faraday_connection)
+    allow(mock_faraday_connection).to receive_message_chain(:headers, :[]=)
+    allow(mock_faraday_connection).to receive(:post).and_return(mock_response)
+
+    expect {
+      client.checkout.payments_api.payments({})
+    }.to raise_error(Adyen::FormatError) do |error|
+      expect(error.code).to eq(400)
+      expect(error.msg).to eq('Structure of CreateCheckoutSessionRequest contains the following unknown fields: [paymentMethod] ErrorCode: 702')
+      expect(error.response[:errorCode]).to eq('702')
+    end
+  end
+
+  it 'raises ValidationError on 422 response with RestServiceError (based on RFC 7807)' do
+    client = Adyen::Client.new(api_key: 'api_key', env: :test)
+    mock_faraday_connection = double(Faraday::Connection)
+    error_body = {
+      type: "https://docs.adyen.com/errors/validation",
+      title: "The request is missing required fields or contains invalid data.",
+      status: 422,
+      detail: "It is mandatory to specify a legalEntityId when creating a new account holder.",
+      invalidFields: [{ "name" => "legalEntityId", "message" => "legalEntityId is not provided" }],
+      errorCode: "30_011"
+    }
+    mock_response = Faraday::Response.new(status: 422, body: error_body)
+
+    allow(Faraday).to receive(:new).and_return(mock_faraday_connection)
+    allow(mock_faraday_connection).to receive_message_chain(:headers, :[]=)
+    allow(mock_faraday_connection).to receive(:post).and_return(mock_response)
+
+    expect {
+      client.checkout.payments_api.payments({})
+    }.to raise_error(Adyen::ValidationError) do |error|
+      expect(error.code).to eq(422)
+      expect(error.msg).to eq('It is mandatory to specify a legalEntityId when creating a new account holder. ErrorCode: 30_011')
+      expect(error.response[:errorCode]).to eq('30_011')
+      expect(error.response[:invalidFields]).to have_attributes(size: 1)
+    end
+  end
+
+  it 'raises ValidationError on 422 response with ServiceError (legacy)' do
+    client = Adyen::Client.new(api_key: 'api_key', env: :test)
+    mock_faraday_connection = double(Faraday::Connection)
+    error_body = {
+      status: 422,
+      errorCode: "14_030",
+      message: "Return URL is missing.",
+      errorType: "validation",
+      pspReference: "8816118280275544"
+    }  
+    mock_response = Faraday::Response.new(status: 422, body: error_body)
+
+    allow(Faraday).to receive(:new).and_return(mock_faraday_connection)
+    allow(mock_faraday_connection).to receive_message_chain(:headers, :[]=)
+    allow(mock_faraday_connection).to receive(:post).and_return(mock_response)
+
+    expect {
+      client.checkout.payments_api.payments({})
+    }.to raise_error(Adyen::ValidationError) do |error|
+      expect(error.code).to eq(422)
+      expect(error.msg).to eq('Return URL is missing. ErrorCode: 14_030')
+      expect(error.response[:errorCode]).to eq('14_030')
+    end
+  end
+
+  it 'raises ServerError on 500 response and checks content' do
+    client = Adyen::Client.new(api_key: 'api_key', env: :test)
+    mock_faraday_connection = double(Faraday::Connection)
+    error_body = {
+      status: 500,
+      errorCode: "999",
+      message: "Unexpected error.",
+      errorType: "server error"
+    }
+    mock_response = Faraday::Response.new(status: 500, body: error_body)
+
+    allow(Faraday).to receive(:new).and_return(mock_faraday_connection)
+    allow(mock_faraday_connection).to receive_message_chain(:headers, :[]=)
+    allow(mock_faraday_connection).to receive(:post).and_return(mock_response)
+
+    expect {
+      client.checkout.payments_api.payments({})
+    }.to raise_error(Adyen::ServerError) do |error|
+      expect(error.code).to eq(500)
+      expect(error.msg).to eq('Unexpected error. ErrorCode: 999')
+    end
+  end
 end

data/spec/data_protection_spec.rb

@@ -10,5 +10,5 @@ RSpec.describe Adyen::DataProtection, service: 'Data Protection Service' do
     %w[request_subject_erasure result SUCCESS]
   ]
 
-  generate_tests(client, 'DataProtectionService', test_sets, client.data_protection)
+  generate_tests(client, 'DataProtectionService', test_sets, client.data_protection.data_protection_api)
 end

data/spec/disputes_spec.rb

@@ -28,7 +28,8 @@ RSpec.describe Adyen::Disputes, service: 'disputes service' do
              body: response_body
            )
 
-    result = @shared_values[:client].disputes.retrieve_applicable_defense_reasons(request_body)
+    result = @shared_values[:client].disputes.disputes_api.retrieve_applicable_defense_reasons(request_body)
+    
     response_hash = result.response
 
     expect(result.status)

data/spec/mocks/requests/BalancePlatform/create_transfer_limit.json

@@ -0,0 +1,14 @@
+{
+  "amount": {
+    "currency": "EUR",
+    "value": 10000
+  },
+  "reference": "Your reference for the transfer limit",
+  "scaInformation": {
+    "scaOnApproval": true
+  },
+  "scope": "perTransaction",
+  "startsAt": "2025-08-15T06:36:20+01:00",
+  "endsAt": "2026-08-14T00:00:00+01:00",
+  "transferType": "all"
+}

data/spec/mocks/requests/BalancePlatform/create_webhook_setting.json

@@ -0,0 +1,16 @@
+{
+  "type": "balance",
+  "target": {
+    "type": "balanceAccount",
+    "id": "BA00000000000000000LIABLE"
+  },
+  "currency": "USD",
+  "status": "active",
+  "conditions": [
+    {
+      "balanceType": "available",
+      "conditionType": "lessThan",
+      "value": 500000
+    }
+  ]
+}

data/spec/mocks/requests/OpenBanking/create_account_verification_routes.json

@@ -0,0 +1,6 @@
+{
+  "country": "NL",
+  "locale": "en-US",
+  "state": "11a1e60a-18b0-4dda-9258-e0ae29e1e2a3",
+  "redirectUrl": "https://merchanturl.example.org/redirect/url"
+}

data/spec/mocks/requests/SessionAuthentication/create_authentication_session.json

@@ -0,0 +1,16 @@
+{
+  "allowOrigin": "https://www.your-website.com",
+  "product": "platform",
+  "policy": {
+    "resources": [
+      {
+        "type": "accountHolder",
+        "accountHolderId": "AH00000000000000000000001"
+      }
+    ],
+    "roles": [
+      "Transactions Overview Component: View",
+      "Payouts Overview Component: View"
+    ]
+  }
+}

data/spec/mocks/responses/BalancePlatform/create_transfer_limit.json

@@ -0,0 +1,16 @@
+{
+  "amount": {
+    "value": 10000,
+    "currency": "EUR"
+  },
+  "id": "TRLI00000000000000000000000001",
+  "scope": "perTransaction",
+  "reference": "Your reference for the transfer limit",
+  "scaInformation": {
+    "status": "pending"
+  },
+  "startsAt": "2025-08-15T06:36:20+01:00",
+  "endsAt": "2026-08-13T23:00:00+01:00",
+  "limitStatus": "pendingSCA",
+  "transferType": "all"
+}

data/spec/mocks/responses/BalancePlatform/create_webhook_setting.json

@@ -0,0 +1,17 @@
+{
+  "id": "BWHS00000000000000000000000001",
+  "type": "balance",
+  "target": {
+    "type": "balanceAccount",
+    "id": "BA00000000000000000LIABLE"
+  },
+  "currency": "USD",
+  "status": "active",
+  "conditions": [
+    {
+      "balanceType": "available",
+      "conditionType": "lessThan",
+      "value": 500000
+    }
+  ]
+}

data/spec/mocks/responses/BalancePlatform/get_all_authorised_card_users.json

@@ -0,0 +1,6 @@
+{
+  "legalEntityIds": [
+    "LE328V522322685LV3KTNF35M",
+    "LE328SW223226B5LWVWNQ8THN"
+  ]
+}

data/spec/mocks/responses/BalancePlatform/get_all_webhook_settings.json

@@ -0,0 +1,38 @@
+{
+  "webhookSettings": [
+    {
+      "id": "BWHS00000000000000000000000001",
+      "type": "balance",
+      "target": {
+        "type": "balancePlatform",
+        "id": "YOUR_BALANCE_PLATFORM"
+      },
+      "currency": "USD",
+      "status": "active",
+      "conditions": [
+        {
+          "balanceType": "available",
+          "conditionType": "lessThan",
+          "value": 500000
+        }
+      ]
+    },
+    {
+      "id": "BWHS00000000000000000000000002",
+      "type": "balance",
+      "target": {
+        "type": "balanceAccount",
+        "id": "BA00000000000000000LIABLE"
+      },
+      "currency": "USD",
+      "status": "active",
+      "conditions": [
+        {
+          "balanceType": "available",
+          "conditionType": "greaterThan",
+          "value": 1000000
+        }
+      ]
+    }
+  ]
+}

data/spec/mocks/responses/BalancePlatform/get_specific_transfer_limit.json

@@ -0,0 +1,17 @@
+{
+  "amount": {
+    "value": 10000,
+    "currency": "EUR"
+  },
+  "id": "TRLI00000000000000000000000001",
+  "endsAt": "2026-08-13T23:00:00+01:00",
+  "scope": "perTransaction",
+  "reference": "Your reference for the transfer limit",
+  "scaInformation": {
+    "exemption": "initialLimit",
+    "status": "notPerformed"
+  },
+  "startsAt": "2025-08-13T23:00:00+01:00",
+  "limitStatus": "active",
+  "transferType": "all"
+}

data/spec/mocks/responses/BalancePlatform/get_transfer_limits.json

@@ -0,0 +1,38 @@
+{
+  "transferLimits": [
+    {
+      "amount": {
+        "value": 10000,
+        "currency": "EUR"
+      },
+      "id": "TRLI00000000000000000000000001",
+      "endsAt": "2026-08-13T23:00:00+01:00",
+      "scope": "perTransaction",
+      "reference": "Your reference for the transfer limit",
+      "scaInformation": {
+        "exemption": "initialLimit",
+        "status": "notPerformed"
+      },
+      "startsAt": "2025-08-13T23:00:00+01:00",
+      "limitStatus": "active",
+      "transferType": "instant"
+    },
+    {
+      "amount": {
+        "value": 20000,
+        "currency": "EUR"
+      },
+      "id": "TRLI00000000000000000000000002",
+      "endsAt": "2026-08-13T23:00:00+01:00",
+      "scope": "perTransaction",
+      "reference": "Your reference for the transfer limit",
+      "scaInformation": {
+        "exemption": "initialLimit",
+        "status": "notPerformed"
+      },
+      "startsAt": "2025-08-13T23:00:00+01:00",
+      "limitStatus": "active",
+      "transferType": "all"
+    }
+  ]
+}

data/spec/mocks/responses/OpenBanking/create_account_verification_routes.json

@@ -0,0 +1,11 @@
+{
+  "routes": [
+    {
+      "provider": {
+        "name": "Tink",
+        "logoURL": "https://obgateway.adyen.com/obgateway/static/provider/images/tink-logo.svg"
+      },
+      "link": "https://obgateway.adyen.com/obgateway/provider/outgoing/tink/redirect/13ec4802-c987-4f8c-8909-9a75ff567256"
+    }
+  ]
+}

data/spec/mocks/responses/OpenBanking/get_account_verification_report.json

@@ -0,0 +1,30 @@
+{
+  "id": "69ee9452ef824fe092f1417f37535755",
+  "country": "ES",
+  "accounts": [
+    {
+      "accountId": "ed5080e4f485430290475d246534c8fd",
+      "accountType": "CURRENT",
+      "accountName": "Checking Account 1",
+      "accountNumber": "ES1376230223254275408743",
+      "currency": "EUR",
+      "identifiers": {
+        "iban": {
+          "iban": "ES1376230223254275408743",
+          "bban": "76230223254275408743",
+          "bic": "BIC001"
+        }
+      },
+      "parties": [
+        {
+          "identity": {
+            "fullLegalName": "Alberta Bobbeth Charleson",
+            "name": "Alberta Bobbeth Charleson"
+          },
+          "role": "HOLDER"
+        }
+      ],
+      "bankName": "Tink Demo Bank"
+    }
+  ]
+}

data/spec/mocks/responses/SessionAuthentication/create_authentication_session.json

@@ -0,0 +1,4 @@
+{
+  "sessionToken": "long_session_token_string",
+  "expiresAt": "2025-10-07T12:00:00Z"
+}

data/spec/open_banking_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'json'
+
+RSpec.describe Adyen::OpenBanking, service: 'OpenBanking' do
+  before(:all) do
+    @shared_values = {
+      client: create_client(:api_key),
+      service: 'OpenBanking'
+    }
+  end
+
+  it 'makes a create_account_verification_routes POST call' do
+    request_body = JSON.parse(json_from_file('mocks/requests/OpenBanking/create_account_verification_routes.json'))
+    response_body = json_from_file('mocks/responses/OpenBanking/create_account_verification_routes.json')
+
+    url = @shared_values[:client].service_url(
+      @shared_values[:service],
+      'accountVerification/routes',
+      @shared_values[:client].open_banking.version
+    )
+    WebMock.stub_request(:post, url)
+           .with(
+             body: request_body,
+             headers: {
+               'x-api-key' => @shared_values[:client].api_key
+             }
+           )
+           .to_return(
+             body: response_body
+           )
+
+    result = @shared_values[:client].open_banking.account_verification_api.create_account_verification_routes(request_body)
+    response_hash = result.response
+
+    expect(result.status).to eq(200)
+    expect(response_hash).to eq(JSON.parse(response_body))
+    expect(response_hash).to be_a Adyen::HashWithAccessors
+    expect(response_hash).to be_a_kind_of Hash
+  end
+
+  it 'makes a get_account_verification_report GET call' do
+    response_body = json_from_file('mocks/responses/OpenBanking/get_account_verification_report.json')
+    code = 'some-verification-code'
+
+    url = @shared_values[:client].service_url(
+      @shared_values[:service],
+      "accountVerification/reports/#{code}",
+      @shared_values[:client].open_banking.version
+    )
+    WebMock.stub_request(:get, url)
+           .with(
+             headers: {
+               'x-api-key' => @shared_values[:client].api_key
+             }
+           )
+           .to_return(
+             body: response_body
+           )
+
+    result = @shared_values[:client].open_banking.account_verification_api.get_account_verification_report(code)
+    response_hash = result.response
+
+    expect(result.status).to eq(200)
+    expect(response_hash).to eq(JSON.parse(response_body))
+    expect(response_hash).to be_a Adyen::HashWithAccessors
+    expect(response_hash).to be_a_kind_of Hash
+  end
+end

data/spec/payments_spec.rb

@@ -28,7 +28,7 @@ RSpec.describe Adyen::Payment, service: 'Payment' do
              body: response_body
            )
 
-    result = @shared_values[:client].payment.adjust_authorisation(request_body)
+    result = @shared_values[:client].payment.modifications_api.adjust_authorisation(request_body)
     response_hash = result.response
 
     expect(result.status)

data/spec/recurring_spec.rb

@@ -14,5 +14,5 @@ RSpec.describe Adyen::Payment, service: 'recurring service' do
     ['schedule_account_updater', 'result', 'Success']
   ]
 
-  generate_tests(client, 'Recurring', test_sets, client.recurring)
+  generate_tests(client, 'Recurring', test_sets, client.recurring.recurring_api)
 end

data/spec/session_authentication_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'json'
+
+RSpec.describe Adyen::SessionAuthentication, service: 'SessionAuthentication' do
+  before(:all) do
+    @shared_values = {
+      client: create_client(:api_key),
+      service: 'SessionAuthentication'
+    }
+  end
+
+  it 'makes a create_authentication_session POST call' do
+    request_body = JSON.parse(json_from_file('mocks/requests/SessionAuthentication/create_authentication_session.json'))
+    response_body = json_from_file('mocks/responses/SessionAuthentication/create_authentication_session.json')
+
+    url = @shared_values[:client].service_url(
+      @shared_values[:service],
+      'sessions',
+      @shared_values[:client].session_authentication.version
+    )
+    WebMock.stub_request(:post, url)
+           .with(
+             body: request_body,
+             headers: {
+               'x-api-key' => @shared_values[:client].api_key
+             }
+           )
+           .to_return(
+             body: response_body
+           )
+
+    result = @shared_values[:client].session_authentication.session_authentication_api.create_authentication_session(request_body)
+    response_hash = result.response
+
+    expect(result.status).to eq(200)
+    expect(response_hash).to eq(JSON.parse(response_body))
+    expect(response_hash).to be_a Adyen::HashWithAccessors
+    expect(response_hash).to be_a_kind_of Hash
+  end
+end

data/spec/stored_value_spec.rb

@@ -28,7 +28,7 @@ RSpec.describe Adyen::BalancePlatform, service: 'balancePlatform' do
              body: response_body
            )
 
-    result = @shared_values[:client].stored_value.issue(request_body)
+    result = @shared_values[:client].stored_value.stored_value_api.issue(request_body)
     response_hash = result.response
 
     expect(result.status)

data/templates/api.mustache

@@ -18,7 +18,7 @@ module Adyen
     #
     # Deprecated {{#vendorExtensions.x-deprecatedInVersion}}since {{#appName}}{{{.}}}{{/appName}} v{{.}}{{/vendorExtensions.x-deprecatedInVersion}}{{#vendorExtensions.x-deprecatedMessage}}
     # {{{.}}}{{/vendorExtensions.x-deprecatedMessage}}{{/isDeprecated}}
-    def {{#lambda.snakecase}}{{#vendorExtensions.x-methodName}}{{.}}{{/vendorExtensions.x-methodName}}{{^vendorExtensions.x-methodName}}{{nickname}}{{/vendorExtensions.x-methodName}}{{/lambda.snakecase}}({{#bodyParams}}request, {{/bodyParams}}{{#requiredParams}}{{^isQueryParam}}{{#lambda.snakecase}}{{paramName}}{{/lambda.snakecase}}, {{/isQueryParam}}{{/requiredParams}}headers: {}{{#queryParams}}{{#-first}}, query_params: {}{{/-first}}{{/queryParams}})
+    def {{#lambda.snakecase}}{{#vendorExtensions.x-methodName}}{{.}}{{/vendorExtensions.x-methodName}}{{^vendorExtensions.x-methodName}}{{nickname}}{{/vendorExtensions.x-methodName}}{{/lambda.snakecase}}({{#bodyParams}}request, {{/bodyParams}}{{#pathParams}}{{#lambda.snakecase}}{{paramName}}{{/lambda.snakecase}}, {{/pathParams}}headers: {}{{#queryParams}}{{#-first}}, query_params: {}{{/-first}}{{/queryParams}})
       endpoint = '{{path}}'.gsub(/{.+?}/, '%s')
       endpoint = endpoint.gsub(%r{^/}, '')
       endpoint = format(endpoint{{#pathParams}}, {{#lambda.snakecase}}{{paramName}}{{/lambda.snakecase}}{{/pathParams}})