transferzero-sdk 1.18.0 → 1.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +19 -16
- data/README.md +12 -4
- data/docs/Document.md +2 -0
- data/docs/PayinMethod.md +12 -4
- data/docs/PayinMethodDetails.md +5 -5
- data/docs/PayinMethodDetailsMobile.md +3 -3
- data/docs/PayinMethodDetailsNGNBank.md +2 -2
- data/docs/PayinMethodResponse.md +17 -0
- data/docs/PayinMethodState.md +16 -0
- data/docs/PayinMethodUxFlow.md +16 -0
- data/docs/PayinMethodsApi.md +256 -0
- data/docs/PayoutMethodDetails.md +1 -1
- data/docs/PayoutMethodDetailsXOFCash.md +1 -1
- data/docs/RecipientStateReasonDetails.md +3 -3
- data/docs/Sender.md +2 -0
- data/docs/StateReasonDetails.md +23 -0
- data/lib/transferzero-sdk/api/payin_methods_api.rb +244 -0
- data/lib/transferzero-sdk/api_client.rb +1 -1
- data/lib/transferzero-sdk/models/document.rb +11 -1
- data/lib/transferzero-sdk/models/payin_method.rb +47 -9
- data/lib/transferzero-sdk/models/payin_method_details.rb +9 -15
- data/lib/transferzero-sdk/models/payin_method_details_mobile.rb +8 -14
- data/lib/transferzero-sdk/models/payin_method_details_ngn_bank.rb +2 -2
- data/lib/transferzero-sdk/models/payin_method_response.rb +202 -0
- data/lib/transferzero-sdk/models/payin_method_state.rb +39 -0
- data/lib/transferzero-sdk/models/payin_method_ux_flow.rb +31 -0
- data/lib/transferzero-sdk/models/payout_method_details.rb +5 -0
- data/lib/transferzero-sdk/models/payout_method_details_xof_cash.rb +6 -1
- data/lib/transferzero-sdk/models/recipient_state_reason_details.rb +21 -2
- data/lib/transferzero-sdk/models/sender.rb +11 -1
- data/lib/transferzero-sdk/models/state_reason_details.rb +235 -0
- data/lib/transferzero-sdk/version.rb +1 -1
- data/lib/transferzero-sdk.rb +5 -0
- data/spec/api/payin_methods_api_spec.rb +84 -0
- data/spec/models/payin_method_response_spec.rb +41 -0
- data/spec/models/payin_method_state_spec.rb +35 -0
- data/spec/models/payin_method_ux_flow_spec.rb +35 -0
- data/spec/models/state_reason_details_spec.rb +59 -0
- metadata +32 -13
- data/transferzero-sdk-1.16.1.gem +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dfcca738eca622153e9248e2c0803a49ed8b1cb7628d36a39eec71ac338a550f
|
4
|
+
data.tar.gz: 4265ce6d054155755389582c1c8399aa87923bfc34eeed61a98285fae7ef79e3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 95a378f133bae68fa12342496cd965a903404af4545cb3b2940b69eba51b1a0bea4c13f66738b0f5a908c5397c0c3385b01174b86ec2d7e6dcd5fb97074119da
|
7
|
+
data.tar.gz: 274f6c1e8e2331dc8614623a0fab304043b23b457d09eef75ba72b82d003ff1572bfcd59b2932a7365374b758bce88605a09977c3e9acb7a0dcad0c6dadc86a2
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
transferzero-sdk (1.
|
4
|
+
transferzero-sdk (1.11.0)
|
5
5
|
activesupport (>= 4)
|
6
6
|
json (>= 1.4)
|
7
7
|
typhoeus (~> 1.0, >= 1.0.1)
|
@@ -10,7 +10,7 @@ GEM
|
|
10
10
|
remote: https://rubygems.org/
|
11
11
|
specs:
|
12
12
|
ZenTest (4.12.0)
|
13
|
-
activesupport (6.1.
|
13
|
+
activesupport (6.1.3)
|
14
14
|
concurrent-ruby (~> 1.0, >= 1.0.2)
|
15
15
|
i18n (>= 1.6, < 2)
|
16
16
|
minitest (>= 5.1)
|
@@ -20,23 +20,24 @@ GEM
|
|
20
20
|
public_suffix (>= 2.0.2, < 5.0)
|
21
21
|
autotest (4.4.6)
|
22
22
|
ZenTest (>= 4.4.1)
|
23
|
+
autotest-fsevent (0.2.17)
|
24
|
+
sys-uname
|
23
25
|
autotest-growl (0.2.16)
|
24
26
|
autotest-rails-pure (4.1.2)
|
25
27
|
byebug (11.1.3)
|
26
28
|
coderay (1.1.3)
|
27
|
-
concurrent-ruby (1.1.
|
28
|
-
crack (0.4.
|
29
|
-
rexml
|
29
|
+
concurrent-ruby (1.1.8)
|
30
|
+
crack (0.4.4)
|
30
31
|
diff-lcs (1.4.4)
|
31
|
-
ethon (0.
|
32
|
-
ffi (>= 1.
|
33
|
-
ffi (1.
|
32
|
+
ethon (0.12.0)
|
33
|
+
ffi (>= 1.3.0)
|
34
|
+
ffi (1.13.1)
|
34
35
|
hashdiff (1.0.1)
|
35
|
-
i18n (1.8.
|
36
|
+
i18n (1.8.9)
|
36
37
|
concurrent-ruby (~> 1.0)
|
37
38
|
json (2.5.1)
|
38
39
|
method_source (1.0.0)
|
39
|
-
minitest (5.14.
|
40
|
+
minitest (5.14.3)
|
40
41
|
pry (0.13.1)
|
41
42
|
coderay (~> 1.1)
|
42
43
|
method_source (~> 1.0)
|
@@ -45,20 +46,21 @@ GEM
|
|
45
46
|
pry (~> 0.13.0)
|
46
47
|
public_suffix (4.0.6)
|
47
48
|
rake (12.0.0)
|
48
|
-
rexml (3.2.4)
|
49
49
|
rspec (3.10.0)
|
50
50
|
rspec-core (~> 3.10.0)
|
51
51
|
rspec-expectations (~> 3.10.0)
|
52
52
|
rspec-mocks (~> 3.10.0)
|
53
|
-
rspec-core (3.10.
|
53
|
+
rspec-core (3.10.0)
|
54
54
|
rspec-support (~> 3.10.0)
|
55
|
-
rspec-expectations (3.10.
|
55
|
+
rspec-expectations (3.10.0)
|
56
56
|
diff-lcs (>= 1.2.0, < 2.0)
|
57
57
|
rspec-support (~> 3.10.0)
|
58
|
-
rspec-mocks (3.10.
|
58
|
+
rspec-mocks (3.10.0)
|
59
59
|
diff-lcs (>= 1.2.0, < 2.0)
|
60
60
|
rspec-support (~> 3.10.0)
|
61
|
-
rspec-support (3.10.
|
61
|
+
rspec-support (3.10.0)
|
62
|
+
sys-uname (1.2.2)
|
63
|
+
ffi (~> 1.1)
|
62
64
|
typhoeus (1.4.0)
|
63
65
|
ethon (>= 0.9.0)
|
64
66
|
tzinfo (2.0.4)
|
@@ -76,6 +78,7 @@ PLATFORMS
|
|
76
78
|
DEPENDENCIES
|
77
79
|
ZenTest (~> 4.11, >= 4.11.2)
|
78
80
|
autotest (~> 4.4, >= 4.4.6)
|
81
|
+
autotest-fsevent (~> 0.2, >= 0.2.12)
|
79
82
|
autotest-growl (~> 0.2, >= 0.2.16)
|
80
83
|
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
81
84
|
pry-byebug
|
@@ -86,4 +89,4 @@ DEPENDENCIES
|
|
86
89
|
webmock (~> 1.24, >= 1.24.3)
|
87
90
|
|
88
91
|
BUNDLED WITH
|
89
|
-
|
92
|
+
1.17.3
|
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.19.0
|
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.19.0.gem
|
35
35
|
```
|
36
|
-
(for development, run `gem install --dev ./transferzero-sdk-1.
|
36
|
+
(for development, run `gem install --dev ./transferzero-sdk-1.19.0.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.19.0'
|
43
43
|
|
44
44
|
### Install from Git
|
45
45
|
|
@@ -120,6 +120,10 @@ Class | Method | HTTP request | Description
|
|
120
120
|
*TransferZero::DocumentsApi* | [**post_documents**](docs/DocumentsApi.md#post_documents) | **POST** /documents | Creating a document
|
121
121
|
*TransferZero::LogsApi* | [**get_webhook_log**](docs/LogsApi.md#get_webhook_log) | **GET** /logs/{Webhook Log ID} | Fetch an individual webhook log
|
122
122
|
*TransferZero::LogsApi* | [**get_webhook_logs**](docs/LogsApi.md#get_webhook_logs) | **GET** /logs/webhooks | Fetch a list of webhook logs
|
123
|
+
*TransferZero::PayinMethodsApi* | [**delete_payin_method**](docs/PayinMethodsApi.md#delete_payin_method) | **DELETE** /payin_methods/{PayinMethod ID} | Deleting a payin method
|
124
|
+
*TransferZero::PayinMethodsApi* | [**get_payin_method**](docs/PayinMethodsApi.md#get_payin_method) | **GET** /payin_methods/{PayinMethod ID} | Fetching a payin method
|
125
|
+
*TransferZero::PayinMethodsApi* | [**patch_payin_method**](docs/PayinMethodsApi.md#patch_payin_method) | **PATCH** /payin_methods/{PayinMethod ID} | Updating a payin method
|
126
|
+
*TransferZero::PayinMethodsApi* | [**retry_payin_method**](docs/PayinMethodsApi.md#retry_payin_method) | **POST** /payin_methods/{PayinMethod ID}/retry | Retries PayinMethod
|
123
127
|
*TransferZero::PaymentMethodsApi* | [**payment_methods_in**](docs/PaymentMethodsApi.md#payment_methods_in) | **GET** /info/payment_methods/in | This method returns possible payin methods.
|
124
128
|
*TransferZero::PaymentMethodsApi* | [**payment_methods_out**](docs/PaymentMethodsApi.md#payment_methods_out) | **GET** /info/payment_methods/out | This method returns possible payout methods.
|
125
129
|
*TransferZero::PayoutMethodsApi* | [**delete_payout_method**](docs/PayoutMethodsApi.md#delete_payout_method) | **DELETE** /payout_methods/{Payout Method ID} | Deleting a payout method
|
@@ -192,6 +196,9 @@ Class | Method | HTTP request | Description
|
|
192
196
|
- [TransferZero::PayinMethodDetailsMobile](docs/PayinMethodDetailsMobile.md)
|
193
197
|
- [TransferZero::PayinMethodDetailsNGNBank](docs/PayinMethodDetailsNGNBank.md)
|
194
198
|
- [TransferZero::PayinMethodRequest](docs/PayinMethodRequest.md)
|
199
|
+
- [TransferZero::PayinMethodResponse](docs/PayinMethodResponse.md)
|
200
|
+
- [TransferZero::PayinMethodState](docs/PayinMethodState.md)
|
201
|
+
- [TransferZero::PayinMethodUxFlow](docs/PayinMethodUxFlow.md)
|
195
202
|
- [TransferZero::PaymentMethod](docs/PaymentMethod.md)
|
196
203
|
- [TransferZero::PaymentMethodListResponse](docs/PaymentMethodListResponse.md)
|
197
204
|
- [TransferZero::PaymentMethodOpposite](docs/PaymentMethodOpposite.md)
|
@@ -247,6 +254,7 @@ Class | Method | HTTP request | Description
|
|
247
254
|
- [TransferZero::SenderResponseMeta](docs/SenderResponseMeta.md)
|
248
255
|
- [TransferZero::SenderState](docs/SenderState.md)
|
249
256
|
- [TransferZero::SenderWebhook](docs/SenderWebhook.md)
|
257
|
+
- [TransferZero::StateReasonDetails](docs/StateReasonDetails.md)
|
250
258
|
- [TransferZero::Transaction](docs/Transaction.md)
|
251
259
|
- [TransferZero::TransactionListResponse](docs/TransactionListResponse.md)
|
252
260
|
- [TransferZero::TransactionRequest](docs/TransactionRequest.md)
|
data/docs/Document.md
CHANGED
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
|
|
17
17
|
**id** | **String** | | [optional]
|
18
18
|
**document_id** | **String** | Document ID issued by government | [optional]
|
19
19
|
**expiry_date** | **Date** | Document expiry date issued by government | [optional]
|
20
|
+
**source** | **String** | Determines the document's source. Default value \"Manual\" | [optional]
|
20
21
|
**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional]
|
21
22
|
|
22
23
|
## Code Sample
|
@@ -37,6 +38,7 @@ instance = TransferZero::Document.new(upload: data:image/png;base64,iVBORw0KGg..
|
|
37
38
|
id: ebe9bc0b-f2f6-4ce8-802a-8b79912d041e,
|
38
39
|
document_id: XYZ12345,
|
39
40
|
expiry_date: null,
|
41
|
+
source: Manual,
|
40
42
|
errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
|
41
43
|
```
|
42
44
|
|
data/docs/PayinMethod.md
CHANGED
@@ -4,22 +4,30 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**type** | **String** | Describes how the payment should be requested from the
|
7
|
+
**type** | **String** | Describes how the payment should be requested from the sender. Possible values: - `GHS::Mobile`: GHS mobile collections - `UGX::Mobile`: UGX mobile collections - `EUR::Bank`: EUR IBAN collections - `GBP::Bank`: GBP IBAN collections | [optional]
|
8
|
+
**ux_flow** | [**PayinMethodUxFlow**](PayinMethodUxFlow.md) | | [optional]
|
8
9
|
**in_details** | [**PayinMethodDetails**](PayinMethodDetails.md) | | [optional]
|
10
|
+
**id** | **String** | | [optional]
|
11
|
+
**state** | [**PayinMethodState**](PayinMethodState.md) | | [optional]
|
12
|
+
**state_reason_details** | [**StateReasonDetails**](StateReasonDetails.md) | | [optional]
|
9
13
|
**out_details** | [**Object**](.md) | This will contain the description on where to pay the funds. Please see the [Collections Details](https://docs.transferzero.com/docs/collection-details) in the API documentation on what to expect here. | [optional]
|
10
14
|
**instructions** | [**Object**](.md) | This will contain the instructions on how to pay the funds. Please see the [Collections Details](https://docs.transferzero.com/docs/collection-details) in the API documentation on what to expect here. | [optional]
|
11
|
-
**
|
15
|
+
**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional]
|
12
16
|
|
13
17
|
## Code Sample
|
14
18
|
|
15
19
|
```ruby
|
16
20
|
require 'TransferZero'
|
17
21
|
|
18
|
-
instance = TransferZero::PayinMethod.new(type:
|
22
|
+
instance = TransferZero::PayinMethod.new(type: GHS::Mobile,
|
23
|
+
ux_flow: null,
|
19
24
|
in_details: null,
|
25
|
+
id: 97e79719-06e4-4794-aeeb-d2d9415d983a,
|
26
|
+
state: null,
|
27
|
+
state_reason_details: null,
|
20
28
|
out_details: null,
|
21
29
|
instructions: null,
|
22
|
-
|
30
|
+
errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
|
23
31
|
```
|
24
32
|
|
25
33
|
|
data/docs/PayinMethodDetails.md
CHANGED
@@ -4,10 +4,10 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**payment_method** | **String** | The payment method which the
|
8
|
-
**redirect_url** | **String** | This is where the
|
9
|
-
**phone_number** | **String** | The phone number where the funds should be collected from |
|
10
|
-
**
|
7
|
+
**payment_method** | **String** | The payment method which the sender will use to make the payments. Options are `bank`, `card` or you can leave empty to support both. | [optional]
|
8
|
+
**redirect_url** | **String** | This is where the sender should be redirected back when the payment has been finished | [optional]
|
9
|
+
**phone_number** | **String** | The phone number where the funds should be collected from | [optional]
|
10
|
+
**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) | | [optional]
|
11
11
|
**refund_address** | **String** | Please make sure the refund_address is a valid BTC address belonging to the sender, as that is going to be used in case the transaction has to be refunded. | [optional]
|
12
12
|
|
13
13
|
## Code Sample
|
@@ -18,7 +18,7 @@ require 'TransferZero'
|
|
18
18
|
instance = TransferZero::PayinMethodDetails.new(payment_method: null,
|
19
19
|
redirect_url: null,
|
20
20
|
phone_number: +2569999999,
|
21
|
-
|
21
|
+
mobile_provider: null,
|
22
22
|
refund_address: null)
|
23
23
|
```
|
24
24
|
|
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**phone_number** | **String** | The phone number where the funds should be collected from |
|
8
|
-
**
|
7
|
+
**phone_number** | **String** | The phone number where the funds should be collected from | [optional]
|
8
|
+
**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) | | [optional]
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
13
13
|
require 'TransferZero'
|
14
14
|
|
15
15
|
instance = TransferZero::PayinMethodDetailsMobile.new(phone_number: +2569999999,
|
16
|
-
|
16
|
+
mobile_provider: null)
|
17
17
|
```
|
18
18
|
|
19
19
|
|
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**payment_method** | **String** | The payment method which the
|
8
|
-
**redirect_url** | **String** | This is where the
|
7
|
+
**payment_method** | **String** | The payment method which the sender will use to make the payments. Options are `bank`, `card` or you can leave empty to support both. | [optional]
|
8
|
+
**redirect_url** | **String** | This is where the sender should be redirected back when the payment has been finished | [optional]
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# TransferZero::PayinMethodResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**object** | [**PayinMethod**](PayinMethod.md) | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'TransferZero'
|
13
|
+
|
14
|
+
instance = TransferZero::PayinMethodResponse.new(object: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# TransferZero::PayinMethodState
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
|
8
|
+
## Code Sample
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'TransferZero'
|
12
|
+
|
13
|
+
instance = TransferZero::PayinMethodState.new()
|
14
|
+
```
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# TransferZero::PayinMethodUxFlow
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
|
8
|
+
## Code Sample
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'TransferZero'
|
12
|
+
|
13
|
+
instance = TransferZero::PayinMethodUxFlow.new()
|
14
|
+
```
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,256 @@
|
|
1
|
+
# TransferZero::PayinMethodsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api-sandbox.transferzero.com/v1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**delete_payin_method**](PayinMethodsApi.md#delete_payin_method) | **DELETE** /payin_methods/{PayinMethod ID} | Deleting a payin method
|
8
|
+
[**get_payin_method**](PayinMethodsApi.md#get_payin_method) | **GET** /payin_methods/{PayinMethod ID} | Fetching a payin method
|
9
|
+
[**patch_payin_method**](PayinMethodsApi.md#patch_payin_method) | **PATCH** /payin_methods/{PayinMethod ID} | Updating a payin method
|
10
|
+
[**retry_payin_method**](PayinMethodsApi.md#retry_payin_method) | **POST** /payin_methods/{PayinMethod ID}/retry | Retries PayinMethod
|
11
|
+
|
12
|
+
|
13
|
+
# **delete_payin_method**
|
14
|
+
> PayinMethodResponse delete_payin_method(payin_method_id)
|
15
|
+
|
16
|
+
Deleting a payin method
|
17
|
+
|
18
|
+
Initiates a cancellation request for the specified payin method
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'transferzero-sdk'
|
24
|
+
|
25
|
+
api_instance = TransferZero::PayinMethodsApi.new
|
26
|
+
|
27
|
+
|
28
|
+
begin
|
29
|
+
#Deleting a payin method
|
30
|
+
result = api_instance.delete_payin_method(payin_method_id)
|
31
|
+
p result
|
32
|
+
rescue TransferZero::ApiError => e
|
33
|
+
if e.validation_error
|
34
|
+
puts "WARN: Validation error occured when calling the endpoint"
|
35
|
+
result = e.response_object("PayinMethodResponse")
|
36
|
+
p result
|
37
|
+
else
|
38
|
+
puts "Exception when calling PayinMethodsApi->delete_payin_method: #{e}"
|
39
|
+
end
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
Name | Type | Description | Notes
|
46
|
+
------------- | ------------- | ------------- | -------------
|
47
|
+
**payin_method_id** | [**String**](.md)| ID of the payin method to delete. Example: `/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670` |
|
48
|
+
|
49
|
+
### Return type
|
50
|
+
|
51
|
+
[**PayinMethodResponse**](PayinMethodResponse.md)
|
52
|
+
|
53
|
+
### Authorization
|
54
|
+
|
55
|
+
You can set the API Key and Secret on the TransferZero object when setting it up:
|
56
|
+
|
57
|
+
```ruby
|
58
|
+
|
59
|
+
TransferZero.configure do |config|
|
60
|
+
config.api_key = '<key'
|
61
|
+
config.api_secret = '<secret>'
|
62
|
+
config.host = 'https://api-sandbox.transferzero.com/v1'
|
63
|
+
end
|
64
|
+
|
65
|
+
```
|
66
|
+
|
67
|
+
### HTTP request headers
|
68
|
+
|
69
|
+
- **Content-Type**: Not defined
|
70
|
+
- **Accept**: application/json
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
# **get_payin_method**
|
75
|
+
> PayinMethodResponse get_payin_method(payin_method_id)
|
76
|
+
|
77
|
+
Fetching a payin method
|
78
|
+
|
79
|
+
Show a payin method by id
|
80
|
+
|
81
|
+
### Example
|
82
|
+
```ruby
|
83
|
+
# load the gem
|
84
|
+
require 'transferzero-sdk'
|
85
|
+
|
86
|
+
api_instance = TransferZero::PayinMethodsApi.new
|
87
|
+
|
88
|
+
|
89
|
+
begin
|
90
|
+
#Fetching a payin method
|
91
|
+
result = api_instance.get_payin_method(payin_method_id)
|
92
|
+
p result
|
93
|
+
rescue TransferZero::ApiError => e
|
94
|
+
if e.validation_error
|
95
|
+
puts "WARN: Validation error occured when calling the endpoint"
|
96
|
+
result = e.response_object("PayinMethodResponse")
|
97
|
+
p result
|
98
|
+
else
|
99
|
+
puts "Exception when calling PayinMethodsApi->get_payin_method: #{e}"
|
100
|
+
end
|
101
|
+
end
|
102
|
+
```
|
103
|
+
|
104
|
+
### Parameters
|
105
|
+
|
106
|
+
Name | Type | Description | Notes
|
107
|
+
------------- | ------------- | ------------- | -------------
|
108
|
+
**payin_method_id** | [**String**](.md)| ID of the payin method to get. Example: `/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670` |
|
109
|
+
|
110
|
+
### Return type
|
111
|
+
|
112
|
+
[**PayinMethodResponse**](PayinMethodResponse.md)
|
113
|
+
|
114
|
+
### Authorization
|
115
|
+
|
116
|
+
You can set the API Key and Secret on the TransferZero object when setting it up:
|
117
|
+
|
118
|
+
```ruby
|
119
|
+
|
120
|
+
TransferZero.configure do |config|
|
121
|
+
config.api_key = '<key'
|
122
|
+
config.api_secret = '<secret>'
|
123
|
+
config.host = 'https://api-sandbox.transferzero.com/v1'
|
124
|
+
end
|
125
|
+
|
126
|
+
```
|
127
|
+
|
128
|
+
### HTTP request headers
|
129
|
+
|
130
|
+
- **Content-Type**: Not defined
|
131
|
+
- **Accept**: application/json
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
# **patch_payin_method**
|
136
|
+
> PayinMethodResponse patch_payin_method(payin_method_idpayin_method)
|
137
|
+
|
138
|
+
Updating a payin method
|
139
|
+
|
140
|
+
Updates the payin method specified in the URL path.
|
141
|
+
|
142
|
+
### Example
|
143
|
+
```ruby
|
144
|
+
# load the gem
|
145
|
+
require 'transferzero-sdk'
|
146
|
+
|
147
|
+
api_instance = TransferZero::PayinMethodsApi.new
|
148
|
+
|
149
|
+
|
150
|
+
begin
|
151
|
+
#Updating a payin method
|
152
|
+
result = api_instance.patch_payin_method(payin_method_idpayin_method)
|
153
|
+
p result
|
154
|
+
rescue TransferZero::ApiError => e
|
155
|
+
if e.validation_error
|
156
|
+
puts "WARN: Validation error occured when calling the endpoint"
|
157
|
+
result = e.response_object("PayinMethodResponse")
|
158
|
+
p result
|
159
|
+
else
|
160
|
+
puts "Exception when calling PayinMethodsApi->patch_payin_method: #{e}"
|
161
|
+
end
|
162
|
+
end
|
163
|
+
```
|
164
|
+
|
165
|
+
### Parameters
|
166
|
+
|
167
|
+
Name | Type | Description | Notes
|
168
|
+
------------- | ------------- | ------------- | -------------
|
169
|
+
**payin_method_id** | [**String**](.md)| ID of the payin method to get. Example: `/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670` |
|
170
|
+
**payin_method** | [**PayinMethod**](PayinMethod.md)| |
|
171
|
+
|
172
|
+
### Return type
|
173
|
+
|
174
|
+
[**PayinMethodResponse**](PayinMethodResponse.md)
|
175
|
+
|
176
|
+
### Authorization
|
177
|
+
|
178
|
+
You can set the API Key and Secret on the TransferZero object when setting it up:
|
179
|
+
|
180
|
+
```ruby
|
181
|
+
|
182
|
+
TransferZero.configure do |config|
|
183
|
+
config.api_key = '<key'
|
184
|
+
config.api_secret = '<secret>'
|
185
|
+
config.host = 'https://api-sandbox.transferzero.com/v1'
|
186
|
+
end
|
187
|
+
|
188
|
+
```
|
189
|
+
|
190
|
+
### HTTP request headers
|
191
|
+
|
192
|
+
- **Content-Type**: application/json
|
193
|
+
- **Accept**: application/json
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
# **retry_payin_method**
|
198
|
+
> retry_payin_method(payin_method_id)
|
199
|
+
|
200
|
+
Retries PayinMethod
|
201
|
+
|
202
|
+
Retries the collection process for the payin method. Please note only payin methods in `error` state can be retried.
|
203
|
+
|
204
|
+
### Example
|
205
|
+
```ruby
|
206
|
+
# load the gem
|
207
|
+
require 'transferzero-sdk'
|
208
|
+
|
209
|
+
api_instance = TransferZero::PayinMethodsApi.new
|
210
|
+
|
211
|
+
|
212
|
+
begin
|
213
|
+
#Retries PayinMethod
|
214
|
+
api_instance.retry_payin_method(payin_method_id)
|
215
|
+
rescue TransferZero::ApiError => e
|
216
|
+
if e.validation_error
|
217
|
+
puts "WARN: Validation error occured when calling the endpoint"
|
218
|
+
result = e.response_object("")
|
219
|
+
p result
|
220
|
+
else
|
221
|
+
puts "Exception when calling PayinMethodsApi->retry_payin_method: #{e}"
|
222
|
+
end
|
223
|
+
end
|
224
|
+
```
|
225
|
+
|
226
|
+
### Parameters
|
227
|
+
|
228
|
+
Name | Type | Description | Notes
|
229
|
+
------------- | ------------- | ------------- | -------------
|
230
|
+
**payin_method_id** | [**String**](.md)| ID of the payin method whose collection process should be retried Example: `/v1/payin_methods/9d4d7b73-a94c-4979-ab57-09074fd55d33/retry` |
|
231
|
+
|
232
|
+
### Return type
|
233
|
+
|
234
|
+
nil (empty response body)
|
235
|
+
|
236
|
+
### Authorization
|
237
|
+
|
238
|
+
You can set the API Key and Secret on the TransferZero object when setting it up:
|
239
|
+
|
240
|
+
```ruby
|
241
|
+
|
242
|
+
TransferZero.configure do |config|
|
243
|
+
config.api_key = '<key'
|
244
|
+
config.api_secret = '<secret>'
|
245
|
+
config.host = 'https://api-sandbox.transferzero.com/v1'
|
246
|
+
end
|
247
|
+
|
248
|
+
```
|
249
|
+
|
250
|
+
### HTTP request headers
|
251
|
+
|
252
|
+
- **Content-Type**: Not defined
|
253
|
+
- **Accept**: Not defined
|
254
|
+
|
255
|
+
|
256
|
+
|
data/docs/PayoutMethodDetails.md
CHANGED
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
|
|
16
16
|
**iban** | **String** | |
|
17
17
|
**bank_name** | **String** | |
|
18
18
|
**bank_country** | **String** | | [optional]
|
19
|
-
**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) | |
|
19
|
+
**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) | |
|
20
20
|
**sort_code** | **String** | | [optional]
|
21
21
|
**bic** | **String** | | [optional]
|
22
22
|
**sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) | |
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**first_name** | **String** | |
|
8
8
|
**last_name** | **String** | |
|
9
9
|
**phone_number** | **String** | |
|
10
|
-
**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) | |
|
10
|
+
**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) | |
|
11
11
|
**country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) | | [optional]
|
12
12
|
|
13
13
|
## Code Sample
|
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**code** | **String** | Status code of
|
8
|
-
**category** | **String** | Main category of
|
7
|
+
**code** | **String** | Status code of transaction | [optional]
|
8
|
+
**category** | **String** | Main category of status code, it could be paid, unknown, pickupable, temporary_error, recipient_error, sender_error, sender_action_required | [optional]
|
9
9
|
**messages** | **Array<String>** | Tiered messages | [optional]
|
10
10
|
**description** | **String** | Public, human readable, detailed error message | [optional]
|
11
11
|
|
@@ -17,7 +17,7 @@ require 'TransferZero'
|
|
17
17
|
instance = TransferZero::RecipientStateReasonDetails.new(code: 311,
|
18
18
|
category: temporary_error,
|
19
19
|
messages: ["Temporary error","Switch Error","Issuer/Switch inoperative"],
|
20
|
-
description: The central switch is not accepting
|
20
|
+
description: The central switch is not accepting transactions at the moment. We will retry the transaction)
|
21
21
|
```
|
22
22
|
|
23
23
|
|
data/docs/Sender.md
CHANGED
@@ -41,6 +41,7 @@ Name | Type | Description | Notes
|
|
41
41
|
**contact_person_email** | **String** | The contact's email address (used only with a Business sender) | [optional]
|
42
42
|
**trading_country** | **String** | The Business trading country (used only with a Business sender) | [optional]
|
43
43
|
**trading_address** | **String** | The Business trading address (used only with a Business sender) | [optional]
|
44
|
+
**trading_name** | **String** | The Business trading name (used only with a Business sender) | [optional]
|
44
45
|
**number_monthly_transactions** | **String** | The estimated number of monthly transactions (used only with a Business sender) | [optional]
|
45
46
|
**amount_monthly_transactions** | **String** | The estimated amount for all transactions each month in USD (used only with a Business sender) | [optional]
|
46
47
|
**documents** | [**Array<Document>**](Document.md) | Needed for KYC checks. Required to approve the sender unless KYC is waived for your account. Please send us an empty list of documents: `\"documents\": [ ]` in the request if KYC has been waived. If the documents already exist, please send the Document ID eg. ```JSON \"documents\": [ { \"id\": \"b6648ba3-1c7b-4f59-8580-684899c84a07\" } ] ``` |
|
@@ -97,6 +98,7 @@ instance = TransferZero::Sender.new(id: bf9ff782-e182-45ac-abea-5bce83ad6670,
|
|
97
98
|
contact_person_email: null,
|
98
99
|
trading_country: null,
|
99
100
|
trading_address: null,
|
101
|
+
trading_name: null,
|
100
102
|
number_monthly_transactions: null,
|
101
103
|
amount_monthly_transactions: null,
|
102
104
|
documents: [{"id":"b6648ba3-1c7b-4f59-8580-684899c84a07"}],
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# TransferZero::StateReasonDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **String** | Status code of transaction | [optional]
|
8
|
+
**category** | **String** | Main category of status code, it could be paid, unknown, pickupable, temporary_error, recipient_error, sender_error, sender_action_required | [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::StateReasonDetails.new(code: 311,
|
18
|
+
category: temporary_error,
|
19
|
+
messages: ["Temporary error","Switch Error","Issuer/Switch inoperative"],
|
20
|
+
description: The central switch is not accepting transactions at the moment. We will retry the transaction)
|
21
|
+
```
|
22
|
+
|
23
|
+
|