transferzero-sdk 1.5.0 → 1.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +7 -5
- data/docs/Document.md +1 -3
- data/docs/DocumentsApi.md +2 -74
- data/docs/PayinMethodDetails.md +3 -1
- data/docs/PayinMethodDetailsBTC.md +17 -0
- data/docs/PayoutMethodDetails.md +5 -1
- data/docs/PayoutMethodDetailsBTC.md +23 -0
- data/docs/PoliticallyExposedPerson.md +31 -0
- data/docs/Sender.md +62 -32
- data/docs/Transaction.md +3 -3
- data/lib/transferzero-sdk.rb +3 -0
- data/lib/transferzero-sdk/api/documents_api.rb +0 -63
- data/lib/transferzero-sdk/api_client.rb +1 -1
- data/lib/transferzero-sdk/models/document.rb +1 -10
- data/lib/transferzero-sdk/models/payin_method_details.rb +15 -4
- data/lib/transferzero-sdk/models/payin_method_details_btc.rb +203 -0
- data/lib/transferzero-sdk/models/payout_method_details.rb +33 -4
- data/lib/transferzero-sdk/models/payout_method_details_btc.rb +249 -0
- data/lib/transferzero-sdk/models/politically_exposed_person.rb +271 -0
- data/lib/transferzero-sdk/models/sender.rb +288 -124
- data/lib/transferzero-sdk/models/sender_state.rb +1 -1
- 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/politically_exposed_person_spec.rb +83 -0
- metadata +15 -4
- data/transferzero-sdk-1.4.0.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: 67d5893020d507b8a392d04e04d4dc4af5098e459d430d89f253245e70cdc188
|
4
|
+
data.tar.gz: 7dbbcaa2a8eff3d52bd2d2fcadcd93e3bd9adf42a75be0846009457e81ec31ca
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 576a248ecae25fef80bc23b7e5fb61d3a68116ababe69751041870371a9cb89e4e7703ef6c9a3b79989c83eabcc18889f68c0ddd8f3ef26d3615beb5cba33bf9
|
7
|
+
data.tar.gz: 5a0d7d0381cf92e9928c9715a19d19bdad73e773c7af978e268143f0ad3e478005c20787aad199cd0719f6edcc4ea4a0d91053929df10e5312ba2d5b11f6e0b1
|
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.6.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.6.0.gem
|
35
35
|
```
|
36
|
-
(for development, run `gem install --dev ./transferzero-sdk-1.
|
36
|
+
(for development, run `gem install --dev ./transferzero-sdk-1.6.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.6.0'
|
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,6 +197,7 @@ 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)
|
201
202
|
- [TransferZero::PayoutMethodDetailsGHSBank](docs/PayoutMethodDetailsGHSBank.md)
|
202
203
|
- [TransferZero::PayoutMethodDetailsIBAN](docs/PayoutMethodDetailsIBAN.md)
|
@@ -212,6 +213,7 @@ Class | Method | HTTP request | Description
|
|
212
213
|
- [TransferZero::PayoutMethodRequest](docs/PayoutMethodRequest.md)
|
213
214
|
- [TransferZero::PayoutMethodResponse](docs/PayoutMethodResponse.md)
|
214
215
|
- [TransferZero::PayoutMethodWebhook](docs/PayoutMethodWebhook.md)
|
216
|
+
- [TransferZero::PoliticallyExposedPerson](docs/PoliticallyExposedPerson.md)
|
215
217
|
- [TransferZero::Recipient](docs/Recipient.md)
|
216
218
|
- [TransferZero::RecipientListResponse](docs/RecipientListResponse.md)
|
217
219
|
- [TransferZero::RecipientRequest](docs/RecipientRequest.md)
|
data/docs/Document.md
CHANGED
@@ -4,7 +4,6 @@
|
|
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 |
|
9
8
|
**upload_file_name** | **String** | Name of the upload |
|
10
9
|
**metadata** | [**Object**](.md) | Metadata of document | [optional]
|
@@ -22,8 +21,7 @@ Name | Type | Description | Notes
|
|
22
21
|
```ruby
|
23
22
|
require 'TransferZero'
|
24
23
|
|
25
|
-
instance = TransferZero::Document.new(
|
26
|
-
upload: data:image/png;base64,iVBORw0KGg...lFTkSuQmCC,
|
24
|
+
instance = TransferZero::Document.new(upload: data:image/png;base64,iVBORw0KGg...lFTkSuQmCC,
|
27
25
|
upload_file_name: example.png,
|
28
26
|
metadata: {},
|
29
27
|
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/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: true
|
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/PayoutMethodDetails.md
CHANGED
@@ -24,6 +24,8 @@ Name | Type | Description | Notes
|
|
24
24
|
**identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) | | [optional]
|
25
25
|
**identity_card_id** | **String** | | [optional]
|
26
26
|
**reference** | **String** | | [optional]
|
27
|
+
**name** | **String** | |
|
28
|
+
**address** | **String** | |
|
27
29
|
|
28
30
|
## Code Sample
|
29
31
|
|
@@ -49,7 +51,9 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
|
|
49
51
|
reason: null,
|
50
52
|
identity_card_type: null,
|
51
53
|
identity_card_id: null,
|
52
|
-
reference: null
|
54
|
+
reference: null,
|
55
|
+
name: null,
|
56
|
+
address: null)
|
53
57
|
```
|
54
58
|
|
55
59
|
|
@@ -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
|
+
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# TransferZero::PoliticallyExposedPerson
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **Integer** | | [optional]
|
8
|
+
**name** | **String** | Full name of the politically exposed person | [optional]
|
9
|
+
**position** | **String** | The office held by the politically exposed person | [optional]
|
10
|
+
**started_date** | **DateTime** | The date on which the person started holding the office | [optional]
|
11
|
+
**ended_date** | **DateTime** | The date on which the person ended holding the office | [optional]
|
12
|
+
**sender_id** | **String** | The ID of the Sender to whom the person is attached to | [optional]
|
13
|
+
**created_at** | **DateTime** | Date and time the person was created | [optional]
|
14
|
+
**updated_at** | **DateTime** | Date and time the person was updated | [optional]
|
15
|
+
|
16
|
+
## Code Sample
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'TransferZero'
|
20
|
+
|
21
|
+
instance = TransferZero::PoliticallyExposedPerson.new(id: 1,
|
22
|
+
name: Ronald Reagan,
|
23
|
+
position: President of the United States,
|
24
|
+
started_date: null,
|
25
|
+
ended_date: null,
|
26
|
+
sender_id: 83a4f5fd-9260-4aaa-9743-63f8a6d8309d,
|
27
|
+
created_at: null,
|
28
|
+
updated_at: null)
|
29
|
+
```
|
30
|
+
|
31
|
+
|
data/docs/Sender.md
CHANGED
@@ -4,68 +4,98 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
7
8
|
**type** | **String** | Type of sender to create - either person or business (defaults to person) | [optional]
|
9
|
+
**state** | [**SenderState**](SenderState.md) | | [optional]
|
8
10
|
**country** | **String** | Country of sender in 2-character alpha ISO 3166-2 country format |
|
11
|
+
**street** | **String** | Sender's street |
|
12
|
+
**postal_code** | **String** | Zip code of sender |
|
13
|
+
**city** | **String** | Sender's city |
|
9
14
|
**phone_country** | **String** | Phone country of sender in 2-character alpha ISO 3166-2 country format |
|
10
15
|
**phone_number** | **String** | Phone number of sender (without country callcode) | [optional]
|
11
16
|
**email** | **String** | Email of sender |
|
17
|
+
**ip** | **String** | IP of sender |
|
18
|
+
**address_description** | **String** | Description of address | [optional]
|
19
|
+
**identification_number** | **String** | Identification number of document used | [optional]
|
20
|
+
**identification_type** | **String** | Document to be identified. The identification type can be one of the following: - `DL`: Driving License - `PP`: International Passport - `ID`: National ID - `OT`: Other | [optional]
|
21
|
+
**name** | **String** | Name of sender (used only with a Business sender) | [optional]
|
12
22
|
**first_name** | **String** | First name of sender (used only with a Personal sender) | [optional]
|
13
23
|
**middle_name** | **String** | Middle name of sender (used only with a Personal sender) | [optional]
|
14
24
|
**last_name** | **String** | Last name of sender (used only with a Personal sender) | [optional]
|
25
|
+
**birth_date** | **Date** | Date of birth of sender (used only with a Personal sender) | [optional]
|
15
26
|
**occupation** | **String** | Occupation of sender (used only with a Personal sender) | [optional]
|
16
27
|
**nationality** | **String** | The nationality of the sender (used only with a Personal sender) | [optional]
|
17
|
-
**
|
18
|
-
**
|
19
|
-
**
|
20
|
-
**
|
21
|
-
**
|
22
|
-
**
|
23
|
-
**
|
24
|
-
**
|
25
|
-
**
|
26
|
-
**
|
27
|
-
**
|
28
|
-
**
|
28
|
+
**legal_entity_type** | **String** | Legal entity type (used only with a Business sender) | [optional]
|
29
|
+
**registration_date** | **String** | The registration date (used only with a Business sender) | [optional]
|
30
|
+
**registration_number** | **String** | The registration number (used only with a Business sender) | [optional]
|
31
|
+
**nature_of_business** | **String** | Nature of business options (used only with a Business sender) | [optional]
|
32
|
+
**source_of_funds** | **String** | The source of funds | [optional]
|
33
|
+
**core_business_activities** | **String** | The core activities (used only with a Business sender) | [optional]
|
34
|
+
**purpose_of_opening_account** | **String** | The purpose for opening their account (used only with a Business sender) | [optional]
|
35
|
+
**office_phone** | **String** | The official phone number (used only with a Business sender) | [optional]
|
36
|
+
**vat_registration_number** | **String** | The VAT registration number (used only with a Business sender) | [optional]
|
37
|
+
**financial_regulator** | **String** | The Financial Regulator (used only with a Business sender) | [optional]
|
38
|
+
**regulatory_licence_number** | **String** | The Regulatory Licence Number (used only with a Business sender) | [optional]
|
39
|
+
**contact_person_email** | **String** | The contact's email address (used only with a Business sender) | [optional]
|
40
|
+
**trading_country** | **String** | The Business trading country (used only with a Business sender) | [optional]
|
41
|
+
**trading_address** | **String** | The Business trading address (used only with a Business sender) | [optional]
|
42
|
+
**number_monthly_transactions** | **String** | The estimated number of monthly transactions (used only with a Business sender) | [optional]
|
43
|
+
**amount_monthly_transactions** | **String** | The estimated amount for all transactions each month in USD (used only with a Business sender) | [optional]
|
29
44
|
**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\" } ] ``` |
|
30
45
|
**metadata** | [**Object**](.md) | Metadata of sender. You can store any detail specific to your integration here (for example the local ID of the sender on your end). When requesting sender details you will receive the sent metadata back. Also when sending sender related webhooks you will receive the details stored here as well. | [optional]
|
31
|
-
**state** | [**SenderState**](SenderState.md) | | [optional]
|
32
|
-
**id** | **String** | | [optional]
|
33
|
-
**external_id** | **String** | Optional ID that is supplied by partner linking it to the partner's own Sender ID. Note: if present we will validate whether the sent ID is a duplicate in our system or not. | [optional]
|
34
46
|
**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional]
|
47
|
+
**onboarding_status** | **String** | The onboarding status of the sender | [optional]
|
48
|
+
**politically_exposed_people** | [**Array<PoliticallyExposedPerson>**](PoliticallyExposedPerson.md) | An optional list of politically exposed people, individuals who are or have been entrusted with prominent public functions by a country, for example heads of state or heads of government, senior politicians, senior government, judicial or military officials, senior executives of state owned corporations, important political party officials. There is a limit of three (3) politically exposed people per Sender. Politically exposed person example: ```json { \"politically_exposed_person\": { \"name\": \"Ronald Reagan\", \"position\": \"President of the United States\", \"started_date\": \"1981-01-20T00:00:00.000Z\", \"ended_date\": \"1989-01-20T00:00:00.000Z\", \"sender_id\": \"344fb668-196d-43db-9d94-b34b7e6c7e0b\" } } ``` | [optional]
|
49
|
+
**external_id** | **String** | Optional ID that is supplied by partner linking it to the partner's own Sender ID. Note: if present we will validate whether the sent ID is a duplicate in our system or not. | [optional]
|
35
50
|
|
36
51
|
## Code Sample
|
37
52
|
|
38
53
|
```ruby
|
39
54
|
require 'TransferZero'
|
40
55
|
|
41
|
-
instance = TransferZero::Sender.new(
|
56
|
+
instance = TransferZero::Sender.new(id: bf9ff782-e182-45ac-abea-5bce83ad6670,
|
57
|
+
type: person,
|
58
|
+
state: null,
|
42
59
|
country: NG,
|
60
|
+
street: Fake Street,
|
61
|
+
postal_code: 798983,
|
62
|
+
city: Kampala,
|
43
63
|
phone_country: NG,
|
44
64
|
phone_number: 752403639,
|
45
65
|
email: example@home.org,
|
66
|
+
ip: 127.0.0.1,
|
67
|
+
address_description: null,
|
68
|
+
identification_number: AB123456,
|
69
|
+
identification_type: ID,
|
70
|
+
name: null,
|
46
71
|
first_name: Johnny,
|
47
72
|
middle_name: Johnny,
|
48
73
|
last_name: English,
|
74
|
+
birth_date: null,
|
49
75
|
occupation: Accountant,
|
50
76
|
nationality: NG,
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
77
|
+
legal_entity_type: sole_proprietorship,
|
78
|
+
registration_date: null,
|
79
|
+
registration_number: null,
|
80
|
+
nature_of_business: null,
|
81
|
+
source_of_funds: null,
|
82
|
+
core_business_activities: null,
|
83
|
+
purpose_of_opening_account: null,
|
84
|
+
office_phone: null,
|
85
|
+
vat_registration_number: null,
|
86
|
+
financial_regulator: null,
|
87
|
+
regulatory_licence_number: null,
|
88
|
+
contact_person_email: null,
|
89
|
+
trading_country: null,
|
90
|
+
trading_address: null,
|
91
|
+
number_monthly_transactions: null,
|
92
|
+
amount_monthly_transactions: null,
|
63
93
|
documents: [{"id":"b6648ba3-1c7b-4f59-8580-684899c84a07"}],
|
64
94
|
metadata: {},
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
95
|
+
errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]},
|
96
|
+
onboarding_status: null,
|
97
|
+
politically_exposed_people: [{"id":"40","name":"Ronald Reagan","position":"President of the United States","started_date":"1981-01-20T00:00:00.000Z","ended_date":"1989-01-20T00:00:00.000Z","sender_id":"f9dc79ca-0c39-4add-9f4d-5ad7e6f187fb"}],
|
98
|
+
external_id: 806ec63a-a5a7-43cc-9d75-1ee74fbcc026)
|
69
99
|
```
|
70
100
|
|
71
101
|
|