transferzero-sdk 1.16.1 → 1.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cb88f7dd25322010286cda4057d0fa7353f08a01372ddd384c25c14a6a42644
-  data.tar.gz: b4fe63d3416fe08dbbe8c8622a09fe1c4014ff6b6cab1bc6afb3e5f4e6b7a258
+  metadata.gz: '00468d46970a925efd5635a7582a0d3a1c1960f9506eb0a50d9b2abcaddc5a20'
+  data.tar.gz: c6ee6c667f53b785dc92c3635ba29f1350d28b66dadddbbe7f7041e9ffa173fc
 SHA512:
-  metadata.gz: 74ccb124ad0d3146592a1380d91e7a77b2bf4090cc2670b4ecbbfe2157a30077b629e8770b14368d2d98e3d31d3bbd7e8845e0a6ba35d454cdefe3be36b57ce8
-  data.tar.gz: a2418c3385939f664e2fe2167627814dd351874241237fac09a8764a7a369e937ff01dd5dfd2c520db407b4707390fbed0b653ec423495c7eecba74854c6c499
+  metadata.gz: 4cca859d0aa1c027a2a4d99fd3f84c3274143ebae977de2aa69a3f3397e9869cbf1b79a32d3b6c18be2613a58dcbc11f76e4898a2c443876a5b7c42a25fa00c2
+  data.tar.gz: 574688f95c6f1cd9c2675d3730ad647a635507df70d83c15dc60a547e737f8515a6b3a587744c378a6ee2ceed8b78f6d1053317f3ca6ad25c8cfd325b7542483

data/README.md

@@ -7,7 +7,7 @@ Reference documentation for the TransferZero API V1
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 1.16.1
+- Package version: 1.19.1
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 For more information, please visit:
@@ -31,15 +31,15 @@ gem build transferzero-sdk.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./transferzero-sdk-1.16.1.gem
+gem install ./transferzero-sdk-1.19.1.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.16.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.19.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'transferzero-sdk', '~> 1.16.1'
+    gem 'transferzero-sdk', '~> 1.19.1'
 
 ### Install from Git
 
@@ -120,6 +120,10 @@ Class | Method | HTTP request | Description
 *TransferZero::DocumentsApi* | [**post_documents**](docs/DocumentsApi.md#post_documents) | **POST** /documents | Creating a document
 *TransferZero::LogsApi* | [**get_webhook_log**](docs/LogsApi.md#get_webhook_log) | **GET** /logs/{Webhook Log ID} | Fetch an individual webhook log
 *TransferZero::LogsApi* | [**get_webhook_logs**](docs/LogsApi.md#get_webhook_logs) | **GET** /logs/webhooks | Fetch a list of webhook logs
+*TransferZero::PayinMethodsApi* | [**delete_payin_method**](docs/PayinMethodsApi.md#delete_payin_method) | **DELETE** /payin_methods/{PayinMethod ID} | Deleting a payin method
+*TransferZero::PayinMethodsApi* | [**get_payin_method**](docs/PayinMethodsApi.md#get_payin_method) | **GET** /payin_methods/{PayinMethod ID} | Fetching a payin method
+*TransferZero::PayinMethodsApi* | [**patch_payin_method**](docs/PayinMethodsApi.md#patch_payin_method) | **PATCH** /payin_methods/{PayinMethod ID} | Updating a payin method
+*TransferZero::PayinMethodsApi* | [**retry_payin_method**](docs/PayinMethodsApi.md#retry_payin_method) | **POST** /payin_methods/{PayinMethod ID}/retry | Retries PayinMethod
 *TransferZero::PaymentMethodsApi* | [**payment_methods_in**](docs/PaymentMethodsApi.md#payment_methods_in) | **GET** /info/payment_methods/in | This method returns possible payin methods.
 *TransferZero::PaymentMethodsApi* | [**payment_methods_out**](docs/PaymentMethodsApi.md#payment_methods_out) | **GET** /info/payment_methods/out | This method returns possible payout methods.
 *TransferZero::PayoutMethodsApi* | [**delete_payout_method**](docs/PayoutMethodsApi.md#delete_payout_method) | **DELETE** /payout_methods/{Payout Method ID} | Deleting a payout method
@@ -192,6 +196,9 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayinMethodDetailsMobile](docs/PayinMethodDetailsMobile.md)
  - [TransferZero::PayinMethodDetailsNGNBank](docs/PayinMethodDetailsNGNBank.md)
  - [TransferZero::PayinMethodRequest](docs/PayinMethodRequest.md)
+ - [TransferZero::PayinMethodResponse](docs/PayinMethodResponse.md)
+ - [TransferZero::PayinMethodState](docs/PayinMethodState.md)
+ - [TransferZero::PayinMethodUxFlow](docs/PayinMethodUxFlow.md)
  - [TransferZero::PaymentMethod](docs/PaymentMethod.md)
  - [TransferZero::PaymentMethodListResponse](docs/PaymentMethodListResponse.md)
  - [TransferZero::PaymentMethodOpposite](docs/PaymentMethodOpposite.md)
@@ -205,6 +212,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodDetailsGBPBank](docs/PayoutMethodDetailsGBPBank.md)
  - [TransferZero::PayoutMethodDetailsGHSBank](docs/PayoutMethodDetailsGHSBank.md)
  - [TransferZero::PayoutMethodDetailsGHSCash](docs/PayoutMethodDetailsGHSCash.md)
+ - [TransferZero::PayoutMethodDetailsGNFMobile](docs/PayoutMethodDetailsGNFMobile.md)
  - [TransferZero::PayoutMethodDetailsIBAN](docs/PayoutMethodDetailsIBAN.md)
  - [TransferZero::PayoutMethodDetailsKESBank](docs/PayoutMethodDetailsKESBank.md)
  - [TransferZero::PayoutMethodDetailsKESMobile](docs/PayoutMethodDetailsKESMobile.md)
@@ -213,6 +221,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodDetailsNGNBank](docs/PayoutMethodDetailsNGNBank.md)
  - [TransferZero::PayoutMethodDetailsUSDBank](docs/PayoutMethodDetailsUSDBank.md)
  - [TransferZero::PayoutMethodDetailsUSDCash](docs/PayoutMethodDetailsUSDCash.md)
+ - [TransferZero::PayoutMethodDetailsXAFMobile](docs/PayoutMethodDetailsXAFMobile.md)
  - [TransferZero::PayoutMethodDetailsXOFBank](docs/PayoutMethodDetailsXOFBank.md)
  - [TransferZero::PayoutMethodDetailsXOFCash](docs/PayoutMethodDetailsXOFCash.md)
  - [TransferZero::PayoutMethodDetailsXOFMobile](docs/PayoutMethodDetailsXOFMobile.md)
@@ -225,6 +234,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodNatureOfBusinessEnum](docs/PayoutMethodNatureOfBusinessEnum.md)
  - [TransferZero::PayoutMethodRequest](docs/PayoutMethodRequest.md)
  - [TransferZero::PayoutMethodResponse](docs/PayoutMethodResponse.md)
+ - [TransferZero::PayoutMethodTransferReasonEnum](docs/PayoutMethodTransferReasonEnum.md)
  - [TransferZero::PayoutMethodWebhook](docs/PayoutMethodWebhook.md)
  - [TransferZero::PoliticallyExposedPerson](docs/PoliticallyExposedPerson.md)
  - [TransferZero::ProofOfPayment](docs/ProofOfPayment.md)
@@ -244,6 +254,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::SenderResponseMeta](docs/SenderResponseMeta.md)
  - [TransferZero::SenderState](docs/SenderState.md)
  - [TransferZero::SenderWebhook](docs/SenderWebhook.md)
+ - [TransferZero::StateReasonDetails](docs/StateReasonDetails.md)
  - [TransferZero::Transaction](docs/Transaction.md)
  - [TransferZero::TransactionListResponse](docs/TransactionListResponse.md)
  - [TransferZero::TransactionRequest](docs/TransactionRequest.md)

data/docs/Document.md

@@ -17,6 +17,7 @@ Name | Type | Description | Notes
 **id** | **String** |  | [optional] 
 **document_id** | **String** | Document ID issued by government | [optional] 
 **expiry_date** | **Date** | Document expiry date issued by government | [optional] 
+**source** | **String** | Determines the document's source. Default value \"Manual\" | [optional] 
 **errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
 
 ## Code Sample
@@ -37,6 +38,7 @@ instance = TransferZero::Document.new(upload: data:image/png;base64,iVBORw0KGg..
                                  id: ebe9bc0b-f2f6-4ce8-802a-8b79912d041e,
                                  document_id: XYZ12345,
                                  expiry_date: null,
+                                 source: Manual,
                                  errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
 ```
 

data/docs/PayinMethod.md

@@ -4,22 +4,30 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | Describes how the payment should be requested from the user.  Possible values: - `NGN::Bank`: NGN bank and card collection requests - `NGN::Mobile`: NGN mobile collections - `GHS::Mobile`: GHS mobile collections - `TZS::Mobile`: TZS mobile collections - `UGX::Mobile`: UGX mobile collections - `EUR::Bank`: EUR IBAN collections - `GBP::Bank`: GBP IBAN collections  | [optional] 
+**type** | **String** | Describes how the payment should be requested from the sender.  Possible values: - `GHS::Mobile`: GHS mobile collections - `UGX::Mobile`: UGX mobile collections - `EUR::Bank`: EUR IBAN collections - `GBP::Bank`: GBP IBAN collections  | [optional] 
+**ux_flow** | [**PayinMethodUxFlow**](PayinMethodUxFlow.md) |  | [optional] 
 **in_details** | [**PayinMethodDetails**](PayinMethodDetails.md) |  | [optional] 
+**id** | **String** |  | [optional] 
+**state** | [**PayinMethodState**](PayinMethodState.md) |  | [optional] 
+**state_reason_details** | [**StateReasonDetails**](StateReasonDetails.md) |  | [optional] 
 **out_details** | [**Object**](.md) | This will contain the description on where to pay the funds. Please see the [Collections Details](https://docs.transferzero.com/docs/collection-details) in the API documentation on what to expect here. | [optional] 
 **instructions** | [**Object**](.md) | This will contain the instructions on how to pay the funds. Please see the [Collections Details](https://docs.transferzero.com/docs/collection-details) in the API documentation on what to expect here. | [optional] 
-**provider** | **String** | Describes which provider to use for collection. Please see the [Collections Details](https://docs.transferzero.com/docs/collection-details) in the API documentation on the valid values | [optional] 
+**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::PayinMethod.new(type: NGN::Bank,
+instance = TransferZero::PayinMethod.new(type: GHS::Mobile,
+                                 ux_flow: null,
                                  in_details: null,
+                                 id: 97e79719-06e4-4794-aeeb-d2d9415d983a,
+                                 state: null,
+                                 state_reason_details: null,
                                  out_details: null,
                                  instructions: null,
-                                 provider: null)
+                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
 ```
 
 

data/docs/PayinMethodDetails.md

@@ -4,10 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payment_method** | **String** | The payment method which the user will use to make the payments. Options are `bank`, `card` or you can leave empty to support both. | [optional] 
-**redirect_url** | **String** | This is where the user should be redirected back when the payment has been finished | [optional] 
-**phone_number** | **String** | The phone number where the funds should be collected from | 
-**send_instructions** | **Boolean** | States whether to send out the instructions to the phone number on how to pay the funds or not. This shuold always be set to true, otherwise the sender might not receive a prompt for payment. | [optional] 
+**payment_method** | **String** | The payment method which the sender will use to make the payments. Options are `bank`, `card` or you can leave empty to support both. | [optional] 
+**redirect_url** | **String** | This is where the sender should be redirected back when the payment has been finished | [optional] 
+**phone_number** | **String** | The phone number where the funds should be collected from | [optional] 
+**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | [optional] 
 **refund_address** | **String** | Please make sure the refund_address is a valid BTC address belonging to the sender, as that is going to be used in case the transaction has to be refunded. | [optional] 
 
 ## Code Sample
@@ -18,7 +18,7 @@ require 'TransferZero'
 instance = TransferZero::PayinMethodDetails.new(payment_method: null,
                                  redirect_url: null,
                                  phone_number: +2569999999,
-                                 send_instructions: true,
+                                 mobile_provider: null,
                                  refund_address: null)
 ```
 

data/docs/PayinMethodDetailsMobile.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**phone_number** | **String** | The phone number where the funds should be collected from | 
-**send_instructions** | **Boolean** | States whether to send out the instructions to the phone number on how to pay the funds or not. This shuold always be set to true, otherwise the sender might not receive a prompt for payment. | [optional] 
+**phone_number** | **String** | The phone number where the funds should be collected from | [optional] 
+**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | [optional] 
 
 ## Code Sample
 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'TransferZero'
 
 instance = TransferZero::PayinMethodDetailsMobile.new(phone_number: +2569999999,
-                                 send_instructions: true)
+                                 mobile_provider: null)
 ```
 
 

data/docs/PayinMethodDetailsNGNBank.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payment_method** | **String** | The payment method which the user will use to make the payments. Options are `bank`, `card` or you can leave empty to support both. | [optional] 
-**redirect_url** | **String** | This is where the user should be redirected back when the payment has been finished | [optional] 
+**payment_method** | **String** | The payment method which the sender will use to make the payments. Options are `bank`, `card` or you can leave empty to support both. | [optional] 
+**redirect_url** | **String** | This is where the sender should be redirected back when the payment has been finished | [optional] 
 
 ## Code Sample
 

data/docs/PayinMethodResponse.md

@@ -0,0 +1,17 @@
+# TransferZero::PayinMethodResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**PayinMethod**](PayinMethod.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayinMethodResponse.new(object: null)
+```
+
+

data/docs/PayinMethodState.md

@@ -0,0 +1,16 @@
+# TransferZero::PayinMethodState
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayinMethodState.new()
+```
+
+

data/docs/PayinMethodUxFlow.md

@@ -0,0 +1,16 @@
+# TransferZero::PayinMethodUxFlow
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayinMethodUxFlow.new()
+```
+
+

data/docs/PayinMethodsApi.md

@@ -0,0 +1,256 @@
+# TransferZero::PayinMethodsApi
+
+All URIs are relative to *https://api-sandbox.transferzero.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_payin_method**](PayinMethodsApi.md#delete_payin_method) | **DELETE** /payin_methods/{PayinMethod ID} | Deleting a payin method
+[**get_payin_method**](PayinMethodsApi.md#get_payin_method) | **GET** /payin_methods/{PayinMethod ID} | Fetching a payin method
+[**patch_payin_method**](PayinMethodsApi.md#patch_payin_method) | **PATCH** /payin_methods/{PayinMethod ID} | Updating a payin method
+[**retry_payin_method**](PayinMethodsApi.md#retry_payin_method) | **POST** /payin_methods/{PayinMethod ID}/retry | Retries PayinMethod
+
+
+# **delete_payin_method**
+> PayinMethodResponse delete_payin_method(payin_method_id)
+
+Deleting a payin method
+
+Initiates a cancellation request for the specified payin method
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::PayinMethodsApi.new
+
+
+begin
+  #Deleting a payin method
+  result = api_instance.delete_payin_method(payin_method_id)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayinMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayinMethodsApi->delete_payin_method: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payin_method_id** | [**String**](.md)| ID of the payin method to delete.  Example: `/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670` | 
+
+### Return type
+
+[**PayinMethodResponse**](PayinMethodResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_payin_method**
+> PayinMethodResponse get_payin_method(payin_method_id)
+
+Fetching a payin method
+
+Show a payin method by id
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::PayinMethodsApi.new
+
+
+begin
+  #Fetching a payin method
+  result = api_instance.get_payin_method(payin_method_id)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayinMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayinMethodsApi->get_payin_method: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payin_method_id** | [**String**](.md)| ID of the payin method to get.  Example: &#x60;/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | 
+
+### Return type
+
+[**PayinMethodResponse**](PayinMethodResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **patch_payin_method**
+> PayinMethodResponse patch_payin_method(payin_method_idpayin_method)
+
+Updating a payin method
+
+Updates the payin method specified in the URL path.
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::PayinMethodsApi.new
+
+
+begin
+  #Updating a payin method
+  result = api_instance.patch_payin_method(payin_method_idpayin_method)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayinMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayinMethodsApi->patch_payin_method: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payin_method_id** | [**String**](.md)| ID of the payin method to get.  Example: &#x60;/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | 
+ **payin_method** | [**PayinMethod**](PayinMethod.md)|  | 
+
+### Return type
+
+[**PayinMethodResponse**](PayinMethodResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retry_payin_method**
+> retry_payin_method(payin_method_id)
+
+Retries PayinMethod
+
+Retries the collection process for the payin method.  Please note only payin methods in `error` state can be retried.
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::PayinMethodsApi.new
+
+
+begin
+  #Retries PayinMethod
+  api_instance.retry_payin_method(payin_method_id)
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("")
+    p result
+  else
+    puts "Exception when calling PayinMethodsApi->retry_payin_method: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payin_method_id** | [**String**](.md)| ID of the payin method whose collection process should be retried  Example: &#x60;/v1/payin_methods/9d4d7b73-a94c-4979-ab57-09074fd55d33/retry&#x60; | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/PayoutMethod.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | Contains the currency to send the money to, and the type of the money movement  Commonly used payout types are:  - `NGN::Bank` - for Nigerian bank account payments. - `NGN::Mobile` - for Nigerian mobile money payments. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `GHS::Cash` - for Ghanaian cash remittance payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for mobile money payments to West-Africa. - `XOF::Bank` - for Senegalese bank account payments. - `XOF::Cash` - for Senegalese cash remittance payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank and FP accounts transfers in GBP. - `ZAR::Bank` - for South Africa bank account payments. - `USD::Bank` - for USD account payments. *** Currently Nigeria only and in Beta phase *** - `USD::Cash` - for USD cash remittance payments. *** Currently Nigeria only and in Beta phase *** - `KES::Bank` - for Kenyan bank account payments. - `KES::Mobile` - for Kenyan mobile money payments.  You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://docs.transferzero.com/docs/additional-features/#collections-from-senders) for more info on how to collect money into internal balance  | [optional] 
+**type** | **String** | Contains the currency to send the money to, and the type of the money movement  Commonly used payout types are:  - `NGN::Bank` - for Nigerian bank account payments. - `NGN::Mobile` - for Nigerian mobile money payments. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `GHS::Cash` - for Ghanaian cash remittance payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for mobile money payments to West-Africa. - `XOF::Bank` - for Senegalese bank account payments. - `XOF::Cash` - for Senegalese cash remittance payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank and FP accounts transfers in GBP. - `ZAR::Bank` - for South Africa bank account payments. - `USD::Bank` - for USD account payments. *** Currently Nigeria only and in Beta phase *** - `USD::Cash` - for USD cash remittance payments. *** Currently Nigeria only and in Beta phase *** - `KES::Bank` - for Kenyan bank account payments. - `KES::Mobile` - for Kenyan mobile money payments. - `XAF::Mobile` - for mobile money payments to Cameroon. - `GNF::Mobile` - for mobile money payments to Guinea.  You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://docs.transferzero.com/docs/additional-features/#collections-from-senders) for more info on how to collect money into internal balance  | [optional] 
 **details** | [**PayoutMethodDetails**](PayoutMethodDetails.md) |  | [optional] 
 **metadata** | [**Object**](.md) | Metadata of payout method. You can store any kind of information in this field. | [optional] 
 **id** | **String** |  | [optional] 

data/docs/PayoutMethodDetails.md

@@ -12,10 +12,11 @@ Name | Type | Description | Notes
 **phone_number** | **String** |  | 
 **mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | 
 **country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) |  | 
+**transfer_reason** | [**PayoutMethodTransferReasonEnum**](PayoutMethodTransferReasonEnum.md) |  | [optional] 
 **iban** | **String** |  | 
 **bank_name** | **String** |  | 
 **bank_country** | **String** |  | [optional] 
-**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) |  | [optional] 
+**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) |  | 
 **sort_code** | **String** |  | [optional] 
 **bic** | **String** |  | [optional] 
 **sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
@@ -33,7 +34,7 @@ Name | Type | Description | Notes
 **postal_code** | **String** |  | 
 **city** | **String** |  | 
 **email** | **String** |  | [optional] 
-**transfer_reason_code** | **String** |  | 
+**transfer_reason_code** | **String** |  | [optional] 
 **contact_first_name** | **String** |  | [optional] 
 **contact_last_name** | **String** |  | [optional] 
 **registration_number** | **String** |  | [optional] 
@@ -55,6 +56,7 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
                                  phone_number: null,
                                  mobile_provider: null,
                                  country: null,
+                                 transfer_reason: null,
                                  iban: null,
                                  bank_name: null,
                                  bank_country: null,

data/docs/PayoutMethodDetailsGNFMobile.md

@@ -0,0 +1,23 @@
+# TransferZero::PayoutMethodDetailsGNFMobile
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**phone_number** | **String** |  | 
+**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsGNFMobile.new(first_name: null,
+                                 last_name: null,
+                                 phone_number: null,
+                                 mobile_provider: null)
+```
+
+

data/docs/PayoutMethodDetailsKESBank.md

@@ -12,7 +12,8 @@ Name | Type | Description | Notes
 **bank_name** | **String** |  | 
 **branch_code** | **String** |  | [optional] 
 **swift_code** | **String** |  | 
-**transfer_reason_code** | **String** |  | 
+**transfer_reason_code** | **String** |  | [optional] 
+**transfer_reason** | [**PayoutMethodTransferReasonEnum**](PayoutMethodTransferReasonEnum.md) |  | [optional] 
 **identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
 **identity_card_id** | **String** |  | 
 
@@ -30,6 +31,7 @@ instance = TransferZero::PayoutMethodDetailsKESBank.new(first_name: null,
                                  branch_code: null,
                                  swift_code: null,
                                  transfer_reason_code: null,
+                                 transfer_reason: null,
                                  identity_card_type: null,
                                  identity_card_id: null)
 ```

data/docs/PayoutMethodDetailsKESMobile.md

@@ -9,7 +9,8 @@ Name | Type | Description | Notes
 **street** | **String** |  | 
 **phone_number** | **String** |  | 
 **mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | 
-**transfer_reason_code** | **String** |  | 
+**transfer_reason_code** | **String** |  | [optional] 
+**transfer_reason** | [**PayoutMethodTransferReasonEnum**](PayoutMethodTransferReasonEnum.md) |  | [optional] 
 **identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
 **identity_card_id** | **String** |  | 
 
@@ -24,6 +25,7 @@ instance = TransferZero::PayoutMethodDetailsKESMobile.new(first_name: null,
                                  phone_number: null,
                                  mobile_provider: null,
                                  transfer_reason_code: null,
+                                 transfer_reason: null,
                                  identity_card_type: null,
                                  identity_card_id: null)
 ```

data/docs/PayoutMethodDetailsXAFMobile.md

@@ -0,0 +1,25 @@
+# TransferZero::PayoutMethodDetailsXAFMobile
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**phone_number** | **String** |  | 
+**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | 
+**country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsXAFMobile.new(first_name: null,
+                                 last_name: null,
+                                 phone_number: null,
+                                 mobile_provider: null,
+                                 country: null)
+```
+
+

data/docs/PayoutMethodDetailsXOFBank.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **bank_name** | **String** |  | [optional] 
 **bank_country** | **String** |  | [optional] 
 **bank_code** | **String** |  | [optional] 
+**transfer_reason** | [**PayoutMethodTransferReasonEnum**](PayoutMethodTransferReasonEnum.md) |  | [optional] 
 
 ## Code Sample
 
@@ -21,7 +22,8 @@ instance = TransferZero::PayoutMethodDetailsXOFBank.new(first_name: null,
                                  iban: null,
                                  bank_name: null,
                                  bank_country: null,
-                                 bank_code: null)
+                                 bank_code: null,
+                                 transfer_reason: null)
 ```