transferzero-sdk 1.9.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65abf7df38463761e657c72743e2d3906ca55b9933ecb0fec06e0213bc965efe
-  data.tar.gz: 71e6bfa8a8ec907e24f2abec488fea17a54512b7d74bd4aac6e10af62d5f985c
+  metadata.gz: '098d647f781cc5eb0d7a5c3ff7be86ed615ab3aea94a154cf2897b3fefebd7c6'
+  data.tar.gz: 56fdced0faebdbdd9e9ef70765e944272d52db9beb60fc780b1181c8bdf0e4c3
 SHA512:
-  metadata.gz: 1d14e138f2cfb1ebebdc156ca10c845f8586ec1784b5b80beef15fe8a7e0b9921dc0b46fcf3072e201e01bd6a1f82d9bfc1a329c82847cd86f3c2c90002d5c94
-  data.tar.gz: a06e60260498ef33c734de0023286ed7363a2c0af064526aef9f92fdfaf83b2bd0c11ed3186e47c572f83675e0d1a8bc5b645e1b4601f22dfe565a890b034a6d
+  metadata.gz: 81fab8828444155af24970fb9cf6a57666c241814685689f145a6d77c31d2eb61cc45f15287465f889ef60cdd5a69213057e0dd0d62d2ac0fb6508136dfc1a86
+  data.tar.gz: 14674bc6e5620af322b800f8263b7a1804f73f03004ba9775f331010a94df9aac58d92577b77dccf9e779adf02445e3a5abc02ef88634b2ba8d41df5a83a3aef

data/Gemfile.lock

@@ -0,0 +1,94 @@
+PATH
+  remote: .
+  specs:
+    transferzero-sdk (1.13.0)
+      activesupport (>= 4)
+      json (>= 1.4)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.12.0)
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.17)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.14.2)
+    hashdiff (1.0.1)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    json (2.5.1)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.6)
+    rake (12.0.0)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-18
+
+DEPENDENCIES
+  ZenTest (~> 4.11, >= 4.11.2)
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  transferzero-sdk!
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   2.2.13

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.9.0
+- Package version: 1.13.0
 - 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.9.0.gem
+gem install ./transferzero-sdk-1.13.0.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.9.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.13.0.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.9.0'
+    gem 'transferzero-sdk', '~> 1.13.0'
 
 ### Install from Git
 
@@ -130,6 +130,7 @@ Class | Method | HTTP request | Description
 *TransferZero::RecipientsApi* | [**delete_recipient**](docs/RecipientsApi.md#delete_recipient) | **DELETE** /recipients/{Recipient ID} | Cancelling a recipient
 *TransferZero::RecipientsApi* | [**get_recipients**](docs/RecipientsApi.md#get_recipients) | **GET** /recipients | Getting a list of recipients with filtering
 *TransferZero::RecipientsApi* | [**patch_recipient**](docs/RecipientsApi.md#patch_recipient) | **PATCH** /recipients/{Recipient ID} | Updating a recipient
+*TransferZero::RecipientsApi* | [**proof_of_payments**](docs/RecipientsApi.md#proof_of_payments) | **GET** /recipients/{Recipient ID}/proof_of_payments | Returns list of proof of payments
 *TransferZero::SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{Sender ID} | Deleting a sender
 *TransferZero::SendersApi* | [**get_sender**](docs/SendersApi.md#get_sender) | **GET** /senders/{Sender ID} | Fetching a sender
 *TransferZero::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Listing senders
@@ -196,16 +197,20 @@ Class | Method | HTTP request | Description
  - [TransferZero::PaymentMethodOpposite](docs/PaymentMethodOpposite.md)
  - [TransferZero::PayoutMethod](docs/PayoutMethod.md)
  - [TransferZero::PayoutMethodBankAccountTypeEnum](docs/PayoutMethodBankAccountTypeEnum.md)
+ - [TransferZero::PayoutMethodCashProviderEnum](docs/PayoutMethodCashProviderEnum.md)
+ - [TransferZero::PayoutMethodCountryEnum](docs/PayoutMethodCountryEnum.md)
  - [TransferZero::PayoutMethodDetails](docs/PayoutMethodDetails.md)
  - [TransferZero::PayoutMethodDetailsBTC](docs/PayoutMethodDetailsBTC.md)
  - [TransferZero::PayoutMethodDetailsBalance](docs/PayoutMethodDetailsBalance.md)
  - [TransferZero::PayoutMethodDetailsGBPBank](docs/PayoutMethodDetailsGBPBank.md)
  - [TransferZero::PayoutMethodDetailsGHSBank](docs/PayoutMethodDetailsGHSBank.md)
+ - [TransferZero::PayoutMethodDetailsGHSCash](docs/PayoutMethodDetailsGHSCash.md)
  - [TransferZero::PayoutMethodDetailsIBAN](docs/PayoutMethodDetailsIBAN.md)
  - [TransferZero::PayoutMethodDetailsMADCash](docs/PayoutMethodDetailsMADCash.md)
  - [TransferZero::PayoutMethodDetailsMobile](docs/PayoutMethodDetailsMobile.md)
  - [TransferZero::PayoutMethodDetailsNGNBank](docs/PayoutMethodDetailsNGNBank.md)
  - [TransferZero::PayoutMethodDetailsXOFBank](docs/PayoutMethodDetailsXOFBank.md)
+ - [TransferZero::PayoutMethodDetailsXOFCash](docs/PayoutMethodDetailsXOFCash.md)
  - [TransferZero::PayoutMethodDetailsXOFMobile](docs/PayoutMethodDetailsXOFMobile.md)
  - [TransferZero::PayoutMethodDetailsZARBank](docs/PayoutMethodDetailsZARBank.md)
  - [TransferZero::PayoutMethodGenderEnum](docs/PayoutMethodGenderEnum.md)
@@ -216,11 +221,14 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodResponse](docs/PayoutMethodResponse.md)
  - [TransferZero::PayoutMethodWebhook](docs/PayoutMethodWebhook.md)
  - [TransferZero::PoliticallyExposedPerson](docs/PoliticallyExposedPerson.md)
+ - [TransferZero::ProofOfPayment](docs/ProofOfPayment.md)
+ - [TransferZero::ProofOfPaymentListResponse](docs/ProofOfPaymentListResponse.md)
  - [TransferZero::Recipient](docs/Recipient.md)
  - [TransferZero::RecipientListResponse](docs/RecipientListResponse.md)
  - [TransferZero::RecipientRequest](docs/RecipientRequest.md)
  - [TransferZero::RecipientResponse](docs/RecipientResponse.md)
  - [TransferZero::RecipientState](docs/RecipientState.md)
+ - [TransferZero::RecipientStateReasonDetails](docs/RecipientStateReasonDetails.md)
  - [TransferZero::RecipientWebhook](docs/RecipientWebhook.md)
  - [TransferZero::Sender](docs/Sender.md)
  - [TransferZero::SenderListResponse](docs/SenderListResponse.md)

data/docs/AccountValidationRequest.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **bank_account** | **String** | Account Number to query | [optional] 
 **bank_code** | **String** | Bank Code to query - same codes are used as for creating the transactions | [optional] 
 **phone_number** | **String** | Phone number to query | [optional] 
+**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | [optional] 
 **country** | **String** | Country of account in 2-character alpha ISO 3166-2 country format | 
 **currency** | **String** | The currency the bank account is in | 
 **method** | **String** | The method of the payment. Currently bank and mobile are supported | 
@@ -19,6 +20,7 @@ require 'TransferZero'
 instance = TransferZero::AccountValidationRequest.new(bank_account: null,
                                  bank_code: null,
                                  phone_number: +233000000000,
+                                 mobile_provider: null,
                                  country: null,
                                  currency: null,
                                  method: null)

data/docs/Document.md

@@ -15,6 +15,8 @@ Name | Type | Description | Notes
 **document_type** | **String** | This is a brief description of the document type | [optional] 
 **issuing_country** | **String** | Issuing country of ID in 2-character alpha ISO 3166-2 country format | [optional] 
 **id** | **String** |  | [optional] 
+**document_id** | **String** | Document ID issued by government | [optional] 
+**expiry_date** | **Date** | Document expiry date issued by government | [optional] 
 **errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
 
 ## Code Sample
@@ -33,6 +35,8 @@ instance = TransferZero::Document.new(upload: data:image/png;base64,iVBORw0KGg..
                                  document_type: certificate_of_business_name_registration,
                                  issuing_country: NG,
                                  id: ebe9bc0b-f2f6-4ce8-802a-8b79912d041e,
+                                 document_id: XYZ12345,
+                                 expiry_date: null,
                                  errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
 ```
 

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. - `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] 
+**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.  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

@@ -11,9 +11,11 @@ Name | Type | Description | Notes
 **bank_account_type** | [**PayoutMethodBankAccountTypeEnum**](PayoutMethodBankAccountTypeEnum.md) |  | [optional] 
 **phone_number** | **String** |  | 
 **mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | 
+**country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) |  | [optional] 
 **iban** | **String** |  | 
 **bank_name** | **String** |  | 
 **bank_country** | **String** |  | 
+**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) |  | [optional] 
 **sort_code** | **String** |  | [optional] 
 **bic** | **String** |  | [optional] 
 **sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
@@ -45,9 +47,11 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
                                  bank_account_type: null,
                                  phone_number: null,
                                  mobile_provider: null,
+                                 country: null,
                                  iban: null,
                                  bank_name: null,
                                  bank_country: null,
+                                 cash_provider: null,
                                  sort_code: null,
                                  bic: null,
                                  sender_identity_card_type: null,

data/docs/PayoutMethodDetailsGHSCash.md

@@ -0,0 +1,21 @@
+# TransferZero::PayoutMethodDetailsGHSCash
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**phone_number** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsGHSCash.new(first_name: null,
+                                 last_name: null,
+                                 phone_number: 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/PayoutMethodDetailsXOFMobile.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **last_name** | **String** |  | 
 **phone_number** | **String** |  | 
 **mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | 
+**country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) |  | [optional] 
 
 ## Code Sample
 
@@ -17,7 +18,8 @@ require 'TransferZero'
 instance = TransferZero::PayoutMethodDetailsXOFMobile.new(first_name: null,
                                  last_name: null,
                                  phone_number: null,
-                                 mobile_provider: null)
+                                 mobile_provider: null,
+                                 country: 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

@@ -14,8 +14,10 @@ Name | Type | Description | Notes
 **input_usd_amount** | **Float** | Shows how much this payment is worth in USD | [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] 
@@ -41,8 +43,10 @@ instance = TransferZero::Recipient.new(requested_amount: 750.0,
                                  input_usd_amount: 10,
                                  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**
@@ -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
+
+
+