transferzero-sdk 1.0.0 → 1.7.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 +17 -11
- data/docs/AccountMeta.md +1 -1
- data/docs/AccountValidationApi.md +4 -4
- data/docs/AccountValidationRequest.md +6 -4
- data/docs/Currency.md +1 -1
- data/docs/CurrencyExchange.md +1 -1
- data/docs/CurrencyInfoApi.md +20 -6
- data/docs/CurrencyOpposite.md +4 -2
- data/docs/Debit.md +2 -2
- data/docs/Document.md +4 -0
- data/docs/FieldSelectValidation.md +1 -1
- data/docs/FieldValidation.md +1 -1
- data/docs/PayinMethod.md +4 -4
- data/docs/PayinMethodDetails.md +7 -3
- data/docs/PayinMethodDetailsBTC.md +17 -0
- data/docs/PayinMethodDetailsMobile.md +1 -1
- data/docs/PayinMethodDetailsNGNBank.md +4 -2
- data/docs/PaymentMethod.md +2 -2
- data/docs/PaymentMethodOpposite.md +2 -2
- data/docs/PayoutMethod.md +1 -1
- data/docs/PayoutMethodDetails.md +12 -4
- data/docs/PayoutMethodDetailsBTC.md +23 -0
- data/docs/PayoutMethodDetailsGBPBank.md +29 -0
- data/docs/PayoutMethodDetailsIBAN.md +1 -1
- data/docs/PayoutMethodDetailsNGNBank.md +1 -1
- data/docs/PayoutMethodDetailsXOFBank.md +25 -0
- data/docs/PoliticallyExposedPerson.md +31 -0
- data/docs/Recipient.md +5 -3
- data/docs/RecipientsApi.md +3 -3
- data/docs/Sender.md +63 -27
- data/docs/Transaction.md +5 -5
- data/docs/TransactionTraits.md +2 -2
- data/docs/TransactionsApi.md +64 -0
- data/example/client.rb +14 -14
- data/git_push.sh +1 -1
- data/lib/transferzero-sdk.rb +5 -0
- data/lib/transferzero-sdk/api/account_validation_api.rb +4 -4
- data/lib/transferzero-sdk/api/currency_info_api.rb +6 -0
- data/lib/transferzero-sdk/api/recipients_api.rb +4 -4
- data/lib/transferzero-sdk/api/transactions_api.rb +59 -0
- data/lib/transferzero-sdk/api_client.rb +5 -5
- 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 +142 -141
- data/lib/transferzero-sdk/models/currency_exchange.rb +158 -157
- 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 -155
- data/lib/transferzero-sdk/models/debit.rb +151 -155
- 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 +181 -160
- 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 -105
- 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 -65
- 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 +338 -288
- 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 -108
- data/lib/transferzero-sdk/models/payout_method_details_xof_bank.rb +264 -0
- data/lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb +97 -96
- 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 +272 -0
- data/lib/transferzero-sdk/models/recipient.rb +230 -219
- 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 +529 -322
- 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 -23
- 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 -27
- 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/api/account_validation_api_spec.rb +2 -2
- data/spec/api/currency_info_api_spec.rb +2 -0
- data/spec/api/documents_api_spec.rb +15 -0
- data/spec/api/recipients_api_spec.rb +1 -1
- data/spec/api/transactions_api_spec.rb +13 -0
- data/spec/models/account_validation_request_spec.rb +7 -1
- data/spec/models/currency_opposite_spec.rb +6 -0
- data/spec/models/document_spec.rb +12 -0
- data/spec/models/payin_method_details_btc_spec.rb +41 -0
- data/spec/models/payin_method_details_ngn_bank_spec.rb +6 -0
- data/spec/models/payin_method_details_spec.rb +6 -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_spec.rb +7 -1
- data/spec/models/payout_method_details_xof_bank_spec.rb +65 -0
- data/spec/models/politically_exposed_person_spec.rb +83 -0
- data/spec/models/recipient_spec.rb +6 -0
- data/spec/models/sender_spec.rb +16 -0
- data/transferzero-sdk.gemspec +2 -2
- metadata +35 -24
- data/spec/api_client_spec.rb +0 -189
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f333393e130ce032c7ae5f25df97e719a671e3f0071aaef40c6c67ad81295473
|
4
|
+
data.tar.gz: 556e231d7edf40381c86bf3dadcf3b3559d9c799976d1f7a4d2ea69e7428094c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '0100867ae3b2c304d8914632fcccbaf8312e3d16a65dc136c76f868ef3fabd43479b13aeb2aac5323ca18c83ce8504cc6693d289cee1408b8ea868a746ca16bc'
|
7
|
+
data.tar.gz: a9b1c802ff472b829eca858a92d2a252b41ee163d28eb50c740d778c7aa86cf4fef5a48a876cb028e37ca4e4c3c6378826d7663d5c87d58ca0aec7056f680e12
|
data/README.md
CHANGED
@@ -7,15 +7,15 @@ 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.7.0
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
For more information, please visit:
|
14
14
|
|
15
|
-
* [API Documentation](https://
|
16
|
-
* [Onboarding guide](https://
|
17
|
-
* [Transaction flow](https://
|
18
|
-
* [Additional features](https://
|
15
|
+
* [API Documentation](https://docs.transferzero.com)
|
16
|
+
* [Onboarding guide](https://docs.transferzero.com/docs/quick-integration/)
|
17
|
+
* [Transaction flow](https://docs.transferzero.com/docs/transaction-flow/)
|
18
|
+
* [Additional features](https://docs.transferzero.com/docs/additional-features/)
|
19
19
|
* [API Specification](https://api.transferzero.com/documentation)
|
20
20
|
|
21
21
|
## Installation
|
@@ -31,21 +31,21 @@ 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.7.0.gem
|
35
35
|
```
|
36
|
-
(for development, run `gem install --dev ./transferzero-sdk-1.
|
36
|
+
(for development, run `gem install --dev ./transferzero-sdk-1.7.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.7.0'
|
43
43
|
|
44
44
|
### Install from Git
|
45
45
|
|
46
|
-
If the Ruby gem is hosted at a git repository: https://github.com/transferzero/transferzero-ruby
|
46
|
+
If the Ruby gem is hosted at a git repository: https://github.com/transferzero/transferzero-sdk-ruby, then add the following in the Gemfile:
|
47
47
|
|
48
|
-
gem 'transferzero-sdk', :git => 'https://github.com/transferzero/transferzero-ruby
|
48
|
+
gem 'transferzero-sdk', :git => 'https://github.com/transferzero/transferzero-sdk-ruby.git'
|
49
49
|
|
50
50
|
### Include the Ruby code directly
|
51
51
|
|
@@ -109,7 +109,7 @@ Class | Method | HTTP request | Description
|
|
109
109
|
*TransferZero::AccountDebitsApi* | [**get_accounts_debit**](docs/AccountDebitsApi.md#get_accounts_debit) | **GET** /accounts/debits/{Account Debit ID} | Fetching an account debit
|
110
110
|
*TransferZero::AccountDebitsApi* | [**get_accounts_debits**](docs/AccountDebitsApi.md#get_accounts_debits) | **GET** /accounts/debits | Listing Accounts debits
|
111
111
|
*TransferZero::AccountDebitsApi* | [**post_accounts_debits**](docs/AccountDebitsApi.md#post_accounts_debits) | **POST** /accounts/debits | Creating an account debit
|
112
|
-
*TransferZero::AccountValidationApi* | [**post_account_validations**](docs/AccountValidationApi.md#post_account_validations) | **POST** /account_validations | Validates the existence of a bank account
|
112
|
+
*TransferZero::AccountValidationApi* | [**post_account_validations**](docs/AccountValidationApi.md#post_account_validations) | **POST** /account_validations | Validates the existence of a bank account or a mobile phone number
|
113
113
|
*TransferZero::AccountsApi* | [**get_account**](docs/AccountsApi.md#get_account) | **GET** /accounts/{Currency} | Fetches account balance for specified currrency
|
114
114
|
*TransferZero::AccountsApi* | [**get_accounts**](docs/AccountsApi.md#get_accounts) | **GET** /accounts | Fetches account balances for all currencies
|
115
115
|
*TransferZero::CurrencyInfoApi* | [**info_currencies**](docs/CurrencyInfoApi.md#info_currencies) | **GET** /info/currencies | Getting a list of possible requested currencies
|
@@ -136,6 +136,7 @@ Class | Method | HTTP request | Description
|
|
136
136
|
*TransferZero::SendersApi* | [**patch_sender**](docs/SendersApi.md#patch_sender) | **PATCH** /senders/{Sender ID} | Updating a sender
|
137
137
|
*TransferZero::SendersApi* | [**post_senders**](docs/SendersApi.md#post_senders) | **POST** /senders | Creating a sender
|
138
138
|
*TransferZero::TransactionsApi* | [**calculate_transactions**](docs/TransactionsApi.md#calculate_transactions) | **POST** /transactions/calculate | Calculates transaction amounts for a transaction payload
|
139
|
+
*TransferZero::TransactionsApi* | [**create_and_fund_transaction**](docs/TransactionsApi.md#create_and_fund_transaction) | **POST** /transactions/create_and_fund | Creates a new transaction and funds it from account balance
|
139
140
|
*TransferZero::TransactionsApi* | [**get_transaction**](docs/TransactionsApi.md#get_transaction) | **GET** /transactions/{Transaction ID} | Fetch a single transaction
|
140
141
|
*TransferZero::TransactionsApi* | [**get_transactions**](docs/TransactionsApi.md#get_transactions) | **GET** /transactions | Get a list of transactions
|
141
142
|
*TransferZero::TransactionsApi* | [**payin_transaction**](docs/TransactionsApi.md#payin_transaction) | **POST** /transactions/{Transaction ID}/payin | Creates a fake payin for transaction
|
@@ -186,6 +187,7 @@ Class | Method | HTTP request | Description
|
|
186
187
|
- [TransferZero::PaginationMeta](docs/PaginationMeta.md)
|
187
188
|
- [TransferZero::PayinMethod](docs/PayinMethod.md)
|
188
189
|
- [TransferZero::PayinMethodDetails](docs/PayinMethodDetails.md)
|
190
|
+
- [TransferZero::PayinMethodDetailsBTC](docs/PayinMethodDetailsBTC.md)
|
189
191
|
- [TransferZero::PayinMethodDetailsMobile](docs/PayinMethodDetailsMobile.md)
|
190
192
|
- [TransferZero::PayinMethodDetailsNGNBank](docs/PayinMethodDetailsNGNBank.md)
|
191
193
|
- [TransferZero::PayinMethodRequest](docs/PayinMethodRequest.md)
|
@@ -195,12 +197,15 @@ Class | Method | HTTP request | Description
|
|
195
197
|
- [TransferZero::PayoutMethod](docs/PayoutMethod.md)
|
196
198
|
- [TransferZero::PayoutMethodBankAccountTypeEnum](docs/PayoutMethodBankAccountTypeEnum.md)
|
197
199
|
- [TransferZero::PayoutMethodDetails](docs/PayoutMethodDetails.md)
|
200
|
+
- [TransferZero::PayoutMethodDetailsBTC](docs/PayoutMethodDetailsBTC.md)
|
198
201
|
- [TransferZero::PayoutMethodDetailsBalance](docs/PayoutMethodDetailsBalance.md)
|
202
|
+
- [TransferZero::PayoutMethodDetailsGBPBank](docs/PayoutMethodDetailsGBPBank.md)
|
199
203
|
- [TransferZero::PayoutMethodDetailsGHSBank](docs/PayoutMethodDetailsGHSBank.md)
|
200
204
|
- [TransferZero::PayoutMethodDetailsIBAN](docs/PayoutMethodDetailsIBAN.md)
|
201
205
|
- [TransferZero::PayoutMethodDetailsMADCash](docs/PayoutMethodDetailsMADCash.md)
|
202
206
|
- [TransferZero::PayoutMethodDetailsMobile](docs/PayoutMethodDetailsMobile.md)
|
203
207
|
- [TransferZero::PayoutMethodDetailsNGNBank](docs/PayoutMethodDetailsNGNBank.md)
|
208
|
+
- [TransferZero::PayoutMethodDetailsXOFBank](docs/PayoutMethodDetailsXOFBank.md)
|
204
209
|
- [TransferZero::PayoutMethodDetailsXOFMobile](docs/PayoutMethodDetailsXOFMobile.md)
|
205
210
|
- [TransferZero::PayoutMethodGenderEnum](docs/PayoutMethodGenderEnum.md)
|
206
211
|
- [TransferZero::PayoutMethodIdentityCardTypeEnum](docs/PayoutMethodIdentityCardTypeEnum.md)
|
@@ -209,6 +214,7 @@ Class | Method | HTTP request | Description
|
|
209
214
|
- [TransferZero::PayoutMethodRequest](docs/PayoutMethodRequest.md)
|
210
215
|
- [TransferZero::PayoutMethodResponse](docs/PayoutMethodResponse.md)
|
211
216
|
- [TransferZero::PayoutMethodWebhook](docs/PayoutMethodWebhook.md)
|
217
|
+
- [TransferZero::PoliticallyExposedPerson](docs/PoliticallyExposedPerson.md)
|
212
218
|
- [TransferZero::Recipient](docs/Recipient.md)
|
213
219
|
- [TransferZero::RecipientListResponse](docs/RecipientListResponse.md)
|
214
220
|
- [TransferZero::RecipientRequest](docs/RecipientRequest.md)
|
data/docs/AccountMeta.md
CHANGED
@@ -4,15 +4,15 @@ All URIs are relative to *https://api-sandbox.transferzero.com/v1*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**post_account_validations**](AccountValidationApi.md#post_account_validations) | **POST** /account_validations | Validates the existence of a bank account
|
7
|
+
[**post_account_validations**](AccountValidationApi.md#post_account_validations) | **POST** /account_validations | Validates the existence of a bank account or a mobile phone number
|
8
8
|
|
9
9
|
|
10
10
|
# **post_account_validations**
|
11
11
|
> AccountValidationResponse post_account_validations(account_validation_request)
|
12
12
|
|
13
|
-
Validates the existence of a bank account
|
13
|
+
Validates the existence of a bank account or a mobile phone number
|
14
14
|
|
15
|
-
Validates the existence of a bank account and returns the associated customer name
|
15
|
+
Validates the existence of a bank account or mobile phone number and returns the associated customer name
|
16
16
|
|
17
17
|
### Example
|
18
18
|
```ruby
|
@@ -23,7 +23,7 @@ api_instance = TransferZero::AccountValidationApi.new
|
|
23
23
|
|
24
24
|
|
25
25
|
begin
|
26
|
-
#Validates the existence of a bank account
|
26
|
+
#Validates the existence of a bank account or a mobile phone number
|
27
27
|
result = api_instance.post_account_validations(account_validation_request)
|
28
28
|
p result
|
29
29
|
rescue TransferZero::ApiError => e
|
@@ -4,11 +4,12 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**bank_account** | **String** | Account Number to query |
|
8
|
-
**bank_code** | **String** | Bank Code to query - same codes are used as for creating the transactions |
|
9
|
-
**
|
7
|
+
**bank_account** | **String** | Account Number to query | [optional]
|
8
|
+
**bank_code** | **String** | Bank Code to query - same codes are used as for creating the transactions | [optional]
|
9
|
+
**phone_number** | **String** | Phone number to query | [optional]
|
10
|
+
**country** | **String** | Country of account in 2-character alpha ISO 3166-2 country format |
|
10
11
|
**currency** | **String** | The currency the bank account is in |
|
11
|
-
**method** | **String** | The method of the payment. Currently
|
12
|
+
**method** | **String** | The method of the payment. Currently bank and mobile are supported |
|
12
13
|
|
13
14
|
## Code Sample
|
14
15
|
|
@@ -17,6 +18,7 @@ require 'TransferZero'
|
|
17
18
|
|
18
19
|
instance = TransferZero::AccountValidationRequest.new(bank_account: null,
|
19
20
|
bank_code: null,
|
21
|
+
phone_number: +233000000000,
|
20
22
|
country: null,
|
21
23
|
currency: null,
|
22
24
|
method: null)
|
data/docs/Currency.md
CHANGED
data/docs/CurrencyExchange.md
CHANGED
data/docs/CurrencyInfoApi.md
CHANGED
@@ -67,7 +67,7 @@ end
|
|
67
67
|
|
68
68
|
|
69
69
|
# **info_currencies_in**
|
70
|
-
> CurrencyExchangeListResponse info_currencies_in
|
70
|
+
> CurrencyExchangeListResponse info_currencies_in(opts)
|
71
71
|
|
72
72
|
Getting a list of possible input currencies
|
73
73
|
|
@@ -80,9 +80,13 @@ require 'transferzero-sdk'
|
|
80
80
|
|
81
81
|
api_instance = TransferZero::CurrencyInfoApi.new
|
82
82
|
|
83
|
+
opts = {
|
84
|
+
sender_id: 'sender_id_example' # String | Allows the scoping of the results by `sender_id` (optional). Example: `/v1/info/currencies/in?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
|
85
|
+
}
|
86
|
+
|
83
87
|
begin
|
84
88
|
#Getting a list of possible input currencies
|
85
|
-
result = api_instance.info_currencies_in
|
89
|
+
result = api_instance.info_currencies_in(opts)
|
86
90
|
p result
|
87
91
|
rescue TransferZero::ApiError => e
|
88
92
|
if e.validation_error
|
@@ -96,7 +100,10 @@ end
|
|
96
100
|
```
|
97
101
|
|
98
102
|
### Parameters
|
99
|
-
|
103
|
+
|
104
|
+
Name | Type | Description | Notes
|
105
|
+
------------- | ------------- | ------------- | -------------
|
106
|
+
**sender_id** | [**String**](.md)| Allows the scoping of the results by `sender_id` (optional). Example: `/v1/info/currencies/in?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` | [optional]
|
100
107
|
|
101
108
|
### Return type
|
102
109
|
|
@@ -124,7 +131,7 @@ end
|
|
124
131
|
|
125
132
|
|
126
133
|
# **info_currencies_out**
|
127
|
-
> CurrencyExchangeListResponse info_currencies_out
|
134
|
+
> CurrencyExchangeListResponse info_currencies_out(opts)
|
128
135
|
|
129
136
|
Getting a list of possible output currencies
|
130
137
|
|
@@ -137,9 +144,13 @@ require 'transferzero-sdk'
|
|
137
144
|
|
138
145
|
api_instance = TransferZero::CurrencyInfoApi.new
|
139
146
|
|
147
|
+
opts = {
|
148
|
+
sender_id: 'sender_id_example' # String | Allows the scoping of the results by `sender_id` (optional). Example: `/v1/info/currencies/out?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
|
149
|
+
}
|
150
|
+
|
140
151
|
begin
|
141
152
|
#Getting a list of possible output currencies
|
142
|
-
result = api_instance.info_currencies_out
|
153
|
+
result = api_instance.info_currencies_out(opts)
|
143
154
|
p result
|
144
155
|
rescue TransferZero::ApiError => e
|
145
156
|
if e.validation_error
|
@@ -153,7 +164,10 @@ end
|
|
153
164
|
```
|
154
165
|
|
155
166
|
### Parameters
|
156
|
-
|
167
|
+
|
168
|
+
Name | Type | Description | Notes
|
169
|
+
------------- | ------------- | ------------- | -------------
|
170
|
+
**sender_id** | [**String**](.md)| Allows the scoping of the results by `sender_id` (optional). Example: `/v1/info/currencies/out?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` | [optional]
|
157
171
|
|
158
172
|
### Return type
|
159
173
|
|
data/docs/CurrencyOpposite.md
CHANGED
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
|
|
15
15
|
**margin** | **String** | The margin set for transactions in this currency | [optional]
|
16
16
|
**usd_equivalent** | **String** | The equivalent of the currency to 1 USD | [optional]
|
17
17
|
**rate** | **Float** | The rate of this particular currency with the base one | [optional]
|
18
|
+
**mtm_rate** | **Float** | Mark to market rate of this particular currency against the base one with the margin factored in | [optional]
|
18
19
|
|
19
20
|
## Code Sample
|
20
21
|
|
@@ -26,12 +27,13 @@ instance = TransferZero::CurrencyOpposite.new(code: NGN,
|
|
26
27
|
symbol: ₦,
|
27
28
|
decimals: 2,
|
28
29
|
subunit_to_unit: 100,
|
29
|
-
primary:
|
30
|
+
primary: true,
|
30
31
|
min: 100,
|
31
32
|
max: 50000000,
|
32
33
|
margin: null,
|
33
34
|
usd_equivalent: null,
|
34
|
-
rate: null
|
35
|
+
rate: null,
|
36
|
+
mtm_rate: null)
|
35
37
|
```
|
36
38
|
|
37
39
|
|
data/docs/Debit.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**amount** | **Float** | The amount to be debited from your account. The
|
8
|
-
**currency** | **String** | The currency of the amount in 3-character alpha ISO 4217 currency format |
|
7
|
+
**amount** | **Float** | The amount to be debited from your account. The \"amount\" parameter is optional - - if included, it must equal the amount required to fund the transaction. - if omitted, it will default to the amount required to fund the transaction. | [optional]
|
8
|
+
**currency** | **String** | The currency of the amount in 3-character alpha ISO 4217 currency format. The \"currency\" parameter is optional - if omitted, it will default to the payin currency of the transaction. - it can be added in as an additional check to ensure that the expected currency is used. (an error will be given back if it does not match up with the payin currency of the transaction) | [optional]
|
9
9
|
**to_type** | **String** | Describes what the debit is funding |
|
10
10
|
**to_id** | **String** | The ID of the resource the debit is funding |
|
11
11
|
**metadata** | [**Object**](.md) | Metadata of account debit | [optional]
|
data/docs/Document.md
CHANGED
@@ -5,12 +5,14 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
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]
|
8
9
|
**upload_file_name** | **String** | Name of the upload |
|
9
10
|
**metadata** | [**Object**](.md) | Metadata of document | [optional]
|
10
11
|
**upload_content_type** | **String** | | [optional]
|
11
12
|
**upload_file_size** | **Integer** | | [optional]
|
12
13
|
**category** | **String** | uncategorised | [optional]
|
13
14
|
**side** | **String** | The side of the KYC ID. One of 'front' or 'back' | [optional]
|
15
|
+
**document_type** | **String** | This is a brief description of the document type | [optional]
|
14
16
|
**issuing_country** | **String** | Issuing country of ID in 2-character alpha ISO 3166-2 country format | [optional]
|
15
17
|
**id** | **String** | | [optional]
|
16
18
|
**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional]
|
@@ -21,12 +23,14 @@ Name | Type | Description | Notes
|
|
21
23
|
require 'TransferZero'
|
22
24
|
|
23
25
|
instance = TransferZero::Document.new(upload: data:image/png;base64,iVBORw0KGg...lFTkSuQmCC,
|
26
|
+
url: https://bitpesa-documents.amazonaws.com/document.pdf,
|
24
27
|
upload_file_name: example.png,
|
25
28
|
metadata: {},
|
26
29
|
upload_content_type: image/png,
|
27
30
|
upload_file_size: 30255,
|
28
31
|
category: null,
|
29
32
|
side: null,
|
33
|
+
document_type: certificate_of_business_name_registration,
|
30
34
|
issuing_country: NG,
|
31
35
|
id: ebe9bc0b-f2f6-4ce8-802a-8b79912d041e,
|
32
36
|
errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
|
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/PayinMethod.md
CHANGED
@@ -4,11 +4,11 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**type** | **String** | Describes how the payment should be requested from the user. Possible values: - `NGN::Bank`: NGN card collection requests - `GHS::Mobile`: GHS mobile collections - `TZS::Mobile`: TZS mobile collections - `UGX::Mobile`: UGX mobile collections | [optional]
|
7
|
+
**type** | **String** | Describes how the payment should be requested from the user. Possible values: - `NGN::Bank`: NGN bank and card collection requests - `NGN::Mobile`: NGN mobile collections - `GHS::Mobile`: GHS mobile collections - `TZS::Mobile`: TZS mobile collections - `UGX::Mobile`: UGX mobile collections - `EUR::Bank`: EUR IBAN collections - `GBP::Bank`: GBP IBAN collections | [optional]
|
8
8
|
**in_details** | [**PayinMethodDetails**](PayinMethodDetails.md) | | [optional]
|
9
|
-
**out_details** | [**Object**](.md) | This will contain the description on where to pay the funds. Please see the [Collections
|
10
|
-
**instructions** | [**Object**](.md) | This will contain the instructions on how to pay the funds. Please see the [Collections
|
11
|
-
**provider** | **String** | Describes which provider to use for collection. Please see the [Collections
|
9
|
+
**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
|
+
**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
|
+
**provider** | **String** | Describes which provider to use for collection. Please see the [Collections Details](https://docs.transferzero.com/docs/collection-details) in the API documentation on the valid values | [optional]
|
12
12
|
|
13
13
|
## Code Sample
|
14
14
|
|
data/docs/PayinMethodDetails.md
CHANGED
@@ -4,18 +4,22 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**
|
7
|
+
**payment_method** | **String** | The payment method which the user 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 user should be redirected back when the payment has been finished | [optional]
|
8
9
|
**phone_number** | **String** | The phone number where the funds should be collected from |
|
9
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]
|
10
12
|
|
11
13
|
## Code Sample
|
12
14
|
|
13
15
|
```ruby
|
14
16
|
require 'TransferZero'
|
15
17
|
|
16
|
-
instance = TransferZero::PayinMethodDetails.new(
|
18
|
+
instance = TransferZero::PayinMethodDetails.new(payment_method: null,
|
19
|
+
redirect_url: null,
|
17
20
|
phone_number: +2569999999,
|
18
|
-
send_instructions:
|
21
|
+
send_instructions: true,
|
22
|
+
refund_address: null)
|
19
23
|
```
|
20
24
|
|
21
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
|
+
|
@@ -4,14 +4,16 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**
|
7
|
+
**payment_method** | **String** | The payment method which the user 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 user should be redirected back when the payment has been finished | [optional]
|
8
9
|
|
9
10
|
## Code Sample
|
10
11
|
|
11
12
|
```ruby
|
12
13
|
require 'TransferZero'
|
13
14
|
|
14
|
-
instance = TransferZero::PayinMethodDetailsNGNBank.new(
|
15
|
+
instance = TransferZero::PayinMethodDetailsNGNBank.new(payment_method: null,
|
16
|
+
redirect_url: null)
|
15
17
|
```
|
16
18
|
|
17
19
|
|
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
|
|