transferzero-sdk 1.8.0 → 1.12.0

data/docs/FieldSelectValidation.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'TransferZero'
 
 instance = TransferZero::FieldSelectValidation.new(_in: {"20":"Current","10":"Savings"},
-                                 allow_blank: null)
+                                 allow_blank: false)
 ```
 
 

data/docs/FieldValidation.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::FieldValidation.new(presence: null,
+instance = TransferZero::FieldValidation.new(presence: true,
                                  inclusion: null,
                                  format: {"with":"(?-mix:\\A\\d+\\z)"})
 ```

data/docs/PayinMethodDetails.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **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] 
+**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
 
@@ -17,7 +18,8 @@ require 'TransferZero'
 instance = TransferZero::PayinMethodDetails.new(payment_method: null,
                                  redirect_url: null,
                                  phone_number: +2569999999,
-                                 send_instructions: null)
+                                 send_instructions: true,
+                                 refund_address: null)
 ```
 
 

data/docs/PayinMethodDetailsBTC.md

@@ -0,0 +1,17 @@
+# TransferZero::PayinMethodDetailsBTC
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayinMethodDetailsBTC.new(refund_address: null)
+```
+
+

data/docs/PayinMethodDetailsMobile.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'TransferZero'
 
 instance = TransferZero::PayinMethodDetailsMobile.new(phone_number: +2569999999,
-                                 send_instructions: null)
+                                 send_instructions: true)
 ```
 
 

data/docs/PaymentMethod.md

@@ -18,9 +18,9 @@ require 'TransferZero'
 
 instance = TransferZero::PaymentMethod.new(type: NGN::Bank,
                                  provider: Interswitch,
-                                 otc_permitted: null,
+                                 otc_permitted: false,
                                  details: ["email","first_name","last_name","address"],
-                                 default: null,
+                                 default: false,
                                  fields: {"email":{"type":"input","validations":{"inclusion":{"in":{"NI":"National Id","PP":"Passport"},"allow_blank":true}}}})
 ```
 

data/docs/PaymentMethodOpposite.md

@@ -19,9 +19,9 @@ require 'TransferZero'
 
 instance = TransferZero::PaymentMethodOpposite.new(type: NGN::Bank,
                                  provider: Interswitch,
-                                 otc_permitted: null,
+                                 otc_permitted: false,
                                  details: ["email","first_name","last_name","address"],
-                                 default: null,
+                                 default: false,
                                  fields: {"email":{"type":"input","validations":{"inclusion":{"in":{"NI":"National Id","PP":"Passport"},"allow_blank":true}}}},
                                  opposites: null)
 ```

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. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for Senegalese mobile money payments. - `XOF::Bank` - for Senegalese bank account payments. *** Currently in Beta phase *** - `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 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://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. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for Senegalese mobile money payments. - `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.  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/PayoutMethodCashProviderEnum.md

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

data/docs/PayoutMethodCountryEnum.md

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

data/docs/PayoutMethodDetails.md

@@ -14,6 +14,9 @@ Name | Type | Description | Notes
 **iban** | **String** |  | 
 **bank_name** | **String** |  | 
 **bank_country** | **String** |  | 
+**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) |  | [optional] 
+**country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) |  | [optional] 
+**sort_code** | **String** |  | [optional] 
 **bic** | **String** |  | [optional] 
 **sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
 **sender_identity_card_id** | **String** |  | 
@@ -24,6 +27,13 @@ Name | Type | Description | Notes
 **identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | [optional] 
 **identity_card_id** | **String** |  | [optional] 
 **reference** | **String** |  | [optional] 
+**name** | **String** |  | 
+**address** | **String** |  | 
+**street** | **String** |  | 
+**postal_code** | **String** |  | 
+**city** | **String** |  | 
+**email** | **String** |  | [optional] 
+**transfer_reason_code** | **String** |  | [optional] 
 
 ## Code Sample
 
@@ -40,6 +50,9 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
                                  iban: null,
                                  bank_name: null,
                                  bank_country: null,
+                                 cash_provider: null,
+                                 country: null,
+                                 sort_code: null,
                                  bic: null,
                                  sender_identity_card_type: null,
                                  sender_identity_card_id: null,
@@ -49,7 +62,14 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
                                  reason: null,
                                  identity_card_type: null,
                                  identity_card_id: null,
-                                 reference: null)
+                                 reference: null,
+                                 name: null,
+                                 address: null,
+                                 street: null,
+                                 postal_code: null,
+                                 city: null,
+                                 email: null,
+                                 transfer_reason_code: null)
 ```
 
 

data/docs/PayoutMethodDetailsBTC.md

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

data/docs/PayoutMethodDetailsGBPBank.md

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

data/docs/PayoutMethodDetailsIBAN.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **first_name** | **String** |  | 
 **last_name** | **String** |  | 
-**bank_name** | **String** |  | 
+**bank_name** | **String** |  | [optional] 
 **iban** | **String** |  | 
 **bic** | **String** |  | [optional] 
 

data/docs/PayoutMethodDetailsMobile.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **first_name** | **String** |  | 
 **last_name** | **String** |  | 
 **phone_number** | **String** |  | 
+**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | [optional] 
 
 ## Code Sample
 
@@ -15,7 +16,8 @@ require 'TransferZero'
 
 instance = TransferZero::PayoutMethodDetailsMobile.new(first_name: null,
                                  last_name: null,
-                                 phone_number: null)
+                                 phone_number: null,
+                                 mobile_provider: null)
 ```
 
 

data/docs/PayoutMethodDetailsXOFCash.md

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

data/docs/PayoutMethodDetailsZARBank.md

@@ -0,0 +1,35 @@
+# TransferZero::PayoutMethodDetailsZARBank
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**street** | **String** |  | 
+**postal_code** | **String** |  | 
+**city** | **String** |  | 
+**email** | **String** |  | [optional] 
+**bank_code** | **String** |  | 
+**bank_account** | **String** |  | 
+**phone_number** | **String** |  | 
+**transfer_reason_code** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsZARBank.new(first_name: null,
+                                 last_name: null,
+                                 street: null,
+                                 postal_code: null,
+                                 city: null,
+                                 email: null,
+                                 bank_code: null,
+                                 bank_account: null,
+                                 phone_number: null,
+                                 transfer_reason_code: null)
+```
+
+

data/docs/ProofOfPayment.md

@@ -0,0 +1,23 @@
+# TransferZero::ProofOfPayment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | UUID of the uploaded document | [optional] 
+**file_name** | **String** | Name of the uploaded file | [optional] 
+**thumbnail** | **String** | URL to thumbnail image of the uploaded file | [optional] 
+**url** | **String** | URL to uploaded file | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::ProofOfPayment.new(id: null,
+                                 file_name: my_file.jpg,
+                                 thumbnail: https://bitpesa-development.s3.eu-west-1.amazonaws.com/my_file_thumb.jpg,
+                                 url: https://bitpesa-development.s3.eu-west-1.amazonaws.com/my_file.jpg)
+```
+
+

data/docs/ProofOfPaymentListResponse.md

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

data/docs/Recipient.md

@@ -12,10 +12,12 @@ Name | Type | Description | Notes
 **editable** | **Boolean** | Shows whether the recipient can be edited using the PATCH /v1/recipients/{id} endpoint or not | [optional] 
 **retriable** | **Boolean** | Shows whether the transaction made to the recipient can be retried or not | [optional] 
 **input_usd_amount** | **Float** | Shows how much this payment is worth in USD | [optional] 
-**may_cancel** | **Boolean** | Shows whether the payment can be cancelled using the DELETE /v1/recipients/{id} endpoint or not. The payment can not be cancelled if the payout is pending. | [optional] 
+**may_cancel** | **Boolean** | If true it shows that the payment can be cancelled immediately using the DELETE /v1/recipients/{id} endpoint. If false you can still try to cancel it, however it will only gets cancelled once we have confirmation from our partner that the payment has failed. | [optional] 
 **state_reason** | **String** | In case the payment is unsuccessful it holds the error message associated with the last unsuccessful payout. | [optional] 
+**state_reason_details** | [**RecipientStateReasonDetails**](RecipientStateReasonDetails.md) |  | [optional] 
 **state** | [**RecipientState**](RecipientState.md) |  | [optional] 
 **transaction_id** | **String** | The ID of the transaction that is related to this recipient | [optional] 
+**transaction_external_id** | **String** | Optional ID that is supplied by partner linking it to the partner's own Transaction ID. | [optional] 
 **transaction_state** | [**TransactionState**](TransactionState.md) |  | [optional] 
 **exchange_rate** | **Float** | The exchange rate used in this payment | [optional] 
 **fee_fractional** | **Float** | The fee for this payment in fractional units (for example cents for USD transactions) | [optional] 
@@ -36,13 +38,15 @@ instance = TransferZero::Recipient.new(requested_amount: 750.0,
                                  payout_method: null,
                                  metadata: {},
                                  created_at: null,
-                                 editable: null,
-                                 retriable: null,
+                                 editable: true,
+                                 retriable: true,
                                  input_usd_amount: 10,
-                                 may_cancel: null,
+                                 may_cancel: true,
                                  state_reason: null,
+                                 state_reason_details: null,
                                  state: null,
                                  transaction_id: 97e79719-06e4-4794-aeeb-d2d9415d983a,
+                                 transaction_external_id: 806ec63a-a5a7-43cc-9d75-1ee74fbcc026,
                                  transaction_state: null,
                                  exchange_rate: 1000,
                                  fee_fractional: 100,

data/docs/RecipientStateReasonDetails.md

@@ -0,0 +1,23 @@
+# TransferZero::RecipientStateReasonDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Status code of failed transaction | [optional] 
+**category** | **String** | Main category of error, it could be paid, unknown, pickupable, temporary_error, recipient_error, sender_error | [optional] 
+**messages** | **Array<String>** | Tiered messages | [optional] 
+**description** | **String** | Public, human readable, detailed error message | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::RecipientStateReasonDetails.new(code: 311,
+                                 category: temporary_error,
+                                 messages: ["Temporary error","Switch Error","Issuer/Switch inoperative"],
+                                 description: The central switch is not accepting transfers at the moment. We will retry the transaction. You can also edit or cancel this transaction.)
+```
+
+

data/docs/RecipientsApi.md

@@ -7,6 +7,7 @@ Method | HTTP request | Description
 [**delete_recipient**](RecipientsApi.md#delete_recipient) | **DELETE** /recipients/{Recipient ID} | Cancelling a recipient
 [**get_recipients**](RecipientsApi.md#get_recipients) | **GET** /recipients | Getting a list of recipients with filtering
 [**patch_recipient**](RecipientsApi.md#patch_recipient) | **PATCH** /recipients/{Recipient ID} | Updating a recipient
+[**proof_of_payments**](RecipientsApi.md#proof_of_payments) | **GET** /recipients/{Recipient ID}/proof_of_payments | Returns list of proof of payments
 
 
 # **delete_recipient**
@@ -14,7 +15,7 @@ Method | HTTP request | Description
 
 Cancelling a recipient
 
-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.
+Cancels the payment to the recipient specified in the URL path.  Please note recipients where the `may_cancel` attribute is true will be cancelled immediately. If the `may_cancel` attribute is false you can still try to cancel the recipient, however it will only gets cancelled if we will receive a confirmation from our partner that the payment has failed
 
 ### Example
 ```ruby
@@ -210,3 +211,64 @@ end
 
 
 
+# **proof_of_payments**
+> ProofOfPaymentListResponse proof_of_payments(recipient_id)
+
+Returns list of proof of payments
+
+Returns a list of uploaded proof of payment files for a transaction recipient
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::RecipientsApi.new
+
+
+begin
+  #Returns list of proof of payments
+  result = api_instance.proof_of_payments(recipient_id)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("ProofOfPaymentListResponse")
+    p result
+  else
+    puts "Exception when calling RecipientsApi->proof_of_payments: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **recipient_id** | [**String**](.md)| ID of the recipient for whom the proof of payments will be returned.  Example: `/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33/proof_of_payments` | 
+
+### Return type
+
+[**ProofOfPaymentListResponse**](ProofOfPaymentListResponse.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
+
+
+