transferzero-sdk 1.14.2 → 1.16.1
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.
- checksums.yaml +4 -4
- data/Gemfile.lock +89 -0
- data/README.md +7 -5
- data/docs/AccountValidationRequest.md +2 -0
- data/docs/PayoutMethod.md +1 -1
- data/docs/PayoutMethodDetails.md +10 -6
- data/docs/PayoutMethodDetailsKESBank.md +37 -0
- data/docs/PayoutMethodDetailsKESMobile.md +31 -0
- data/docs/PayoutMethodDetailsUSDBank.md +1 -1
- data/docs/PayoutMethodDetailsUSDCash.md +23 -0
- data/docs/PayoutMethodDetailsXOFBank.md +5 -3
- data/docs/Recipient.md +2 -0
- data/lib/transferzero-sdk/api_client.rb +1 -1
- data/lib/transferzero-sdk/models/account_validation_request.rb +13 -3
- data/lib/transferzero-sdk/models/payout_method.rb +1 -1
- data/lib/transferzero-sdk/models/payout_method_details.rb +46 -10
- data/lib/transferzero-sdk/models/payout_method_details_kes_bank.rb +343 -0
- data/lib/transferzero-sdk/models/payout_method_details_kes_mobile.rb +306 -0
- data/lib/transferzero-sdk/models/payout_method_details_usd_bank.rb +2 -2
- data/lib/transferzero-sdk/models/payout_method_details_usd_cash.rb +250 -0
- data/lib/transferzero-sdk/models/payout_method_details_xof_bank.rb +14 -15
- data/lib/transferzero-sdk/models/payout_method_details_zar_bank.rb +1 -1
- data/lib/transferzero-sdk/models/payout_method_mobile_provider_enum.rb +3 -0
- data/lib/transferzero-sdk/models/recipient.rb +45 -1
- data/lib/transferzero-sdk/version.rb +1 -1
- data/lib/transferzero-sdk.rb +3 -1
- data/spec/models/payout_method_details_kes_bank_spec.rb +101 -0
- data/spec/models/payout_method_details_kes_mobile_spec.rb +83 -0
- data/spec/models/payout_method_details_usd_cash_spec.rb +59 -0
- metadata +25 -16
- data/docs/PayoutMethodCountryEnumUSDBank.md +0 -16
- data/lib/transferzero-sdk/models/payout_method_country_enum_usd_bank.rb +0 -269
- data/spec/models/payout_method_country_enum_usd_bank_spec.rb +0 -35
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0cb88f7dd25322010286cda4057d0fa7353f08a01372ddd384c25c14a6a42644
|
4
|
+
data.tar.gz: b4fe63d3416fe08dbbe8c8622a09fe1c4014ff6b6cab1bc6afb3e5f4e6b7a258
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 74ccb124ad0d3146592a1380d91e7a77b2bf4090cc2670b4ecbbfe2157a30077b629e8770b14368d2d98e3d31d3bbd7e8845e0a6ba35d454cdefe3be36b57ce8
|
7
|
+
data.tar.gz: a2418c3385939f664e2fe2167627814dd351874241237fac09a8764a7a369e937ff01dd5dfd2c520db407b4707390fbed0b653ec423495c7eecba74854c6c499
|
data/Gemfile.lock
ADDED
@@ -0,0 +1,89 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
transferzero-sdk (1.16.0)
|
5
|
+
activesupport (>= 4)
|
6
|
+
json (>= 1.4)
|
7
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
8
|
+
|
9
|
+
GEM
|
10
|
+
remote: https://rubygems.org/
|
11
|
+
specs:
|
12
|
+
ZenTest (4.12.0)
|
13
|
+
activesupport (6.1.4.1)
|
14
|
+
concurrent-ruby (~> 1.0, >= 1.0.2)
|
15
|
+
i18n (>= 1.6, < 2)
|
16
|
+
minitest (>= 5.1)
|
17
|
+
tzinfo (~> 2.0)
|
18
|
+
zeitwerk (~> 2.3)
|
19
|
+
addressable (2.7.0)
|
20
|
+
public_suffix (>= 2.0.2, < 5.0)
|
21
|
+
autotest (4.4.6)
|
22
|
+
ZenTest (>= 4.4.1)
|
23
|
+
autotest-growl (0.2.16)
|
24
|
+
autotest-rails-pure (4.1.2)
|
25
|
+
byebug (11.1.3)
|
26
|
+
coderay (1.1.3)
|
27
|
+
concurrent-ruby (1.1.9)
|
28
|
+
crack (0.4.5)
|
29
|
+
rexml
|
30
|
+
diff-lcs (1.4.4)
|
31
|
+
ethon (0.14.0)
|
32
|
+
ffi (>= 1.15.0)
|
33
|
+
ffi (1.15.4)
|
34
|
+
hashdiff (1.0.1)
|
35
|
+
i18n (1.8.10)
|
36
|
+
concurrent-ruby (~> 1.0)
|
37
|
+
json (2.5.1)
|
38
|
+
method_source (1.0.0)
|
39
|
+
minitest (5.14.4)
|
40
|
+
pry (0.13.1)
|
41
|
+
coderay (~> 1.1)
|
42
|
+
method_source (~> 1.0)
|
43
|
+
pry-byebug (3.9.0)
|
44
|
+
byebug (~> 11.0)
|
45
|
+
pry (~> 0.13.0)
|
46
|
+
public_suffix (4.0.6)
|
47
|
+
rake (12.0.0)
|
48
|
+
rexml (3.2.4)
|
49
|
+
rspec (3.10.0)
|
50
|
+
rspec-core (~> 3.10.0)
|
51
|
+
rspec-expectations (~> 3.10.0)
|
52
|
+
rspec-mocks (~> 3.10.0)
|
53
|
+
rspec-core (3.10.1)
|
54
|
+
rspec-support (~> 3.10.0)
|
55
|
+
rspec-expectations (3.10.1)
|
56
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
57
|
+
rspec-support (~> 3.10.0)
|
58
|
+
rspec-mocks (3.10.1)
|
59
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
60
|
+
rspec-support (~> 3.10.0)
|
61
|
+
rspec-support (3.10.1)
|
62
|
+
typhoeus (1.4.0)
|
63
|
+
ethon (>= 0.9.0)
|
64
|
+
tzinfo (2.0.4)
|
65
|
+
concurrent-ruby (~> 1.0)
|
66
|
+
vcr (3.0.3)
|
67
|
+
webmock (1.24.6)
|
68
|
+
addressable (>= 2.3.6)
|
69
|
+
crack (>= 0.3.2)
|
70
|
+
hashdiff
|
71
|
+
zeitwerk (2.4.2)
|
72
|
+
|
73
|
+
PLATFORMS
|
74
|
+
ruby
|
75
|
+
|
76
|
+
DEPENDENCIES
|
77
|
+
ZenTest (~> 4.11, >= 4.11.2)
|
78
|
+
autotest (~> 4.4, >= 4.4.6)
|
79
|
+
autotest-growl (~> 0.2, >= 0.2.16)
|
80
|
+
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
81
|
+
pry-byebug
|
82
|
+
rake (~> 12.0.0)
|
83
|
+
rspec (~> 3.6, >= 3.6.0)
|
84
|
+
transferzero-sdk!
|
85
|
+
vcr (~> 3.0, >= 3.0.1)
|
86
|
+
webmock (~> 1.24, >= 1.24.3)
|
87
|
+
|
88
|
+
BUNDLED WITH
|
89
|
+
2.1.4
|
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.
|
10
|
+
- Package version: 1.16.1
|
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.
|
34
|
+
gem install ./transferzero-sdk-1.16.1.gem
|
35
35
|
```
|
36
|
-
(for development, run `gem install --dev ./transferzero-sdk-1.
|
36
|
+
(for development, run `gem install --dev ./transferzero-sdk-1.16.1.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.
|
42
|
+
gem 'transferzero-sdk', '~> 1.16.1'
|
43
43
|
|
44
44
|
### Install from Git
|
45
45
|
|
@@ -199,7 +199,6 @@ Class | Method | HTTP request | Description
|
|
199
199
|
- [TransferZero::PayoutMethodBankAccountTypeEnum](docs/PayoutMethodBankAccountTypeEnum.md)
|
200
200
|
- [TransferZero::PayoutMethodCashProviderEnum](docs/PayoutMethodCashProviderEnum.md)
|
201
201
|
- [TransferZero::PayoutMethodCountryEnum](docs/PayoutMethodCountryEnum.md)
|
202
|
-
- [TransferZero::PayoutMethodCountryEnumUSDBank](docs/PayoutMethodCountryEnumUSDBank.md)
|
203
202
|
- [TransferZero::PayoutMethodDetails](docs/PayoutMethodDetails.md)
|
204
203
|
- [TransferZero::PayoutMethodDetailsBTC](docs/PayoutMethodDetailsBTC.md)
|
205
204
|
- [TransferZero::PayoutMethodDetailsBalance](docs/PayoutMethodDetailsBalance.md)
|
@@ -207,10 +206,13 @@ Class | Method | HTTP request | Description
|
|
207
206
|
- [TransferZero::PayoutMethodDetailsGHSBank](docs/PayoutMethodDetailsGHSBank.md)
|
208
207
|
- [TransferZero::PayoutMethodDetailsGHSCash](docs/PayoutMethodDetailsGHSCash.md)
|
209
208
|
- [TransferZero::PayoutMethodDetailsIBAN](docs/PayoutMethodDetailsIBAN.md)
|
209
|
+
- [TransferZero::PayoutMethodDetailsKESBank](docs/PayoutMethodDetailsKESBank.md)
|
210
|
+
- [TransferZero::PayoutMethodDetailsKESMobile](docs/PayoutMethodDetailsKESMobile.md)
|
210
211
|
- [TransferZero::PayoutMethodDetailsMADCash](docs/PayoutMethodDetailsMADCash.md)
|
211
212
|
- [TransferZero::PayoutMethodDetailsMobile](docs/PayoutMethodDetailsMobile.md)
|
212
213
|
- [TransferZero::PayoutMethodDetailsNGNBank](docs/PayoutMethodDetailsNGNBank.md)
|
213
214
|
- [TransferZero::PayoutMethodDetailsUSDBank](docs/PayoutMethodDetailsUSDBank.md)
|
215
|
+
- [TransferZero::PayoutMethodDetailsUSDCash](docs/PayoutMethodDetailsUSDCash.md)
|
214
216
|
- [TransferZero::PayoutMethodDetailsXOFBank](docs/PayoutMethodDetailsXOFBank.md)
|
215
217
|
- [TransferZero::PayoutMethodDetailsXOFCash](docs/PayoutMethodDetailsXOFCash.md)
|
216
218
|
- [TransferZero::PayoutMethodDetailsXOFMobile](docs/PayoutMethodDetailsXOFMobile.md)
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
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
|
+
**iban** | **String** | IBAN to query - BBAN format for XOF bank accounts | [optional]
|
9
10
|
**phone_number** | **String** | Phone number to query | [optional]
|
10
11
|
**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) | | [optional]
|
11
12
|
**country** | **String** | Country of account in 2-character alpha ISO 3166-2 country format |
|
@@ -19,6 +20,7 @@ require 'TransferZero'
|
|
19
20
|
|
20
21
|
instance = TransferZero::AccountValidationRequest.new(bank_account: null,
|
21
22
|
bank_code: null,
|
23
|
+
iban: null,
|
22
24
|
phone_number: +233000000000,
|
23
25
|
mobile_provider: null,
|
24
26
|
country: null,
|
data/docs/PayoutMethod.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**type** | **String** | Contains the currency to send the money to, and the type of the money movement Commonly used payout types are: - `NGN::Bank` - for Nigerian bank account payments. - `NGN::Mobile` - for Nigerian mobile money payments. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `GHS::Cash` - for Ghanaian cash remittance payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for mobile money payments to West-Africa. - `XOF::Bank` - for Senegalese bank account payments. - `XOF::Cash` - for Senegalese cash remittance payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank and FP accounts transfers in GBP. - `ZAR::Bank` - for South Africa bank account payments. - `USD::Bank` - for USD account payments. *** Currently Nigeria only and in Beta phase *** 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]
|
7
|
+
**type** | **String** | Contains the currency to send the money to, and the type of the money movement Commonly used payout types are: - `NGN::Bank` - for Nigerian bank account payments. - `NGN::Mobile` - for Nigerian mobile money payments. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `GHS::Cash` - for Ghanaian cash remittance payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for mobile money payments to West-Africa. - `XOF::Bank` - for Senegalese bank account payments. - `XOF::Cash` - for Senegalese cash remittance payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank and FP accounts transfers in GBP. - `ZAR::Bank` - for South Africa bank account payments. - `USD::Bank` - for USD account payments. *** Currently Nigeria only and in Beta phase *** - `USD::Cash` - for USD cash remittance payments. *** Currently Nigeria only and in Beta phase *** - `KES::Bank` - for Kenyan bank account payments. - `KES::Mobile` - for Kenyan mobile money payments. You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://docs.transferzero.com/docs/additional-features/#collections-from-senders) for more info on how to collect money into internal balance | [optional]
|
8
8
|
**details** | [**PayoutMethodDetails**](PayoutMethodDetails.md) | | [optional]
|
9
9
|
**metadata** | [**Object**](.md) | Metadata of payout method. You can store any kind of information in this field. | [optional]
|
10
10
|
**id** | **String** | | [optional]
|
data/docs/PayoutMethodDetails.md
CHANGED
@@ -11,10 +11,10 @@ Name | Type | Description | Notes
|
|
11
11
|
**bank_account_type** | [**PayoutMethodBankAccountTypeEnum**](PayoutMethodBankAccountTypeEnum.md) | | [optional]
|
12
12
|
**phone_number** | **String** | |
|
13
13
|
**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) | |
|
14
|
-
**country** | [**
|
14
|
+
**country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) | |
|
15
15
|
**iban** | **String** | |
|
16
16
|
**bank_name** | **String** | |
|
17
|
-
**bank_country** | **String** | |
|
17
|
+
**bank_country** | **String** | | [optional]
|
18
18
|
**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) | | [optional]
|
19
19
|
**sort_code** | **String** | | [optional]
|
20
20
|
**bic** | **String** | | [optional]
|
@@ -24,8 +24,8 @@ Name | Type | Description | Notes
|
|
24
24
|
**sender_country_of_birth** | **String** | | [optional]
|
25
25
|
**sender_gender** | [**PayoutMethodGenderEnum**](PayoutMethodGenderEnum.md) | | [optional]
|
26
26
|
**reason** | **String** | | [optional]
|
27
|
-
**identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) | |
|
28
|
-
**identity_card_id** | **String** | |
|
27
|
+
**identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) | |
|
28
|
+
**identity_card_id** | **String** | |
|
29
29
|
**reference** | **String** | | [optional]
|
30
30
|
**name** | **String** | |
|
31
31
|
**address** | **String** | |
|
@@ -33,12 +33,14 @@ Name | Type | Description | Notes
|
|
33
33
|
**postal_code** | **String** | |
|
34
34
|
**city** | **String** | |
|
35
35
|
**email** | **String** | | [optional]
|
36
|
-
**transfer_reason_code** | **String** | |
|
36
|
+
**transfer_reason_code** | **String** | |
|
37
37
|
**contact_first_name** | **String** | | [optional]
|
38
38
|
**contact_last_name** | **String** | | [optional]
|
39
39
|
**registration_number** | **String** | | [optional]
|
40
40
|
**nature_of_business** | [**PayoutMethodNatureOfBusinessEnum**](PayoutMethodNatureOfBusinessEnum.md) | | [optional]
|
41
41
|
**legal_entity_type** | [**PayoutMethodLegalEntityTypeEnum**](PayoutMethodLegalEntityTypeEnum.md) | | [optional]
|
42
|
+
**branch_code** | **String** | | [optional]
|
43
|
+
**swift_code** | **String** | |
|
42
44
|
|
43
45
|
## Code Sample
|
44
46
|
|
@@ -79,7 +81,9 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
|
|
79
81
|
contact_last_name: null,
|
80
82
|
registration_number: null,
|
81
83
|
nature_of_business: null,
|
82
|
-
legal_entity_type: null
|
84
|
+
legal_entity_type: null,
|
85
|
+
branch_code: null,
|
86
|
+
swift_code: null)
|
83
87
|
```
|
84
88
|
|
85
89
|
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# TransferZero::PayoutMethodDetailsKESBank
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**first_name** | **String** | |
|
8
|
+
**last_name** | **String** | |
|
9
|
+
**bank_code** | **String** | |
|
10
|
+
**street** | **String** | |
|
11
|
+
**bank_account** | **String** | |
|
12
|
+
**bank_name** | **String** | |
|
13
|
+
**branch_code** | **String** | | [optional]
|
14
|
+
**swift_code** | **String** | |
|
15
|
+
**transfer_reason_code** | **String** | |
|
16
|
+
**identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) | |
|
17
|
+
**identity_card_id** | **String** | |
|
18
|
+
|
19
|
+
## Code Sample
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'TransferZero'
|
23
|
+
|
24
|
+
instance = TransferZero::PayoutMethodDetailsKESBank.new(first_name: null,
|
25
|
+
last_name: null,
|
26
|
+
bank_code: null,
|
27
|
+
street: null,
|
28
|
+
bank_account: null,
|
29
|
+
bank_name: null,
|
30
|
+
branch_code: null,
|
31
|
+
swift_code: null,
|
32
|
+
transfer_reason_code: null,
|
33
|
+
identity_card_type: null,
|
34
|
+
identity_card_id: null)
|
35
|
+
```
|
36
|
+
|
37
|
+
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# TransferZero::PayoutMethodDetailsKESMobile
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**first_name** | **String** | |
|
8
|
+
**last_name** | **String** | |
|
9
|
+
**street** | **String** | |
|
10
|
+
**phone_number** | **String** | |
|
11
|
+
**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) | |
|
12
|
+
**transfer_reason_code** | **String** | |
|
13
|
+
**identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) | |
|
14
|
+
**identity_card_id** | **String** | |
|
15
|
+
|
16
|
+
## Code Sample
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'TransferZero'
|
20
|
+
|
21
|
+
instance = TransferZero::PayoutMethodDetailsKESMobile.new(first_name: null,
|
22
|
+
last_name: null,
|
23
|
+
street: null,
|
24
|
+
phone_number: null,
|
25
|
+
mobile_provider: null,
|
26
|
+
transfer_reason_code: null,
|
27
|
+
identity_card_type: null,
|
28
|
+
identity_card_id: null)
|
29
|
+
```
|
30
|
+
|
31
|
+
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**phone_number** | **String** | |
|
10
10
|
**bank_code** | **String** | |
|
11
11
|
**bank_account** | **String** | |
|
12
|
-
**country** | [**
|
12
|
+
**country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) | |
|
13
13
|
|
14
14
|
## Code Sample
|
15
15
|
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# TransferZero::PayoutMethodDetailsUSDCash
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**first_name** | **String** | |
|
8
|
+
**last_name** | **String** | |
|
9
|
+
**phone_number** | **String** | |
|
10
|
+
**country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) | |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'TransferZero'
|
16
|
+
|
17
|
+
instance = TransferZero::PayoutMethodDetailsUSDCash.new(first_name: null,
|
18
|
+
last_name: null,
|
19
|
+
phone_number: null,
|
20
|
+
country: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -7,8 +7,9 @@ Name | Type | Description | Notes
|
|
7
7
|
**first_name** | **String** | |
|
8
8
|
**last_name** | **String** | |
|
9
9
|
**iban** | **String** | |
|
10
|
-
**bank_name** | **String** | |
|
11
|
-
**bank_country** | **String** | |
|
10
|
+
**bank_name** | **String** | | [optional]
|
11
|
+
**bank_country** | **String** | | [optional]
|
12
|
+
**bank_code** | **String** | | [optional]
|
12
13
|
|
13
14
|
## Code Sample
|
14
15
|
|
@@ -19,7 +20,8 @@ instance = TransferZero::PayoutMethodDetailsXOFBank.new(first_name: null,
|
|
19
20
|
last_name: null,
|
20
21
|
iban: null,
|
21
22
|
bank_name: null,
|
22
|
-
bank_country: null
|
23
|
+
bank_country: null,
|
24
|
+
bank_code: null)
|
23
25
|
```
|
24
26
|
|
25
27
|
|
data/docs/Recipient.md
CHANGED
@@ -26,6 +26,7 @@ Name | Type | Description | Notes
|
|
26
26
|
**output_amount** | **Float** | The amount that will be paid to the recipient | [optional]
|
27
27
|
**output_currency** | **String** | The currency the payment will be delivered in | [optional]
|
28
28
|
**id** | **String** | | [optional]
|
29
|
+
**type** | **String** | Type of recipient to create - either person or business (defaults to person) | [optional]
|
29
30
|
**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional]
|
30
31
|
|
31
32
|
## Code Sample
|
@@ -55,6 +56,7 @@ instance = TransferZero::Recipient.new(requested_amount: 750.0,
|
|
55
56
|
output_amount: 10000,
|
56
57
|
output_currency: NGN,
|
57
58
|
id: 97e79719-06e4-4794-aeeb-d2d9415d983a,
|
59
|
+
type: person,
|
58
60
|
errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
|
59
61
|
```
|
60
62
|
|
@@ -35,7 +35,7 @@ module TransferZero
|
|
35
35
|
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
36
36
|
def initialize(config = Configuration.default)
|
37
37
|
@config = config
|
38
|
-
@user_agent = "TransferZero-SDK/Ruby/1.
|
38
|
+
@user_agent = "TransferZero-SDK/Ruby/1.16.1"
|
39
39
|
@default_headers = {
|
40
40
|
'Content-Type' => 'application/json',
|
41
41
|
'User-Agent' => @user_agent
|
@@ -20,6 +20,9 @@ class AccountValidationRequest
|
|
20
20
|
# Bank Code to query - same codes are used as for creating the transactions
|
21
21
|
attr_accessor :bank_code
|
22
22
|
|
23
|
+
# IBAN to query - BBAN format for XOF bank accounts
|
24
|
+
attr_accessor :iban
|
25
|
+
|
23
26
|
# Phone number to query
|
24
27
|
attr_accessor :phone_number
|
25
28
|
|
@@ -61,6 +64,7 @@ class AccountValidationRequest
|
|
61
64
|
{
|
62
65
|
:'bank_account' => :'bank_account',
|
63
66
|
:'bank_code' => :'bank_code',
|
67
|
+
:'iban' => :'iban',
|
64
68
|
:'phone_number' => :'phone_number',
|
65
69
|
:'mobile_provider' => :'mobile_provider',
|
66
70
|
:'country' => :'country',
|
@@ -74,6 +78,7 @@ class AccountValidationRequest
|
|
74
78
|
{
|
75
79
|
:'bank_account' => :'String',
|
76
80
|
:'bank_code' => :'String',
|
81
|
+
:'iban' => :'String',
|
77
82
|
:'phone_number' => :'String',
|
78
83
|
:'mobile_provider' => :'PayoutMethodMobileProviderEnum',
|
79
84
|
:'country' => :'String',
|
@@ -105,6 +110,10 @@ class AccountValidationRequest
|
|
105
110
|
self.bank_code = attributes[:'bank_code']
|
106
111
|
end
|
107
112
|
|
113
|
+
if attributes.key?(:'iban')
|
114
|
+
self.iban = attributes[:'iban']
|
115
|
+
end
|
116
|
+
|
108
117
|
if attributes.key?(:'phone_number')
|
109
118
|
self.phone_number = attributes[:'phone_number']
|
110
119
|
end
|
@@ -149,7 +158,7 @@ class AccountValidationRequest
|
|
149
158
|
# @return true if the model is valid
|
150
159
|
def valid?
|
151
160
|
return false if @country.nil?
|
152
|
-
country_validator = EnumAttributeValidator.new('String', ["NG", "GH", "SN"])
|
161
|
+
country_validator = EnumAttributeValidator.new('String', ["NG", "GH", "SN", "CI"])
|
153
162
|
return false unless country_validator.valid?(@country)
|
154
163
|
return false if @currency.nil?
|
155
164
|
currency_validator = EnumAttributeValidator.new('String', ["NGN", "GHS", "XOF"])
|
@@ -163,7 +172,7 @@ class AccountValidationRequest
|
|
163
172
|
# Custom attribute writer method checking allowed values (enum).
|
164
173
|
# @param [Object] country Object to be assigned
|
165
174
|
def country=(country)
|
166
|
-
validator = EnumAttributeValidator.new('String', ["NG", "GH", "SN"])
|
175
|
+
validator = EnumAttributeValidator.new('String', ["NG", "GH", "SN", "CI"])
|
167
176
|
unless validator.valid?(country) || country.empty?
|
168
177
|
fail ArgumentError, "invalid value for \"country\", must be one of #{validator.allowable_values}."
|
169
178
|
end
|
@@ -197,6 +206,7 @@ class AccountValidationRequest
|
|
197
206
|
self.class == o.class &&
|
198
207
|
bank_account == o.bank_account &&
|
199
208
|
bank_code == o.bank_code &&
|
209
|
+
iban == o.iban &&
|
200
210
|
phone_number == o.phone_number &&
|
201
211
|
mobile_provider == o.mobile_provider &&
|
202
212
|
country == o.country &&
|
@@ -213,7 +223,7 @@ class AccountValidationRequest
|
|
213
223
|
# Calculates hash code according to all attributes.
|
214
224
|
# @return [Integer] Hash code
|
215
225
|
def hash
|
216
|
-
[bank_account, bank_code, phone_number, mobile_provider, country, currency, method].hash
|
226
|
+
[bank_account, bank_code, iban, phone_number, mobile_provider, country, currency, method].hash
|
217
227
|
end
|
218
228
|
|
219
229
|
require 'active_support/core_ext/hash'
|
@@ -15,7 +15,7 @@ require 'date'
|
|
15
15
|
module TransferZero
|
16
16
|
# This describes the specific details on how the payment has to be routed to the recipient.
|
17
17
|
class PayoutMethod
|
18
|
-
# Contains the currency to send the money to, and the type of the money movement Commonly used payout types are: - `NGN::Bank` - for Nigerian bank account payments. - `NGN::Mobile` - for Nigerian mobile money payments. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `GHS::Cash` - for Ghanaian cash remittance payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for mobile money payments to West-Africa. - `XOF::Bank` - for Senegalese bank account payments. - `XOF::Cash` - for Senegalese cash remittance payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank and FP accounts transfers in GBP. - `ZAR::Bank` - for South Africa bank account payments. - `USD::Bank` - for USD account payments. *** Currently Nigeria only and in Beta phase *** 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
|
18
|
+
# Contains the currency to send the money to, and the type of the money movement Commonly used payout types are: - `NGN::Bank` - for Nigerian bank account payments. - `NGN::Mobile` - for Nigerian mobile money payments. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `GHS::Cash` - for Ghanaian cash remittance payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for mobile money payments to West-Africa. - `XOF::Bank` - for Senegalese bank account payments. - `XOF::Cash` - for Senegalese cash remittance payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank and FP accounts transfers in GBP. - `ZAR::Bank` - for South Africa bank account payments. - `USD::Bank` - for USD account payments. *** Currently Nigeria only and in Beta phase *** - `USD::Cash` - for USD cash remittance payments. *** Currently Nigeria only and in Beta phase *** - `KES::Bank` - for Kenyan bank account payments. - `KES::Mobile` - for Kenyan mobile money payments. You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://docs.transferzero.com/docs/additional-features/#collections-from-senders) for more info on how to collect money into internal balance
|
19
19
|
attr_accessor :type
|
20
20
|
|
21
21
|
attr_accessor :details
|
@@ -84,6 +84,10 @@ class PayoutMethodDetails
|
|
84
84
|
|
85
85
|
attr_accessor :legal_entity_type
|
86
86
|
|
87
|
+
attr_accessor :branch_code
|
88
|
+
|
89
|
+
attr_accessor :swift_code
|
90
|
+
|
87
91
|
# Attribute mapping from ruby-style variable name to JSON key.
|
88
92
|
def self.attribute_map
|
89
93
|
{
|
@@ -121,7 +125,9 @@ class PayoutMethodDetails
|
|
121
125
|
:'contact_last_name' => :'contact_last_name',
|
122
126
|
:'registration_number' => :'registration_number',
|
123
127
|
:'nature_of_business' => :'nature_of_business',
|
124
|
-
:'legal_entity_type' => :'legal_entity_type'
|
128
|
+
:'legal_entity_type' => :'legal_entity_type',
|
129
|
+
:'branch_code' => :'branch_code',
|
130
|
+
:'swift_code' => :'swift_code'
|
125
131
|
}
|
126
132
|
end
|
127
133
|
|
@@ -135,7 +141,7 @@ class PayoutMethodDetails
|
|
135
141
|
:'bank_account_type' => :'PayoutMethodBankAccountTypeEnum',
|
136
142
|
:'phone_number' => :'String',
|
137
143
|
:'mobile_provider' => :'PayoutMethodMobileProviderEnum',
|
138
|
-
:'country' => :'
|
144
|
+
:'country' => :'PayoutMethodCountryEnum',
|
139
145
|
:'iban' => :'String',
|
140
146
|
:'bank_name' => :'String',
|
141
147
|
:'bank_country' => :'String',
|
@@ -162,7 +168,9 @@ class PayoutMethodDetails
|
|
162
168
|
:'contact_last_name' => :'String',
|
163
169
|
:'registration_number' => :'String',
|
164
170
|
:'nature_of_business' => :'PayoutMethodNatureOfBusinessEnum',
|
165
|
-
:'legal_entity_type' => :'PayoutMethodLegalEntityTypeEnum'
|
171
|
+
:'legal_entity_type' => :'PayoutMethodLegalEntityTypeEnum',
|
172
|
+
:'branch_code' => :'String',
|
173
|
+
:'swift_code' => :'String'
|
166
174
|
}
|
167
175
|
end
|
168
176
|
|
@@ -175,10 +183,13 @@ class PayoutMethodDetails
|
|
175
183
|
:'PayoutMethodDetailsGHSBank',
|
176
184
|
:'PayoutMethodDetailsGHSCash',
|
177
185
|
:'PayoutMethodDetailsIBAN',
|
186
|
+
:'PayoutMethodDetailsKESBank',
|
187
|
+
:'PayoutMethodDetailsKESMobile',
|
178
188
|
:'PayoutMethodDetailsMADCash',
|
179
189
|
:'PayoutMethodDetailsMobile',
|
180
190
|
:'PayoutMethodDetailsNGNBank',
|
181
191
|
:'PayoutMethodDetailsUSDBank',
|
192
|
+
:'PayoutMethodDetailsUSDCash',
|
182
193
|
:'PayoutMethodDetailsXOFBank',
|
183
194
|
:'PayoutMethodDetailsXOFCash',
|
184
195
|
:'PayoutMethodDetailsXOFMobile',
|
@@ -340,6 +351,14 @@ class PayoutMethodDetails
|
|
340
351
|
if attributes.key?(:'legal_entity_type')
|
341
352
|
self.legal_entity_type = attributes[:'legal_entity_type']
|
342
353
|
end
|
354
|
+
|
355
|
+
if attributes.key?(:'branch_code')
|
356
|
+
self.branch_code = attributes[:'branch_code']
|
357
|
+
end
|
358
|
+
|
359
|
+
if attributes.key?(:'swift_code')
|
360
|
+
self.swift_code = attributes[:'swift_code']
|
361
|
+
end
|
343
362
|
end
|
344
363
|
|
345
364
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -382,10 +401,6 @@ class PayoutMethodDetails
|
|
382
401
|
invalid_properties.push('invalid value for "bank_name", bank_name cannot be nil.')
|
383
402
|
end
|
384
403
|
|
385
|
-
if @bank_country.nil?
|
386
|
-
invalid_properties.push('invalid value for "bank_country", bank_country cannot be nil.')
|
387
|
-
end
|
388
|
-
|
389
404
|
if @sender_identity_card_type.nil?
|
390
405
|
invalid_properties.push('invalid value for "sender_identity_card_type", sender_identity_card_type cannot be nil.')
|
391
406
|
end
|
@@ -394,6 +409,14 @@ class PayoutMethodDetails
|
|
394
409
|
invalid_properties.push('invalid value for "sender_identity_card_id", sender_identity_card_id cannot be nil.')
|
395
410
|
end
|
396
411
|
|
412
|
+
if @identity_card_type.nil?
|
413
|
+
invalid_properties.push('invalid value for "identity_card_type", identity_card_type cannot be nil.')
|
414
|
+
end
|
415
|
+
|
416
|
+
if @identity_card_id.nil?
|
417
|
+
invalid_properties.push('invalid value for "identity_card_id", identity_card_id cannot be nil.')
|
418
|
+
end
|
419
|
+
|
397
420
|
if @name.nil?
|
398
421
|
invalid_properties.push('invalid value for "name", name cannot be nil.')
|
399
422
|
end
|
@@ -414,6 +437,14 @@ class PayoutMethodDetails
|
|
414
437
|
invalid_properties.push('invalid value for "city", city cannot be nil.')
|
415
438
|
end
|
416
439
|
|
440
|
+
if @transfer_reason_code.nil?
|
441
|
+
invalid_properties.push('invalid value for "transfer_reason_code", transfer_reason_code cannot be nil.')
|
442
|
+
end
|
443
|
+
|
444
|
+
if @swift_code.nil?
|
445
|
+
invalid_properties.push('invalid value for "swift_code", swift_code cannot be nil.')
|
446
|
+
end
|
447
|
+
|
417
448
|
invalid_properties
|
418
449
|
end
|
419
450
|
|
@@ -429,14 +460,17 @@ class PayoutMethodDetails
|
|
429
460
|
return false if @country.nil?
|
430
461
|
return false if @iban.nil?
|
431
462
|
return false if @bank_name.nil?
|
432
|
-
return false if @bank_country.nil?
|
433
463
|
return false if @sender_identity_card_type.nil?
|
434
464
|
return false if @sender_identity_card_id.nil?
|
465
|
+
return false if @identity_card_type.nil?
|
466
|
+
return false if @identity_card_id.nil?
|
435
467
|
return false if @name.nil?
|
436
468
|
return false if @address.nil?
|
437
469
|
return false if @street.nil?
|
438
470
|
return false if @postal_code.nil?
|
439
471
|
return false if @city.nil?
|
472
|
+
return false if @transfer_reason_code.nil?
|
473
|
+
return false if @swift_code.nil?
|
440
474
|
_one_of_found = false
|
441
475
|
openapi_one_of.each do |_class|
|
442
476
|
_one_of = TransferZero.const_get(_class).build_from_hash(self.to_hash)
|
@@ -495,7 +529,9 @@ class PayoutMethodDetails
|
|
495
529
|
contact_last_name == o.contact_last_name &&
|
496
530
|
registration_number == o.registration_number &&
|
497
531
|
nature_of_business == o.nature_of_business &&
|
498
|
-
legal_entity_type == o.legal_entity_type
|
532
|
+
legal_entity_type == o.legal_entity_type &&
|
533
|
+
branch_code == o.branch_code &&
|
534
|
+
swift_code == o.swift_code
|
499
535
|
end
|
500
536
|
|
501
537
|
# @see the `==` method
|
@@ -507,7 +543,7 @@ class PayoutMethodDetails
|
|
507
543
|
# Calculates hash code according to all attributes.
|
508
544
|
# @return [Integer] Hash code
|
509
545
|
def hash
|
510
|
-
[first_name, last_name, bank_code, bank_account, bank_account_type, phone_number, mobile_provider, country, iban, bank_name, bank_country, cash_provider, sort_code, bic, sender_identity_card_type, sender_identity_card_id, sender_city_of_birth, sender_country_of_birth, sender_gender, reason, identity_card_type, identity_card_id, reference, name, address, street, postal_code, city, email, transfer_reason_code, contact_first_name, contact_last_name, registration_number, nature_of_business, legal_entity_type].hash
|
546
|
+
[first_name, last_name, bank_code, bank_account, bank_account_type, phone_number, mobile_provider, country, iban, bank_name, bank_country, cash_provider, sort_code, bic, sender_identity_card_type, sender_identity_card_id, sender_city_of_birth, sender_country_of_birth, sender_gender, reason, identity_card_type, identity_card_id, reference, name, address, street, postal_code, city, email, transfer_reason_code, contact_first_name, contact_last_name, registration_number, nature_of_business, legal_entity_type, branch_code, swift_code].hash
|
511
547
|
end
|
512
548
|
|
513
549
|
require 'active_support/core_ext/hash'
|