transferzero-sdk 1.11.0 → 1.14.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/README.md +8 -4
- data/docs/AccountValidationRequest.md +2 -0
- data/docs/PayoutMethod.md +1 -1
- data/docs/PayoutMethodCountryEnum.md +16 -0
- data/docs/PayoutMethodDetails.md +16 -4
- data/docs/PayoutMethodDetailsGHSCash.md +21 -0
- data/docs/PayoutMethodDetailsMADCash.md +3 -3
- data/docs/PayoutMethodDetailsXOFCash.md +3 -1
- data/docs/PayoutMethodDetailsXOFMobile.md +3 -1
- data/docs/PayoutMethodDetailsZARBank.md +13 -1
- data/docs/PayoutMethodLegalEntityTypeEnum.md +16 -0
- data/docs/PayoutMethodNatureOfBusinessEnum.md +16 -0
- data/docs/TransactionsApi.md +2 -0
- data/example/client.rb +18 -55
- data/lib/transferzero-sdk.rb +4 -0
- data/lib/transferzero-sdk/api/transactions_api.rb +6 -0
- data/lib/transferzero-sdk/api_client.rb +1 -1
- data/lib/transferzero-sdk/models/account_validation_request.rb +10 -1
- data/lib/transferzero-sdk/models/payout_method.rb +1 -1
- data/lib/transferzero-sdk/models/payout_method_country_enum.rb +43 -0
- data/lib/transferzero-sdk/models/payout_method_details.rb +59 -19
- data/lib/transferzero-sdk/models/payout_method_details_ghs_cash.rb +236 -0
- data/lib/transferzero-sdk/models/payout_method_details_mad_cash.rb +1 -16
- data/lib/transferzero-sdk/models/payout_method_details_xof_cash.rb +14 -5
- data/lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb +14 -5
- data/lib/transferzero-sdk/models/payout_method_details_zar_bank.rb +59 -5
- data/lib/transferzero-sdk/models/payout_method_identity_card_type_enum.rb +1 -1
- data/lib/transferzero-sdk/models/payout_method_legal_entity_type_enum.rb +37 -0
- data/lib/transferzero-sdk/models/payout_method_mobile_provider_enum.rb +1 -0
- data/lib/transferzero-sdk/models/payout_method_nature_of_business_enum.rb +65 -0
- data/lib/transferzero-sdk/version.rb +1 -1
- data/spec/models/payout_method_country_enum_spec.rb +35 -0
- data/spec/models/payout_method_details_ghs_cash_spec.rb +53 -0
- data/spec/models/payout_method_legal_entity_type_enum_spec.rb +35 -0
- data/spec/models/payout_method_nature_of_business_enum_spec.rb +35 -0
- data/transferzero-sdk-1.11.0.gem +0 -0
- data/transferzero-sdk-1.12.0.gem +0 -0
- data/transferzero-sdk-1.14.0.gem +0 -0
- metadata +21 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 766d7cc6fa2f0d4d2234114ebca6e4d021ff8f64fb0dffeaac07c517afb0b49d
|
4
|
+
data.tar.gz: 2bbdea4c91a4295183a2cfdb69f28d5f96847874cd6a7e4b8236d9f7faae4908
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e5343224fb113777a508f00675924fdf63627e692bab302d9a6f490198c82444891fa7d2c9f71e3b44503a39bbfa1bbd699a7617dddebab9ca4b75629fae2d2a
|
7
|
+
data.tar.gz: ccedd0371e38501fa45b92000bbaefe551b20e3f74839128487189782125c91e01343639f516423f0b52e09509c57c2466cb387861f68dc64a48136ffe99c671
|
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.14.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.14.1.gem
|
35
35
|
```
|
36
|
-
(for development, run `gem install --dev ./transferzero-sdk-1.
|
36
|
+
(for development, run `gem install --dev ./transferzero-sdk-1.14.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.14.1'
|
43
43
|
|
44
44
|
### Install from Git
|
45
45
|
|
@@ -198,11 +198,13 @@ Class | Method | HTTP request | Description
|
|
198
198
|
- [TransferZero::PayoutMethod](docs/PayoutMethod.md)
|
199
199
|
- [TransferZero::PayoutMethodBankAccountTypeEnum](docs/PayoutMethodBankAccountTypeEnum.md)
|
200
200
|
- [TransferZero::PayoutMethodCashProviderEnum](docs/PayoutMethodCashProviderEnum.md)
|
201
|
+
- [TransferZero::PayoutMethodCountryEnum](docs/PayoutMethodCountryEnum.md)
|
201
202
|
- [TransferZero::PayoutMethodDetails](docs/PayoutMethodDetails.md)
|
202
203
|
- [TransferZero::PayoutMethodDetailsBTC](docs/PayoutMethodDetailsBTC.md)
|
203
204
|
- [TransferZero::PayoutMethodDetailsBalance](docs/PayoutMethodDetailsBalance.md)
|
204
205
|
- [TransferZero::PayoutMethodDetailsGBPBank](docs/PayoutMethodDetailsGBPBank.md)
|
205
206
|
- [TransferZero::PayoutMethodDetailsGHSBank](docs/PayoutMethodDetailsGHSBank.md)
|
207
|
+
- [TransferZero::PayoutMethodDetailsGHSCash](docs/PayoutMethodDetailsGHSCash.md)
|
206
208
|
- [TransferZero::PayoutMethodDetailsIBAN](docs/PayoutMethodDetailsIBAN.md)
|
207
209
|
- [TransferZero::PayoutMethodDetailsMADCash](docs/PayoutMethodDetailsMADCash.md)
|
208
210
|
- [TransferZero::PayoutMethodDetailsMobile](docs/PayoutMethodDetailsMobile.md)
|
@@ -213,8 +215,10 @@ Class | Method | HTTP request | Description
|
|
213
215
|
- [TransferZero::PayoutMethodDetailsZARBank](docs/PayoutMethodDetailsZARBank.md)
|
214
216
|
- [TransferZero::PayoutMethodGenderEnum](docs/PayoutMethodGenderEnum.md)
|
215
217
|
- [TransferZero::PayoutMethodIdentityCardTypeEnum](docs/PayoutMethodIdentityCardTypeEnum.md)
|
218
|
+
- [TransferZero::PayoutMethodLegalEntityTypeEnum](docs/PayoutMethodLegalEntityTypeEnum.md)
|
216
219
|
- [TransferZero::PayoutMethodListResponse](docs/PayoutMethodListResponse.md)
|
217
220
|
- [TransferZero::PayoutMethodMobileProviderEnum](docs/PayoutMethodMobileProviderEnum.md)
|
221
|
+
- [TransferZero::PayoutMethodNatureOfBusinessEnum](docs/PayoutMethodNatureOfBusinessEnum.md)
|
218
222
|
- [TransferZero::PayoutMethodRequest](docs/PayoutMethodRequest.md)
|
219
223
|
- [TransferZero::PayoutMethodResponse](docs/PayoutMethodResponse.md)
|
220
224
|
- [TransferZero::PayoutMethodWebhook](docs/PayoutMethodWebhook.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/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. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for
|
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. 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]
|
@@ -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
|
+
|
data/docs/PayoutMethodDetails.md
CHANGED
@@ -11,6 +11,7 @@ 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** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) | | [optional]
|
14
15
|
**iban** | **String** | |
|
15
16
|
**bank_name** | **String** | |
|
16
17
|
**bank_country** | **String** | |
|
@@ -19,9 +20,9 @@ Name | Type | Description | Notes
|
|
19
20
|
**bic** | **String** | | [optional]
|
20
21
|
**sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) | |
|
21
22
|
**sender_identity_card_id** | **String** | |
|
22
|
-
**sender_city_of_birth** | **String** | |
|
23
|
-
**sender_country_of_birth** | **String** | |
|
24
|
-
**sender_gender** | [**PayoutMethodGenderEnum**](PayoutMethodGenderEnum.md) | |
|
23
|
+
**sender_city_of_birth** | **String** | | [optional]
|
24
|
+
**sender_country_of_birth** | **String** | | [optional]
|
25
|
+
**sender_gender** | [**PayoutMethodGenderEnum**](PayoutMethodGenderEnum.md) | | [optional]
|
25
26
|
**reason** | **String** | | [optional]
|
26
27
|
**identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) | | [optional]
|
27
28
|
**identity_card_id** | **String** | | [optional]
|
@@ -33,6 +34,11 @@ Name | Type | Description | Notes
|
|
33
34
|
**city** | **String** | |
|
34
35
|
**email** | **String** | | [optional]
|
35
36
|
**transfer_reason_code** | **String** | | [optional]
|
37
|
+
**contact_first_name** | **String** | | [optional]
|
38
|
+
**contact_last_name** | **String** | | [optional]
|
39
|
+
**registration_number** | **String** | | [optional]
|
40
|
+
**nature_of_business** | [**PayoutMethodNatureOfBusinessEnum**](PayoutMethodNatureOfBusinessEnum.md) | | [optional]
|
41
|
+
**legal_entity_type** | [**PayoutMethodLegalEntityTypeEnum**](PayoutMethodLegalEntityTypeEnum.md) | | [optional]
|
36
42
|
|
37
43
|
## Code Sample
|
38
44
|
|
@@ -46,6 +52,7 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
|
|
46
52
|
bank_account_type: null,
|
47
53
|
phone_number: null,
|
48
54
|
mobile_provider: null,
|
55
|
+
country: null,
|
49
56
|
iban: null,
|
50
57
|
bank_name: null,
|
51
58
|
bank_country: null,
|
@@ -67,7 +74,12 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
|
|
67
74
|
postal_code: null,
|
68
75
|
city: null,
|
69
76
|
email: null,
|
70
|
-
transfer_reason_code: null
|
77
|
+
transfer_reason_code: null,
|
78
|
+
contact_first_name: null,
|
79
|
+
contact_last_name: null,
|
80
|
+
registration_number: null,
|
81
|
+
nature_of_business: null,
|
82
|
+
legal_entity_type: null)
|
71
83
|
```
|
72
84
|
|
73
85
|
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# TransferZero::PayoutMethodDetailsGHSCash
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**first_name** | **String** | |
|
8
|
+
**last_name** | **String** | |
|
9
|
+
**phone_number** | **String** | |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'TransferZero'
|
15
|
+
|
16
|
+
instance = TransferZero::PayoutMethodDetailsGHSCash.new(first_name: null,
|
17
|
+
last_name: null,
|
18
|
+
phone_number: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -9,9 +9,9 @@ Name | Type | Description | Notes
|
|
9
9
|
**phone_number** | **String** | |
|
10
10
|
**sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) | |
|
11
11
|
**sender_identity_card_id** | **String** | |
|
12
|
-
**sender_city_of_birth** | **String** | |
|
13
|
-
**sender_country_of_birth** | **String** | |
|
14
|
-
**sender_gender** | [**PayoutMethodGenderEnum**](PayoutMethodGenderEnum.md) | |
|
12
|
+
**sender_city_of_birth** | **String** | | [optional]
|
13
|
+
**sender_country_of_birth** | **String** | | [optional]
|
14
|
+
**sender_gender** | [**PayoutMethodGenderEnum**](PayoutMethodGenderEnum.md) | | [optional]
|
15
15
|
**reason** | **String** | | [optional]
|
16
16
|
**identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) | | [optional]
|
17
17
|
**identity_card_id** | **String** | | [optional]
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**last_name** | **String** | |
|
9
9
|
**phone_number** | **String** | |
|
10
10
|
**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) | | [optional]
|
11
|
+
**country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) | | [optional]
|
11
12
|
|
12
13
|
## Code Sample
|
13
14
|
|
@@ -17,7 +18,8 @@ require 'TransferZero'
|
|
17
18
|
instance = TransferZero::PayoutMethodDetailsXOFCash.new(first_name: null,
|
18
19
|
last_name: null,
|
19
20
|
phone_number: null,
|
20
|
-
cash_provider: null
|
21
|
+
cash_provider: null,
|
22
|
+
country: null)
|
21
23
|
```
|
22
24
|
|
23
25
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**last_name** | **String** | |
|
9
9
|
**phone_number** | **String** | |
|
10
10
|
**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) | |
|
11
|
+
**country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) | | [optional]
|
11
12
|
|
12
13
|
## Code Sample
|
13
14
|
|
@@ -17,7 +18,8 @@ require 'TransferZero'
|
|
17
18
|
instance = TransferZero::PayoutMethodDetailsXOFMobile.new(first_name: null,
|
18
19
|
last_name: null,
|
19
20
|
phone_number: null,
|
20
|
-
mobile_provider: null
|
21
|
+
mobile_provider: null,
|
22
|
+
country: null)
|
21
23
|
```
|
22
24
|
|
23
25
|
|
@@ -14,6 +14,12 @@ Name | Type | Description | Notes
|
|
14
14
|
**bank_account** | **String** | |
|
15
15
|
**phone_number** | **String** | |
|
16
16
|
**transfer_reason_code** | **String** | | [optional]
|
17
|
+
**name** | **String** | | [optional]
|
18
|
+
**contact_first_name** | **String** | | [optional]
|
19
|
+
**contact_last_name** | **String** | | [optional]
|
20
|
+
**registration_number** | **String** | | [optional]
|
21
|
+
**nature_of_business** | [**PayoutMethodNatureOfBusinessEnum**](PayoutMethodNatureOfBusinessEnum.md) | | [optional]
|
22
|
+
**legal_entity_type** | [**PayoutMethodLegalEntityTypeEnum**](PayoutMethodLegalEntityTypeEnum.md) | | [optional]
|
17
23
|
|
18
24
|
## Code Sample
|
19
25
|
|
@@ -29,7 +35,13 @@ instance = TransferZero::PayoutMethodDetailsZARBank.new(first_name: null,
|
|
29
35
|
bank_code: null,
|
30
36
|
bank_account: null,
|
31
37
|
phone_number: null,
|
32
|
-
transfer_reason_code: null
|
38
|
+
transfer_reason_code: null,
|
39
|
+
name: null,
|
40
|
+
contact_first_name: null,
|
41
|
+
contact_last_name: null,
|
42
|
+
registration_number: null,
|
43
|
+
nature_of_business: null,
|
44
|
+
legal_entity_type: null)
|
33
45
|
```
|
34
46
|
|
35
47
|
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# TransferZero::PayoutMethodLegalEntityTypeEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
|
8
|
+
## Code Sample
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'TransferZero'
|
12
|
+
|
13
|
+
instance = TransferZero::PayoutMethodLegalEntityTypeEnum.new()
|
14
|
+
```
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# TransferZero::PayoutMethodNatureOfBusinessEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
|
8
|
+
## Code Sample
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'TransferZero'
|
12
|
+
|
13
|
+
instance = TransferZero::PayoutMethodNatureOfBusinessEnum.new()
|
14
|
+
```
|
15
|
+
|
16
|
+
|
data/docs/TransactionsApi.md
CHANGED
@@ -216,6 +216,7 @@ opts = {
|
|
216
216
|
per: 10 # Integer | The number of results to load per page (defaults to 10)
|
217
217
|
external_id: 'external_id_example' # String | Allows filtering results by `external_id`. Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
|
218
218
|
sender_id: 'sender_id_example' # String | Allows filtering results by `sender_id`. Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
|
219
|
+
transactions_type: 'transactions_type_example' # String | Allows filtering results by `transactions_type`. Example: `/v1/transactions?transactions_type=automated`
|
219
220
|
}
|
220
221
|
|
221
222
|
begin
|
@@ -241,6 +242,7 @@ Name | Type | Description | Notes
|
|
241
242
|
**per** | **Integer**| The number of results to load per page (defaults to 10) | [optional]
|
242
243
|
**external_id** | **String**| Allows filtering results by `external_id`. Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` | [optional]
|
243
244
|
**sender_id** | **String**| Allows filtering results by `sender_id`. Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7` | [optional]
|
245
|
+
**transactions_type** | **String**| Allows filtering results by `transactions_type`. Example: `/v1/transactions?transactions_type=automated` | [optional]
|
244
246
|
|
245
247
|
### Return type
|
246
248
|
|
data/example/client.rb
CHANGED
@@ -4,17 +4,15 @@ require 'securerandom'
|
|
4
4
|
require 'bundler/inline'
|
5
5
|
|
6
6
|
gemfile do
|
7
|
-
|
8
|
-
gem 'transferzero-sdk', path: '/Users/lindelwencube/projects/spec/api-specification/public/generated/transferzero-sdk-ruby'
|
7
|
+
gem "transferzero-sdk", "=1.0.0"
|
9
8
|
end
|
10
9
|
|
11
10
|
require 'transferzero-sdk'
|
12
11
|
|
13
12
|
credentials = {
|
14
|
-
key: "
|
15
|
-
secret: "
|
16
|
-
host: "
|
17
|
-
scheme: 'http'
|
13
|
+
key: "<key>",
|
14
|
+
secret: "<secret>",
|
15
|
+
host: "https://api-sandbox.transferzero.com/v1"
|
18
16
|
}
|
19
17
|
|
20
18
|
# Please see our documentation at https://docs.transferzero.com
|
@@ -27,7 +25,6 @@ class Client
|
|
27
25
|
config.api_key = credentials[:key]
|
28
26
|
config.api_secret = credentials[:secret]
|
29
27
|
config.host = credentials[:host]
|
30
|
-
config.scheme = credentials[:scheme]
|
31
28
|
end
|
32
29
|
end
|
33
30
|
|
@@ -144,66 +141,32 @@ class Client
|
|
144
141
|
sender = TransferZero::Sender.new
|
145
142
|
# When adding a sender to transaction, please use either an id or external_id. Providing both will result in a validation error.
|
146
143
|
# Please see our documentation at https://docs.transferzero.com/docs/transaction-flow/#sender
|
147
|
-
sender.id =
|
148
|
-
sender.identification_number = '894369978426'
|
149
|
-
sender.identification_type = 'ID'
|
150
|
-
# sender.city_of_birth = "London"
|
151
|
-
# sender.country_of_birth = "GB"
|
152
|
-
# sender.gender = "F"
|
153
|
-
|
154
|
-
|
155
|
-
|
144
|
+
sender.id = 'ec33484c-4456-4625-a823-9704a3a54e68'
|
156
145
|
|
157
146
|
# You can find the various payout options at https://docs.transferzero.com/docs/transaction-flow/#payout-details
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
#xof cash
|
166
|
-
xof_cash_details = TransferZero::PayoutMethodDetails.new
|
167
|
-
xof_cash_details.phone_number = '221774103945'
|
168
|
-
xof_cash_details.first_name = 'first'
|
169
|
-
xof_cash_details.last_name = 'last'
|
170
|
-
# xof_cash_details.identity_card_id = 'OLD'
|
171
|
-
# xof_cash_details.identity_card_type = TransferZero::PayoutMethodIdentityCardTypeEnum::NI
|
172
|
-
xof_cash_details.cash_provider = TransferZero::PayoutMethodCashProviderEnum::WIZALL
|
173
|
-
# xof_cash_details.country = TransferZero::PayoutMethodCashProviderEnum::WIZALL
|
147
|
+
ngn_bank_details = TransferZero::PayoutMethodDetails.new
|
148
|
+
ngn_bank_details.bank_account = '123456789'
|
149
|
+
ngn_bank_details.bank_account_type = TransferZero::PayoutMethodBankAccountTypeEnum::N20
|
150
|
+
ngn_bank_details.bank_code = '082'
|
151
|
+
ngn_bank_details.first_name = 'first'
|
152
|
+
ngn_bank_details.last_name = 'last'
|
174
153
|
|
175
154
|
payout_method = TransferZero::PayoutMethod.new
|
176
|
-
payout_method.type = '
|
177
|
-
payout_method.details =
|
178
|
-
|
179
|
-
# #mad cash
|
180
|
-
# mad_cash_details = TransferZero::PayoutMethodDetails.new
|
181
|
-
# mad_cash_details.phone_number = '212537718685'
|
182
|
-
# mad_cash_details.first_name = 'first'
|
183
|
-
# mad_cash_details.last_name = 'last'
|
184
|
-
# mad_cash_details.reason = "Remittance payment"
|
185
|
-
# mad_cash_details.sender_identity_card_type = TransferZero::PayoutMethodIdentityCardTypeEnum::O
|
186
|
-
# mad_cash_details.sender_identity_card_id = "123456789"
|
187
|
-
# mad_cash_details.identity_card_type = TransferZero::PayoutMethodIdentityCardTypeEnum::PP
|
188
|
-
# mad_cash_details.identity_card_id = "123456789"
|
189
|
-
|
190
|
-
|
191
|
-
# payout_method = TransferZero::PayoutMethod.new
|
192
|
-
# payout_method.type = 'MAD::Cash'
|
193
|
-
# payout_method.details = mad_cash_details
|
155
|
+
payout_method.type = 'NGN::Bank'
|
156
|
+
payout_method.details = ngn_bank_details
|
194
157
|
|
195
158
|
# Please see https://docs.transferzero.com/docs/transaction-flow/#requested-amount-and-currency
|
196
159
|
# on what the request amount and currencies do
|
197
160
|
recipient = TransferZero::Recipient.new
|
198
|
-
recipient.requested_amount =
|
199
|
-
recipient.requested_currency = '
|
161
|
+
recipient.requested_amount = 10000
|
162
|
+
recipient.requested_currency = 'NGN'
|
200
163
|
recipient.payout_method = payout_method
|
201
164
|
|
202
165
|
# Similarly you can check https://docs.transferzero.com/docs/transaction-flow/#requested-amount-and-currency
|
203
166
|
# on details about the input currency parameter
|
204
167
|
|
205
168
|
# Find more details on external IDs at https://docs.transferzero.com/docs/transaction-flow/#external-id
|
206
|
-
|
169
|
+
transaction.external_id = 'TRANSACTION-1f834add' # Optional field for customer's ID
|
207
170
|
transaction.input_currency = 'GBP'
|
208
171
|
transaction.sender = sender
|
209
172
|
transaction.recipients = [recipient]
|
@@ -498,7 +461,7 @@ class Client
|
|
498
461
|
end
|
499
462
|
end
|
500
463
|
|
501
|
-
client = Client.new(credentials)
|
464
|
+
# client = Client.new(credentials)
|
502
465
|
# client.list_currencies_example
|
503
466
|
# client.account_validation_example
|
504
467
|
# client.create_sender_example
|
@@ -506,5 +469,5 @@ client = Client.new(credentials)
|
|
506
469
|
# client.update_sender_example
|
507
470
|
# client.create_transaction_example
|
508
471
|
# client.get_transaction_by_external_id_example
|
509
|
-
client.create_and_fund_transaction_example
|
472
|
+
# client.create_and_fund_transaction_example
|
510
473
|
# client.webhook_parse_example
|
data/lib/transferzero-sdk.rb
CHANGED
@@ -62,11 +62,13 @@ 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
64
|
require 'transferzero-sdk/models/payout_method_cash_provider_enum'
|
65
|
+
require 'transferzero-sdk/models/payout_method_country_enum'
|
65
66
|
require 'transferzero-sdk/models/payout_method_details'
|
66
67
|
require 'transferzero-sdk/models/payout_method_details_btc'
|
67
68
|
require 'transferzero-sdk/models/payout_method_details_balance'
|
68
69
|
require 'transferzero-sdk/models/payout_method_details_gbp_bank'
|
69
70
|
require 'transferzero-sdk/models/payout_method_details_ghs_bank'
|
71
|
+
require 'transferzero-sdk/models/payout_method_details_ghs_cash'
|
70
72
|
require 'transferzero-sdk/models/payout_method_details_iban'
|
71
73
|
require 'transferzero-sdk/models/payout_method_details_mad_cash'
|
72
74
|
require 'transferzero-sdk/models/payout_method_details_mobile'
|
@@ -77,8 +79,10 @@ require 'transferzero-sdk/models/payout_method_details_xof_mobile'
|
|
77
79
|
require 'transferzero-sdk/models/payout_method_details_zar_bank'
|
78
80
|
require 'transferzero-sdk/models/payout_method_gender_enum'
|
79
81
|
require 'transferzero-sdk/models/payout_method_identity_card_type_enum'
|
82
|
+
require 'transferzero-sdk/models/payout_method_legal_entity_type_enum'
|
80
83
|
require 'transferzero-sdk/models/payout_method_list_response'
|
81
84
|
require 'transferzero-sdk/models/payout_method_mobile_provider_enum'
|
85
|
+
require 'transferzero-sdk/models/payout_method_nature_of_business_enum'
|
82
86
|
require 'transferzero-sdk/models/payout_method_request'
|
83
87
|
require 'transferzero-sdk/models/payout_method_response'
|
84
88
|
require 'transferzero-sdk/models/payout_method_webhook'
|