hamza-payments-query-sdk 1.0.0

data/lib/payments.rb

@@ -0,0 +1,280 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+require 'json'
+
+require 'apimatic_core_interfaces'
+require 'apimatic_core'
+require 'apimatic_faraday_client_adapter'
+
+require_relative 'payments/api_helper'
+require_relative 'payments/client'
+
+# Utilities
+require_relative 'payments/utilities/file_wrapper'
+require_relative 'payments/utilities/date_time_helper'
+require_relative 'payments/utilities/union_type_lookup'
+
+# Http
+require_relative 'payments/http/http_call_back'
+require_relative 'payments/http/http_method_enum'
+require_relative 'payments/http/http_request'
+require_relative 'payments/http/http_response'
+require_relative 'payments/http/proxy_settings'
+
+
+require_relative 'payments/http/auth/basic_auth'
+
+# Models
+require_relative 'payments/models/base_model'
+require_relative 'payments/models/payments_action_partial_refund'
+require_relative 'payments/models/payments_action_refund'
+require_relative 'payments/models/payments_link'
+require_relative 'payments/models/mself'
+require_relative 'payments/models/settle_action_list'
+require_relative 'payments/models/settle_response'
+require_relative 'payments/models/refund_response'
+require_relative 'payments/models/payments_partial_settle_request'
+require_relative 'payments/models/payments_sequence'
+require_relative 'payments/models/value'
+require_relative 'payments/models/partial_settle_action_list'
+require_relative 'payments/models/partial_settle_response'
+require_relative 'payments/models/payments_action_cancel'
+require_relative 'payments/models/payments_action_partial_settle'
+require_relative 'payments/models/payments_partial_refund_request'
+require_relative 'payments/models/partial_refund_action_list'
+require_relative 'payments/models/partial_refund_response'
+require_relative 'payments/models/cancel_response'
+require_relative 'payments/models/device_data_request'
+require_relative 'payments/models/advice'
+require_relative 'payments/models/authentication'
+require_relative 'payments/models/authorization_action_list'
+require_relative 'payments/models/billing_address'
+require_relative 'payments/models/card_authorized_payment_response'
+require_relative 'payments/models/challenge_info'
+require_relative 'payments/models/challenged_action_list'
+require_relative 'payments/models/challenged_response'
+require_relative 'payments/models/conflict_payment_instrument'
+require_relative 'payments/models/device_data_response201'
+require_relative 'payments/models/expiry_date'
+require_relative 'payments/models/fraud'
+require_relative 'payments/models/issuer'
+require_relative 'payments/models/payment_refused_response'
+require_relative 'payments/models/payments_action_complete3ds_challenge'
+require_relative 'payments/models/payments_action_settle'
+require_relative 'payments/models/payments_exemption'
+require_relative 'payments/models/payments_response'
+require_relative 'payments/models/payments_response_payment_instrument'
+require_relative 'payments/models/risk_factor'
+require_relative 'payments/models/token'
+require_relative 'payments/models/token_response_conflicts'
+require_relative 'payments/models/unsuccessful_authentication_response'
+require_relative 'payments/models/updated_payment_instrument'
+require_relative 'payments/models/verification'
+require_relative 'payments/models/sent_for_cancellation_response'
+require_relative 'payments/models/sent_for_settlement_action_list'
+require_relative 'payments/models/sent_for_settlement_response'
+require_relative 'payments/models/challenge_response202'
+require_relative 'payments/models/challenge_response201'
+require_relative 'payments/models/account_history'
+require_relative 'payments/models/applepay_payments_instruction'
+require_relative 'payments/models/cancellation'
+require_relative 'payments/models/card_payment_instrument'
+require_relative 'payments/models/card_payments_instruction'
+require_relative 'payments/models/payment_instrument'
+require_relative 'payments/models/challenge'
+require_relative 'payments/models/custom'
+require_relative 'payments/models/customer'
+require_relative 'payments/models/device_data'
+require_relative 'payments/models/exemption'
+require_relative 'payments/models/googlepay_payments_instruction'
+require_relative 'payments/models/installment_plan'
+require_relative 'payments/models/merchant'
+require_relative 'payments/models/narrative'
+require_relative 'payments/models/payment_request'
+require_relative 'payments/models/payments_bank_account'
+require_relative 'payments/models/payments_card_account'
+require_relative 'payments/models/payments_card_on_file_customer_agreement'
+require_relative 'payments/models/payments_card_plain_payment_instrument'
+require_relative 'payments/models/payments_customer_agreement'
+require_relative 'payments/models/payments_email_account'
+require_relative 'payments/models/payments_fraud'
+require_relative 'payments/models/payments_funds_recipient'
+require_relative 'payments/models/payments_funds_sender'
+require_relative 'payments/models/payments_funds_transfer'
+require_relative 'payments/models/payments_gift_cards_purchase'
+require_relative 'payments/models/payments_installment_customer_agreement'
+require_relative 'payments/models/payments_instruction'
+require_relative 'payments/models/payments_network_token_payment_instrument'
+require_relative 'payments/models/payments_payment_facilitator'
+require_relative 'payments/models/payments_payment_instrument'
+require_relative 'payments/models/payments_phone_account'
+require_relative 'payments/models/payments_recipient'
+require_relative 'payments/models/payments_recipient_account'
+require_relative 'payments/models/payments_recipient_address'
+require_relative 'payments/models/payments_shipping_address'
+require_relative 'payments/models/payments_social_network_account'
+require_relative 'payments/models/payments_sub_merchant'
+require_relative 'payments/models/payments_sub_merchant_address'
+require_relative 'payments/models/payments_subscription_customer_agreement'
+require_relative 'payments/models/payments_three_ds'
+require_relative 'payments/models/payments_transfer_address'
+require_relative 'payments/models/payments_unscheduled_customer_agreement'
+require_relative 'payments/models/payments_wallet_account'
+require_relative 'payments/models/routing'
+require_relative 'payments/models/session_payment_instrument'
+require_relative 'payments/models/settlement'
+require_relative 'payments/models/shipping'
+require_relative 'payments/models/token_creation'
+require_relative 'payments/models/token_payment_instrument'
+require_relative 'payments/models/transaction_history'
+require_relative 'payments/models/wallet_payment_instrument'
+require_relative 'payments/models/payments_response202'
+require_relative 'payments/models/device_data_collection'
+require_relative 'payments/models/device_data_required_action_list'
+require_relative 'payments/models/device_data_required_response'
+require_relative 'payments/models/fraud_high_risk_response'
+require_relative 'payments/models/payments_action_supply3ds_device_data'
+require_relative 'payments/models/query_action_list'
+require_relative 'payments/models/query_events_response'
+require_relative 'payments/models/authorization_requested'
+require_relative 'payments/models/authorization_succeeded'
+require_relative 'payments/models/authorization_refused'
+require_relative 'payments/models/authorization_failed'
+require_relative 'payments/models/authorization_timed_out'
+require_relative 'payments/models/sale_requested'
+require_relative 'payments/models/sale_succeeded'
+require_relative 'payments/models/sale_refused'
+require_relative 'payments/models/sale_failed'
+require_relative 'payments/models/sale_timed_out'
+require_relative 'payments/models/settlement_requested'
+require_relative 'payments/models/settlement_request_submitted'
+require_relative 'payments/models/settlement_failed'
+require_relative 'payments/models/settlement_timed_out'
+require_relative 'payments/models/refund_requested'
+require_relative 'payments/models/refund_request_submitted'
+require_relative 'payments/models/refund_failed'
+require_relative 'payments/models/refund_timed_out'
+require_relative 'payments/models/cancellation_requested'
+require_relative 'payments/models/cancellation_request_submitted'
+require_relative 'payments/models/cancellation_failed'
+require_relative 'payments/models/cancellation_timed_out'
+require_relative 'payments/models/reversal_requested'
+require_relative 'payments/models/reversal_request_submitted'
+require_relative 'payments/models/reversal_failed'
+require_relative 'payments/models/reversal_timed_out'
+require_relative 'payments/models/pq_querybypaymentid200_response'
+require_relative 'payments/models/pq_querybydaterange200_response'
+require_relative 'payments/models/pq_queryhistoricalpayments200_response'
+require_relative 'payments/models/card'
+require_relative 'payments/models/card1'
+require_relative 'payments/models/card3'
+require_relative 'payments/models/customer_agreement'
+require_relative 'payments/models/embedded'
+require_relative 'payments/models/embedded1'
+require_relative 'payments/models/error'
+require_relative 'payments/models/expiry_date1'
+require_relative 'payments/models/issuer1'
+require_relative 'payments/models/links'
+require_relative 'payments/models/links1'
+require_relative 'payments/models/links2'
+require_relative 'payments/models/links3'
+require_relative 'payments/models/narrative1'
+require_relative 'payments/models/narrative2'
+require_relative 'payments/models/mnext'
+require_relative 'payments/models/number'
+require_relative 'payments/models/number3'
+require_relative 'payments/models/payment'
+require_relative 'payments/models/payment1'
+require_relative 'payments/models/payment_instrument4'
+require_relative 'payments/models/payment_instrument6'
+require_relative 'payments/models/payment_instrument7'
+require_relative 'payments/models/payments_cancel'
+require_relative 'payments/models/payments_events'
+require_relative 'payments/models/payments_partial_settle'
+require_relative 'payments/models/payments_settle'
+require_relative 'payments/models/scheme'
+require_relative 'payments/models/self1'
+require_relative 'payments/models/self2'
+require_relative 'payments/models/self3'
+require_relative 'payments/models/updated_payment_instrument1'
+require_relative 'payments/models/value1'
+require_relative 'payments/models/value2'
+require_relative 'payments/models/value3'
+require_relative 'payments/models/value4'
+require_relative 'payments/models/last_event_enum'
+require_relative 'payments/models/accept_enum'
+require_relative 'payments/models/account_updater_message_enum'
+require_relative 'payments/models/account_updater_message1_enum'
+require_relative 'payments/models/authorization_type_enum'
+require_relative 'payments/models/authorization_type1_enum'
+require_relative 'payments/models/avs_not_matched_enum'
+require_relative 'payments/models/browser_color_depth_enum'
+require_relative 'payments/models/category_enum'
+require_relative 'payments/models/channel_enum'
+require_relative 'payments/models/channel1_enum'
+require_relative 'payments/models/content_type_enum'
+require_relative 'payments/models/cvc_not_matched_enum'
+require_relative 'payments/models/detail_enum'
+require_relative 'payments/models/funding_type_enum'
+require_relative 'payments/models/identifier_type_enum'
+require_relative 'payments/models/installment_type_enum'
+require_relative 'payments/models/issuer_response_enum'
+require_relative 'payments/models/message_enum'
+require_relative 'payments/models/method_enum'
+require_relative 'payments/models/name_enum'
+require_relative 'payments/models/outcome_enum'
+require_relative 'payments/models/outcome6_enum'
+require_relative 'payments/models/outcome7_enum'
+require_relative 'payments/models/outcome16_enum'
+require_relative 'payments/models/outcome17_enum'
+require_relative 'payments/models/placement_enum'
+require_relative 'payments/models/preference_enum'
+require_relative 'payments/models/preferred_card_brand_enum'
+require_relative 'payments/models/purpose_enum'
+require_relative 'payments/models/reason_enum'
+require_relative 'payments/models/result_enum'
+require_relative 'payments/models/risk_enum'
+require_relative 'payments/models/stored_card_usage_enum'
+require_relative 'payments/models/stored_card_usage1_enum'
+require_relative 'payments/models/time_frame_enum'
+require_relative 'payments/models/transaction_type_enum'
+require_relative 'payments/models/transaction_type1_enum'
+require_relative 'payments/models/type_enum'
+require_relative 'payments/models/type1_enum'
+require_relative 'payments/models/type2_enum'
+require_relative 'payments/models/type3_enum'
+require_relative 'payments/models/type4_enum'
+require_relative 'payments/models/type5_enum'
+require_relative 'payments/models/type6_enum'
+require_relative 'payments/models/type7_enum'
+require_relative 'payments/models/type8_enum'
+require_relative 'payments/models/type9_enum'
+require_relative 'payments/models/type10_enum'
+require_relative 'payments/models/type12_enum'
+require_relative 'payments/models/user_type_enum'
+require_relative 'payments/models/window_size_enum'
+require_relative 'payments/models/wp_api_version_enum'
+
+# Exceptions
+require_relative 'payments/exceptions/api_exception'
+require_relative 'payments/exceptions/error_response_exception'
+require_relative 'payments/exceptions/header_error_response_exception'
+require_relative 'payments/exceptions/validation_error_response_exception'
+require_relative 'payments/exceptions/pq_querybydaterange400_response_exception'
+require_relative 'payments/exceptions/' \
+                 'pq_queryhistoricalpayments400_response_exception'
+require_relative 'payments/exceptions/' \
+                 'pq_querybypaymentid404_response_error_exception'
+
+require_relative 'payments/configuration'
+
+# Controllers
+require_relative 'payments/controllers/base_controller'
+require_relative 'payments/controllers/payment_controller'
+require_relative 'payments/controllers/m3_ds_actions_controller'
+require_relative 'payments/controllers/manage_payments_controller'
+require_relative 'payments/controllers/payment_queries_controller'

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,29 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'json'
+require 'minitest/autorun'
+require 'minitest/hell'
+require 'minitest/pride'
+require 'minitest/proveit'
+require 'payments'
+require_relative '../http_response_catcher'
+
+class ControllerTestBase < Minitest::Test
+  parallelize_me!
+  include Payments
+  include CoreLibrary
+
+  # Create configuration and set any test parameters
+  def create_configuration
+    Configuration.new(http_callback: HttpResponseCatcher.new)
+  end
+
+  # Initializes the base test controller
+  def setup_class
+    _config = create_configuration
+    @client = Client.new(config: _config)
+  end
+end

data/test/controllers/test_payment_controller.rb

@@ -0,0 +1,161 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class PaymentControllerTest < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    setup_class
+    @controller = @client.payment
+    @response_catcher = @controller.http_call_back
+  end
+
+  # Initiate Payment. Take merchant entity as default if not provided
+  def test_payment
+    # Parameters for the API call
+    wp_api_version = '2024-06-01'
+    body = PaymentRequest.from_hash(APIHelper.json_deserialize(
+      '{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"de'\
+      'fault"},"instruction":{"method":"card","paymentInstrument":{"type":"pla'\
+      'in","cardHolderName":"Sherlock Holmes","cardNumber":"4000000000001091",'\
+      '"expiryDate":{"month":5,"year":2035},"billingAddress":{"address1":"221B'\
+      ' Baker Street","address2":"Marylebone","address3":"Westminster","postal'\
+      'Code":"SW1 1AA","city":"London","state":"Greater London","countryCode":'\
+      '"GB"},"cvc":"123"},"narrative":{"line1":"trading name"},"value":{"curre'\
+      'ncy":"GBP","amount":42}}}', false))
+
+    # Perform the API call through the SDK function
+    result = @controller.payment(wp_api_version, body)
+
+    # Test response code
+    assert_equal(201, @response_catcher.response.status_code)
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json; charset=utf-8'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    refute_nil(result)
+    expected_body = JSON.parse(
+      '{"outcome":"authorized","transactionReference":"Memory265-13/08/1876","'\
+      'schemeReference":"060720116005060","issuer":{"authorizationCode":"67572'\
+      '5"},"riskFactors":[{"risk":"notChecked","type":"cvc"},{"risk":"notCheck'\
+      'ed","detail":"address","type":"avs"},{"risk":"notChecked","detail":"pos'\
+      'tcode","type":"avs"}],"paymentInstrument":{"type":"card/plain+masked","'\
+      'cardBin":"400000","lastFour":"1000","countryCode":"GB","expiryDate":{"y'\
+      'ear":2035,"month":5},"cardBrand":"mastercard","fundingType":"debit","ca'\
+      'tegory":"consumer","issuerName":"BANK LIMITED","paymentAccountReference'\
+      '":"3001DBT34Q41D6J7PFC5W0UACOT4C"},"_links":{"self":{"href":"https://tr'\
+      'y.access.worldpay.com/api/payments/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9u'\
+      'IjoiNS4wLjAifQ%3D%3D.sN%3Ag8wd64bwkbrp0md%2BbPxcanBnk2zLdsIqSa1pR99GeDr'\
+      'CwEtsymFb5gQw9WlrStDTK3eIWPy93y%3A7njc4649JSrU7%2BvFDl1J36%2BcwOkX0lW4Z'\
+      '%2BfnZKMutoUGX3m1%3AmZ%2BxHZ9nDpadu%2BBh7pRyJwnWeiSFTlqKvbrBxNm3HV0xann'\
+      '55pFjZ7qi4DNGZtx9zW6eOLVNOsPL6ecsn3Dp377s7pWRQKSZJKSFIJvAisP8cBzFPzqire'\
+      'uqfCu5ojcm60gRSsqS3glurO24RJkg5SrpRjgY6g7ca8uoA7tKDk9OVOIwORF5sGPHSSGMa'\
+      '2bEl2lMUkAANoWclQHiGzxWQQ%3AAwSoo6RsrBugbhEp0K8HxZkfVrqy4oVlW8FdQ7kIuZO'\
+      'H78i6pPLzArc%2BOtMdnU%3ArZ%3AVhRHFzbbwymcuTiRbNw%3D"}},"_actions":{"can'\
+      'celPayment":{"href":"https://try.access.worldpay.com/api/payments/eyJrI'\
+      'joiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNS4wLjAifQ%3D%3D.sN%3Ag8wd64bwkbrp0m'\
+      'd%2BbPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y%3A7njc46'\
+      '49JSrU7%2BvFDl1J36%2BcwOkX0lW4Z%2BfnZKMutoUGX3m1%3AmZ%2BxHZ9nDpadu%2BBh'\
+      '7pRyJwnWeiSFTlqKvbrBxNm3HV0xann55pFjZ7qi4DNGZtx9zW6eOLVNOsPL6ecsn3Dp377'\
+      's7pWRQKSZJKSFIJvAisP8cBzFPzqireuqfCu5ojcm60gRSsqS3glurO24RJkg5SrpRjgY6g'\
+      '7ca8uoA7tKDk9OVOIwORF5sGPHSSGMa2bEl2lMUkAANoWclQHiGzxWQQ%3AAwSoo6RsrBug'\
+      'bhEp0K8HxZkfVrqy4oVlW8FdQ7kIuZOH78i6pPLzArc%2BOtMdnU%3ArZ%3AVhRHFzbbwym'\
+      'cuTiRbNw%3D/cancellations","method":"POST"},"settlePayment":{"href":"ht'\
+      'tps://try.access.worldpay.com/api/payments/eyJrIjoiazNhYjYzMiIsImxpbmtW'\
+      'ZXJzaW9uIjoiNS4wLjAifQ%3D%3D.sN%3Ag8wd64bwkbrp0md%2BbPxcanBnk2zLdsIqSa1'\
+      'pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y%3A7njc4649JSrU7%2BvFDl1J36%2Bcw'\
+      'OkX0lW4Z%2BfnZKMutoUGX3m1%3AmZ%2BxHZ9nDpadu%2BBh7pRyJwnWeiSFTlqKvbrBxNm'\
+      '3HV0xann55pFjZ7qi4DNGZtx9zW6eOLVNOsPL6ecsn3Dp377s7pWRQKSZJKSFIJvAisP8cB'\
+      'zFPzqireuqfCu5ojcm60gRSsqS3glurO24RJkg5SrpRjgY6g7ca8uoA7tKDk9OVOIwORF5s'\
+      'GPHSSGMa2bEl2lMUkAANoWclQHiGzxWQQ%3AAwSoo6RsrBugbhEp0K8HxZkfVrqy4oVlW8F'\
+      'dQ7kIuZOH78i6pPLzArc%2BOtMdnU%3ArZ%3AVhRHFzbbwymcuTiRbNw%3D/settlements'\
+      '","method":"POST"},"partiallySettlePayment":{"href":"https://try.access'\
+      '.worldpay.com/api/payments/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNS4w'\
+      'LjAifQ%3D%3D.sN%3Ag8wd64bwkbrp0md%2BbPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymF'\
+      'b5gQw9WlrStDTK3eIWPy93y%3A7njc4649JSrU7%2BvFDl1J36%2BcwOkX0lW4Z%2BfnZKM'\
+      'utoUGX3m1%3AmZ%2BxHZ9nDpadu%2BBh7pRyJwnWeiSFTlqKvbrBxNm3HV0xann55pFjZ7q'\
+      'i4DNGZtx9zW6eOLVNOsPL6ecsn3Dp377s7pWRQKSZJKSFIJvAisP8cBzFPzqireuqfCu5oj'\
+      'cm60gRSsqS3glurO24RJkg5SrpRjgY6g7ca8uoA7tKDk9OVOIwORF5sGPHSSGMa2bEl2lMU'\
+      'kAANoWclQHiGzxWQQ%3AAwSoo6RsrBugbhEp0K8HxZkfVrqy4oVlW8FdQ7kIuZOH78i6pPL'\
+      'zArc%2BOtMdnU%3ArZ%3AVhRHFzbbwymcuTiRbNw%3D/partialSettlements","method'\
+      '":"POST"}}}'
+    )
+    received_body = JSON.parse(@response_catcher.response.raw_body)
+    assert(ComparisonHelper.match_body(expected_body, received_body))
+  end
+
+  # Initiate Payment. Take merchant entity as default if not provided
+  def test_payment1
+    # Parameters for the API call
+    wp_api_version = '2024-06-01'
+    body = PaymentRequest.from_hash(APIHelper.json_deserialize(
+      '{"transactionReference":"Memory265-13/08/1876","merchant":{"entity":"de'\
+      'fault"},"instruction":{"method":"card","paymentInstrument":{"type":"pla'\
+      'in","cardHolderName":"Sherlock Holmes","cardNumber":"4000000000001091",'\
+      '"expiryDate":{"month":5,"year":2035},"billingAddress":{"address1":"221B'\
+      ' Baker Street","address2":"Marylebone","address3":"Westminster","postal'\
+      'Code":"SW1 1AA","city":"London","state":"Greater London","countryCode":'\
+      '"GB"},"cvc":"123"},"narrative":{"line1":"trading name"},"value":{"curre'\
+      'ncy":"GBP","amount":42}}}', false))
+
+    # Perform the API call through the SDK function
+    result = @controller.payment(wp_api_version, body)
+
+    # Test response code
+    assert_equal(202, @response_catcher.response.status_code)
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json; charset=utf-8'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    refute_nil(result)
+    expected_body = JSON.parse(
+      '{"outcome":"sentForSettlement","transactionReference":"Memory265-13/08/'\
+      '1876","schemeReference":"060720116005060","issuer":{"authorizationCode"'\
+      ':"675725"},"riskFactors":[{"risk":"notChecked","type":"cvc"},{"risk":"n'\
+      'otChecked","detail":"address","type":"avs"},{"risk":"notChecked","detai'\
+      'l":"postcode","type":"avs"}],"paymentInstrument":{"type":"card/plain+ma'\
+      'sked","cardBin":"400000","lastFour":"1000","countryCode":"GB","expiryDa'\
+      'te":{"year":2035,"month":5},"cardBrand":"mastercard","fundingType":"deb'\
+      'it","category":"consumer","issuerName":"BANK LIMITED","paymentAccountRe'\
+      'ference":"3001DBT34Q41D6J7PFC5W0UACOT4C"},"_links":{"self":{"href":"htt'\
+      'ps://try.access.worldpay.com/api/payments/eyJrIjoiazNhYjYzMiIsImxpbmtWZ'\
+      'XJzaW9uIjoiNS4wLjAifQ%3D%3D.sN%3Ag8wd64bwkbrp0md%2BbPxcanBnk2zLdsIqSa1p'\
+      'R99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y%3A7njc4649JSrU7%2BvFDl1J36%2BcwO'\
+      'kX0lW4Z%2BfnZKMutoUGX3m1%3AmUCGmlXGGNqJmZcIdZa%3Aufi8N9Y8uwrkGtx1suHsSF'\
+      'nXn2PMsm%3AcRBXHzZt3giUlFW6eOLVNOsPL6ecsn3Dp377s7pWRQKSZJKSFIJvAisP8cBz'\
+      'FPzqireuqfCu5ojcm60gRSsqS3glurO24RJkg5SrpRjgY6g7ca8uoA7tKDk9OVOIwORF5sG'\
+      'PHSSGMa2bEl2lMUkAANoWclQHiGzxWQQ2hKYh1GAhFAwfPvBamw%3AisDwI2AuXQ9KT%3AM'\
+      't9SY%3AfYERqcZ58SBNT3Gkwn1j%2Bkd7LZ%3AVhRHFzbbwymcuTiRbNw%3D"}},"_actio'\
+      'ns":{"refundPayment":{"href":"https://try.access.worldpay.com/api/payme'\
+      'nts/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNS4wLjAifQ%3D%3D.sN%3Ag8wd6'\
+      '4bwkbrp0md%2BbPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y'\
+      '%3A7njc4649JSrU7%2BvFDl1J36%2BcwOkX0lW4Z%2BfnZKMutoUGX3m1%3AmUCGmlXGGNq'\
+      'JmZcIdZa%3Aufi8N9Y8uwrkGtx1suHsSFnXn2PMsm%3AcRBXHzZt3giUlFW6eOLVNOsPL6e'\
+      'csn3Dp377s7pWRQKSZJKSFIJvAisP8cBzFPzqireuqfCu5ojcm60gRSsqS3glurO24RJkg5'\
+      'SrpRjgY6g7ca8uoA7tKDk9OVOIwORF5sGPHSSGMa2bEl2lMUkAANoWclQHiGzxWQQ2hKYh1'\
+      'GAhFAwfPvBamw%3AisDwI2AuXQ9KT%3AMt9SY%3AfYERqcZ58SBNT3Gkwn1j%2Bkd7LZ%3A'\
+      'VhRHFzbbwymcuTiRbNw%3D/refunds","method":"POST"},"partiallyRefundPaymen'\
+      't":{"href":"https://try.access.worldpay.com/api/payments/eyJrIjoiazNhYj'\
+      'YzMiIsImxpbmtWZXJzaW9uIjoiNS4wLjAifQ%3D%3D.sN%3Ag8wd64bwkbrp0md%2BbPxca'\
+      'nBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y%3A7njc4649JSrU7%2'\
+      'BvFDl1J36%2BcwOkX0lW4Z%2BfnZKMutoUGX3m1%3AmUCGmlXGGNqJmZcIdZa%3Aufi8N9Y'\
+      '8uwrkGtx1suHsSFnXn2PMsm%3AcRBXHzZt3giUlFW6eOLVNOsPL6ecsn3Dp377s7pWRQKSZ'\
+      'JKSFIJvAisP8cBzFPzqireuqfCu5ojcm60gRSsqS3glurO24RJkg5SrpRjgY6g7ca8uoA7t'\
+      'KDk9OVOIwORF5sGPHSSGMa2bEl2lMUkAANoWclQHiGzxWQQ2hKYh1GAhFAwfPvBamw%3Ais'\
+      'DwI2AuXQ9KT%3AMt9SY%3AfYERqcZ58SBNT3Gkwn1j%2Bkd7LZ%3AVhRHFzbbwymcuTiRbN'\
+      'w%3D/partialRefunds","method":"POST"}}}'
+    )
+    received_body = JSON.parse(@response_catcher.response.raw_body)
+    assert(ComparisonHelper.match_body(expected_body, received_body))
+  end
+
+end

data/test/controllers/test_payment_queries_controller.rb

@@ -0,0 +1,68 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class PaymentQueriesControllerTest < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    setup_class
+    @controller = @client.payment_queries
+    @response_catcher = @controller.http_call_back
+  end
+
+  # Retrieve a single payment by payment ID.
+  #
+  #The API returns detailed data for payments processed after 25 June 2024. For payments processed before then use our [query for historical payments](/products/payment-queries/@v1/query-archive.md).
+  def test_retrieve_by_payment_id
+    # Parameters for the API call
+    accept = 'application/vnd.worldpay.payment-queries-v1.hal+json'
+    payment_id = 'payv0A4Hx2eY1-5P2_CpV7qy0'
+
+    # Perform the API call through the SDK function
+    result = @controller.retrieve_by_payment_id(accept, payment_id)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/vnd.worldpay.payment-queries-v1.hal+json'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    refute_nil(result)
+    expected_body = JSON.parse(
+      '{"timestamp":"2025-06-08T16:11:13.164Z","paymentId":"payVGX28GOT7iDY5qa'\
+      'nttPWF0","transactionReference":"89197aeb-c94a-456e-8014-1272fbcb64eb",'\
+      '"narrative":{"line1":"trading name","line2":"order number"},"transactio'\
+      'nType":"oneTime","authorizationType":"authorization","entity":"default"'\
+      ',"lastEvent":"authorizationSucceeded","issuer":{"authorizationCode":"T3'\
+      '1306"},"scheme":{"reference":"MCCOLXT1C0104  "},"paymentInstrument":{"t'\
+      'ype":"card/plain+masked","card":{"number":{"last4Digits":"1111","cardBi'\
+      'n":"444433"},"brand":"visa","expiryDate":{"month":5,"year":2030},"count'\
+      'ryCode":"GB","fundingType":"credit","issuerName":"AN ISSUING BANK LTD",'\
+      '"paymentAccountReference":"Q1HJZ28RKA1EBL470G9XYG90R5D3E","category":"c'\
+      'onsumer"}},"value":{"currency":"GBP","amount":1200},"events":[{"eventNa'\
+      'me":"authorizationRequested","timestamp":"2025-06-08T16:11:13.164Z","co'\
+      'mmandId":"cmd0-IiS92BsJR8VaJ10V_420"},{"eventName":"authorizationSuccee'\
+      'ded","timestamp":"2025-06-08T16:11:14.229Z","outcome":"authorized","com'\
+      'mandId":"cmd0-IiS92BsJR8VaJ10V_420"}],"_links":{"self":{"href":"/paymen'\
+      'tQueries/payments/payv0A4Hx2eY1-5P2_CpV7qy0"},"cardPayments:cancel":{"h'\
+      'ref":"https://access.worldpay.com/payments/authorizations/cancellations'\
+      '/{linkData}"},"cardPayments:settle":{"href":"https://access.worldpay.co'\
+      'm/payments/settlements/full/{linkData}"},"cardPayments:partialSettle":{'\
+      '"href":"https://access.worldpay.com/payments/settlements/partials/{link'\
+      'Data}"},"cardPayments:events":{"href":"https://access.worldpay.com/paym'\
+      'ents/events/{linkData}"},"cardPayments:partialCancel":{"href":"https://'\
+      'access.worldpay.com/payments/authorizations/cancellations/partials/{lin'\
+      'kData}"},"cardPayments:reverse":{"href":"https://access.worldpay.com/pa'\
+      'yments/authorizations/reversals/{linkData}"}}}'
+    )
+    received_body = JSON.parse(@response_catcher.response.raw_body)
+    assert(ComparisonHelper.match_body(expected_body, received_body))
+  end
+
+end

data/test/http_response_catcher.rb

@@ -0,0 +1,19 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+class HttpResponseCatcher < Payments::HttpCallBack
+  attr_reader :response
+
+  def on_before_request(request)
+  end
+
+  # Catching the response
+  def on_after_response(response)
+    @response = response
+  end
+end
+
+
+