ps-apimatic-sdk 0.0.1

data/lib/paysecure_api_documentation_live/apis/m_paypal_wallet_api.rb

@@ -0,0 +1,126 @@
+# paysecure_api_documentation_live
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PaysecureApiDocumentationLive
+  # MPaypalWalletApi
+  class MPaypalWalletApi < BaseApi
+    # To Initiate a payment, the very first call to make is `/purchases` with
+    # the required data in the request body.
+    # To generate a Purchase, you are required to provide the `Brand ID` (in the
+    # request body) and `API key` (in the header) Both can be located in the
+    # Dashboard section of your merchant account login.
+    # The request body structure is shown on the request body of the example
+    # request shown here.
+    # The following (see table below) are the mandatory parameters that are
+    # required to create a purchase request.
+    # ### **Mandatory parameters in the request body:**
+    # | **Parameter** | **Notes** |
+    # | --- | --- |
+    # | client.email | The customer's email. |
+    # | client.city | The customer's city. |
+    # | client.country | ISO-3166 Country Code. Must be upper case. Example “SG”
+    # (Alpha2) |
+    # | client.stateCode | Example “AL”, “XZ”. Must be in upper case. |
+    # | Client.street_address | The customer's address. |
+    # | client.zip_code | The customer's ZIP or postal code. If country=US, zip
+    # format must be NNNNN or NNNNN-NNNN. |
+    # | purchase.currency | ISO 4217 code for currency you want to send the
+    # transaction in.  <br>  <br>Please note, the currency has to be enabled by
+    # the account manager for your account. |
+    # | purchase.products | An object which contains the list of products which
+    # the customer is buying. |
+    # | purchase.products.name | The name of the product. |
+    # | purchase.products.price | Price in decimal format.  <br>example 1:
+    # <br>EUR 5 , should be sent as 5.00  <br>  <br>example 2:  <br>USD 10 and
+    # 37 cents , should be sent as 10.37 |
+    # | brand_id | Obtain from Dashboard section of your merchant account login.
+    # |
+    # | success_redirect | URL to send the user if the transactions is
+    # successful. |
+    # | pending_redirect | URL to send the user if the transactions is in
+    # pending. |
+    # | failure_redirect | URL to send the user if the transactions is
+    # unsuccessful. |
+    # ## Essential Optional Parameters
+    # ### merchantRef
+    # The `merchantRef` parameter, although not mandatory, is strongly advised
+    # for merchants to specify. Its inclusion offers two significant advantages
+    # for the merchant:
+    # 1. **Prevention of Duplicate Requests:** When a `merchantRef` is utilized,
+    # it acts as a unique identifier. This means that if a second purchase
+    # request is made using the same `merchantRef` (reference number), the
+    # system will recognize it and prevent duplicate transactions from
+    # occurring. This prevents unintended or duplicate purchases.
+    # 
+    # 2. **Facilitation of Transaction Retrieval:** In situations where the
+    # response from the initial purchase request times out or the 'purchaseId'
+    # isn't received, having the `merchantRef` allows the merchant to retrieve
+    # detailed transaction information. This ensures they can track and access
+    # the specific purchase details related to that reference, even if the
+    # immediate response was not received.
+    # 
+    # However, if the merchant does not specify the 'merchantRef' parameter, the
+    # platform will automatically assign and use an internal 'purchaseId' as a
+    # reference for that transaction.
+    # Upon successul create on a Purchase you'd get a `"purchaseId"` . Use this
+    # ID for the next step in Server to server call by calling
+    # `p/{purchaseId}/?s2s=true .`
+    # ### paymentMethod
+    # The `paymentMethod` parameter identifies which payment solution merchant
+    # wants to use to perform a transaction. If parameter is provided, than
+    # Paysecure will perform direct payment with the selected payment method
+    # instead of loading Paysecure URL.
+    # ### Errors
+    # If there are any errors then it'll be in the format of :
+    # ``` json
+    # {
+    #     "message": "descriptive error message",
+    #     "code": "error_code"
+    # }
+    #  ```
+    # ### Possible Error Messages
+    # | **Error Messages** |
+    # | --- |
+    # | Allowed Limit for this card for particular time period has been consumed
+    # |
+    # | some Mandatory Parameter are missing |
+    # | Invalid format of Date_of_Birth \[allowed format: yyyy-mm-dd\] |
+    # | Invalid Email Format |
+    # | Please submit Valid Alpha2 Country Code Ex:(AF,IN) in \\"country\\"
+    # parameter |
+    # | Please pass Valid State Code |
+    # | Please pass valid street address in \\"street_address\\" parameter |
+    # | Please pass valid city name in \\"city\\" parameter |
+    # | Please pass valid postal Code name in \\"zip_code\\" parameter |
+    # | You are not Allowed for Live Transaction |
+    # | Merchant Limit is not set |
+    # | Minimum amount is not set for this merchant |
+    # | Brand not found ! |
+    # | Your charges setting is incomplete .Plese Contact to Administrator. |
+    # | Only {{currencyCode}} currency is allowed. |
+    # | Transaction amount must be equal or greater to minimum trans amount |
+    # | Invalid_Parameter  <br>You'd usually get it when one or more mandatory
+    # parameters are not present in the request. |
+    # @param [PurchaseRequest1] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def purchase(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/purchases',
+                                     Server::SERVER_3)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:deserialize_primitive_types))
+                    .deserialize_into(proc do |response| response&.to_s end)
+                    .is_api_response(true)
+                    .is_primitive_response(true))
+        .execute
+    end
+  end
+end

data/lib/paysecure_api_documentation_live/apis/m_virtual_cards_payout_api.rb

@@ -0,0 +1,182 @@
+# paysecure_api_documentation_live
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PaysecureApiDocumentationLive
+  # MVirtualCardsPayoutApi
+  class MVirtualCardsPayoutApi < BaseApi
+    # **OVERIEW**
+    # The **createCustomer API** allows merchants to create a customer profile
+    # on PaySecure when a user visits their website, facilitating a seamless
+    # payment experience by pre-filling the customer's details, on the PaySecure
+    # Cashier. The API takes in customer information and returns a unique
+    # customerID that can be passed in purchase payload, eliminating the need
+    # for customers to manually enter their details during transactions.
+    # | Parameter | Type | **Required** | Description | Example |
+    # | --- | --- | --- | --- | --- |
+    # | merchantCustomerId | String | Yes | unique customer ID provided by
+    # merchant. This can be email, mobile or an alphanumeric string |
+    # [rahultestcustomer@paysecure.net](https://mailto:rahultestcustomer@paysecu
+    # re.net) |
+    # | fullName | String | Yes | Full name of the customer. | Rahul Agarwal |
+    # | emailId | String | Yes | Email address of the customer. |
+    # [test@paysecure.net](https://mailto:test@paysecure.net) |
+    # | dateOfBirth | String | Optional | Customer's date of birth in YYYY-MM-DD
+    # format. | 1995-12-27 |
+    # | phoneNo | String | Yes | Customer's phone number. Preferred with the
+    # country code | +91 797639082 |
+    # | city | String | Optional | City of the customer. | Jaipur |
+    # | stateCode | String | Yes | State code of the customer. | RJ |
+    # | zipCode | String | Optional | Postal code of the customer's location. |
+    # 302018 |
+    # | address | String | Optional | Full address of the customer. | House
+    # Number 53, Vaishali Nagar, Jaipur |
+    # | country | String | Yes | Country code (ISO 3166-1 alpha-2). | IN |
+    # | custRegDate | Sting | Optional | Customer registration date on merchant
+    # site in YYYY-MM-DD format. | 2023-12-27 |
+    # | successTxn | String | Optional | Number of successful transactions
+    # customer has carried on merchant site. | 32 |
+    # ### **User Flow**
+    # 1. **Customer visits merchant's website**: The customer selects the
+    # product or service and proceeds to checkout page.
+    # 
+    # 2. **Merchant calls the** **`createCustomer`** **API**: The merchant sends
+    # a `POST` request to the Paysecure API with the customer's details.
+    # 
+    # 3. **Customer ID generation**: Paysecure processes the request and
+    # generates a unique `customerId` which is returned in the response.
+    # 
+    # 4. **Payment Process**: The merchant uses the `customerId` for subsequent
+    # session creation, ensuring the customer doesn’t need to re-enter their
+    # details for future payments.
+    # 
+    # ---
+    # ### **Benefits**
+    # - **Seamless user experience**: The customer does not have to enter their
+    # details manually for every purchase.
+    # 
+    # - **Faster Checkout**: The merchant can use the `customerId` for faster
+    # payment processing.
+    # 
+    # - **Data Security**: Customer details are stored securely and can be
+    # reused across transactions, reducing the chances of errors.
+    # 
+    # ### Implementing createCustomer on merchant site:
+    # The `createCustomer` can be implemented on merchant site in one of two
+    # ways, depending on merchant’s integration flow:
+    # **At Checkout:**
+    # When a customer initiates the checkout process, your system should invoke
+    # the `createCustomer` API, before actually starting the session.
+    # - **Call** **`createCustomer`**: This API call generates a unique customer
+    # ID.
+    # 
+    # - **Use of Customer ID:** Pass the returned customer ID in Session API,
+    # when creating a payment session.
+    # 
+    # **Upon Customer Login:**
+    # Alternatively, merchants may choose to call `createCustomer` at the time
+    # of customer login on their site.
+    # - **Persistent Customer Profiles:** This approach can help build or
+    # maintain a persistent customer profile, ensuring the customer ID is
+    # available for any subsequent payment sessions without needing to call
+    # `createCustomer` again.
+    # 
+    # - **Integration Flexibility:** This is useful for merchants who want to
+    # initialize customer data early in the customer journey rather than during
+    # checkout.
+    # 
+    # The method you choose depends on your business requirements and how your
+    # system is architected. Regardless of when you call it, the resulting
+    # customer ID must be passed to the `createSession` API to initiate a
+    # payment session.
+    # @param [String] brand_id Required parameter: TODO: type description here
+    # @param [CreateCustomerRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_customer(brand_id,
+                        body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/customer',
+                                     Server::SERVER_3)
+                   .header_param(new_parameter(brand_id, key: 'BrandId')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Success19.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 FailureException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 ExistingCustomerException))
+        .execute
+    end
+
+    # This endpoint makes an HTTP GET request to retrieve customer information
+    # from the Paysecure API.
+    # ### Request
+    # The request does not include any query parameters, but it uses a raw
+    # request body with the following parameter "merchantCustomerId", which will
+    # be the customer id on the merchant's side.
+    # ### Response
+    # The response of this request can be documented as a JSON schema.
+    # @param [String] brand_id Required parameter: TODO: type description here
+    # @param [String] accept Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_customer(brand_id,
+                     accept)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customer',
+                                     Server::SERVER_2)
+                   .header_param(new_parameter(brand_id, key: 'BrandId')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(accept, key: 'Accept')
+                                  .is_required(true)))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Success19.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 InvalidCustomerException))
+        .execute
+    end
+
+    # To Initiate a payout, the very first call to make is /payout/
+    # with the required data in the request body.
+    # To generate a Payout, you are required to provide the `API key` (in the
+    # header) can be located in the Dashboard section of your merchant account
+    # login.
+    # The request body structure is shown on the request body of the example
+    # request shown here.
+    # @param [CreatePayOutRequest5] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_pay_out(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/payout',
+                                     Server::SERVER_3)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Success21.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end