transferzero-sdk 1.8.0 → 1.8.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +8 -5
- data/docs/AccountMeta.md +1 -1
- data/docs/Currency.md +1 -3
- data/docs/CurrencyExchange.md +1 -3
- data/docs/CurrencyOpposite.md +4 -4
- data/docs/Document.md +3 -3
- data/docs/DocumentsApi.md +2 -74
- data/docs/FieldSelectValidation.md +1 -1
- data/docs/FieldValidation.md +1 -1
- data/docs/PayinMethodDetails.md +3 -1
- data/docs/PayinMethodDetailsBTC.md +17 -0
- data/docs/PayinMethodDetailsMobile.md +1 -1
- data/docs/PaymentMethod.md +2 -2
- data/docs/PaymentMethodOpposite.md +2 -2
- data/docs/PayoutMethod.md +1 -1
- data/docs/PayoutMethodDetails.md +17 -1
- data/docs/PayoutMethodDetailsBTC.md +23 -0
- data/docs/PayoutMethodDetailsGBPBank.md +29 -0
- data/docs/PayoutMethodDetailsIBAN.md +1 -1
- data/docs/PayoutMethodDetailsZARBank.md +35 -0
- data/docs/Recipient.md +4 -4
- data/docs/RecipientsApi.md +1 -1
- data/docs/Sender.md +71 -33
- data/lib/transferzero-sdk.rb +4 -0
- data/lib/transferzero-sdk/api/documents_api.rb +0 -63
- data/lib/transferzero-sdk/api/recipients_api.rb +2 -2
- data/lib/transferzero-sdk/api_client.rb +5 -3
- data/lib/transferzero-sdk/models/account.rb +70 -69
- data/lib/transferzero-sdk/models/account_list_response.rb +67 -66
- data/lib/transferzero-sdk/models/account_meta.rb +61 -60
- data/lib/transferzero-sdk/models/account_response.rb +66 -65
- data/lib/transferzero-sdk/models/account_validation_error.rb +61 -60
- data/lib/transferzero-sdk/models/account_validation_request.rb +164 -163
- data/lib/transferzero-sdk/models/account_validation_response.rb +66 -65
- data/lib/transferzero-sdk/models/account_validation_result.rb +61 -60
- data/lib/transferzero-sdk/models/api_log.rb +136 -135
- data/lib/transferzero-sdk/models/api_log_list_response.rb +70 -69
- data/lib/transferzero-sdk/models/api_log_response.rb +60 -59
- data/lib/transferzero-sdk/models/currency.rb +133 -142
- data/lib/transferzero-sdk/models/currency_exchange.rb +149 -158
- data/lib/transferzero-sdk/models/currency_exchange_list_response.rb +62 -61
- data/lib/transferzero-sdk/models/currency_list_response.rb +62 -61
- data/lib/transferzero-sdk/models/currency_opposite.rb +166 -165
- data/lib/transferzero-sdk/models/debit.rb +151 -150
- data/lib/transferzero-sdk/models/debit_list_request.rb +61 -60
- data/lib/transferzero-sdk/models/debit_list_response.rb +67 -66
- data/lib/transferzero-sdk/models/debit_request.rb +60 -59
- data/lib/transferzero-sdk/models/debit_request_wrapper.rb +80 -79
- data/lib/transferzero-sdk/models/debit_response.rb +60 -59
- data/lib/transferzero-sdk/models/document.rb +179 -177
- data/lib/transferzero-sdk/models/document_list_response.rb +67 -66
- data/lib/transferzero-sdk/models/document_request.rb +60 -59
- data/lib/transferzero-sdk/models/document_response.rb +60 -59
- data/lib/transferzero-sdk/models/document_webhook.rb +96 -95
- data/lib/transferzero-sdk/models/error_status.rb +66 -65
- data/lib/transferzero-sdk/models/field_description.rb +95 -94
- data/lib/transferzero-sdk/models/field_select_validation.rb +70 -69
- data/lib/transferzero-sdk/models/field_validation.rb +78 -77
- data/lib/transferzero-sdk/models/pagination.rb +97 -96
- data/lib/transferzero-sdk/models/pagination_meta.rb +60 -59
- data/lib/transferzero-sdk/models/payin_method.rb +97 -96
- data/lib/transferzero-sdk/models/payin_method_details.rb +122 -110
- data/lib/transferzero-sdk/models/payin_method_details_btc.rb +204 -0
- data/lib/transferzero-sdk/models/payin_method_details_mobile.rb +75 -74
- data/lib/transferzero-sdk/models/payin_method_details_ngn_bank.rb +71 -70
- data/lib/transferzero-sdk/models/payin_method_request.rb +60 -59
- data/lib/transferzero-sdk/models/payment_method.rb +109 -108
- data/lib/transferzero-sdk/models/payment_method_list_response.rb +61 -60
- data/lib/transferzero-sdk/models/payment_method_opposite.rb +124 -123
- data/lib/transferzero-sdk/models/payout_method.rb +107 -106
- data/lib/transferzero-sdk/models/payout_method_bank_account_type_enum.rb +14 -19
- data/lib/transferzero-sdk/models/payout_method_details.rb +398 -297
- data/lib/transferzero-sdk/models/payout_method_details_balance.rb +61 -60
- data/lib/transferzero-sdk/models/payout_method_details_btc.rb +250 -0
- data/lib/transferzero-sdk/models/payout_method_details_gbp_bank.rb +267 -0
- data/lib/transferzero-sdk/models/payout_method_details_ghs_bank.rb +97 -96
- data/lib/transferzero-sdk/models/payout_method_details_iban.rb +100 -104
- data/lib/transferzero-sdk/models/payout_method_details_mad_cash.rb +162 -161
- data/lib/transferzero-sdk/models/payout_method_details_mobile.rb +86 -85
- data/lib/transferzero-sdk/models/payout_method_details_ngn_bank.rb +104 -103
- data/lib/transferzero-sdk/models/payout_method_details_xof_bank.rb +108 -107
- data/lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb +97 -96
- data/lib/transferzero-sdk/models/payout_method_details_zar_bank.rb +324 -0
- data/lib/transferzero-sdk/models/payout_method_gender_enum.rb +14 -19
- data/lib/transferzero-sdk/models/payout_method_identity_card_type_enum.rb +15 -20
- data/lib/transferzero-sdk/models/payout_method_list_response.rb +67 -66
- data/lib/transferzero-sdk/models/payout_method_mobile_provider_enum.rb +14 -19
- data/lib/transferzero-sdk/models/payout_method_request.rb +60 -59
- data/lib/transferzero-sdk/models/payout_method_response.rb +60 -59
- data/lib/transferzero-sdk/models/payout_method_webhook.rb +96 -95
- data/lib/transferzero-sdk/models/politically_exposed_person.rb +123 -123
- data/lib/transferzero-sdk/models/recipient.rb +230 -229
- data/lib/transferzero-sdk/models/recipient_list_response.rb +67 -66
- data/lib/transferzero-sdk/models/recipient_request.rb +60 -59
- data/lib/transferzero-sdk/models/recipient_response.rb +60 -59
- data/lib/transferzero-sdk/models/recipient_state.rb +22 -27
- data/lib/transferzero-sdk/models/recipient_webhook.rb +96 -95
- data/lib/transferzero-sdk/models/sender.rb +573 -358
- data/lib/transferzero-sdk/models/sender_list_response.rb +67 -66
- data/lib/transferzero-sdk/models/sender_request.rb +60 -59
- data/lib/transferzero-sdk/models/sender_response.rb +66 -65
- data/lib/transferzero-sdk/models/sender_response_existing.rb +60 -59
- data/lib/transferzero-sdk/models/sender_response_meta.rb +60 -59
- data/lib/transferzero-sdk/models/sender_state.rb +19 -24
- data/lib/transferzero-sdk/models/sender_webhook.rb +96 -95
- data/lib/transferzero-sdk/models/transaction.rb +192 -191
- data/lib/transferzero-sdk/models/transaction_list_response.rb +67 -66
- data/lib/transferzero-sdk/models/transaction_request.rb +60 -59
- data/lib/transferzero-sdk/models/transaction_response.rb +66 -65
- data/lib/transferzero-sdk/models/transaction_response_existing.rb +66 -65
- data/lib/transferzero-sdk/models/transaction_response_meta.rb +60 -59
- data/lib/transferzero-sdk/models/transaction_state.rb +23 -28
- data/lib/transferzero-sdk/models/transaction_traits.rb +71 -70
- data/lib/transferzero-sdk/models/transaction_webhook.rb +96 -95
- data/lib/transferzero-sdk/models/validation_error_description.rb +62 -61
- data/lib/transferzero-sdk/models/webhook.rb +92 -91
- data/lib/transferzero-sdk/models/webhook_definition.rb +107 -106
- data/lib/transferzero-sdk/models/webhook_definition_event_list_response.rb +61 -60
- data/lib/transferzero-sdk/models/webhook_definition_list_response.rb +67 -66
- data/lib/transferzero-sdk/models/webhook_definition_request.rb +60 -59
- data/lib/transferzero-sdk/models/webhook_definition_response.rb +60 -59
- data/lib/transferzero-sdk/models/webhook_log.rb +97 -96
- data/lib/transferzero-sdk/models/webhook_log_list_response.rb +70 -69
- data/lib/transferzero-sdk/models/webhook_log_metadata.rb +129 -128
- data/lib/transferzero-sdk/models/webhook_log_metadata_request.rb +80 -79
- data/lib/transferzero-sdk/models/webhook_log_metadata_response.rb +81 -80
- data/lib/transferzero-sdk/models/webhook_log_response.rb +60 -59
- data/lib/transferzero-sdk/version.rb +1 -1
- data/spec/models/payin_method_details_btc_spec.rb +41 -0
- data/spec/models/payout_method_details_btc_spec.rb +59 -0
- data/spec/models/payout_method_details_gbp_bank_spec.rb +77 -0
- data/spec/models/payout_method_details_zar_bank_spec.rb +89 -0
- metadata +28 -12
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 789ad23b6116cceec9f440aa143c57de74b1fc0cfe6a6eae6ce3837c69557377
|
4
|
+
data.tar.gz: b4a8b36050fe596bc293b2a957ceb6f9ff3035ff04fb880b21ab156fdcb34993
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5a364139b6dc0183617314385db76f4dadbbdf0b76511f1a75eb756d2efe0cba98b2e315e32fd9013630c7a411f9d3e8d72b354a635f221dea7e4e217b0d78a6
|
7
|
+
data.tar.gz: 9ed6bf61834e00ab0e92ead44d5ad8fc97b6c4ffbbea8bd58b51dbc8ff4bbefc694a457c372446c061fca88722686b06c59d7cc4b462cbbca488a07ca31e257d
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Reference documentation for the TransferZero API V1
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 1.0
|
10
|
-
- Package version: 1.8.
|
10
|
+
- Package version: 1.8.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.8.
|
34
|
+
gem install ./transferzero-sdk-1.8.1.gem
|
35
35
|
```
|
36
|
-
(for development, run `gem install --dev ./transferzero-sdk-1.8.
|
36
|
+
(for development, run `gem install --dev ./transferzero-sdk-1.8.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.8.
|
42
|
+
gem 'transferzero-sdk', '~> 1.8.1'
|
43
43
|
|
44
44
|
### Install from Git
|
45
45
|
|
@@ -115,7 +115,6 @@ Class | Method | HTTP request | Description
|
|
115
115
|
*TransferZero::CurrencyInfoApi* | [**info_currencies**](docs/CurrencyInfoApi.md#info_currencies) | **GET** /info/currencies | Getting a list of possible requested currencies
|
116
116
|
*TransferZero::CurrencyInfoApi* | [**info_currencies_in**](docs/CurrencyInfoApi.md#info_currencies_in) | **GET** /info/currencies/in | Getting a list of possible input currencies
|
117
117
|
*TransferZero::CurrencyInfoApi* | [**info_currencies_out**](docs/CurrencyInfoApi.md#info_currencies_out) | **GET** /info/currencies/out | Getting a list of possible output currencies
|
118
|
-
*TransferZero::DocumentsApi* | [**delete_document**](docs/DocumentsApi.md#delete_document) | **DELETE** /documents/{Document ID} | Deleting a document
|
119
118
|
*TransferZero::DocumentsApi* | [**get_document**](docs/DocumentsApi.md#get_document) | **GET** /documents/{Document ID} | Fetching a document
|
120
119
|
*TransferZero::DocumentsApi* | [**get_documents**](docs/DocumentsApi.md#get_documents) | **GET** /documents | Getting a list of documents
|
121
120
|
*TransferZero::DocumentsApi* | [**post_documents**](docs/DocumentsApi.md#post_documents) | **POST** /documents | Creating a document
|
@@ -188,6 +187,7 @@ Class | Method | HTTP request | Description
|
|
188
187
|
- [TransferZero::PaginationMeta](docs/PaginationMeta.md)
|
189
188
|
- [TransferZero::PayinMethod](docs/PayinMethod.md)
|
190
189
|
- [TransferZero::PayinMethodDetails](docs/PayinMethodDetails.md)
|
190
|
+
- [TransferZero::PayinMethodDetailsBTC](docs/PayinMethodDetailsBTC.md)
|
191
191
|
- [TransferZero::PayinMethodDetailsMobile](docs/PayinMethodDetailsMobile.md)
|
192
192
|
- [TransferZero::PayinMethodDetailsNGNBank](docs/PayinMethodDetailsNGNBank.md)
|
193
193
|
- [TransferZero::PayinMethodRequest](docs/PayinMethodRequest.md)
|
@@ -197,7 +197,9 @@ Class | Method | HTTP request | Description
|
|
197
197
|
- [TransferZero::PayoutMethod](docs/PayoutMethod.md)
|
198
198
|
- [TransferZero::PayoutMethodBankAccountTypeEnum](docs/PayoutMethodBankAccountTypeEnum.md)
|
199
199
|
- [TransferZero::PayoutMethodDetails](docs/PayoutMethodDetails.md)
|
200
|
+
- [TransferZero::PayoutMethodDetailsBTC](docs/PayoutMethodDetailsBTC.md)
|
200
201
|
- [TransferZero::PayoutMethodDetailsBalance](docs/PayoutMethodDetailsBalance.md)
|
202
|
+
- [TransferZero::PayoutMethodDetailsGBPBank](docs/PayoutMethodDetailsGBPBank.md)
|
201
203
|
- [TransferZero::PayoutMethodDetailsGHSBank](docs/PayoutMethodDetailsGHSBank.md)
|
202
204
|
- [TransferZero::PayoutMethodDetailsIBAN](docs/PayoutMethodDetailsIBAN.md)
|
203
205
|
- [TransferZero::PayoutMethodDetailsMADCash](docs/PayoutMethodDetailsMADCash.md)
|
@@ -205,6 +207,7 @@ Class | Method | HTTP request | Description
|
|
205
207
|
- [TransferZero::PayoutMethodDetailsNGNBank](docs/PayoutMethodDetailsNGNBank.md)
|
206
208
|
- [TransferZero::PayoutMethodDetailsXOFBank](docs/PayoutMethodDetailsXOFBank.md)
|
207
209
|
- [TransferZero::PayoutMethodDetailsXOFMobile](docs/PayoutMethodDetailsXOFMobile.md)
|
210
|
+
- [TransferZero::PayoutMethodDetailsZARBank](docs/PayoutMethodDetailsZARBank.md)
|
208
211
|
- [TransferZero::PayoutMethodGenderEnum](docs/PayoutMethodGenderEnum.md)
|
209
212
|
- [TransferZero::PayoutMethodIdentityCardTypeEnum](docs/PayoutMethodIdentityCardTypeEnum.md)
|
210
213
|
- [TransferZero::PayoutMethodListResponse](docs/PayoutMethodListResponse.md)
|
data/docs/AccountMeta.md
CHANGED
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
|
@@ -25,10 +24,9 @@ instance = TransferZero::Currency.new(code: NGN,
|
|
25
24
|
symbol: ₦,
|
26
25
|
decimals: 2,
|
27
26
|
subunit_to_unit: 100,
|
28
|
-
primary:
|
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
|
|
@@ -26,10 +25,9 @@ instance = TransferZero::CurrencyExchange.new(code: NGN,
|
|
26
25
|
symbol: ₦,
|
27
26
|
decimals: 2,
|
28
27
|
subunit_to_unit: 100,
|
29
|
-
primary:
|
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
|
|
@@ -27,13 +27,13 @@ instance = TransferZero::CurrencyOpposite.new(code: NGN,
|
|
27
27
|
symbol: ₦,
|
28
28
|
decimals: 2,
|
29
29
|
subunit_to_unit: 100,
|
30
|
-
primary:
|
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
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**sender_id** | **String** | | [optional]
|
8
7
|
**upload** | **String** | Base64 encoded data uri of an image/pdf file or a fully qualified url |
|
8
|
+
**url** | **String** | URL of the document location | [optional]
|
9
9
|
**upload_file_name** | **String** | Name of the upload |
|
10
10
|
**metadata** | [**Object**](.md) | Metadata of document | [optional]
|
11
11
|
**upload_content_type** | **String** | | [optional]
|
@@ -22,8 +22,8 @@ Name | Type | Description | Notes
|
|
22
22
|
```ruby
|
23
23
|
require 'TransferZero'
|
24
24
|
|
25
|
-
instance = TransferZero::Document.new(
|
26
|
-
|
25
|
+
instance = TransferZero::Document.new(upload: data:image/png;base64,iVBORw0KGg...lFTkSuQmCC,
|
26
|
+
url: https://bitpesa-documents.amazonaws.com/document.pdf,
|
27
27
|
upload_file_name: example.png,
|
28
28
|
metadata: {},
|
29
29
|
upload_content_type: image/png,
|
data/docs/DocumentsApi.md
CHANGED
@@ -4,79 +4,13 @@ All URIs are relative to *https://api-sandbox.transferzero.com/v1*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**delete_document**](DocumentsApi.md#delete_document) | **DELETE** /documents/{Document ID} | Deleting a document
|
8
7
|
[**get_document**](DocumentsApi.md#get_document) | **GET** /documents/{Document ID} | Fetching a document
|
9
8
|
[**get_documents**](DocumentsApi.md#get_documents) | **GET** /documents | Getting a list of documents
|
10
9
|
[**post_documents**](DocumentsApi.md#post_documents) | **POST** /documents | Creating a document
|
11
10
|
|
12
11
|
|
13
|
-
# **delete_document**
|
14
|
-
> DocumentResponse delete_document(document_idopts)
|
15
|
-
|
16
|
-
Deleting a document
|
17
|
-
|
18
|
-
Deletes a single document by the Document ID
|
19
|
-
|
20
|
-
### Example
|
21
|
-
```ruby
|
22
|
-
# load the gem
|
23
|
-
require 'transferzero-sdk'
|
24
|
-
|
25
|
-
api_instance = TransferZero::DocumentsApi.new
|
26
|
-
|
27
|
-
opts = {
|
28
|
-
sender_id: 'sender_id_example' # String | Allows filtering results by `sender_id`. Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
|
29
|
-
}
|
30
|
-
|
31
|
-
begin
|
32
|
-
#Deleting a document
|
33
|
-
result = api_instance.delete_document(document_idopts)
|
34
|
-
p result
|
35
|
-
rescue TransferZero::ApiError => e
|
36
|
-
if e.validation_error
|
37
|
-
puts "WARN: Validation error occured when calling the endpoint"
|
38
|
-
result = e.response_object("DocumentResponse")
|
39
|
-
p result
|
40
|
-
else
|
41
|
-
puts "Exception when calling DocumentsApi->delete_document: #{e}"
|
42
|
-
end
|
43
|
-
end
|
44
|
-
```
|
45
|
-
|
46
|
-
### Parameters
|
47
|
-
|
48
|
-
Name | Type | Description | Notes
|
49
|
-
------------- | ------------- | ------------- | -------------
|
50
|
-
**document_id** | [**String**](.md)| ID of the document to delete. Example: `/v1/document/bf9ff782-e182-45ac-abea-5bce83ad6670` |
|
51
|
-
**sender_id** | **String**| Allows filtering results by `sender_id`. Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7` | [optional]
|
52
|
-
|
53
|
-
### Return type
|
54
|
-
|
55
|
-
[**DocumentResponse**](DocumentResponse.md)
|
56
|
-
|
57
|
-
### Authorization
|
58
|
-
|
59
|
-
You can set the API Key and Secret on the TransferZero object when setting it up:
|
60
|
-
|
61
|
-
```ruby
|
62
|
-
|
63
|
-
TransferZero.configure do |config|
|
64
|
-
config.api_key = '<key'
|
65
|
-
config.api_secret = '<secret>'
|
66
|
-
config.host = 'https://api-sandbox.transferzero.com/v1'
|
67
|
-
end
|
68
|
-
|
69
|
-
```
|
70
|
-
|
71
|
-
### HTTP request headers
|
72
|
-
|
73
|
-
- **Content-Type**: Not defined
|
74
|
-
- **Accept**: application/json
|
75
|
-
|
76
|
-
|
77
|
-
|
78
12
|
# **get_document**
|
79
|
-
> DocumentResponse get_document(
|
13
|
+
> DocumentResponse get_document(document_id)
|
80
14
|
|
81
15
|
Fetching a document
|
82
16
|
|
@@ -89,13 +23,10 @@ require 'transferzero-sdk'
|
|
89
23
|
|
90
24
|
api_instance = TransferZero::DocumentsApi.new
|
91
25
|
|
92
|
-
opts = {
|
93
|
-
sender_id: 'sender_id_example' # String | Allows filtering results by `sender_id`. Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
|
94
|
-
}
|
95
26
|
|
96
27
|
begin
|
97
28
|
#Fetching a document
|
98
|
-
result = api_instance.get_document(
|
29
|
+
result = api_instance.get_document(document_id)
|
99
30
|
p result
|
100
31
|
rescue TransferZero::ApiError => e
|
101
32
|
if e.validation_error
|
@@ -113,7 +44,6 @@ end
|
|
113
44
|
Name | Type | Description | Notes
|
114
45
|
------------- | ------------- | ------------- | -------------
|
115
46
|
**document_id** | [**String**](.md)| ID of the document to get. Example: `/v1/documents/bf9ff782-e182-45ac-abea-5bce83ad6670` |
|
116
|
-
**sender_id** | **String**| Allows filtering results by `sender_id`. Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7` | [optional]
|
117
47
|
|
118
48
|
### Return type
|
119
49
|
|
@@ -157,7 +87,6 @@ api_instance = TransferZero::DocumentsApi.new
|
|
157
87
|
opts = {
|
158
88
|
page: 1 # Integer | The page number to request (defaults to 1)
|
159
89
|
per: 10 # Integer | The number of results to load per page (defaults to 10)
|
160
|
-
sender_id: 'sender_id_example' # String | Allows filtering results by `sender_id`. Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
|
161
90
|
}
|
162
91
|
|
163
92
|
begin
|
@@ -181,7 +110,6 @@ Name | Type | Description | Notes
|
|
181
110
|
------------- | ------------- | ------------- | -------------
|
182
111
|
**page** | **Integer**| The page number to request (defaults to 1) | [optional]
|
183
112
|
**per** | **Integer**| The number of results to load per page (defaults to 10) | [optional]
|
184
|
-
**sender_id** | **String**| Allows filtering results by `sender_id`. Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7` | [optional]
|
185
113
|
|
186
114
|
### Return type
|
187
115
|
|
data/docs/FieldValidation.md
CHANGED
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
13
13
|
```ruby
|
14
14
|
require 'TransferZero'
|
15
15
|
|
16
|
-
instance = TransferZero::FieldValidation.new(presence:
|
16
|
+
instance = TransferZero::FieldValidation.new(presence: true,
|
17
17
|
inclusion: null,
|
18
18
|
format: {"with":"(?-mix:\\A\\d+\\z)"})
|
19
19
|
```
|
data/docs/PayinMethodDetails.md
CHANGED
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**redirect_url** | **String** | This is where the user should be redirected back when the payment has been finished | [optional]
|
9
9
|
**phone_number** | **String** | The phone number where the funds should be collected from |
|
10
10
|
**send_instructions** | **Boolean** | States whether to send out the instructions to the phone number on how to pay the funds or not. This shuold always be set to true, otherwise the sender might not receive a prompt for payment. | [optional]
|
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]
|
11
12
|
|
12
13
|
## Code Sample
|
13
14
|
|
@@ -17,7 +18,8 @@ require 'TransferZero'
|
|
17
18
|
instance = TransferZero::PayinMethodDetails.new(payment_method: null,
|
18
19
|
redirect_url: null,
|
19
20
|
phone_number: +2569999999,
|
20
|
-
send_instructions:
|
21
|
+
send_instructions: true,
|
22
|
+
refund_address: null)
|
21
23
|
```
|
22
24
|
|
23
25
|
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# TransferZero::PayinMethodDetailsBTC
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**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]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'TransferZero'
|
13
|
+
|
14
|
+
instance = TransferZero::PayinMethodDetailsBTC.new(refund_address: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/PaymentMethod.md
CHANGED
@@ -18,9 +18,9 @@ require 'TransferZero'
|
|
18
18
|
|
19
19
|
instance = TransferZero::PaymentMethod.new(type: NGN::Bank,
|
20
20
|
provider: Interswitch,
|
21
|
-
otc_permitted:
|
21
|
+
otc_permitted: false,
|
22
22
|
details: ["email","first_name","last_name","address"],
|
23
|
-
default:
|
23
|
+
default: false,
|
24
24
|
fields: {"email":{"type":"input","validations":{"inclusion":{"in":{"NI":"National Id","PP":"Passport"},"allow_blank":true}}}})
|
25
25
|
```
|
26
26
|
|
@@ -19,9 +19,9 @@ require 'TransferZero'
|
|
19
19
|
|
20
20
|
instance = TransferZero::PaymentMethodOpposite.new(type: NGN::Bank,
|
21
21
|
provider: Interswitch,
|
22
|
-
otc_permitted:
|
22
|
+
otc_permitted: false,
|
23
23
|
details: ["email","first_name","last_name","address"],
|
24
|
-
default:
|
24
|
+
default: false,
|
25
25
|
fields: {"email":{"type":"input","validations":{"inclusion":{"in":{"NI":"National Id","PP":"Passport"},"allow_blank":true}}}},
|
26
26
|
opposites: null)
|
27
27
|
```
|
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]
|
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
|
+
**sort_code** | **String** | | [optional]
|
17
18
|
**bic** | **String** | | [optional]
|
18
19
|
**sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) | |
|
19
20
|
**sender_identity_card_id** | **String** | |
|
@@ -24,6 +25,13 @@ Name | Type | Description | Notes
|
|
24
25
|
**identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) | | [optional]
|
25
26
|
**identity_card_id** | **String** | | [optional]
|
26
27
|
**reference** | **String** | | [optional]
|
28
|
+
**name** | **String** | |
|
29
|
+
**address** | **String** | |
|
30
|
+
**street** | **String** | |
|
31
|
+
**postal_code** | **String** | |
|
32
|
+
**city** | **String** | |
|
33
|
+
**email** | **String** | | [optional]
|
34
|
+
**transfer_reason_code** | **String** | | [optional]
|
27
35
|
|
28
36
|
## Code Sample
|
29
37
|
|
@@ -40,6 +48,7 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
|
|
40
48
|
iban: null,
|
41
49
|
bank_name: null,
|
42
50
|
bank_country: null,
|
51
|
+
sort_code: null,
|
43
52
|
bic: null,
|
44
53
|
sender_identity_card_type: null,
|
45
54
|
sender_identity_card_id: null,
|
@@ -49,7 +58,14 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
|
|
49
58
|
reason: null,
|
50
59
|
identity_card_type: null,
|
51
60
|
identity_card_id: null,
|
52
|
-
reference: null
|
61
|
+
reference: null,
|
62
|
+
name: null,
|
63
|
+
address: null,
|
64
|
+
street: null,
|
65
|
+
postal_code: null,
|
66
|
+
city: null,
|
67
|
+
email: null,
|
68
|
+
transfer_reason_code: null)
|
53
69
|
```
|
54
70
|
|
55
71
|
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# TransferZero::PayoutMethodDetailsBTC
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**first_name** | **String** | |
|
8
|
+
**last_name** | **String** | |
|
9
|
+
**name** | **String** | |
|
10
|
+
**address** | **String** | |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'TransferZero'
|
16
|
+
|
17
|
+
instance = TransferZero::PayoutMethodDetailsBTC.new(first_name: null,
|
18
|
+
last_name: null,
|
19
|
+
name: null,
|
20
|
+
address: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|