bitpesa-sdk 0.1.0 → 0.2.0

data/spec/api/payment_methods_api_spec.rb

@@ -1,25 +1,25 @@
 =begin
 #BitPesa API
 
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+#Reference documentation for the BitPesa API V1
 
 OpenAPI spec version: 1.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for BitPesa::PaymentMethodsApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Unit tests for Bitpesa::PaymentMethodsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'PaymentMethodsApi' do
   before do
     # run before each test
-    @instance = BitPesa::PaymentMethodsApi.new
+    @instance = Bitpesa::PaymentMethodsApi.new
   end
 
   after do
@@ -28,7 +28,7 @@ describe 'PaymentMethodsApi' do
 
   describe 'test an instance of PaymentMethodsApi' do
     it 'should create an instance of PaymentMethodsApi' do
-      expect(@instance).to be_instance_of(BitPesa::PaymentMethodsApi)
+      expect(@instance).to be_instance_of(Bitpesa::PaymentMethodsApi)
     end
   end
 
@@ -36,9 +36,9 @@ describe 'PaymentMethodsApi' do
   # This method returns possible payin methods.
   # Fetching possible payin methods. 
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2008]
+  # @return [PaymentMethodListResponse]
   describe 'payment_methods_in test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -47,9 +47,9 @@ describe 'PaymentMethodsApi' do
   # This method returns possible payout methods.
   # Fetching possible payout methods. 
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2008]
+  # @return [PaymentMethodListResponse]
   describe 'payment_methods_out test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/spec/api/payout_methods_api_spec.rb

@@ -1,25 +1,25 @@
 =begin
 #BitPesa API
 
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+#Reference documentation for the BitPesa API V1
 
 OpenAPI spec version: 1.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for BitPesa::PayoutMethodsApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Unit tests for Bitpesa::PayoutMethodsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'PayoutMethodsApi' do
   before do
     # run before each test
-    @instance = BitPesa::PayoutMethodsApi.new
+    @instance = Bitpesa::PayoutMethodsApi.new
   end
 
   after do
@@ -28,7 +28,19 @@ describe 'PayoutMethodsApi' do
 
   describe 'test an instance of PayoutMethodsApi' do
     it 'should create an instance of PayoutMethodsApi' do
-      expect(@instance).to be_instance_of(BitPesa::PayoutMethodsApi)
+      expect(@instance).to be_instance_of(Bitpesa::PayoutMethodsApi)
+    end
+  end
+
+  # unit tests for delete_payout_method
+  # Deleting a payout method
+  # Deletes a single payout method by the Payout Method ID
+  # @param payout_method_id ID of the payout method to delete.  Example: `/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`
+  # @param [Hash] opts the optional parameters
+  # @return [PayoutMethodResponse]
+  describe 'delete_payout_method test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
@@ -37,9 +49,9 @@ describe 'PayoutMethodsApi' do
   # Show a payout method by id
   # @param payout_method_id ID of the payout method to get.  Example: `/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse20012]
+  # @return [PayoutMethodResponse]
   describe 'get_payout_method test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -48,9 +60,41 @@ describe 'PayoutMethodsApi' do
   # Listing payout methods
   # List available payout methods
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse20011]
+  # @option opts [Array<String>] :state Allows filtering results by &#x60;state&#x60; of the payout method.  Example: &#x60;/v1/payout_methods?state[]&#x3D;enabled&#x60;
+  # @option opts [Array<String>] :type Allows filtering results by the specified type.  Example: &#x60;/v1/payout_methods?type[]&#x3D;NGN::Bank&#x60;
+  # @option opts [String] :sender_id Allows filtering results by the specified sender id.  Example: &#x60;/v1/payout_methods?sender_id&#x3D;bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;
+  # @option opts [Integer] :page The page number to request (defaults to 1)
+  # @option opts [Integer] :per The number of results to load per page (defaults to 10)
+  # @option opts [String] :created_at_from Start date to filter recipients by created_at range Allows filtering results by the specified &#x60;created_at&#x60; timeframe.  Example: &#x60;/v1/recipients?created_at_from&#x3D;2018-06-06&amp;created_at_to&#x3D;2018-06-08&#x60;
+  # @option opts [String] :created_at_to End date to filter recipients by created_at range Allows filtering results by the specified &#x60;created_at&#x60; timeframe.  Example: &#x60;/v1/recipients?created_at_from&#x3D;2018-06-06&amp;created_at_to&#x3D;2018-06-08&#x60;
+  # @return [PayoutMethodListResponse]
   describe 'get_payout_methods test' do
-    it "should work" do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for patch_payout_method
+  # Updating a payout method
+  # Updates the payout method specified in the URL path.
+  # @param payout_method_id ID of the payout method to get.  Example: &#x60;/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;
+  # @param payout_method 
+  # @param [Hash] opts the optional parameters
+  # @return [PayoutMethodResponse]
+  describe 'patch_payout_method test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for post_payout_methods
+  # Creating a payout method
+  # Creates a new payout method in our system. 
+  # @param payout_method_request 
+  # @param [Hash] opts the optional parameters
+  # @return [PayoutMethodResponse]
+  describe 'post_payout_methods test' do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/spec/api/recipients_api_spec.rb

@@ -1,25 +1,25 @@
 =begin
 #BitPesa API
 
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+#Reference documentation for the BitPesa API V1
 
 OpenAPI spec version: 1.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for BitPesa::RecipientsApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Unit tests for Bitpesa::RecipientsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'RecipientsApi' do
   before do
     # run before each test
-    @instance = BitPesa::RecipientsApi.new
+    @instance = Bitpesa::RecipientsApi.new
   end
 
   after do
@@ -28,18 +28,18 @@ describe 'RecipientsApi' do
 
   describe 'test an instance of RecipientsApi' do
     it 'should create an instance of RecipientsApi' do
-      expect(@instance).to be_instance_of(BitPesa::RecipientsApi)
+      expect(@instance).to be_instance_of(Bitpesa::RecipientsApi)
     end
   end
 
   # unit tests for delete_recipient
   # Cancelling a recipient
-  # Cancels the recipient specified in the URL path.
+  # Cancels the payment to the recipient specified in the URL path.  Please note only recipients where the `may_cancel` attribute is true can be cancelled.
   # @param recipient_id ID of recipient to cancel.  Example: `/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33`
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse20014]
+  # @return [RecipientResponse]
   describe 'delete_recipient test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -48,25 +48,30 @@ describe 'RecipientsApi' do
   # Getting a list of recipients with filtering
   # Fetches details of all recipients.
   # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page The page number to request (defaults to 1)
+  # @option opts [Integer] :per The number of results to load per page (defaults to 10)
+  # @option opts [String] :created_at_from Start date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe.  Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`
+  # @option opts [String] :created_at_to End date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe.  Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`
+  # @option opts [String] :amount_from Minimum amount to filter recipients by amount range.  Allows filtering results by the specified `amount` range. When using this filter, the `currency` should also be specified.  Example: `/v1/recipients?currency=NGN&amount_from=83.76672339&amount_to=83.76672339`
+  # @option opts [String] :amount_to Max amount to filter recipients by amount range.  Allows filtering results by the specified `amount` range. When using this filter, the `currency` should also be specified.  Example: `/v1/recipients?currency=NGN&amount_from=83.76672339&amount_to=83.76672339`
   # @option opts [Array<String>] :state Allows filtering results by &#x60;state&#x60; of recipient. See [API Documentation - Recipient state](https://github.com/bitpesa/api-documentation/blob/master/transaction-flow.md#state-1) for possible states.  Example: &#x60;/v1/recipients?state[]&#x3D;error&amp;state[]&#x3D;initial&#x60;
-  # @option opts [Array<String>] :currency Allows filtering results by &#x60;input_currency&#x60;.  Example: &#x60;/v1/recipients?currency[]&#x3D;KES&amp;currency[]&#x3D;NGN&#x60;
-  # @option opts [String] :created_at Allows filtering results by the specified &#x60;created_at&#x60; timeframe.  Example: &#x60;/v1/recipients?created_at_from&#x3D;2018-06-06&amp;created_at_to&#x3D;2018-06-08&#x60;
-  # @option opts [String] :amount Allows filtering results by the specified &#x60;amount&#x60; range. When using this filter, the &#x60;currency&#x60; should also be specified.  Example: &#x60;/v1/recipients?currency&#x3D;BTC&amp;amount_from&#x3D;83.76672339&amp;amount_to&#x3D;83.76672339&#x60;
-  # @return [InlineResponse20013]
+  # @option opts [Array<String>] :currency Allows filtering results by &#x60;input_currency&#x60;.  Additionally required when filtering by an amount range Example: &#x60;/v1/recipients?currency[]&#x3D;KES&amp;currency[]&#x3D;NGN&#x60;
+  # @return [RecipientListResponse]
   describe 'get_recipients test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for patch_recipient
   # Updating a recipient
-  # Updates the recipient specified in the URL path.
+  # Updates the recipient specified in the URL path.  Please note that only recipients where the &#x60;editable&#x60; field is true can be modified. Once the recipient is modified any subsequent payout tries will be sent to the updated details.
   # @param recipient_id ID of recipient to update.  Example: &#x60;/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33&#x60;
+  # @param recipient_request 
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse20014]
+  # @return [RecipientResponse]
   describe 'patch_recipient test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/spec/api/senders_api_spec.rb

@@ -1,25 +1,25 @@
 =begin
 #BitPesa API
 
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+#Reference documentation for the BitPesa API V1
 
 OpenAPI spec version: 1.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for BitPesa::SendersApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Unit tests for Bitpesa::SendersApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'SendersApi' do
   before do
     # run before each test
-    @instance = BitPesa::SendersApi.new
+    @instance = Bitpesa::SendersApi.new
   end
 
   after do
@@ -28,18 +28,18 @@ describe 'SendersApi' do
 
   describe 'test an instance of SendersApi' do
     it 'should create an instance of SendersApi' do
-      expect(@instance).to be_instance_of(BitPesa::SendersApi)
+      expect(@instance).to be_instance_of(Bitpesa::SendersApi)
     end
   end
 
   # unit tests for delete_sender
   # Deleting a sender
   # Deletes a single sender by the Sender ID
-  # @param sender_id ID of the sender to get.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`
+  # @param sender_id ID of the sender to delete.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2011]
+  # @return [SenderResponse]
   describe 'delete_sender test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -49,9 +49,9 @@ describe 'SendersApi' do
   # Returns a single sender by the Sender ID
   # @param sender_id ID of the sender to get.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2011]
+  # @return [SenderResponse]
   describe 'get_sender test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -60,9 +60,14 @@ describe 'SendersApi' do
   # Listing senders
   # Get a list of available senders
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse20015]
+  # @option opts [Integer] :page The page number to request (defaults to 1)
+  # @option opts [Integer] :per The number of results to load per page (defaults to 10)
+  # @option opts [String] :created_at_from Start date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe.  Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`
+  # @option opts [String] :created_at_to End date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe.  Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`
+  # @option opts [String] :external_id Allows filtering results by `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
+  # @return [SenderListResponse]
   describe 'get_senders test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -71,23 +76,23 @@ describe 'SendersApi' do
   # Updating a sender
   # Updates the sender specified in the URL path.
   # @param sender_id ID of the sender to get.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`
-  # @param sender 
+  # @param sender_request 
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2011]
+  # @return [SenderResponse]
   describe 'patch_sender test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for post_senders
   # Creating a sender
-  # Creates a new sender and transitions their onboarding status  When a sender is created you will receive a response which contains the senders status. Possible states for a sender are:  - initial - When a sender is created and has not been through any KYC checking (cannot transact) - verified - A sender has passed sanction list checks (cannot transact) - approved - The sender has passed both KYC and sanction checks (can transact) - banned - An admin has banned the sender (cannot transact) - rejected - The sender has failed sanction list checks (cannot transact) - disabled - A sender is put into this state as a result of a delete request via the API (cannot transact) 
-  # @param sender 
+  # Creates a new sender in our system. 
+  # @param sender_request 
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2011]
+  # @return [SenderResponse]
   describe 'post_senders test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/spec/api/transactions_api_spec.rb

@@ -1,25 +1,25 @@
 =begin
 #BitPesa API
 
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+#Reference documentation for the BitPesa API V1
 
 OpenAPI spec version: 1.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for BitPesa::TransactionsApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Unit tests for Bitpesa::TransactionsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'TransactionsApi' do
   before do
     # run before each test
-    @instance = BitPesa::TransactionsApi.new
+    @instance = Bitpesa::TransactionsApi.new
   end
 
   after do
@@ -28,18 +28,44 @@ describe 'TransactionsApi' do
 
   describe 'test an instance of TransactionsApi' do
     it 'should create an instance of TransactionsApi' do
-      expect(@instance).to be_instance_of(BitPesa::TransactionsApi)
+      expect(@instance).to be_instance_of(Bitpesa::TransactionsApi)
     end
   end
 
   # unit tests for calculate_transactions
   # Calculates transaction amounts for a transaction payload
   # Calculates the input, output and fee amounts for the recipients in a transaction payload
-  # @param transaction Transaction payload to be calculated
+  # @param transaction_request 
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2012]
+  # @return [TransactionResponse]
   describe 'calculate_transactions test' do
-    it "should work" do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_transaction
+  # Fetch a single transaction
+  # Finds and returns a Transaction created by the requesting API key, using the provided Transaction ID.
+  # @param transaction_id ID of the transaction.  Example: `/v1/transactions/bf9ff782-e182-45ac-abea-5bce83ad6670`
+  # @param [Hash] opts the optional parameters
+  # @return [TransactionResponse]
+  describe 'get_transaction test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_transactions
+  # Get a list of transactions
+  # Retrieves a paginated list of the Transactions created by your API key.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page The page number to request (defaults to 1)
+  # @option opts [Integer] :per The number of results to load per page (defaults to 10)
+  # @option opts [String] :external_id Allows filtering results by `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
+  # @return [TransactionListResponse]
+  describe 'get_transactions test' do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -48,11 +74,11 @@ describe 'TransactionsApi' do
   # Creates a fake payin for transaction
   # This method is available only in sandbox environment and is supposed to be used only for testing integration. It allows you to emulate a payin without paying actual money. 
   # @param transaction_id ID of the transaction to payin.  Example: `/v1/transactions/bf9ff782-e182-45ac-abea-5bce83ad6670/payin`
-  # @param payin_method A partial payin method object
+  # @param payin_method_request 
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2012]
+  # @return [TransactionResponse]
   describe 'payin_transaction test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -62,21 +88,21 @@ describe 'TransactionsApi' do
   # This method is available only in sandbox environment and is supposed to be used only for testing. It allows you to emulate the payout of a transaction after payin. 
   # @param transaction_id ID of the transaction to payout.  Example: `/v1/transactions/bf9ff782-e182-45ac-abea-5bce83ad6670/payout`
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2012]
+  # @return [TransactionResponse]
   describe 'payout_transaction test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for post_transactions
   # Creates a new transaction
-  # Transactions are the main objects in the BitPesa API, so it's important to understand how to create and manage them. Transactions facilitate money movement from one Sender in a specific currency to one or multiple Recipients in another currency.  The main flow of a successful transaction flow is the following - - Transaction is created linking the Sender to the Recipient(s) with the requested amounts. - Once the sender is KYC'd and approved the transaction can be funded. - Once the transaction is funded, we will initiate the payout to the recipient(s). - After the recipient (or all recipients) has received the money, the transaction is finished.  Unfortunately not all transactions are successful. The main causes of issues are the following - - Transactions are cancelled automatically if they are not funded within the first hour of creation. - The recipient details might be wrong (for example the destination bank account number is invalid), or there are other issues blocking the successful payout. In these cases the transaction has to be cancelled.  In order to transact with Bitpesa we need to have an approved sender record. The flow for approving senders depend on whether KYC requirements are waived for your integration or not (See the notes section).  In case the KYC requirements are not waived then the typical flow for approval this will be the following.  ![Senders KYC Flow](https://raw.githubusercontent.com/bitpesa/api-documentation/master/uml/sender-kyc.png)  *Notes*  - The sender's phone number is composed of two parts, the phone_country (in ISO 2-letter format), and the phone_number. The phone number should be specified without the international prefix. - The documents should contain all documents necessary to KYC the sender.   - If you already do KYC on your system, then please contact us and we can waive this requirement from you. In this case you should send us an empty list of documents - `\"documents\": [ ]` in the request. All of the senders you create in the system will be immediately set to the approved state and you won't need to wait for them to get approved.   - If when creating senders or transactions you get the following error in the response - `\"errors\":{\"documents\":[{\"error\":\"blank\"}]}` it means that KYC requirements are not yet waived for your account. If we already approved your KYC process and so they should be, then please contact us so we can rectify the issue and update your account accordingly.   - In case you don't do KYC on your site, then you will need to send us documents that we can use to verify the sender's identity, for more details on this please see the API reference documentation. - The metadata field can store any information you wish to store with the sender. Usual data would include the ID inside your own system for this particular sender. If you don't wish to store anything simply specify {}.
-  # @param transaction Transaction object to be created
+  # Transactions are the main objects in the BitPesa API, so it's important to understand how to create and manage them. Transactions facilitate money movement from one Sender in a specific currency to one or multiple Recipients in another currency.  The main flow of a successful transaction flow is the following - - Transaction is created linking the Sender to the Recipient(s) with the requested amounts. - Once the sender is KYC'd and approved the transaction can be funded. - Once the transaction is funded, we will initiate the payout to the recipient(s). - After the recipient (or all recipients) has received the money, the transaction is finished.
+  # @param transaction_request 
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2012]
+  # @return [TransactionResponse]
   describe 'post_transactions test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -84,11 +110,11 @@ describe 'TransactionsApi' do
   # unit tests for validate_transactions
   # Validates a transaction payload
   # Validates fields in a transaction payload and displays invalid or missing fields
-  # @param transaction Transaction payload to be validated
+  # @param transaction_request 
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2012]
+  # @return [TransactionResponse]
   describe 'validate_transactions test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end