ps-apimatic-sdk 0.0.1

data/lib/paysecure_api_documentation_live/apis/payin_api.rb

@@ -0,0 +1,265 @@
+# paysecure_api_documentation_live
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PaysecureApiDocumentationLive
+  # PayinApi
+  class PayinApi < BaseApi
+    # ### **Payin API**
+    # <img
+    # src="https://content.pstmn.io/e448df41-3cb5-4b2a-9dc5-f961d9048bff/dW5uYW1
+    # lZC0yLnBuZw==" alt="" height="301" width="800">
+    # **Integration Steps:** To integrate Virtual Account payments with
+    # Paysecure, follow these steps:
+    # 1. **Enable Virtual Account in Paysecure**: Sign up with Paysecure and
+    # ensure the Virtual Account payment method is enabled for your merchant
+    # account. Get your API keys for authentication (test and live).
+    # 
+    # 2. **Configure Webhooks**: Set up Paysecure webhooks (e.g.
+    # transaction.paid, transaction.failed) so your system is notified of
+    # payment status changes.
+    # 
+    # 3. **Implement PayIn** (Customer Payments): In your checkout flow, allow
+    # the customer to choose Virtual Account and then call Paysecure’s PayIn API
+    # (e.g. POST /purchases ) with parameters such as amount, currency and
+    # paymentMethod=VIRTUAL-ACCOUNT. 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.
+    # @param [CreatePurchaseRequest1] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_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))
+                   .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(PurchaseSucess.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This API tells you about all the details of a purchase (PayIn), including
+    # its history
+    # **Note:** With respect to bank transfers, the purchase request is
+    # synonymous with the PayIn request.
+    # ### Mandatory
+    # you need to pass the `PurchaseID` in the API URL
+    # ### Possible Value of Status
+    # | **Status** | **Notes** |
+    # | --- | --- |
+    # | paid | Transaction Successful |
+    # | payment_in_process | Payment is under Processing |
+    # | expired | Purchase has Expired. |
+    # | error | Transaction has Failed. |
+    # ### Response Examples
+    # In the response examples you can see instances of both `Paid` and `Error`
+    # Status purchases.
+    # ### Error Details
+    # If there are any issues on the Purchase you can get more details from the
+    # `transaction_data.attempts.error` attribute of the response object
+    # ### Errors
+    # If there are any errors then it'll be in the format of :
+    # ``` json
+    # {
+    #     "message": "descriptive error message",
+    #     "code": "error_code"
+    # }
+    #  ```
+    # Please see the Status Code section for further details.
+    # @param [String] purchase_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_status(purchase_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/v1/purchases/{purchaseId}',
+                                     Server::SERVER_3)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .template_param(new_parameter(purchase_id, key: 'purchaseId')
+                                    .is_required(true)
+                                    .should_encode(true)))
+        .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
+
+    # 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 | An Identifier for a user |
+    # | client.city |  |
+    # | client.country | ISO-3166 Country Code. It must be upper case.  <br>This
+    # should be "IN" for India |
+    # | client.stateCode | Example “AL”, “XZ”.. Must be in upper case. |
+    # | client.street_address |  |
+    # | client.zip_code |  |
+    # | client.full_name |  |
+    # | purchase.currency | ISO 4217 code for currency you want to send the
+    # transaction in. |
+    # | purchase.products.name |  |
+    # | purchase.products.price | Price in decimal format.  <br>example 1:
+    # <br>INR 5 , should be sent as 10.00 |
+    # | brand_id | Obtain from Dashboard section of your merchant account login.
+    # |
+    # | success_redirect | URL to send the user if the transactions is
+    # successful |
+    # | failure_redirect | URL to send the user if the transactions is
+    # UNSUCCESSFUL |
+    # ## Optional Parameters
+    # ### expireInMin
+    # This parameter, when passed in the PayIn request, sets the time window
+    # within which a customer should make the Interac payment through their
+    # bank's app. If a customer doesn't complete the payment within the
+    # configured time window, the status of the payment will be marked as
+    # 'EXPIRED' in Paysecure.
+    # However, in certain cases, a payment made outside of this window could
+    # still be successful i.e. customer's account may be debited which would
+    # result in inconsistencies among Paysecure's, merchant's and customer's
+    # status of the transaction. To avoid such cases it is advised to set the
+    # expiry time limit appropriately and advise the customers to make payment
+    # within this window. However, if there is an inconsistency between the
+    # status at Paysecure and at customer's Bank, the merchant and Paysecure
+    # will reconcile the amounts during the settlement.
+    # ### 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.
+    # ### 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.
+    # ### Possible Error Messages
+    # | **Error Messages** | **Description** |
+    # | --- | --- |
+    # | Invalid format of Date_of_Birth\[allowed format: yyyy-mm-dd\] |  |
+    # | Enter Valid Email |  |
+    # | 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 |  |
+    # | Minimum amount is not set for this merchant |  |
+    # | success_redirect/failure_redirect/brand_id is missing |  |
+    # | brand_id cannot be null |  |
+    # | success_redirect cannot be null |  |
+    # | failure_redirect cannot be null |  |
+    # | Invalid failure_redirect: minimum 10 characters |  |
+    # | purchase.products.price cannot be null |  |
+    # | purchase.products\[0\].name/purchase.products\[0\].price are missing |
+    # |
+    # | Your charges setting is incomplete .Plese Contact to Administrator. |  |
+    # | Currency "{curr_name}" is Not Allowed |  |
+    # | Transaction amount must be equal or greater to minimum trans amount |  |
+    # | Allowed Limit for this card for particular time period has been consumed
+    # |  |
+    # **Note:** For certain use cases, in addition to long format purchase Id,
+    # Paysecure also provides a 7 digit unique code for each purchase starting
+    # with digit 4, eg 4000001
+    # _“purchaseIdShortCode”: “4000013"_
+    # @param [CreatePurchaseRequest1] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_purchase1(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
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This API tells you about all the details of a purchase (PayIn), including
+    # its history
+    # **Note:** With respect to bank transfers, the purchase request is
+    # synonymous with the PayIn request.
+    # ### Mandatory
+    # you need to pass the `PurchaseID` in the API URL
+    # ### Possible Value of Status
+    # | **Status** | **Notes** |
+    # | --- | --- |
+    # | paid | Transaction Successful |
+    # | payment_in_process | Payment is under Processing |
+    # | expired | Purchase has Expired. |
+    # | error | Transaction has Failed. |
+    # ### Response Examples
+    # In the response examples you can see instances of both `Paid` and `Error`
+    # Status purchases.
+    # ### Error Details
+    # If there are any issues on the Purchase you can get more details from the
+    # `transaction_data.attempts.error` attribute of the response object
+    # ### Errors
+    # If there are any errors then it'll be in the format of :
+    # ``` json
+    # {
+    #     "message": "descriptive error message",
+    #     "code": "error_code"
+    # }
+    #  ```
+    # Please see the Status Code section for further details.
+    # @param [String] purchase_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_status1(purchase_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/v1/purchases/{purchaseId}',
+                                     Server::SERVER_3)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .template_param(new_parameter(purchase_id, key: 'purchaseId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PurchasesSuccess5.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/paysecure_api_documentation_live/apis/payout_api.rb

@@ -0,0 +1,196 @@
+# paysecure_api_documentation_live
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PaysecureApiDocumentationLive
+  # PayoutApi
+  class PayoutApi < BaseApi
+    # To Initiate a payment, the very first API 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.
+    # The following (see table below) are the mandatory parameters that are
+    # required to create a Payout request.
+    # ### **Mandatory parameters in the request body:**
+    # | **Parameter** | **Notes** |
+    # | --- | --- |
+    # | client.email | The customer's email. |
+    # | client.phone | The customer's phone number along with the country code.
+    # <br>Example: +91 9634088651 |
+    # | 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. |
+    # | 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. |
+    # | amount | amount 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 |
+    # | payoutMethod | example: PAYOUT-BANKTRANSFER |
+    # | 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. |
+    # | Purpose | The purpose of doing a payout. |
+    # ### Additional **parameters for this usecase:**
+    # | **Parameter** | **Notes** |
+    # | --- | --- |
+    # | beneficiaryDetail.bankName | The Bank Name in which the customer want's
+    # to credit the money.  <br>  <br>Optional Field.  <br>If passed, only use
+    # the mentioned bank names below. Anything else might lead to payout
+    # failures.  <br>If you don't want to pass, then you might need to open our
+    # checkout_url in the response and user can select the Bank from the
+    # dropdown. |
+    # | beneficiaryDetail.bankAccountName | Mandatory Field.  <br>Account
+    # Holder's Full Name.  <br>It is advised to have atleast 2 words in the
+    # name. |
+    # | beneficiaryDetail.bankAccountCurrency | Optional Field.  <br>The
+    # Currency in which the money will be credited. Generally the same as the
+    # `currency` field mentioned above. |
+    # | beneficiaryDetail.bankAccountNumber | Mandatory Field.  <br>Account
+    # Holder's Account Number.  <br>This is the account in which the money will
+    # be credited. |
+    # | beneficiaryDetail.ifscCode | Mandatory Field.  <br>IFSC code of the
+    # account in which the money will be credited. |
+    # | beneficiaryDetail.bankCountryCode | Optional Field.  <br>The country
+    # code in which the account exist. Generally the same as the `country` field
+    # mentioned above. |
+    # **Bank Names:**
+    # <img
+    # src="https://content.pstmn.io/94f46e68-73b7-4a16-bff1-1d4a57dd6e92/aW1hZ2U
+    # ucG5n" width="676" height="3498">
+    # @param [String] accept Required parameter: TODO: type description here
+    # @param [PayOutRequest1] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def pay_out(accept,
+                body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/payout',
+                                     Server::SERVER_3)
+                   .header_param(new_parameter(accept, key: 'Accept')
+                                  .is_required(true))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json; charset=utf-8', key: 'content-type'))
+                   .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
+
+    # This API tells you about all the details of a Payout, including its
+    # history.
+    # ### Mandatory
+    # you need to pass the payoutId in the API URL
+    # ### Possible Value of Status
+    # | **Status** | **Notes** |
+    # | --- | --- |
+    # | paid | Transaction Successful |
+    # | payout_in_process | payout is under Processing. |
+    # | error | Transaction has Failed. |
+    # @param [String] payout_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_status(payout_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/v1/getpayout/{payoutId}',
+                                     Server::SERVER_3)
+                   .template_param(new_parameter(payout_id, key: 'payoutId')
+                                    .is_required(true)
+                                    .should_encode(true)))
+        .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
+
+    # To Initiate a payment, 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.
+    # The following (see table below) are the mandatory parameters that are
+    # required to create a Payout request.
+    # ### **Mandatory parameters in the request body:**
+    # | **Parameter** | **Notes** |
+    # | --- | --- |
+    # | client.email | An Identifier for a user |
+    # | client.phone | An Identifier for a user |
+    # | client.full_name | An Identifier for a user |
+    # | client.country |  |
+    # | payoutMethod | PAYOUT-THIRDPARTY-UPI |
+    # | beneficiaryDetail.upi | VPA (UPI ID) |
+    # | Currency | Note this is currency account for which you have balance |
+    # | Amount | Amount in Currency |
+    # | Purpose | Purpose of the payment |
+    # @param [CreatePayOutRequest7] 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))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This API tells you about all the details of a Payout, including its
+    # history
+    # ### Mandatory
+    # you need to pass the payoutId in the API URL
+    # ### Possible Value of Status
+    # | **Status** | **Notes** |
+    # | --- | --- |
+    # | paid | Transaction Successful |
+    # | payout_in_process | payout is under Processing. |
+    # | error | Transaction has Failed. |
+    # The webhook will only be triggered for paid transactions or errors.
+    # Paid: "success_callback": "[https://success.com](https://success.com)",
+    # Error: "failure_callback": “[https://failure.com”](https://failure.com”)
+    # @param [String] payout_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_status1(payout_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/v1/getpayout/{payoutId}',
+                                     Server::SERVER_3)
+                   .template_param(new_parameter(payout_id, key: 'payoutId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetSuccessStatus3.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/paysecure_api_documentation_live/apis/payout_manual_review_api.rb

@@ -0,0 +1,175 @@
+# paysecure_api_documentation_live
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PaysecureApiDocumentationLive
+  # PayoutManualReviewApi
+  class PayoutManualReviewApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [Integer] page_no Required parameter: TODO: type description here
+    # @param [Integer] page_size Required parameter: TODO: type description
+    # here
+    # @param [String] status Required parameter: TODO: type description here
+    # @param [String] timezone Required parameter: TODO: type description here
+    # @param [String] start_date Required parameter: TODO: type description
+    # here
+    # @param [String] end_date Required parameter: TODO: type description here
+    # @param [String] payment_method Required parameter: TODO: type description
+    # here
+    # @param [String] email Required parameter: TODO: type description here
+    # @param [String] customer_segment Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_payouts(page_no,
+                     page_size,
+                     status,
+                     timezone,
+                     start_date,
+                     end_date,
+                     payment_method,
+                     email,
+                     customer_segment)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/v1/external/transactions/payout/list',
+                                     Server::SERVER_3)
+                   .query_param(new_parameter(page_no, key: 'page_no')
+                                 .is_required(true))
+                   .query_param(new_parameter(page_size, key: 'page_size')
+                                 .is_required(true))
+                   .query_param(new_parameter(status, key: 'status')
+                                 .is_required(true))
+                   .query_param(new_parameter(timezone, key: 'timezone')
+                                 .is_required(true))
+                   .query_param(new_parameter(start_date, key: 'start_date')
+                                 .is_required(true))
+                   .query_param(new_parameter(end_date, key: 'end_date')
+                                 .is_required(true))
+                   .query_param(new_parameter(payment_method, key: 'payment_method')
+                                 .is_required(true))
+                   .query_param(new_parameter(email, key: 'email')
+                                 .is_required(true))
+                   .query_param(new_parameter(customer_segment, key: 'customer_segment')
+                                 .is_required(true)))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] action Required parameter: TODO: type description here
+    # @param [Object] body Required parameter: TODO: type description here
+    # @param [String] payout_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def approve_payout(action,
+                       body,
+                       payout_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/payouts/{payout_id}/action',
+                                     Server::SERVER_3)
+                   .query_param(new_parameter(action, key: 'action')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .template_param(new_parameter(payout_id, key: 'payout_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .body_serializer(APIHelper.method(:json_serialize)))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] action Required parameter: TODO: type description here
+    # @param [ApprovePayoutWithRemarksRequest] body Required parameter: TODO:
+    # type description here
+    # @param [String] payout_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def approve_payout_with_remarks(action,
+                                    body,
+                                    payout_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/payouts/{payout_id}/action',
+                                     Server::SERVER_3)
+                   .query_param(new_parameter(action, key: 'action')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .template_param(new_parameter(payout_id, key: 'payout_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] action Required parameter: TODO: type description here
+    # @param [Object] body Required parameter: TODO: type description here
+    # @param [String] payout_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def reject_payout(action,
+                      body,
+                      payout_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/payouts/{payout_id}/action',
+                                     Server::SERVER_3)
+                   .query_param(new_parameter(action, key: 'action')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .template_param(new_parameter(payout_id, key: 'payout_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .body_serializer(APIHelper.method(:json_serialize)))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] action Required parameter: TODO: type description here
+    # @param [RejectPayoutWithRemarksRequest] body Required parameter: TODO:
+    # type description here
+    # @param [String] payout_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def reject_payout_with_remarks(action,
+                                   body,
+                                   payout_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/payouts/{payout_id}/action',
+                                     Server::SERVER_3)
+                   .query_param(new_parameter(action, key: 'action')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .template_param(new_parameter(payout_id, key: 'payout_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/paysecure_api_documentation_live/apis/refund_api.rb

@@ -0,0 +1,38 @@
+# paysecure_api_documentation_live
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PaysecureApiDocumentationLive
+  # RefundApi
+  class RefundApi < BaseApi
+    # This API is used to initate refund of the purchases that have status as
+    # `PAID`
+    # Once the refund has been initiated, the status of the purchase would
+    # become `REFUND_IN_PROCESS` and once the refund has been approved by the
+    # bank, the status woud become `REFUNDED`
+    # Purchase ID is **mandatory** for this API.
+    # If due to some reason, the refund has failed, the status would again
+    # become `PAID`
+    # ### Response Examples
+    # In the response examples you can see instances of both `successful` and
+    # `unsuccessful` in refund of purchases.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def refund
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/v1/purchases/657af976c3fceb7beb30eeb4/refund',
+                                     Server::SERVER_3)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(RefundPending1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 RefundErrorException))
+        .execute
+    end
+  end
+end