transferzero-sdk 1.7.0 → 1.11.0
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 +93 -0
- data/README.md +11 -4
- data/docs/Currency.md +0 -2
- data/docs/CurrencyExchange.md +0 -2
- data/docs/CurrencyOpposite.md +3 -3
- data/docs/Document.md +4 -0
- data/docs/PayoutMethod.md +1 -1
- data/docs/PayoutMethodCashProviderEnum.md +16 -0
- data/docs/PayoutMethodDetails.md +13 -1
- data/docs/PayoutMethodDetailsMobile.md +3 -1
- data/docs/PayoutMethodDetailsXOFCash.md +23 -0
- data/docs/PayoutMethodDetailsZARBank.md +35 -0
- data/docs/ProofOfPayment.md +23 -0
- data/docs/ProofOfPaymentListResponse.md +17 -0
- data/docs/Recipient.md +4 -0
- data/docs/RecipientStateReasonDetails.md +23 -0
- data/docs/RecipientsApi.md +62 -0
- data/docs/Sender.md +18 -8
- data/example/client.rb +55 -18
- data/lib/transferzero-sdk.rb +6 -0
- data/lib/transferzero-sdk/api/recipients_api.rb +54 -0
- data/lib/transferzero-sdk/api_client.rb +1 -1
- data/lib/transferzero-sdk/models/currency.rb +1 -11
- data/lib/transferzero-sdk/models/currency_exchange.rb +1 -11
- data/lib/transferzero-sdk/models/currency_opposite.rb +14 -14
- data/lib/transferzero-sdk/models/document.rb +21 -1
- data/lib/transferzero-sdk/models/payout_method.rb +1 -1
- data/lib/transferzero-sdk/models/payout_method_cash_provider_enum.rb +31 -0
- data/lib/transferzero-sdk/models/payout_method_details.rb +76 -5
- data/lib/transferzero-sdk/models/payout_method_details_mobile.rb +13 -4
- data/lib/transferzero-sdk/models/payout_method_details_xof_bank.rb +1 -1
- data/lib/transferzero-sdk/models/payout_method_details_xof_cash.rb +245 -0
- data/lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb +1 -1
- data/lib/transferzero-sdk/models/payout_method_details_zar_bank.rb +324 -0
- data/lib/transferzero-sdk/models/payout_method_mobile_provider_enum.rb +3 -0
- data/lib/transferzero-sdk/models/proof_of_payment.rb +233 -0
- data/lib/transferzero-sdk/models/proof_of_payment_list_response.rb +204 -0
- data/lib/transferzero-sdk/models/recipient.rb +20 -1
- data/lib/transferzero-sdk/models/recipient_state_reason_details.rb +235 -0
- data/lib/transferzero-sdk/models/sender.rb +88 -14
- data/lib/transferzero-sdk/version.rb +1 -1
- data/spec/models/payout_method_cash_provider_enum_spec.rb +35 -0
- data/spec/models/payout_method_details_xof_cash_spec.rb +71 -0
- data/spec/models/payout_method_details_zar_bank_spec.rb +89 -0
- data/spec/models/proof_of_payment_list_response_spec.rb +41 -0
- data/spec/models/proof_of_payment_spec.rb +59 -0
- data/spec/models/recipient_state_reason_details_spec.rb +59 -0
- data/transferzero-sdk-1.10.0.gem +0 -0
- metadata +28 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a812f687f43ed50327ba8c0bc8c3023f47b7e84fb995419da547d76556ae43d2
|
4
|
+
data.tar.gz: 8888e69236bf452f337478c1d77cbd09c4ec1b3729ff48236f04ab2c4ffb4cf2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: da69f1ae7da9d4d65487616f6f44b2c4bb36f2695b77e92c8e2fb73e14299cb13d6692c45f12f0f9563d19292874bf27a01e69eabfafe471a02ec9b5baf1c461
|
7
|
+
data.tar.gz: 905e94eaaa92f092b6746f0486e8e552b8bef29af04a3cc6722ff9ac6c79764149a3412f7896e2699d0a223d5c57c9339f25f98ac9f82c07cd5af93978f49ee1
|
data/Gemfile.lock
ADDED
@@ -0,0 +1,93 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
transferzero-sdk (1.9.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.0.3.4)
|
14
|
+
concurrent-ruby (~> 1.0, >= 1.0.2)
|
15
|
+
i18n (>= 0.7, < 2)
|
16
|
+
minitest (~> 5.1)
|
17
|
+
tzinfo (~> 1.1)
|
18
|
+
zeitwerk (~> 2.2, >= 2.2.2)
|
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-fsevent (0.2.17)
|
24
|
+
sys-uname
|
25
|
+
autotest-growl (0.2.16)
|
26
|
+
autotest-rails-pure (4.1.2)
|
27
|
+
byebug (11.1.3)
|
28
|
+
coderay (1.1.3)
|
29
|
+
concurrent-ruby (1.1.7)
|
30
|
+
crack (0.4.4)
|
31
|
+
diff-lcs (1.4.4)
|
32
|
+
ethon (0.12.0)
|
33
|
+
ffi (>= 1.3.0)
|
34
|
+
ffi (1.13.1)
|
35
|
+
hashdiff (1.0.1)
|
36
|
+
i18n (1.8.5)
|
37
|
+
concurrent-ruby (~> 1.0)
|
38
|
+
json (2.3.1)
|
39
|
+
method_source (1.0.0)
|
40
|
+
minitest (5.14.2)
|
41
|
+
pry (0.13.1)
|
42
|
+
coderay (~> 1.1)
|
43
|
+
method_source (~> 1.0)
|
44
|
+
pry-byebug (3.9.0)
|
45
|
+
byebug (~> 11.0)
|
46
|
+
pry (~> 0.13.0)
|
47
|
+
public_suffix (4.0.6)
|
48
|
+
rake (12.0.0)
|
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.0)
|
54
|
+
rspec-support (~> 3.10.0)
|
55
|
+
rspec-expectations (3.10.0)
|
56
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
57
|
+
rspec-support (~> 3.10.0)
|
58
|
+
rspec-mocks (3.10.0)
|
59
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
60
|
+
rspec-support (~> 3.10.0)
|
61
|
+
rspec-support (3.10.0)
|
62
|
+
sys-uname (1.2.2)
|
63
|
+
ffi (~> 1.1)
|
64
|
+
thread_safe (0.3.6)
|
65
|
+
typhoeus (1.4.0)
|
66
|
+
ethon (>= 0.9.0)
|
67
|
+
tzinfo (1.2.8)
|
68
|
+
thread_safe (~> 0.1)
|
69
|
+
vcr (3.0.3)
|
70
|
+
webmock (1.24.6)
|
71
|
+
addressable (>= 2.3.6)
|
72
|
+
crack (>= 0.3.2)
|
73
|
+
hashdiff
|
74
|
+
zeitwerk (2.4.2)
|
75
|
+
|
76
|
+
PLATFORMS
|
77
|
+
ruby
|
78
|
+
|
79
|
+
DEPENDENCIES
|
80
|
+
ZenTest (~> 4.11, >= 4.11.2)
|
81
|
+
autotest (~> 4.4, >= 4.4.6)
|
82
|
+
autotest-fsevent (~> 0.2, >= 0.2.12)
|
83
|
+
autotest-growl (~> 0.2, >= 0.2.16)
|
84
|
+
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
85
|
+
pry-byebug
|
86
|
+
rake (~> 12.0.0)
|
87
|
+
rspec (~> 3.6, >= 3.6.0)
|
88
|
+
transferzero-sdk!
|
89
|
+
vcr (~> 3.0, >= 3.0.1)
|
90
|
+
webmock (~> 1.24, >= 1.24.3)
|
91
|
+
|
92
|
+
BUNDLED WITH
|
93
|
+
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.11.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.11.0.gem
|
35
35
|
```
|
36
|
-
(for development, run `gem install --dev ./transferzero-sdk-1.
|
36
|
+
(for development, run `gem install --dev ./transferzero-sdk-1.11.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.11.0'
|
43
43
|
|
44
44
|
### Install from Git
|
45
45
|
|
@@ -130,6 +130,7 @@ Class | Method | HTTP request | Description
|
|
130
130
|
*TransferZero::RecipientsApi* | [**delete_recipient**](docs/RecipientsApi.md#delete_recipient) | **DELETE** /recipients/{Recipient ID} | Cancelling a recipient
|
131
131
|
*TransferZero::RecipientsApi* | [**get_recipients**](docs/RecipientsApi.md#get_recipients) | **GET** /recipients | Getting a list of recipients with filtering
|
132
132
|
*TransferZero::RecipientsApi* | [**patch_recipient**](docs/RecipientsApi.md#patch_recipient) | **PATCH** /recipients/{Recipient ID} | Updating a recipient
|
133
|
+
*TransferZero::RecipientsApi* | [**proof_of_payments**](docs/RecipientsApi.md#proof_of_payments) | **GET** /recipients/{Recipient ID}/proof_of_payments | Returns list of proof of payments
|
133
134
|
*TransferZero::SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{Sender ID} | Deleting a sender
|
134
135
|
*TransferZero::SendersApi* | [**get_sender**](docs/SendersApi.md#get_sender) | **GET** /senders/{Sender ID} | Fetching a sender
|
135
136
|
*TransferZero::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Listing senders
|
@@ -196,6 +197,7 @@ Class | Method | HTTP request | Description
|
|
196
197
|
- [TransferZero::PaymentMethodOpposite](docs/PaymentMethodOpposite.md)
|
197
198
|
- [TransferZero::PayoutMethod](docs/PayoutMethod.md)
|
198
199
|
- [TransferZero::PayoutMethodBankAccountTypeEnum](docs/PayoutMethodBankAccountTypeEnum.md)
|
200
|
+
- [TransferZero::PayoutMethodCashProviderEnum](docs/PayoutMethodCashProviderEnum.md)
|
199
201
|
- [TransferZero::PayoutMethodDetails](docs/PayoutMethodDetails.md)
|
200
202
|
- [TransferZero::PayoutMethodDetailsBTC](docs/PayoutMethodDetailsBTC.md)
|
201
203
|
- [TransferZero::PayoutMethodDetailsBalance](docs/PayoutMethodDetailsBalance.md)
|
@@ -206,7 +208,9 @@ Class | Method | HTTP request | Description
|
|
206
208
|
- [TransferZero::PayoutMethodDetailsMobile](docs/PayoutMethodDetailsMobile.md)
|
207
209
|
- [TransferZero::PayoutMethodDetailsNGNBank](docs/PayoutMethodDetailsNGNBank.md)
|
208
210
|
- [TransferZero::PayoutMethodDetailsXOFBank](docs/PayoutMethodDetailsXOFBank.md)
|
211
|
+
- [TransferZero::PayoutMethodDetailsXOFCash](docs/PayoutMethodDetailsXOFCash.md)
|
209
212
|
- [TransferZero::PayoutMethodDetailsXOFMobile](docs/PayoutMethodDetailsXOFMobile.md)
|
213
|
+
- [TransferZero::PayoutMethodDetailsZARBank](docs/PayoutMethodDetailsZARBank.md)
|
210
214
|
- [TransferZero::PayoutMethodGenderEnum](docs/PayoutMethodGenderEnum.md)
|
211
215
|
- [TransferZero::PayoutMethodIdentityCardTypeEnum](docs/PayoutMethodIdentityCardTypeEnum.md)
|
212
216
|
- [TransferZero::PayoutMethodListResponse](docs/PayoutMethodListResponse.md)
|
@@ -215,11 +219,14 @@ Class | Method | HTTP request | Description
|
|
215
219
|
- [TransferZero::PayoutMethodResponse](docs/PayoutMethodResponse.md)
|
216
220
|
- [TransferZero::PayoutMethodWebhook](docs/PayoutMethodWebhook.md)
|
217
221
|
- [TransferZero::PoliticallyExposedPerson](docs/PoliticallyExposedPerson.md)
|
222
|
+
- [TransferZero::ProofOfPayment](docs/ProofOfPayment.md)
|
223
|
+
- [TransferZero::ProofOfPaymentListResponse](docs/ProofOfPaymentListResponse.md)
|
218
224
|
- [TransferZero::Recipient](docs/Recipient.md)
|
219
225
|
- [TransferZero::RecipientListResponse](docs/RecipientListResponse.md)
|
220
226
|
- [TransferZero::RecipientRequest](docs/RecipientRequest.md)
|
221
227
|
- [TransferZero::RecipientResponse](docs/RecipientResponse.md)
|
222
228
|
- [TransferZero::RecipientState](docs/RecipientState.md)
|
229
|
+
- [TransferZero::RecipientStateReasonDetails](docs/RecipientStateReasonDetails.md)
|
223
230
|
- [TransferZero::RecipientWebhook](docs/RecipientWebhook.md)
|
224
231
|
- [TransferZero::Sender](docs/Sender.md)
|
225
232
|
- [TransferZero::SenderListResponse](docs/SenderListResponse.md)
|
data/docs/Currency.md
CHANGED
@@ -12,7 +12,6 @@ Name | Type | Description | Notes
|
|
12
12
|
**primary** | **Boolean** | Is this a primary currency? | [optional]
|
13
13
|
**min** | **String** | The minimum amount allowed in a transaction | [optional]
|
14
14
|
**max** | **String** | The maximum amount allowed in a transaction | [optional]
|
15
|
-
**margin** | **String** | The margin set for transactions in this currency | [optional]
|
16
15
|
**usd_equivalent** | **String** | The equivalent of the currency to 1 USD | [optional]
|
17
16
|
|
18
17
|
## Code Sample
|
@@ -28,7 +27,6 @@ instance = TransferZero::Currency.new(code: NGN,
|
|
28
27
|
primary: true,
|
29
28
|
min: 100,
|
30
29
|
max: 50000000,
|
31
|
-
margin: null,
|
32
30
|
usd_equivalent: null)
|
33
31
|
```
|
34
32
|
|
data/docs/CurrencyExchange.md
CHANGED
@@ -12,7 +12,6 @@ Name | Type | Description | Notes
|
|
12
12
|
**primary** | **Boolean** | Is this a primary currency? | [optional]
|
13
13
|
**min** | **String** | The minimum amount allowed in a transaction | [optional]
|
14
14
|
**max** | **String** | The maximum amount allowed in a transaction | [optional]
|
15
|
-
**margin** | **String** | The margin set for transactions in this currency | [optional]
|
16
15
|
**usd_equivalent** | **String** | The equivalent of the currency to 1 USD | [optional]
|
17
16
|
**opposites** | [**Array<CurrencyOpposite>**](CurrencyOpposite.md) | Lists the currencies where you can exchange from this one | [optional]
|
18
17
|
|
@@ -29,7 +28,6 @@ instance = TransferZero::CurrencyExchange.new(code: NGN,
|
|
29
28
|
primary: true,
|
30
29
|
min: 100,
|
31
30
|
max: 50000000,
|
32
|
-
margin: null,
|
33
31
|
usd_equivalent: null,
|
34
32
|
opposites: null)
|
35
33
|
```
|
data/docs/CurrencyOpposite.md
CHANGED
@@ -12,10 +12,10 @@ Name | Type | Description | Notes
|
|
12
12
|
**primary** | **Boolean** | Is this a primary currency? | [optional]
|
13
13
|
**min** | **String** | The minimum amount allowed in a transaction | [optional]
|
14
14
|
**max** | **String** | The maximum amount allowed in a transaction | [optional]
|
15
|
-
**margin** | **String** | The margin set for transactions in this currency | [optional]
|
16
15
|
**usd_equivalent** | **String** | The equivalent of the currency to 1 USD | [optional]
|
17
16
|
**rate** | **Float** | The rate of this particular currency with the base one | [optional]
|
18
17
|
**mtm_rate** | **Float** | Mark to market rate of this particular currency against the base one with the margin factored in | [optional]
|
18
|
+
**margin** | **String** | The margin set for transactions of this particular currency with the base one | [optional]
|
19
19
|
|
20
20
|
## Code Sample
|
21
21
|
|
@@ -30,10 +30,10 @@ instance = TransferZero::CurrencyOpposite.new(code: NGN,
|
|
30
30
|
primary: true,
|
31
31
|
min: 100,
|
32
32
|
max: 50000000,
|
33
|
-
margin: null,
|
34
33
|
usd_equivalent: null,
|
35
34
|
rate: null,
|
36
|
-
mtm_rate: null
|
35
|
+
mtm_rate: null,
|
36
|
+
margin: null)
|
37
37
|
```
|
38
38
|
|
39
39
|
|
data/docs/Document.md
CHANGED
@@ -15,6 +15,8 @@ Name | Type | Description | Notes
|
|
15
15
|
**document_type** | **String** | This is a brief description of the document type | [optional]
|
16
16
|
**issuing_country** | **String** | Issuing country of ID in 2-character alpha ISO 3166-2 country format | [optional]
|
17
17
|
**id** | **String** | | [optional]
|
18
|
+
**document_id** | **String** | Document ID issued by government | [optional]
|
19
|
+
**expiry_date** | **Date** | Document expiry date issued by government | [optional]
|
18
20
|
**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional]
|
19
21
|
|
20
22
|
## Code Sample
|
@@ -33,6 +35,8 @@ instance = TransferZero::Document.new(upload: data:image/png;base64,iVBORw0KGg..
|
|
33
35
|
document_type: certificate_of_business_name_registration,
|
34
36
|
issuing_country: NG,
|
35
37
|
id: ebe9bc0b-f2f6-4ce8-802a-8b79912d041e,
|
38
|
+
document_id: XYZ12345,
|
39
|
+
expiry_date: null,
|
36
40
|
errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
|
37
41
|
```
|
38
42
|
|
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 Senegalese mobile money payments. - `XOF::Bank` - for Senegalese bank account payments.
|
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 Senegalese mobile money payments. - `XOF::Bank` - for Senegalese bank account payments. - `XOF::Cash` - for Senegalese cash remittance payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank and FP accounts transfers in GBP. - `ZAR::Bank` - for South Africa bank account payments. You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://docs.transferzero.com/docs/additional-features/#collections-from-senders) for more info on how to collect money into internal balance | [optional]
|
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::PayoutMethodCashProviderEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
|
8
|
+
## Code Sample
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'TransferZero'
|
12
|
+
|
13
|
+
instance = TransferZero::PayoutMethodCashProviderEnum.new()
|
14
|
+
```
|
15
|
+
|
16
|
+
|
data/docs/PayoutMethodDetails.md
CHANGED
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
14
14
|
**iban** | **String** | |
|
15
15
|
**bank_name** | **String** | |
|
16
16
|
**bank_country** | **String** | |
|
17
|
+
**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) | | [optional]
|
17
18
|
**sort_code** | **String** | | [optional]
|
18
19
|
**bic** | **String** | | [optional]
|
19
20
|
**sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) | |
|
@@ -27,6 +28,11 @@ Name | Type | Description | Notes
|
|
27
28
|
**reference** | **String** | | [optional]
|
28
29
|
**name** | **String** | |
|
29
30
|
**address** | **String** | |
|
31
|
+
**street** | **String** | |
|
32
|
+
**postal_code** | **String** | |
|
33
|
+
**city** | **String** | |
|
34
|
+
**email** | **String** | | [optional]
|
35
|
+
**transfer_reason_code** | **String** | | [optional]
|
30
36
|
|
31
37
|
## Code Sample
|
32
38
|
|
@@ -43,6 +49,7 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
|
|
43
49
|
iban: null,
|
44
50
|
bank_name: null,
|
45
51
|
bank_country: null,
|
52
|
+
cash_provider: null,
|
46
53
|
sort_code: null,
|
47
54
|
bic: null,
|
48
55
|
sender_identity_card_type: null,
|
@@ -55,7 +62,12 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
|
|
55
62
|
identity_card_id: null,
|
56
63
|
reference: null,
|
57
64
|
name: null,
|
58
|
-
address: null
|
65
|
+
address: null,
|
66
|
+
street: null,
|
67
|
+
postal_code: null,
|
68
|
+
city: null,
|
69
|
+
email: null,
|
70
|
+
transfer_reason_code: null)
|
59
71
|
```
|
60
72
|
|
61
73
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**first_name** | **String** | |
|
8
8
|
**last_name** | **String** | |
|
9
9
|
**phone_number** | **String** | |
|
10
|
+
**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) | | [optional]
|
10
11
|
|
11
12
|
## Code Sample
|
12
13
|
|
@@ -15,7 +16,8 @@ require 'TransferZero'
|
|
15
16
|
|
16
17
|
instance = TransferZero::PayoutMethodDetailsMobile.new(first_name: null,
|
17
18
|
last_name: null,
|
18
|
-
phone_number: null
|
19
|
+
phone_number: null,
|
20
|
+
mobile_provider: null)
|
19
21
|
```
|
20
22
|
|
21
23
|
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# TransferZero::PayoutMethodDetailsXOFCash
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**first_name** | **String** | |
|
8
|
+
**last_name** | **String** | |
|
9
|
+
**phone_number** | **String** | |
|
10
|
+
**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'TransferZero'
|
16
|
+
|
17
|
+
instance = TransferZero::PayoutMethodDetailsXOFCash.new(first_name: null,
|
18
|
+
last_name: null,
|
19
|
+
phone_number: null,
|
20
|
+
cash_provider: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,35 @@
|
|
1
|
+
# TransferZero::PayoutMethodDetailsZARBank
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**first_name** | **String** | |
|
8
|
+
**last_name** | **String** | |
|
9
|
+
**street** | **String** | |
|
10
|
+
**postal_code** | **String** | |
|
11
|
+
**city** | **String** | |
|
12
|
+
**email** | **String** | | [optional]
|
13
|
+
**bank_code** | **String** | |
|
14
|
+
**bank_account** | **String** | |
|
15
|
+
**phone_number** | **String** | |
|
16
|
+
**transfer_reason_code** | **String** | | [optional]
|
17
|
+
|
18
|
+
## Code Sample
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'TransferZero'
|
22
|
+
|
23
|
+
instance = TransferZero::PayoutMethodDetailsZARBank.new(first_name: null,
|
24
|
+
last_name: null,
|
25
|
+
street: null,
|
26
|
+
postal_code: null,
|
27
|
+
city: null,
|
28
|
+
email: null,
|
29
|
+
bank_code: null,
|
30
|
+
bank_account: null,
|
31
|
+
phone_number: null,
|
32
|
+
transfer_reason_code: null)
|
33
|
+
```
|
34
|
+
|
35
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# TransferZero::ProofOfPayment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | UUID of the uploaded document | [optional]
|
8
|
+
**file_name** | **String** | Name of the uploaded file | [optional]
|
9
|
+
**thumbnail** | **String** | URL to thumbnail image of the uploaded file | [optional]
|
10
|
+
**url** | **String** | URL to uploaded file | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'TransferZero'
|
16
|
+
|
17
|
+
instance = TransferZero::ProofOfPayment.new(id: null,
|
18
|
+
file_name: my_file.jpg,
|
19
|
+
thumbnail: https://bitpesa-development.s3.eu-west-1.amazonaws.com/my_file_thumb.jpg,
|
20
|
+
url: https://bitpesa-development.s3.eu-west-1.amazonaws.com/my_file.jpg)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# TransferZero::ProofOfPaymentListResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**object** | [**Array<ProofOfPayment>**](ProofOfPayment.md) | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'TransferZero'
|
13
|
+
|
14
|
+
instance = TransferZero::ProofOfPaymentListResponse.new(object: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/Recipient.md
CHANGED
@@ -14,8 +14,10 @@ Name | Type | Description | Notes
|
|
14
14
|
**input_usd_amount** | **Float** | Shows how much this payment is worth in USD | [optional]
|
15
15
|
**may_cancel** | **Boolean** | If true it shows that the payment can be cancelled immediately using the DELETE /v1/recipients/{id} endpoint. If false you can still try to cancel it, however it will only gets cancelled once we have confirmation from our partner that the payment has failed. | [optional]
|
16
16
|
**state_reason** | **String** | In case the payment is unsuccessful it holds the error message associated with the last unsuccessful payout. | [optional]
|
17
|
+
**state_reason_details** | [**RecipientStateReasonDetails**](RecipientStateReasonDetails.md) | | [optional]
|
17
18
|
**state** | [**RecipientState**](RecipientState.md) | | [optional]
|
18
19
|
**transaction_id** | **String** | The ID of the transaction that is related to this recipient | [optional]
|
20
|
+
**transaction_external_id** | **String** | Optional ID that is supplied by partner linking it to the partner's own Transaction ID. | [optional]
|
19
21
|
**transaction_state** | [**TransactionState**](TransactionState.md) | | [optional]
|
20
22
|
**exchange_rate** | **Float** | The exchange rate used in this payment | [optional]
|
21
23
|
**fee_fractional** | **Float** | The fee for this payment in fractional units (for example cents for USD transactions) | [optional]
|
@@ -41,8 +43,10 @@ instance = TransferZero::Recipient.new(requested_amount: 750.0,
|
|
41
43
|
input_usd_amount: 10,
|
42
44
|
may_cancel: true,
|
43
45
|
state_reason: null,
|
46
|
+
state_reason_details: null,
|
44
47
|
state: null,
|
45
48
|
transaction_id: 97e79719-06e4-4794-aeeb-d2d9415d983a,
|
49
|
+
transaction_external_id: 806ec63a-a5a7-43cc-9d75-1ee74fbcc026,
|
46
50
|
transaction_state: null,
|
47
51
|
exchange_rate: 1000,
|
48
52
|
fee_fractional: 100,
|