bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/controllers/charge_controller.rb

@@ -0,0 +1,247 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # ChargeController
+  class ChargeController < BaseController
+    # The 'charge' request processes a payment against a previously authorized
+    # opt-in. The 'optin-id' received in the 'optin'/'confirm-optin' response
+    # must be supplied in order to validate the consumer payment method.
+    # If the 'optin-id' and the other parameters of the request are valid, the
+    # charge is submitted to the issuer for processing. A 'charge-id' is
+    # returned in the API response.
+    # 'Charge' may operate as a synchronous request, fully asynchronous, or
+    # synchronous with fallback to asynchronous after a timeout. The timeout is
+    # supplied with the request, or can default to a value configurable for the
+    # merchant. The 'charge' method returns a unique 'charge-id' in all cases
+    # where the request has been accepted for processing, including success,
+    # failure, and pending cases.
+    # The 'charge' method is idempotent. If the same request is sent again (with
+    # the same 'merchant-request-id'), Boku will return the current status of
+    # the transaction. For example:
+    # * If the transaction has completed successfully, a response code of "0"
+    # will be returned.
+    # * If the transaction has completed with a billing error, a response code
+    # of "107" will be   returned
+    # * If the charge request has been accepted and is being processed, a
+    # response code of "139" will   be returned. Final confirmation may take
+    # several days, depending on the payment method (e.g.,   direct debit).
+    # @param [ChargeRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ChargeResponse] Response from the API call.
+    def charge(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/billing/3.0/charge',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/xml', key: 'Content-Type'))
+                   .xml_attributes(XmlAttributes.new
+                                                .value(body)
+                                                .root_element_name('charge-request'))
+                   .header_param(new_parameter('application/xml', key: 'accept'))
+                   .body_serializer(XmlUtilities.method(:serialize_to_xml)))
+        .response(new_response_handler
+                    .deserializer(XmlUtilities.method(:deserialize_xml))
+                    .deserialize_into(ChargeResponse)
+                    .is_xml_response(true)
+                    .xml_attribute(XmlAttributes.new
+                                                .root_element_name('charge-response')))
+        .execute
+    end
+
+    # Retrieves the status and all details of prior charges matching the given
+    # request criteria.
+    # Each returned charge element is similar to a charge-response: although
+    # some elements are missing, all present elements have the same names,
+    # format and meaning as those in the original charge-response.
+    # The query-charge API call is guaranteed to return transactions up to 1
+    # year old. If the transaction was created before that period, this API may
+    # return no results.
+    # Criteria are evaluated in an AND fashion, i.e. if more than one field is
+    # supplied then all will be used to filter the returned charge elements. In
+    # normal usage this is not relevant, since you would only supply one of the
+    # three fields by itself.
+    # The query-charge request one of the following values to be exclusively
+    # provided: charge-id, merchant-request-id, or merchant-transaction-id.
+    # @param [QueryChargeRequest] body Required parameter: TODO: type
+    # description here
+    # @return [QueryChargeResponse] Response from the API call.
+    def query_charge(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/billing/3.0/query-charge',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/xml', key: 'Content-Type'))
+                   .xml_attributes(XmlAttributes.new
+                                                .value(body)
+                                                .root_element_name('query-charge-request'))
+                   .header_param(new_parameter('application/xml', key: 'accept'))
+                   .body_serializer(XmlUtilities.method(:serialize_to_xml)))
+        .response(new_response_handler
+                    .deserializer(XmlUtilities.method(:deserialize_xml))
+                    .deserialize_into(QueryChargeResponse)
+                    .is_xml_response(true)
+                    .xml_attribute(XmlAttributes.new
+                                                .root_element_name('query-charge-response')))
+        .execute
+    end
+
+    # **DISCLAIMER: This API is use-case specific and not required for standard
+    # payment product integrations. Please disregard unless otherwise directed
+    # to include in your integration.**
+    #  The Reverse Charge API reverses a charge request. This method is
+    # typically used when the result of a prior charge is unknown, and the
+    # charge was made within the last hour.
+    #  An unknown result can occur for several reasons:
+    #  * Network issue
+    #  * Request timed out by merchant
+    #  * Response received but could not be recorded
+    #  Reverse charge requests should be submitted within one hour of the
+    # original charge. Requests submitted after one hour will be rejected. In
+    # those cases, use the Refund Charge API instead.
+    #  _**NOTE:** The Reverse Charge API is not applicable for direct debit
+    # charge requests. This is because direct debit transactions (e.g., BACS)
+    # are processed asynchronously through banking networks and cannot be
+    # programmatically reversed once submitted. Use the Refund Charge API to
+    # reverse a direct debit charge._
+    #  Due to the 24-hour idempotency window on charge requests, a reverse
+    # charge made more than 24 hours after the original request could still
+    # succeed and impact settlement reports. Boku strongly recommends using the
+    # Refund Charge API for any charge ID older than 24 hours.
+    #  In most cases, a reversal request will return a status of "OK" even if
+    # Boku never received the original charge.
+    # @param [ReverseChargeRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ReverseChargeResponse] Response from the API call.
+    def reverse_charge(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/billing/3.0/reverse-charge',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/xml', key: 'Content-Type'))
+                   .xml_attributes(XmlAttributes.new
+                                                .value(body)
+                                                .root_element_name('reverse-charge-request'))
+                   .header_param(new_parameter('application/xml', key: 'accept'))
+                   .body_serializer(XmlUtilities.method(:serialize_to_xml)))
+        .response(new_response_handler
+                    .deserializer(XmlUtilities.method(:deserialize_xml))
+                    .deserialize_into(ReverseChargeResponse)
+                    .is_xml_response(true)
+                    .xml_attribute(XmlAttributes.new
+                                                .root_element_name('reverse-charge-response')))
+        .execute
+    end
+
+    # The purpose of the 'begin-single-charge' API call is to initiate a one
+    # time charge. Currently, this feature is limited to eWallet payment methods
+    # only. The 'begin-single-charge' call initiates a process in which a
+    # consumer is required to authenticate themselves each time a purchase is
+    # requested. This API provides a payment option for consumers who choose not
+    # to save a payment method with the merchant.
+    # The Merchant can obtain information on the status of the charge made
+    # through the 'begin-single-charge' API in the following ways
+    # * 'query-charge' API
+    # * notification to a Merchant's notification URL specified in the
+    # 'begin-single-charge' request
+    # @param [BeginSingleChargeRequest] body Required parameter: TODO: type
+    # description here
+    # @return [BeginSingleChargeResponse] Response from the API call.
+    def begin_single_charge(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/billing/3.0/begin-single-charge',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/xml', key: 'Content-Type'))
+                   .xml_attributes(XmlAttributes.new
+                                                .value(body)
+                                                .root_element_name('begin-single-charge-request'))
+                   .header_param(new_parameter('application/xml', key: 'accept'))
+                   .body_serializer(XmlUtilities.method(:serialize_to_xml)))
+        .response(new_response_handler
+                    .deserializer(XmlUtilities.method(:deserialize_xml))
+                    .deserialize_into(BeginSingleChargeResponse)
+                    .is_xml_response(true)
+                    .xml_attribute(XmlAttributes.new
+                                                .root_element_name('begin-single-charge-response')))
+        .execute
+    end
+
+    # **DISCLAIMER: This API or element is use-case specific and not needed for
+    # generic usage of our payment product. Please disregard unless otherwise
+    # directed to include in your integration.**
+    # The 'charge-msisdn' request processes a payment against previously
+    # obtained consumer consent for charging.
+    # If the 'network', 'msisdn' and 'country' and the other parameters of the
+    # request are valid, the charge is submitted to the operator for processing.
+    # A 'charge-id' is returned in the API response.
+    # 'Charge-msisdn' will operate as a synchronous request. The timeout is
+    # supplied with the request, or can default to a value configurable per
+    # merchant. The 'charge-msisdn' method returns a unique 'charge-id' in all
+    # cases where the request has been accepted for processing, including
+    # success, failure, and pending cases.
+    # The 'charge-msisdn' method is idempotent. If the same request is sent
+    # again (with the same 'merchant-request-id'), Boku will return the current
+    # status of the transaction. For example:
+    # If the transaction has completed successfully, a response code of "0" will
+    # be returned.
+    # If the transaction has completed with a billing error, a response code of
+    # "107" will be returned
+    # @param [ChargeMsisdnRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ChargeResponse] Response from the API call.
+    def charge_msisdn(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/billing/3.0/charge-msisdn',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/xml', key: 'Content-Type'))
+                   .xml_attributes(XmlAttributes.new
+                                                .value(body)
+                                                .root_element_name('charge-msisdn-request'))
+                   .header_param(new_parameter('application/xml', key: 'accept'))
+                   .body_serializer(XmlUtilities.method(:serialize_to_xml)))
+        .response(new_response_handler
+                    .deserializer(XmlUtilities.method(:deserialize_xml))
+                    .deserialize_into(ChargeResponse)
+                    .is_xml_response(true)
+                    .xml_attribute(XmlAttributes.new
+                                                .root_element_name('charge-response')))
+        .execute
+    end
+
+    # The purpose of the 'charge-plus-optin' API call is to initiate a one time
+    # charge and create an optin that becomes valid once the charge is complete.
+    # Currently, this feature is limited to certain eWallet payment methods
+    # only.
+    # After a `charge-plus-optin` call, an opt-in is usually in status
+    # `pending-validate`.
+    # The Merchant can obtain information on the status of the charge made
+    # through the 'charge-plus-optin' API in from the notification to the
+    # notification URL specified in the 'charge-plus-optin' request
+    # @param [ChargePlusOptinRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ChargePlusOptinResponse] Response from the API call.
+    def charge_plus_optin(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/billing/3.0/charge-plus-optin',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/xml', key: 'Content-Type'))
+                   .xml_attributes(XmlAttributes.new
+                                                .value(body)
+                                                .root_element_name('charge-plus-optin-request'))
+                   .header_param(new_parameter('application/xml', key: 'accept'))
+                   .body_serializer(XmlUtilities.method(:serialize_to_xml)))
+        .response(new_response_handler
+                    .deserializer(XmlUtilities.method(:deserialize_xml))
+                    .deserialize_into(ChargePlusOptinResponse)
+                    .is_xml_response(true)
+                    .xml_attribute(XmlAttributes.new
+                                                .root_element_name('charge-plus-optin-response')))
+        .execute
+    end
+  end
+end

data/lib/boku_direct_payments_api/controllers/config_resources_controller.rb

@@ -0,0 +1,50 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # ConfigResourcesController
+  class ConfigResourcesController < BaseController
+    # **DISCLAIMER: This API or element is use-case specific and not needed for
+    # generic usage of our payment product. Please disregard unless otherwise
+    # directed to include in your integration.**
+    # The network-info call allows retrieval of relatively static data about the
+    # identity and properties of all mobile networks (carriers) available on the
+    # system.
+    # There are two main purposes for this information:
+    # * Some operations require knowledge of the particular mobile network the
+    # user's handset resides on. If using a mobile device, this may be derivable
+    # using the network-info in conjunction with the device MCC and MNC.
+    # * Some of the below API calls return the network upon which a particular
+    # transaction occurred by referring to the ID, so this API may provide
+    # information about what that ID means.
+    # The canonical network ID in this API uses an internal proprietary scheme,
+    # rather than a public standard identifier. Unfortunately there is no good
+    # international standard for representing networks at the granularity that
+    # makes sense for a high-level billing service - ITU E.212 specifies MCC and
+    # MNC codes, but most logical networks are represented by many different
+    # codes due to historical merging of smaller networks or simply different
+    # physical networks for regions within the same country. The MCC/MNC list
+    # also changes on a not infrequent basis, which E.212 is not always
+    # up-to-date with.
+    # Any network ID returned by the payment gateway or batch files is always
+    # guaranteed to be found in the 'network-info' response and associated with
+    # a human readable name.
+    # @return [NetworkInfo] Response from the API call.
+    def get_network_info
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/config/3.0/network-info',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/xml', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(XmlUtilities.method(:deserialize_xml))
+                    .deserialize_into(NetworkInfo)
+                    .is_xml_response(true)
+                    .xml_attribute(XmlAttributes.new
+                                                .root_element_name('network-info')))
+        .execute
+    end
+  end
+end