bitpesa-sdk 0.1.0

data/docs/TransactionRequest.md

@@ -0,0 +1,8 @@
+# Bitpesa::TransactionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction** | [**Transaction**](Transaction.md) |  | [optional] 
+
+

data/docs/TransactionRequestBase.md

@@ -0,0 +1,9 @@
+# Bitpesa::TransactionRequestBase
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [**TransactionValidResponse**](TransactionValidResponse.md) |  | 
+**metadata** | **Object** | Metadata of transaction request | [optional] 
+
+

data/docs/TransactionRequestErrorResponse.md

@@ -0,0 +1,10 @@
+# Bitpesa::TransactionRequestErrorResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [**TransactionValidResponse**](TransactionValidResponse.md) |  | 
+**metadata** | **Object** | Metadata of transaction request | [optional] 
+**errors** | **Object** | List of invalid fields with associated errors | [optional] 
+
+

data/docs/TransactionRequestRequest.md

@@ -0,0 +1,9 @@
+# Bitpesa::TransactionRequestRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [**TransactionValidResponse**](TransactionValidResponse.md) |  | 
+**metadata** | **Object** | Metadata of transaction request | [optional] 
+
+

data/docs/TransactionRequestValidResponse.md

@@ -0,0 +1,10 @@
+# Bitpesa::TransactionRequestValidResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [**TransactionValidResponse**](TransactionValidResponse.md) |  | 
+**metadata** | **Object** | Metadata of transaction request | [optional] 
+**id** | **String** |  | [optional] 
+
+

data/docs/TransactionRequestsApi.md

@@ -0,0 +1,199 @@
+# Bitpesa::TransactionRequestsApi
+
+All URIs are relative to *https://api-staging.bitpesa.co/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_transaction_request**](TransactionRequestsApi.md#get_transaction_request) | **GET** /transaction_requests/{Transaction Request ID} | Fetching a transaction request
+[**get_transaction_requests**](TransactionRequestsApi.md#get_transaction_requests) | **GET** /transaction_requests | Listing transaction requests
+[**post_transaction_request**](TransactionRequestsApi.md#post_transaction_request) | **POST** /transaction_requests | Creating a transaction request
+
+
+# **get_transaction_request**
+> InlineResponse20110 get_transaction_request(transaction_request_id)
+
+Fetching a transaction request
+
+Returns a single transaction request by the Transaction Request ID
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa'
+# setup authorization
+Bitpesa.configure do |config|
+  # Configure API key authorization: AuthorizationKey
+  config.api_key['Authorization-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization-Key'] = 'Bearer'
+
+  # Configure API key authorization: AuthorizationSecret
+  config.api_key['Authorization-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization-Secret'] = 'Bearer'
+end
+
+api_instance = Bitpesa::TransactionRequestsApi.new
+
+transaction_request_id = "transaction_request_id_example" # String | ID of the transaction request to get.  Example: `/v1/transaction_requests/bf9ff782-e182-45ac-abea-5bce83ad6670`
+
+
+begin
+  #Fetching a transaction request
+  result = api_instance.get_transaction_request(transaction_request_id)
+  p result
+rescue Bitpesa::ApiError => e
+  puts "Exception when calling TransactionRequestsApi->get_transaction_request: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_request_id** | [**String**](.md)| ID of the transaction request to get.  Example: `/v1/transaction_requests/bf9ff782-e182-45ac-abea-5bce83ad6670` | 
+
+### Return type
+
+[**InlineResponse20110**](InlineResponse20110.md)
+
+### Authorization
+
+[AuthorizationKey](../README.md#AuthorizationKey), [AuthorizationSecret](../README.md#AuthorizationSecret)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_transaction_requests**
+> InlineResponse20036 get_transaction_requests(opts)
+
+Listing transaction requests
+
+Get a list of transaction requests
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa'
+# setup authorization
+Bitpesa.configure do |config|
+  # Configure API key authorization: AuthorizationKey
+  config.api_key['Authorization-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization-Key'] = 'Bearer'
+
+  # Configure API key authorization: AuthorizationSecret
+  config.api_key['Authorization-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization-Secret'] = 'Bearer'
+end
+
+api_instance = Bitpesa::TransactionRequestsApi.new
+
+opts = { 
+  state: ["state_example"], # Array<String> | Returns transaction requests with specified states.  Example: `/v1/transaction_requests?state[]=pending&state[]=modified`
+  currency: ["currency_example"], # Array<String> | Returns transaction requests with specified input_currency.  Example: `/v1/transaction_requests?state[]=pending&state[]=modified`
+  created_at_from: "created_at_from_example", # String | Returns transaction requests with specified created_at lower limit.  Example: `/v1/transaction_requests?created_at_from=2018-06-09`
+  created_at_to: "created_at_to_example", # String | Returns transaction requests with specified created_at upper limit.  Example: `/v1/transaction_requests?created_at_to=2018-06-08`
+  amount_from: "amount_from_example", # String | Returns transaction requests with specified amount lower limit.  Example: `/v1/transaction_requests?currency=BTC&amount_from=2.4319983`
+  amount_to: "amount_to_example" # String | Returns transaction requests with specified amount upper limit.  Example: `/v1/transaction_requests?currency=BTC&amount_to=2.4319985`
+}
+
+begin
+  #Listing transaction requests
+  result = api_instance.get_transaction_requests(opts)
+  p result
+rescue Bitpesa::ApiError => e
+  puts "Exception when calling TransactionRequestsApi->get_transaction_requests: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **state** | [**Array&lt;String&gt;**](String.md)| Returns transaction requests with specified states.  Example: &#x60;/v1/transaction_requests?state[]&#x3D;pending&amp;state[]&#x3D;modified&#x60; | [optional] 
+ **currency** | [**Array&lt;String&gt;**](String.md)| Returns transaction requests with specified input_currency.  Example: &#x60;/v1/transaction_requests?state[]&#x3D;pending&amp;state[]&#x3D;modified&#x60; | [optional] 
+ **created_at_from** | **String**| Returns transaction requests with specified created_at lower limit.  Example: &#x60;/v1/transaction_requests?created_at_from&#x3D;2018-06-09&#x60; | [optional] 
+ **created_at_to** | **String**| Returns transaction requests with specified created_at upper limit.  Example: &#x60;/v1/transaction_requests?created_at_to&#x3D;2018-06-08&#x60; | [optional] 
+ **amount_from** | **String**| Returns transaction requests with specified amount lower limit.  Example: &#x60;/v1/transaction_requests?currency&#x3D;BTC&amp;amount_from&#x3D;2.4319983&#x60; | [optional] 
+ **amount_to** | **String**| Returns transaction requests with specified amount upper limit.  Example: &#x60;/v1/transaction_requests?currency&#x3D;BTC&amp;amount_to&#x3D;2.4319985&#x60; | [optional] 
+
+### Return type
+
+[**InlineResponse20036**](InlineResponse20036.md)
+
+### Authorization
+
+[AuthorizationKey](../README.md#AuthorizationKey), [AuthorizationSecret](../README.md#AuthorizationSecret)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **post_transaction_request**
+> InlineResponse20110 post_transaction_request(transaction_request)
+
+Creating a transaction request
+
+Creates a new transaction request 
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa'
+# setup authorization
+Bitpesa.configure do |config|
+  # Configure API key authorization: AuthorizationKey
+  config.api_key['Authorization-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization-Key'] = 'Bearer'
+
+  # Configure API key authorization: AuthorizationSecret
+  config.api_key['Authorization-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization-Secret'] = 'Bearer'
+end
+
+api_instance = Bitpesa::TransactionRequestsApi.new
+
+transaction_request = Bitpesa::TransactionRequestRequest.new # TransactionRequestRequest | 
+
+
+begin
+  #Creating a transaction request
+  result = api_instance.post_transaction_request(transaction_request)
+  p result
+rescue Bitpesa::ApiError => e
+  puts "Exception when calling TransactionRequestsApi->post_transaction_request: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_request** | [**TransactionRequestRequest**](TransactionRequestRequest.md)|  | 
+
+### Return type
+
+[**InlineResponse20110**](InlineResponse20110.md)
+
+### Authorization
+
+[AuthorizationKey](../README.md#AuthorizationKey), [AuthorizationSecret](../README.md#AuthorizationSecret)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/TransactionResponse.md

@@ -0,0 +1,8 @@
+# Bitpesa::TransactionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Transaction**](Transaction.md) |  | [optional] 
+
+

data/docs/TransactionState.md

@@ -0,0 +1,7 @@
+# Bitpesa::TransactionState
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/TransactionTraits.md

@@ -0,0 +1,9 @@
+# Bitpesa::TransactionTraits
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**auto_refund** | **BOOLEAN** | Enables or disables the auto refund functionality. Please see [Auto cancellation and refund of transactions](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md#auto-cancellation-and-refund-of-transactions) for more details | [optional] 
+**account_validation** | **BOOLEAN** | Enabled or disables the name validation functionality. Please see [Name validation in transactions](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md#name-validation-in-transactions) for more details | [optional] 
+
+

data/docs/TransactionValidResponse.md

@@ -0,0 +1,21 @@
+# Bitpesa::TransactionValidResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_currency** | **String** | The input currency describes what currency the transaction will be paid in (3-character alpha ISO 4217 currency format). For example if you wish to create an EUR to NGN transaction then input currency should be set to EUR. | 
+**payin_methods** | [**Array<PayinMethodBase>**](PayinMethodBase.md) | Allows setting alternative collections, where funding the transaction is done through alternative means and not via account balance.  For more information please see [Collections from senders](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation | [optional] 
+**metadata** | **Object** |  | [optional] 
+**sender** | [**SenderValidResponse**](SenderValidResponse.md) |  | 
+**recipients** | [**Array<RecipientValidResponse>**](RecipientValidResponse.md) |  | 
+**traits** | [**TransactionTraits**](TransactionTraits.md) |  | [optional] 
+**state** | **String** | The state of the transaction, which can be one of the following:  * `initial`: Transaction is created, but not yet ready to receive payments (waiting for Sender to be KYC'd and approved). * `approved`: Transaction is created and the sender is approved. Payment can be received * `pending`: Transaction has received a payin, and it's waiting for the funds to clear. * `received`: Transaction has received the correct payin amount and will start processing the payouts. * `mispaid`: Transaction received funds, but not the requested amount. The transaction will be resized, and will start payout based on the received funds. * `manual`: Some of the payments to the recipients have run into issues. Please check the recipient statuses for more information. * `paid`: Transaction has received correct payins and has performed payouts to all recipients. No further steps required * `canceled`: The transaction has been cancelled. Transactions are cancelled automatically after one hour if there was no funds received. Once transactions are funded they can be cancelled by the API user unless the recipients have been paid out. * `refunded`: The transaction has been cancelled after it has been funded, but the funds have been returned now to the sender either partially or fully. * `exception`: An exception happened during the processing of the transaction. Please contact BitPesa | [optional] 
+**input_amount** | **Float** | The amount that was requested in the input currency | [optional] 
+**payin_reference** | **String** | The reference number that has to be provided in case the transaction is not funded through account balance | [optional] 
+**paid_amount** | **Float** | The amount that was already paid in to the transaction | [optional] 
+**due_amount** | **Float** | The amount needed to be paid in for the transaction to get funded | [optional] 
+**created_at** | **DateTime** | The time the transaction was created | [optional] 
+**expires_at** | **DateTime** | The latest time when the transaction has to be funded, otherwise it will be cancelled | [optional] 
+**id** | **String** |  | [optional] 
+
+

data/docs/TransactionWebhook.md

@@ -0,0 +1,10 @@
+# Bitpesa::TransactionWebhook
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhook** | **String** | The ID of the webhook that was used to send out this callback | 
+**event** | **String** | The event that triggered this webhook | 
+**object** | [**Transaction**](Transaction.md) |  | 
+
+

data/docs/TransactionsApi.md

@@ -0,0 +1,448 @@
+# Bitpesa::TransactionsApi
+
+All URIs are relative to *https://api-sandbox.bitpesa.co/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**calculate_transactions**](TransactionsApi.md#calculate_transactions) | **POST** /transactions/calculate | Calculates transaction amounts for a transaction payload
+[**get_transaction**](TransactionsApi.md#get_transaction) | **GET** /transactions/{Transaction ID} | Fetch a single transaction
+[**get_transactions**](TransactionsApi.md#get_transactions) | **GET** /transactions | Get a list of transactions
+[**payin_transaction**](TransactionsApi.md#payin_transaction) | **POST** /transactions/{Transaction ID}/payin | Creates a fake payin for transaction
+[**payout_transaction**](TransactionsApi.md#payout_transaction) | **POST** /transactions/{Transaction ID}/payout | Creates a fake payout for transaction
+[**post_transactions**](TransactionsApi.md#post_transactions) | **POST** /transactions | Creates a new transaction
+[**validate_transactions**](TransactionsApi.md#validate_transactions) | **POST** /transactions/validate | Validates a transaction payload
+
+
+# **calculate_transactions**
+> TransactionResponse calculate_transactions(transaction_request)
+
+Calculates transaction amounts for a transaction payload
+
+Calculates the input, output and fee amounts for the recipients in a transaction payload
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::TransactionsApi.new
+
+
+begin
+  #Calculates transaction amounts for a transaction payload
+  result = api_instance.calculate_transactions(transaction_request)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("TransactionResponse")
+    p result
+  else
+    puts "Exception when calling TransactionsApi->calculate_transactions: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_request** | [**TransactionRequest**](TransactionRequest.md)|  | 
+
+### Return type
+
+[**TransactionResponse**](TransactionResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the Bitpesa object when setting it up:
+
+```ruby
+
+Bitpesa.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.bitpesa.co/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_transaction**
+> TransactionResponse get_transaction(transaction_id)
+
+Fetch a single transaction
+
+Finds and returns a Transaction created by the requesting API key, using the provided Transaction ID.
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::TransactionsApi.new
+
+
+begin
+  #Fetch a single transaction
+  result = api_instance.get_transaction(transaction_id)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("TransactionResponse")
+    p result
+  else
+    puts "Exception when calling TransactionsApi->get_transaction: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_id** | [**String**](.md)| ID of the transaction.  Example: &#x60;/v1/transactions/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | 
+
+### Return type
+
+[**TransactionResponse**](TransactionResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the Bitpesa object when setting it up:
+
+```ruby
+
+Bitpesa.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.bitpesa.co/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_transactions**
+> TransactionListResponse get_transactions(opts)
+
+Get a list of transactions
+
+Retrieves a paginated list of the Transactions created by your API key.
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::TransactionsApi.new
+
+opts = { 
+  page: 1 # Integer | The page number to request (defaults to 1)
+  per: 10 # Integer | The number of results to load per page (defaults to 10)
+}
+
+begin
+  #Get a list of transactions
+  result = api_instance.get_transactions(opts)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("TransactionListResponse")
+    p result
+  else
+    puts "Exception when calling TransactionsApi->get_transactions: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| The page number to request (defaults to 1) | [optional] 
+ **per** | **Integer**| The number of results to load per page (defaults to 10) | [optional] 
+
+### Return type
+
+[**TransactionListResponse**](TransactionListResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the Bitpesa object when setting it up:
+
+```ruby
+
+Bitpesa.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.bitpesa.co/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **payin_transaction**
+> TransactionResponse payin_transaction(transaction_idpayin_method_request)
+
+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. 
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::TransactionsApi.new
+
+
+begin
+  #Creates a fake payin for transaction
+  result = api_instance.payin_transaction(transaction_idpayin_method_request)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("TransactionResponse")
+    p result
+  else
+    puts "Exception when calling TransactionsApi->payin_transaction: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_id** | [**String**](.md)| ID of the transaction to payin.  Example: &#x60;/v1/transactions/bf9ff782-e182-45ac-abea-5bce83ad6670/payin&#x60; | 
+ **payin_method_request** | [**PayinMethodRequest**](PayinMethodRequest.md)|  | 
+
+### Return type
+
+[**TransactionResponse**](TransactionResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the Bitpesa object when setting it up:
+
+```ruby
+
+Bitpesa.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.bitpesa.co/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **payout_transaction**
+> TransactionResponse payout_transaction(transaction_id)
+
+Creates a fake payout for transaction
+
+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. 
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::TransactionsApi.new
+
+
+begin
+  #Creates a fake payout for transaction
+  result = api_instance.payout_transaction(transaction_id)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("TransactionResponse")
+    p result
+  else
+    puts "Exception when calling TransactionsApi->payout_transaction: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_id** | [**String**](.md)| ID of the transaction to payout.  Example: &#x60;/v1/transactions/bf9ff782-e182-45ac-abea-5bce83ad6670/payout&#x60; | 
+
+### Return type
+
+[**TransactionResponse**](TransactionResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the Bitpesa object when setting it up:
+
+```ruby
+
+Bitpesa.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.bitpesa.co/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **post_transactions**
+> TransactionResponse post_transactions(transaction_request)
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::TransactionsApi.new
+
+
+begin
+  #Creates a new transaction
+  result = api_instance.post_transactions(transaction_request)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("TransactionResponse")
+    p result
+  else
+    puts "Exception when calling TransactionsApi->post_transactions: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_request** | [**TransactionRequest**](TransactionRequest.md)|  | 
+
+### Return type
+
+[**TransactionResponse**](TransactionResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the Bitpesa object when setting it up:
+
+```ruby
+
+Bitpesa.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.bitpesa.co/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **validate_transactions**
+> TransactionResponse validate_transactions(transaction_request)
+
+Validates a transaction payload
+
+Validates fields in a transaction payload and displays invalid or missing fields
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::TransactionsApi.new
+
+
+begin
+  #Validates a transaction payload
+  result = api_instance.validate_transactions(transaction_request)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("TransactionResponse")
+    p result
+  else
+    puts "Exception when calling TransactionsApi->validate_transactions: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_request** | [**TransactionRequest**](TransactionRequest.md)|  | 
+
+### Return type
+
+[**TransactionResponse**](TransactionResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the Bitpesa object when setting it up:
+
+```ruby
+
+Bitpesa.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.bitpesa.co/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+