transferzero-sdk 1.8.1 → 1.12.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +11 -4
  3. data/docs/AccountValidationRequest.md +2 -0
  4. data/docs/Document.md +4 -0
  5. data/docs/PayoutMethodCashProviderEnum.md +16 -0
  6. data/docs/PayoutMethodCountryEnum.md +16 -0
  7. data/docs/PayoutMethodDetails.md +4 -0
  8. data/docs/PayoutMethodDetailsMobile.md +3 -1
  9. data/docs/PayoutMethodDetailsXOFCash.md +25 -0
  10. data/docs/ProofOfPayment.md +23 -0
  11. data/docs/ProofOfPaymentListResponse.md +17 -0
  12. data/docs/Recipient.md +4 -0
  13. data/docs/RecipientStateReasonDetails.md +23 -0
  14. data/docs/RecipientsApi.md +62 -0
  15. data/docs/Sender.md +8 -6
  16. data/lib/transferzero-sdk.rb +6 -0
  17. data/lib/transferzero-sdk/api/recipients_api.rb +54 -0
  18. data/lib/transferzero-sdk/api_client.rb +1 -1
  19. data/lib/transferzero-sdk/models/account_validation_request.rb +10 -1
  20. data/lib/transferzero-sdk/models/document.rb +21 -1
  21. data/lib/transferzero-sdk/models/payout_method_cash_provider_enum.rb +31 -0
  22. data/lib/transferzero-sdk/models/payout_method_country_enum.rb +43 -0
  23. data/lib/transferzero-sdk/models/payout_method_details.rb +20 -1
  24. data/lib/transferzero-sdk/models/payout_method_details_mad_cash.rb +1 -1
  25. data/lib/transferzero-sdk/models/payout_method_details_mobile.rb +13 -4
  26. data/lib/transferzero-sdk/models/payout_method_details_xof_bank.rb +1 -1
  27. data/lib/transferzero-sdk/models/payout_method_details_xof_cash.rb +254 -0
  28. data/lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb +1 -1
  29. data/lib/transferzero-sdk/models/payout_method_identity_card_type_enum.rb +1 -1
  30. data/lib/transferzero-sdk/models/payout_method_mobile_provider_enum.rb +3 -0
  31. data/lib/transferzero-sdk/models/proof_of_payment.rb +233 -0
  32. data/lib/transferzero-sdk/models/proof_of_payment_list_response.rb +204 -0
  33. data/lib/transferzero-sdk/models/recipient.rb +20 -1
  34. data/lib/transferzero-sdk/models/recipient_state_reason_details.rb +235 -0
  35. data/lib/transferzero-sdk/models/sender.rb +29 -7
  36. data/lib/transferzero-sdk/version.rb +1 -1
  37. data/spec/models/payout_method_cash_provider_enum_spec.rb +35 -0
  38. data/spec/models/payout_method_country_enum_spec.rb +35 -0
  39. data/spec/models/payout_method_details_xof_cash_spec.rb +71 -0
  40. data/spec/models/proof_of_payment_list_response_spec.rb +41 -0
  41. data/spec/models/proof_of_payment_spec.rb +59 -0
  42. data/spec/models/recipient_state_reason_details_spec.rb +59 -0
  43. data/transferzero-sdk-1.9.0.gem +0 -0
  44. metadata +27 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 789ad23b6116cceec9f440aa143c57de74b1fc0cfe6a6eae6ce3837c69557377
4
- data.tar.gz: b4a8b36050fe596bc293b2a957ceb6f9ff3035ff04fb880b21ab156fdcb34993
3
+ metadata.gz: '0801e5de9f7d7b390d9da8326a1ad9421b3b07c4fa9f501e4f806783123138ef'
4
+ data.tar.gz: d3aee7c91d1eae43b96b79f5e9c5553fac2cbe257e35528bcb4ec4b21c7832cf
5
5
  SHA512:
6
- metadata.gz: 5a364139b6dc0183617314385db76f4dadbbdf0b76511f1a75eb756d2efe0cba98b2e315e32fd9013630c7a411f9d3e8d72b354a635f221dea7e4e217b0d78a6
7
- data.tar.gz: 9ed6bf61834e00ab0e92ead44d5ad8fc97b6c4ffbbea8bd58b51dbc8ff4bbefc694a457c372446c061fca88722686b06c59d7cc4b462cbbca488a07ca31e257d
6
+ metadata.gz: 889711b7a190f71685a31ac90eca202b602bcf7a00c440c562790f87932de78dbbc37c978ab5d34fa2b25e55276dc6911754dbcceba2f8f3e9b9e607e0ddfbed
7
+ data.tar.gz: 29ebc7e29f6121b0f7d006612b70f0c4cc4cd2cc958ee54b16545a5ac93da3617e48920047a3cd6fe95ed4935d6c482006a0812f70a192899f29a140dd3dbe88
data/README.md CHANGED
@@ -7,7 +7,7 @@ Reference documentation for the TransferZero API V1
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 1.0
10
- - Package version: 1.8.1
10
+ - Package version: 1.12.2
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
 
13
13
  For more information, please visit:
@@ -31,15 +31,15 @@ gem build transferzero-sdk.gemspec
31
31
  Then either install the gem locally:
32
32
 
33
33
  ```shell
34
- gem install ./transferzero-sdk-1.8.1.gem
34
+ gem install ./transferzero-sdk-1.12.2.gem
35
35
  ```
36
- (for development, run `gem install --dev ./transferzero-sdk-1.8.1.gem` to install the development dependencies)
36
+ (for development, run `gem install --dev ./transferzero-sdk-1.12.2.gem` to install the development dependencies)
37
37
 
38
38
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
39
39
 
40
40
  Finally add this to the Gemfile:
41
41
 
42
- gem 'transferzero-sdk', '~> 1.8.1'
42
+ gem 'transferzero-sdk', '~> 1.12.2'
43
43
 
44
44
  ### Install from Git
45
45
 
@@ -130,6 +130,7 @@ Class | Method | HTTP request | Description
130
130
  *TransferZero::RecipientsApi* | [**delete_recipient**](docs/RecipientsApi.md#delete_recipient) | **DELETE** /recipients/{Recipient ID} | Cancelling a recipient
131
131
  *TransferZero::RecipientsApi* | [**get_recipients**](docs/RecipientsApi.md#get_recipients) | **GET** /recipients | Getting a list of recipients with filtering
132
132
  *TransferZero::RecipientsApi* | [**patch_recipient**](docs/RecipientsApi.md#patch_recipient) | **PATCH** /recipients/{Recipient ID} | Updating a recipient
133
+ *TransferZero::RecipientsApi* | [**proof_of_payments**](docs/RecipientsApi.md#proof_of_payments) | **GET** /recipients/{Recipient ID}/proof_of_payments | Returns list of proof of payments
133
134
  *TransferZero::SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{Sender ID} | Deleting a sender
134
135
  *TransferZero::SendersApi* | [**get_sender**](docs/SendersApi.md#get_sender) | **GET** /senders/{Sender ID} | Fetching a sender
135
136
  *TransferZero::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Listing senders
@@ -196,6 +197,8 @@ Class | Method | HTTP request | Description
196
197
  - [TransferZero::PaymentMethodOpposite](docs/PaymentMethodOpposite.md)
197
198
  - [TransferZero::PayoutMethod](docs/PayoutMethod.md)
198
199
  - [TransferZero::PayoutMethodBankAccountTypeEnum](docs/PayoutMethodBankAccountTypeEnum.md)
200
+ - [TransferZero::PayoutMethodCashProviderEnum](docs/PayoutMethodCashProviderEnum.md)
201
+ - [TransferZero::PayoutMethodCountryEnum](docs/PayoutMethodCountryEnum.md)
199
202
  - [TransferZero::PayoutMethodDetails](docs/PayoutMethodDetails.md)
200
203
  - [TransferZero::PayoutMethodDetailsBTC](docs/PayoutMethodDetailsBTC.md)
201
204
  - [TransferZero::PayoutMethodDetailsBalance](docs/PayoutMethodDetailsBalance.md)
@@ -206,6 +209,7 @@ Class | Method | HTTP request | Description
206
209
  - [TransferZero::PayoutMethodDetailsMobile](docs/PayoutMethodDetailsMobile.md)
207
210
  - [TransferZero::PayoutMethodDetailsNGNBank](docs/PayoutMethodDetailsNGNBank.md)
208
211
  - [TransferZero::PayoutMethodDetailsXOFBank](docs/PayoutMethodDetailsXOFBank.md)
212
+ - [TransferZero::PayoutMethodDetailsXOFCash](docs/PayoutMethodDetailsXOFCash.md)
209
213
  - [TransferZero::PayoutMethodDetailsXOFMobile](docs/PayoutMethodDetailsXOFMobile.md)
210
214
  - [TransferZero::PayoutMethodDetailsZARBank](docs/PayoutMethodDetailsZARBank.md)
211
215
  - [TransferZero::PayoutMethodGenderEnum](docs/PayoutMethodGenderEnum.md)
@@ -216,11 +220,14 @@ Class | Method | HTTP request | Description
216
220
  - [TransferZero::PayoutMethodResponse](docs/PayoutMethodResponse.md)
217
221
  - [TransferZero::PayoutMethodWebhook](docs/PayoutMethodWebhook.md)
218
222
  - [TransferZero::PoliticallyExposedPerson](docs/PoliticallyExposedPerson.md)
223
+ - [TransferZero::ProofOfPayment](docs/ProofOfPayment.md)
224
+ - [TransferZero::ProofOfPaymentListResponse](docs/ProofOfPaymentListResponse.md)
219
225
  - [TransferZero::Recipient](docs/Recipient.md)
220
226
  - [TransferZero::RecipientListResponse](docs/RecipientListResponse.md)
221
227
  - [TransferZero::RecipientRequest](docs/RecipientRequest.md)
222
228
  - [TransferZero::RecipientResponse](docs/RecipientResponse.md)
223
229
  - [TransferZero::RecipientState](docs/RecipientState.md)
230
+ - [TransferZero::RecipientStateReasonDetails](docs/RecipientStateReasonDetails.md)
224
231
  - [TransferZero::RecipientWebhook](docs/RecipientWebhook.md)
225
232
  - [TransferZero::Sender](docs/Sender.md)
226
233
  - [TransferZero::SenderListResponse](docs/SenderListResponse.md)
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **bank_account** | **String** | Account Number to query | [optional]
8
8
  **bank_code** | **String** | Bank Code to query - same codes are used as for creating the transactions | [optional]
9
9
  **phone_number** | **String** | Phone number to query | [optional]
10
+ **mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) | | [optional]
10
11
  **country** | **String** | Country of account in 2-character alpha ISO 3166-2 country format |
11
12
  **currency** | **String** | The currency the bank account is in |
12
13
  **method** | **String** | The method of the payment. Currently bank and mobile are supported |
@@ -19,6 +20,7 @@ require 'TransferZero'
19
20
  instance = TransferZero::AccountValidationRequest.new(bank_account: null,
20
21
  bank_code: null,
21
22
  phone_number: +233000000000,
23
+ mobile_provider: null,
22
24
  country: null,
23
25
  currency: null,
24
26
  method: null)
data/docs/Document.md CHANGED
@@ -15,6 +15,8 @@ Name | Type | Description | Notes
15
15
  **document_type** | **String** | This is a brief description of the document type | [optional]
16
16
  **issuing_country** | **String** | Issuing country of ID in 2-character alpha ISO 3166-2 country format | [optional]
17
17
  **id** | **String** | | [optional]
18
+ **document_id** | **String** | Document ID issued by government | [optional]
19
+ **expiry_date** | **Date** | Document expiry date issued by government | [optional]
18
20
  **errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional]
19
21
 
20
22
  ## Code Sample
@@ -33,6 +35,8 @@ instance = TransferZero::Document.new(upload: data:image/png;base64,iVBORw0KGg..
33
35
  document_type: certificate_of_business_name_registration,
34
36
  issuing_country: NG,
35
37
  id: ebe9bc0b-f2f6-4ce8-802a-8b79912d041e,
38
+ document_id: XYZ12345,
39
+ expiry_date: null,
36
40
  errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
37
41
  ```
38
42
 
@@ -0,0 +1,16 @@
1
+ # TransferZero::PayoutMethodCashProviderEnum
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+
8
+ ## Code Sample
9
+
10
+ ```ruby
11
+ require 'TransferZero'
12
+
13
+ instance = TransferZero::PayoutMethodCashProviderEnum.new()
14
+ ```
15
+
16
+
@@ -0,0 +1,16 @@
1
+ # TransferZero::PayoutMethodCountryEnum
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+
8
+ ## Code Sample
9
+
10
+ ```ruby
11
+ require 'TransferZero'
12
+
13
+ instance = TransferZero::PayoutMethodCountryEnum.new()
14
+ ```
15
+
16
+
@@ -14,6 +14,8 @@ Name | Type | Description | Notes
14
14
  **iban** | **String** | |
15
15
  **bank_name** | **String** | |
16
16
  **bank_country** | **String** | |
17
+ **cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) | | [optional]
18
+ **country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) | | [optional]
17
19
  **sort_code** | **String** | | [optional]
18
20
  **bic** | **String** | | [optional]
19
21
  **sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) | |
@@ -48,6 +50,8 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
48
50
  iban: null,
49
51
  bank_name: null,
50
52
  bank_country: null,
53
+ cash_provider: null,
54
+ country: null,
51
55
  sort_code: null,
52
56
  bic: null,
53
57
  sender_identity_card_type: null,
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **first_name** | **String** | |
8
8
  **last_name** | **String** | |
9
9
  **phone_number** | **String** | |
10
+ **mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) | | [optional]
10
11
 
11
12
  ## Code Sample
12
13
 
@@ -15,7 +16,8 @@ require 'TransferZero'
15
16
 
16
17
  instance = TransferZero::PayoutMethodDetailsMobile.new(first_name: null,
17
18
  last_name: null,
18
- phone_number: null)
19
+ phone_number: null,
20
+ mobile_provider: null)
19
21
  ```
20
22
 
21
23
 
@@ -0,0 +1,25 @@
1
+ # TransferZero::PayoutMethodDetailsXOFCash
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **first_name** | **String** | |
8
+ **last_name** | **String** | |
9
+ **phone_number** | **String** | |
10
+ **cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) | | [optional]
11
+ **country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) | | [optional]
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'TransferZero'
17
+
18
+ instance = TransferZero::PayoutMethodDetailsXOFCash.new(first_name: null,
19
+ last_name: null,
20
+ phone_number: null,
21
+ cash_provider: null,
22
+ country: null)
23
+ ```
24
+
25
+
@@ -0,0 +1,23 @@
1
+ # TransferZero::ProofOfPayment
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | UUID of the uploaded document | [optional]
8
+ **file_name** | **String** | Name of the uploaded file | [optional]
9
+ **thumbnail** | **String** | URL to thumbnail image of the uploaded file | [optional]
10
+ **url** | **String** | URL to uploaded file | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'TransferZero'
16
+
17
+ instance = TransferZero::ProofOfPayment.new(id: null,
18
+ file_name: my_file.jpg,
19
+ thumbnail: https://bitpesa-development.s3.eu-west-1.amazonaws.com/my_file_thumb.jpg,
20
+ url: https://bitpesa-development.s3.eu-west-1.amazonaws.com/my_file.jpg)
21
+ ```
22
+
23
+
@@ -0,0 +1,17 @@
1
+ # TransferZero::ProofOfPaymentListResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **object** | [**Array<ProofOfPayment>**](ProofOfPayment.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'TransferZero'
13
+
14
+ instance = TransferZero::ProofOfPaymentListResponse.new(object: null)
15
+ ```
16
+
17
+
data/docs/Recipient.md CHANGED
@@ -14,8 +14,10 @@ Name | Type | Description | Notes
14
14
  **input_usd_amount** | **Float** | Shows how much this payment is worth in USD | [optional]
15
15
  **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]
16
16
  **state_reason** | **String** | In case the payment is unsuccessful it holds the error message associated with the last unsuccessful payout. | [optional]
17
+ **state_reason_details** | [**RecipientStateReasonDetails**](RecipientStateReasonDetails.md) | | [optional]
17
18
  **state** | [**RecipientState**](RecipientState.md) | | [optional]
18
19
  **transaction_id** | **String** | The ID of the transaction that is related to this recipient | [optional]
20
+ **transaction_external_id** | **String** | Optional ID that is supplied by partner linking it to the partner's own Transaction ID. | [optional]
19
21
  **transaction_state** | [**TransactionState**](TransactionState.md) | | [optional]
20
22
  **exchange_rate** | **Float** | The exchange rate used in this payment | [optional]
21
23
  **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,
41
43
  input_usd_amount: 10,
42
44
  may_cancel: true,
43
45
  state_reason: null,
46
+ state_reason_details: null,
44
47
  state: null,
45
48
  transaction_id: 97e79719-06e4-4794-aeeb-d2d9415d983a,
49
+ transaction_external_id: 806ec63a-a5a7-43cc-9d75-1ee74fbcc026,
46
50
  transaction_state: null,
47
51
  exchange_rate: 1000,
48
52
  fee_fractional: 100,
@@ -0,0 +1,23 @@
1
+ # TransferZero::RecipientStateReasonDetails
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **code** | **String** | Status code of failed transaction | [optional]
8
+ **category** | **String** | Main category of error, it could be paid, unknown, pickupable, temporary_error, recipient_error, sender_error | [optional]
9
+ **messages** | **Array<String>** | Tiered messages | [optional]
10
+ **description** | **String** | Public, human readable, detailed error message | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'TransferZero'
16
+
17
+ instance = TransferZero::RecipientStateReasonDetails.new(code: 311,
18
+ category: temporary_error,
19
+ messages: ["Temporary error","Switch Error","Issuer/Switch inoperative"],
20
+ description: The central switch is not accepting transfers at the moment. We will retry the transaction. You can also edit or cancel this transaction.)
21
+ ```
22
+
23
+
@@ -7,6 +7,7 @@ Method | HTTP request | Description
7
7
  [**delete_recipient**](RecipientsApi.md#delete_recipient) | **DELETE** /recipients/{Recipient ID} | Cancelling a recipient
8
8
  [**get_recipients**](RecipientsApi.md#get_recipients) | **GET** /recipients | Getting a list of recipients with filtering
9
9
  [**patch_recipient**](RecipientsApi.md#patch_recipient) | **PATCH** /recipients/{Recipient ID} | Updating a recipient
10
+ [**proof_of_payments**](RecipientsApi.md#proof_of_payments) | **GET** /recipients/{Recipient ID}/proof_of_payments | Returns list of proof of payments
10
11
 
11
12
 
12
13
  # **delete_recipient**
@@ -210,3 +211,64 @@ end
210
211
 
211
212
 
212
213
 
214
+ # **proof_of_payments**
215
+ > ProofOfPaymentListResponse proof_of_payments(recipient_id)
216
+
217
+ Returns list of proof of payments
218
+
219
+ Returns a list of uploaded proof of payment files for a transaction recipient
220
+
221
+ ### Example
222
+ ```ruby
223
+ # load the gem
224
+ require 'transferzero-sdk'
225
+
226
+ api_instance = TransferZero::RecipientsApi.new
227
+
228
+
229
+ begin
230
+ #Returns list of proof of payments
231
+ result = api_instance.proof_of_payments(recipient_id)
232
+ p result
233
+ rescue TransferZero::ApiError => e
234
+ if e.validation_error
235
+ puts "WARN: Validation error occured when calling the endpoint"
236
+ result = e.response_object("ProofOfPaymentListResponse")
237
+ p result
238
+ else
239
+ puts "Exception when calling RecipientsApi->proof_of_payments: #{e}"
240
+ end
241
+ end
242
+ ```
243
+
244
+ ### Parameters
245
+
246
+ Name | Type | Description | Notes
247
+ ------------- | ------------- | ------------- | -------------
248
+ **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` |
249
+
250
+ ### Return type
251
+
252
+ [**ProofOfPaymentListResponse**](ProofOfPaymentListResponse.md)
253
+
254
+ ### Authorization
255
+
256
+ You can set the API Key and Secret on the TransferZero object when setting it up:
257
+
258
+ ```ruby
259
+
260
+ TransferZero.configure do |config|
261
+ config.api_key = '<key'
262
+ config.api_secret = '<secret>'
263
+ config.host = 'https://api-sandbox.transferzero.com/v1'
264
+ end
265
+
266
+ ```
267
+
268
+ ### HTTP request headers
269
+
270
+ - **Content-Type**: Not defined
271
+ - **Accept**: application/json
272
+
273
+
274
+
data/docs/Sender.md CHANGED
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  **id** | **String** | | [optional]
8
8
  **type** | **String** | Type of sender to create - either person or business (defaults to person) | [optional]
9
9
  **state** | [**SenderState**](SenderState.md) | | [optional]
10
- **country** | **String** | Country of sender in 2-character alpha ISO 3166-2 country format |
10
+ **country** | **String** | Country of sender in 2-character alpha ISO 3166-2 country format. This is the residential country for personal senders and the country of incorporation for business senders. |
11
11
  **street** | **String** | Sender&#39;s street |
12
12
  **postal_code** | **String** | Zip code of sender |
13
13
  **city** | **String** | Sender&#39;s city |
@@ -17,7 +17,8 @@ Name | Type | Description | Notes
17
17
  **ip** | **String** | IP of sender |
18
18
  **address_description** | **String** | Description of address | [optional]
19
19
  **identification_number** | **String** | Identification number of document used | [optional]
20
- **identification_type** | **String** | Document to be identified. The identification type can be one of the following: - &#x60;DL&#x60;: Driving License - &#x60;PP&#x60;: International Passport - &#x60;ID&#x60;: National ID - &#x60;OT&#x60;: Other | [optional]
20
+ **identification_type** | **String** | Document to be identified. The identification type can be one of the following: - &#x60;DL&#x60;: Driving License - &#x60;PP&#x60;: International Passport - &#x60;ID&#x60;: National ID - &#x60;OT&#x60;: Other Please note for Wizall &#x60;XOF::Cash&#x60; transactions the valid options are: - &#x60;ID&#x60;: National ID - &#x60;PP&#x60;: Passport | [optional]
21
+ **lang** | **String** | Determines language of the served content. Defaults to English | [optional]
21
22
  **name** | **String** | Name of sender (used only with a Business sender) | [optional]
22
23
  **first_name** | **String** | First name of sender (used only with a Personal sender) | [optional]
23
24
  **middle_name** | **String** | Middle name of sender (used only with a Personal sender) | [optional]
@@ -25,10 +26,10 @@ Name | Type | Description | Notes
25
26
  **birth_date** | **Date** | Date of birth of sender (used only with a Personal sender) | [optional]
26
27
  **occupation** | **String** | Occupation of sender (used only with a Personal sender) | [optional]
27
28
  **nationality** | **String** | The nationality of the sender (used only with a Personal sender) | [optional]
28
- **legal_entity_type** | **String** | Legal entity type (used only with a Business sender) | [optional]
29
- **registration_date** | **String** | The registration date (used only with a Business sender) | [optional]
29
+ **legal_entity_type** | **String** | Legal entity type (used only with a Business sender) Available values: - sole_proprietorship: Sole Proprietorship - partnership: Partnership - privately_owned_company: Privately Owned Company (Limited Company) - publicly_owned_company: Publicly Listed Company (PLC) - government_owned_entity: Government Owned Entity Trusts - trust: Foundations &amp; Similar Entities - ngo: Non-Government Organisations / Charities inc Religious bodies and place of worship - club_and_society: Clubs and Societies - go: GO (Majority Owned Subsidiary of State-Owned Company) - financial_institution: Financial Institution Please note not all values are acceptable for some our corridors. Please reach out to our sales teams for more information. Note that if you select &#x60;financial_institution&#x60; then the fields &#x60;vat_registration_number&#x60;, &#x60;financial_regulator&#x60; and &#x60;regulatory_licence_number&#x60; will be mandatory as well. | [optional]
30
+ **registration_date** | **Date** | The registration date (used only with a Business sender) | [optional]
30
31
  **registration_number** | **String** | The registration number (used only with a Business sender) | [optional]
31
- **nature_of_business** | **String** | Nature of business options (used only with a Business sender) | [optional]
32
+ **nature_of_business** | **String** | Nature of business options (used only with a Business sender) Available values: - personal: Personal - agriculture_and_hunting: Agriculture and Hunting - forestry: Forestry - fishing: Fishing - agricultural_by_products: Agricultural By-Products - coal_mining: Coal Mining - oil_mining: Oil Mining - iron_ore_mining: Iron Ore Mining - other_metal_and_diamond_mining: Other Metal and Diamond Mining - other_mineral_mining: Other Mineral Mining - manufacturing_of_food_drink_tobacco: Manufacture of Food/Drink/Tobacco - manufacturing_of_textiles_leather_fur_furniture: Manufacture of Textiles/Leather/Fur/Furniture - manufacture_of_wooden_products_furniture: Manufacture of Wooden Products/Furniture - manufacture_of_paper_pulp_allied_products: Manufacture of Paper/Pulp/Allied Products - manufacture_of_chemicals_medical_petroleum_rubber_plastic_products: Manufacture Of Chemicals Medical Petroleum Rubber Plastic Products - manufacture_of_pottery_china_glass_stone: Manufacture Of Pottery China Glass Stone - manufacture_of_iron_steel_non_ferrous_metals_basic_industries: Manufacture Of Iron Steel Non-Ferrous Metals Basic Industries - manufacture_of_metal_products_electrical_and_scientific_engineering: Manufacture Of Metal Products Electrical And Scientific Engineering - manufacture_of_jewelry_musical_instruments_toys: Manufacture Of Jewelry Musical Instruments Toys - electricity_gas_and_water: Electricity, Gas And Water - construction: Construction - wholesale_trade: Wholesale Trade - retail_trade: Retail Trade - catering_incl_hotels: Catering Incl. Hotels - transport_storage: Transport Storage - communications: Communications - finance_and_holding_companies: Finance And Holding Companies - insurance: Insurance - business_services: Business Services - real_estate_development_investment: Real Estate Development Investment - central_state_governments: Central State Governments - community_services_defence_police_prisons_etc: Community Services Defence Police Prisons Etc - social_services_education_health_care: Social Services Education Health Care - personal_services_leisure_services: Personal Services - Leisure Services - personal_services_domestic_laundry_repairs: Personal Services - Domestic Laundry Repairs - personal_services_embassies_international_organisations: Personal Services - Embassies | [optional]
32
33
  **source_of_funds** | **String** | The source of funds | [optional]
33
34
  **custom_source_of_funds** | **String** | Custom source of funds | [optional]
34
35
  **core_business_activity** | **String** | The core activity (used only with a Business sender) | [optional]
@@ -72,6 +73,7 @@ instance = TransferZero::Sender.new(id: bf9ff782-e182-45ac-abea-5bce83ad6670,
72
73
  address_description: null,
73
74
  identification_number: AB123456,
74
75
  identification_type: ID,
76
+ lang: en,
75
77
  name: null,
76
78
  first_name: Johnny,
77
79
  middle_name: Johnny,
@@ -79,7 +81,7 @@ instance = TransferZero::Sender.new(id: bf9ff782-e182-45ac-abea-5bce83ad6670,
79
81
  birth_date: null,
80
82
  occupation: Accountant,
81
83
  nationality: NG,
82
- legal_entity_type: sole_proprietorship,
84
+ legal_entity_type: privately_owned_company,
83
85
  registration_date: null,
84
86
  registration_number: null,
85
87
  nature_of_business: null,
@@ -61,6 +61,8 @@ require 'transferzero-sdk/models/payment_method_list_response'
61
61
  require 'transferzero-sdk/models/payment_method_opposite'
62
62
  require 'transferzero-sdk/models/payout_method'
63
63
  require 'transferzero-sdk/models/payout_method_bank_account_type_enum'
64
+ require 'transferzero-sdk/models/payout_method_cash_provider_enum'
65
+ require 'transferzero-sdk/models/payout_method_country_enum'
64
66
  require 'transferzero-sdk/models/payout_method_details'
65
67
  require 'transferzero-sdk/models/payout_method_details_btc'
66
68
  require 'transferzero-sdk/models/payout_method_details_balance'
@@ -71,6 +73,7 @@ require 'transferzero-sdk/models/payout_method_details_mad_cash'
71
73
  require 'transferzero-sdk/models/payout_method_details_mobile'
72
74
  require 'transferzero-sdk/models/payout_method_details_ngn_bank'
73
75
  require 'transferzero-sdk/models/payout_method_details_xof_bank'
76
+ require 'transferzero-sdk/models/payout_method_details_xof_cash'
74
77
  require 'transferzero-sdk/models/payout_method_details_xof_mobile'
75
78
  require 'transferzero-sdk/models/payout_method_details_zar_bank'
76
79
  require 'transferzero-sdk/models/payout_method_gender_enum'
@@ -81,11 +84,14 @@ require 'transferzero-sdk/models/payout_method_request'
81
84
  require 'transferzero-sdk/models/payout_method_response'
82
85
  require 'transferzero-sdk/models/payout_method_webhook'
83
86
  require 'transferzero-sdk/models/politically_exposed_person'
87
+ require 'transferzero-sdk/models/proof_of_payment'
88
+ require 'transferzero-sdk/models/proof_of_payment_list_response'
84
89
  require 'transferzero-sdk/models/recipient'
85
90
  require 'transferzero-sdk/models/recipient_list_response'
86
91
  require 'transferzero-sdk/models/recipient_request'
87
92
  require 'transferzero-sdk/models/recipient_response'
88
93
  require 'transferzero-sdk/models/recipient_state'
94
+ require 'transferzero-sdk/models/recipient_state_reason_details'
89
95
  require 'transferzero-sdk/models/recipient_webhook'
90
96
  require 'transferzero-sdk/models/sender'
91
97
  require 'transferzero-sdk/models/sender_list_response'