transferzero-sdk 1.0.0

data/docs/PayoutMethod.md

@@ -0,0 +1,27 @@
+# TransferZero::PayoutMethod
+
+## Properties
+
+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. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for Senegalese mobile money payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank transfers in GBP.  You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://github.com/transferzero/api-documentation/blob/master/additional-features.md#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] 
+**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
+**fields** | [**Hash<String, FieldDescription>**](FieldDescription.md) | The fields needed for payments with this payment method with details on validation requirements | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethod.new(type: NGN::Bank,
+                                 details: null,
+                                 metadata: {},
+                                 id: null,
+                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]},
+                                 fields: {"email":{"type":"input","validations":{"inclusion":{"in":{"NI":"National Id","PP":"Passport"},"allow_blank":true}}}})
+```
+
+

data/docs/PayoutMethodBankAccountTypeEnum.md

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

data/docs/PayoutMethodDetails.md

@@ -0,0 +1,53 @@
+# TransferZero::PayoutMethodDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**bank_code** | **String** |  | 
+**bank_account** | **String** |  | 
+**bank_account_type** | [**PayoutMethodBankAccountTypeEnum**](PayoutMethodBankAccountTypeEnum.md) |  | 
+**phone_number** | **String** |  | 
+**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | 
+**bank_name** | **String** |  | 
+**iban** | **String** |  | 
+**bic** | **String** |  | [optional] 
+**sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
+**sender_identity_card_id** | **String** |  | 
+**sender_city_of_birth** | **String** |  | 
+**sender_country_of_birth** | **String** |  | 
+**sender_gender** | [**PayoutMethodGenderEnum**](PayoutMethodGenderEnum.md) |  | 
+**reason** | **String** |  | [optional] 
+**identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | [optional] 
+**identity_card_id** | **String** |  | [optional] 
+**reference** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetails.new(first_name: null,
+                                 last_name: null,
+                                 bank_code: null,
+                                 bank_account: null,
+                                 bank_account_type: null,
+                                 phone_number: null,
+                                 mobile_provider: null,
+                                 bank_name: null,
+                                 iban: null,
+                                 bic: null,
+                                 sender_identity_card_type: null,
+                                 sender_identity_card_id: null,
+                                 sender_city_of_birth: null,
+                                 sender_country_of_birth: null,
+                                 sender_gender: null,
+                                 reason: null,
+                                 identity_card_type: null,
+                                 identity_card_id: null,
+                                 reference: null)
+```
+
+

data/docs/PayoutMethodDetailsBalance.md

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

data/docs/PayoutMethodDetailsGHSBank.md

@@ -0,0 +1,23 @@
+# TransferZero::PayoutMethodDetailsGHSBank
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**bank_code** | **String** |  | 
+**bank_account** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsGHSBank.new(first_name: null,
+                                 last_name: null,
+                                 bank_code: null,
+                                 bank_account: null)
+```
+
+

data/docs/PayoutMethodDetailsIBAN.md

@@ -0,0 +1,25 @@
+# TransferZero::PayoutMethodDetailsIBAN
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**bank_name** | **String** |  | 
+**iban** | **String** |  | 
+**bic** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsIBAN.new(first_name: null,
+                                 last_name: null,
+                                 bank_name: null,
+                                 iban: null,
+                                 bic: null)
+```
+
+

data/docs/PayoutMethodDetailsMADCash.md

@@ -0,0 +1,37 @@
+# TransferZero::PayoutMethodDetailsMADCash
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**phone_number** | **String** |  | 
+**sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
+**sender_identity_card_id** | **String** |  | 
+**sender_city_of_birth** | **String** |  | 
+**sender_country_of_birth** | **String** |  | 
+**sender_gender** | [**PayoutMethodGenderEnum**](PayoutMethodGenderEnum.md) |  | 
+**reason** | **String** |  | [optional] 
+**identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | [optional] 
+**identity_card_id** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsMADCash.new(first_name: null,
+                                 last_name: null,
+                                 phone_number: null,
+                                 sender_identity_card_type: null,
+                                 sender_identity_card_id: null,
+                                 sender_city_of_birth: null,
+                                 sender_country_of_birth: null,
+                                 sender_gender: null,
+                                 reason: null,
+                                 identity_card_type: null,
+                                 identity_card_id: null)
+```
+
+

data/docs/PayoutMethodDetailsMobile.md

@@ -0,0 +1,21 @@
+# TransferZero::PayoutMethodDetailsMobile
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**phone_number** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsMobile.new(first_name: null,
+                                 last_name: null,
+                                 phone_number: null)
+```
+
+

data/docs/PayoutMethodDetailsNGNBank.md

@@ -0,0 +1,25 @@
+# TransferZero::PayoutMethodDetailsNGNBank
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**bank_code** | **String** |  | 
+**bank_account** | **String** |  | 
+**bank_account_type** | [**PayoutMethodBankAccountTypeEnum**](PayoutMethodBankAccountTypeEnum.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsNGNBank.new(first_name: null,
+                                 last_name: null,
+                                 bank_code: null,
+                                 bank_account: null,
+                                 bank_account_type: null)
+```
+
+

data/docs/PayoutMethodDetailsXOFMobile.md

@@ -0,0 +1,23 @@
+# TransferZero::PayoutMethodDetailsXOFMobile
+
+## 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::PayoutMethodDetailsXOFMobile.new(first_name: null,
+                                 last_name: null,
+                                 phone_number: null,
+                                 mobile_provider: null)
+```
+
+

data/docs/PayoutMethodGenderEnum.md

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

data/docs/PayoutMethodIdentityCardTypeEnum.md

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

data/docs/PayoutMethodListResponse.md

@@ -0,0 +1,19 @@
+# TransferZero::PayoutMethodListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Array<PayoutMethod>**](PayoutMethod.md) |  | [optional] 
+**meta** | [**PaginationMeta**](PaginationMeta.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodListResponse.new(object: null,
+                                 meta: null)
+```
+
+

data/docs/PayoutMethodMobileProviderEnum.md

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

data/docs/PayoutMethodRequest.md

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

data/docs/PayoutMethodResponse.md

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

data/docs/PayoutMethodWebhook.md

@@ -0,0 +1,21 @@
+# TransferZero::PayoutMethodWebhook
+
+## 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** | [**PayoutMethod**](PayoutMethod.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodWebhook.new(webhook: b2f574ff-7efe-4579-9f16-fcb9097e5ab6,
+                                 event: transaction.paid,
+                                 object: null)
+```
+
+

data/docs/PayoutMethodsApi.md

@@ -0,0 +1,334 @@
+# TransferZero::PayoutMethodsApi
+
+All URIs are relative to *https://api-sandbox.transferzero.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_payout_method**](PayoutMethodsApi.md#delete_payout_method) | **DELETE** /payout_methods/{Payout Method ID} | Deleting a payout method
+[**get_payout_method**](PayoutMethodsApi.md#get_payout_method) | **GET** /payout_methods/{Payout Method ID} | Fetching a payout method
+[**get_payout_methods**](PayoutMethodsApi.md#get_payout_methods) | **GET** /payout_methods | Listing payout methods
+[**patch_payout_method**](PayoutMethodsApi.md#patch_payout_method) | **PATCH** /payout_methods/{Payout Method ID} | Updating a payout method
+[**post_payout_methods**](PayoutMethodsApi.md#post_payout_methods) | **POST** /payout_methods | Creating a payout method
+
+
+# **delete_payout_method**
+> PayoutMethodResponse delete_payout_method(payout_method_id)
+
+Deleting a payout method
+
+Deletes a single payout method by the Payout Method ID
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::PayoutMethodsApi.new
+
+
+begin
+  #Deleting a payout method
+  result = api_instance.delete_payout_method(payout_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("PayoutMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayoutMethodsApi->delete_payout_method: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_method_id** | [**String**](.md)| ID of the payout method to delete.  Example: `/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670` | 
+
+### Return type
+
+[**PayoutMethodResponse**](PayoutMethodResponse.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_payout_method**
+> PayoutMethodResponse get_payout_method(payout_method_id)
+
+Fetching a payout method
+
+Show a payout method by id
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::PayoutMethodsApi.new
+
+
+begin
+  #Fetching a payout method
+  result = api_instance.get_payout_method(payout_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("PayoutMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayoutMethodsApi->get_payout_method: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_method_id** | [**String**](.md)| ID of the payout method to get.  Example: &#x60;/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | 
+
+### Return type
+
+[**PayoutMethodResponse**](PayoutMethodResponse.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_payout_methods**
+> PayoutMethodListResponse get_payout_methods(opts)
+
+Listing payout methods
+
+List available payout methods
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::PayoutMethodsApi.new
+
+opts = { 
+  state: ['state_example'] # Array<String> | Allows filtering results by `state` of the payout method.  Example: `/v1/payout_methods?state[]=enabled`
+  type: ['type_example'] # Array<String> | Allows filtering results by the specified type.  Example: `/v1/payout_methods?type[]=NGN::Bank`
+  sender_id: 'sender_id_example' # String | Allows filtering results by the specified sender id.  Example: `/v1/payout_methods?sender_id=bf9ff782-e182-45ac-abea-5bce83ad6670`
+  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)
+  created_at_from: 'created_at_from_example' # String | 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`
+  created_at_to: 'created_at_to_example' # String | 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`
+}
+
+begin
+  #Listing payout methods
+  result = api_instance.get_payout_methods(opts)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayoutMethodListResponse")
+    p result
+  else
+    puts "Exception when calling PayoutMethodsApi->get_payout_methods: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **state** | [**Array&lt;String&gt;**](String.md)| Allows filtering results by &#x60;state&#x60; of the payout method.  Example: &#x60;/v1/payout_methods?state[]&#x3D;enabled&#x60; | [optional] 
+ **type** | [**Array&lt;String&gt;**](String.md)| Allows filtering results by the specified type.  Example: &#x60;/v1/payout_methods?type[]&#x3D;NGN::Bank&#x60; | [optional] 
+ **sender_id** | **String**| Allows filtering results by the specified sender id.  Example: &#x60;/v1/payout_methods?sender_id&#x3D;bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | [optional] 
+ **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] 
+ **created_at_from** | **String**| 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; | [optional] 
+ **created_at_to** | **String**| 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; | [optional] 
+
+### Return type
+
+[**PayoutMethodListResponse**](PayoutMethodListResponse.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_payout_method**
+> PayoutMethodResponse patch_payout_method(payout_method_idpayout_method)
+
+Updating a payout method
+
+Updates the payout method specified in the URL path.
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::PayoutMethodsApi.new
+
+
+begin
+  #Updating a payout method
+  result = api_instance.patch_payout_method(payout_method_idpayout_method)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayoutMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayoutMethodsApi->patch_payout_method: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_method_id** | [**String**](.md)| ID of the payout method to get.  Example: &#x60;/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | 
+ **payout_method** | [**PayoutMethod**](PayoutMethod.md)|  | 
+
+### Return type
+
+[**PayoutMethodResponse**](PayoutMethodResponse.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
+
+
+
+# **post_payout_methods**
+> PayoutMethodResponse post_payout_methods(payout_method_request)
+
+Creating a payout method
+
+Creates a new payout method in our system. 
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::PayoutMethodsApi.new
+
+
+begin
+  #Creating a payout method
+  result = api_instance.post_payout_methods(payout_method_request)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayoutMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayoutMethodsApi->post_payout_methods: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_method_request** | [**PayoutMethodRequest**](PayoutMethodRequest.md)|  | 
+
+### Return type
+
+[**PayoutMethodResponse**](PayoutMethodResponse.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
+
+
+