bleumi_pay_sdk_ruby 1.0.3 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc384aaf481786ccd3546ddc5358d31d94d13b150b7d6e1452d2516f0a0e84e6
-  data.tar.gz: e3733fd251abb802c79ade9ac224baf851550fcf6551efed73e9b84332bee38f
+  metadata.gz: f674c786edf797b23064688549cc64d5e1a633cebcaf7f6b3c2b8b58be79b339
+  data.tar.gz: e343ecc1b4f1eb38028bda5019fb395c550ba396b4e7dc473ea7331d21966746
 SHA512:
-  metadata.gz: e8960f23b98ec45fc14766ca95b1438c60cdf19f0c187164605d3f1ca8c79e2d7a5ece991317a4593c21b1029658067b2c8cbbbf94eed3e657faaac099f4b28a
-  data.tar.gz: 654e9d7eb14a69596378ecd0fdc092271322cc08e7a697f607216cc872c054ccb51cb4a8c86e7bbf1c55e5bbaa79555c3cc465c6b5d9ea75f51e61617bc18262
+  metadata.gz: 74b19c62f0e23ba0e7e9bac944f025f1dc7534c05cab7cd9dbb28b4a43aaaff966aa2c5b449e0ed7d118903644b7c4ff73ea67c2b32c46314299ae5081b2b291
+  data.tar.gz: 45e6059ba61cb6169c6b6ea1e9080f9393852f91bde03bea6c8f2d495df89d1baae854cb2e262848b7d42bb61f745a0c360b0b49a192c04965ba620c67fdd991

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.0.0'
+  gem 'rake', '~> 13.0.1'
   gem 'pry-byebug'
   gem 'rubocop', '~> 0.66.0'
 end

data/README.md

@@ -1,12 +1,12 @@
-<img src="https://pay.bleumi.com/wp-content/uploads/2019/04/logo_dark_bleumi_invoice_6797x1122.png" height="30">
+<img src="./assets/images/BleumiPay.png" height="30">
 
 # Bleumi Pay SDK for Ruby
 
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/bleumi/bleumi-pay-sdk-ruby/master/LICENSE)
 
-The Bleumi Pay SDK is a one-stop shop to help you integrate ERC-20, Ethereum, xDai payments and/or payouts into your business or application. The SDK bundles [Bleumi Pay API](https://pay.bleumi.com/docs/#introduction) into one SDK to ease implementation and support.
+The Bleumi Pay SDK helps you integrate Algo, Algorand Standard Asset, Ethereum, ERC-20, RSK, RSK ERC-20 & xDai payments and payouts into your business or application. The SDK bundles [Bleumi Pay API](https://pay.bleumi.com/docs/#introduction) into one SDK to ease implementation and support.
 
-bleumi-pay-sdk-ruby is a Ruby library that provides an interface between your Rubu=y application and [Bleumi Pay API](https://pay.bleumi.com/docs/#introduction). This tutorial covers the basics, including examples, needed to use the SDK.
+**bleumi-pay-sdk-ruby** is a Ruby library that provides an interface between your Ruby application and [Bleumi Pay API](https://pay.bleumi.com/docs/#introduction). This tutorial covers the basics, including examples, needed to use the SDK.
 
 ## Getting Started
 
@@ -38,7 +38,7 @@ Add the following in the Gemfile:
 
 ### Run Sample Code
 
-The following code generates a payment request to accept payment from the buyer:
+The following code generates an unique checkout URL to accept payment from the buyer:
 
 
 ```ruby
@@ -50,23 +50,25 @@ BleumiPay.configure do |config|
   config.api_key['x-api-key'] = '<YOUR_API_KEY>'
 end
 
-api_instance = BleumiPay::PayoutsApi.new
-create_payment_request = BleumiPay::CreatePaymentRequest.new # CreatePaymentRequest | 
-opts = {
-  chain: BleumiPay::Chain.new # Chain | Ethereum network in which payment is to be created. Please refer documentation for Supported Networks
-}
+api_instance = BleumiPay::HostedCheckoutsApi.new
+create_checkout_url_request = BleumiPay::CreateCheckoutUrlRequest.new # CreateCheckoutUrlRequest | Specify checkout URL creation parameters.
 
 begin
-  
-  create_payment_request.id = '<ID>'
-  create_payment_request.buyer_address = BleumiPay::EthAddress.new('<BUYER_ADDR>') # Replace <BUYER_ADDR> with the Buyer's Enthereum Network Address
-  create_payment_request.transfer_address = BleumiPay::EthAddress.new('<MERCHANT_ADDR>') # Replace <MERCHANT_ADDR> with the Merchant's Enthereum Network Address
 
-  #Create a payout.
-  result = api_instance.create_payment(create_payment_request, opts)
+  create_checkout_url_request = BleumiPay::CreateCheckoutUrlRequest.new # CreatePayoutRequest | Specify payout creation parameters.
+  create_checkout_url_request.id = '<ID>' # Eg. 1
+  create_checkout_url_request.currency = "<CURRENCY>" # Eg. USD
+  create_checkout_url_request.amount = "<AMOUNT>" # Eg. 10
+  create_checkout_url_request.success_url = "<SUCCESS_URL>" # Eg. https://demo.store/api/completeOrder
+  create_checkout_url_request.cancel_url = "<CANCEL_URL>" # Eg. https://demo.store/api/cancelOrder
+  create_checkout_url_request.token = '<TOKEN>' # Replace <TOKEN>  by anyone of the following values: 'ETH' or 'XDAI' or 'XDAIT' or ECR-20 Contract Address or 'RBTC' or RSK ECR-20 Contract Address or 'Asset ID' of Algorand Standard Asset. | Optional
+  create_checkout_url_request.chain = BleumiPay::Chain::GOERLI # Replace with any Chain as required
+
+  #Generate a unique checkout URL to accept payment.
+  result = api_instance.create_checkout_url(create_checkout_url_request)
   p result
 rescue BleumiPay::ApiError => e
-  puts "Exception when calling PayoutsApi->create_payment: #{e}"
+  puts "Exception when calling HostedCheckoutsApi->create_checkout_url: #{e}"
 end
 ```
 
@@ -76,33 +78,36 @@ More examples can be found under each method in [SDK Classes](#sdk-classes) sect
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-BleumiPay::PaymentsApi | [**create_payment**](docs/PaymentsApi.md#create_payment) | **POST** /v1/payment | Generate a unique wallet address in the specified network to accept payment
+BleumiPay::HostedCheckoutsApi | [**create_checkout_url**](docs/HostedCheckoutsApi.md#create_checkout_url) | **POST** /v1/payment/hc | Generate a unique checkout URL to accept payment.
+BleumiPay::HostedCheckoutsApi | [**list_tokens**](docs/HostedCheckoutsApi.md#list_tokens) | **GET** /v1/payment/hc/tokens | Retrieve all tokens configured for the Hosted Checkout in your account in the [Bleumi Pay Dashboard](https://pay.bleumi.com/app/).
+BleumiPay::HostedCheckoutsApi | [**validate_checkout_payment**](docs/HostedCheckoutsApi.md#validate_checkout_payment) | **POST** /v1/payment/hc/validate | Validate the GET parameters passed by Hosted Checkout in successUrl upon successfully completing payment.
 BleumiPay::PaymentsApi | [**get_payment**](docs/PaymentsApi.md#get_payment) | **GET** /v1/payment/{id} | Retrieve the wallet addresses & token balances for a given payment
 BleumiPay::PaymentsApi | [**list_payments**](docs/PaymentsApi.md#list_payments) | **GET** /v1/payment | Retrieve all payments created.
 BleumiPay::PaymentsApi | [**settle_payment**](docs/PaymentsApi.md#settle_payment) | **POST** /v1/payment/{id}/settle | Settle a specific amount of a token for a given payment to the transferAddress and remaining balance (if any) will be refunded to the buyerAddress
 BleumiPay::PaymentsApi | [**refund_payment**](docs/PaymentsApi.md#refund_payment) | **POST** /v1/payment/{id}/refund | Refund the balance of a token for a given payment to the buyerAddress
 BleumiPay::PaymentsApi | [**get_payment_operation**](docs/PaymentsApi.md#get_payment_operation) | **GET** /v1/payment/{id}/operation/{txid} | Retrieve a payment operation for a specific payment.
 BleumiPay::PaymentsApi | [**list_payment_operations**](docs/PaymentsApi.md#list_payment_operations) | **GET** /v1/payment/{id}/operation | Retrieve all payment operations for a specific payment.
-BleumiPay::HostedCheckoutsApi | [**create_checkout_url**](docs/HostedCheckoutsApi.md#create_checkout_url) | **POST** /v1/payment/hc | Generate a unique checkout URL to accept payment.
-BleumiPay::HostedCheckoutsApi | [**list_tokens**](docs/HostedCheckoutsApi.md#list_tokens) | **GET** /v1/payment/hc/tokens | Retrieve all tokens configured for the Hosted Checkout in your account in the [Bleumi Pay Dashboard](https://pay.bleumi.com/app/).
-BleumiPay::HostedCheckoutsApi | [**validate_checkout_payment**](docs/HostedCheckoutsApi.md#validate_checkout_payment) | **POST** /v1/payment/hc/validate | Validate the GET parameters passed by Hosted Checkout in successUrl upon successfully completing payment.
 BleumiPay::PayoutsApi | [**create_payout**](docs/PayoutsApi.md#create_payout) | **POST** /v1/payout | Create a payout.
 *BleumiPay::PayoutsApi* | [**list_payouts**](docs/PayoutsApi.md#list_payouts) | **GET** /v1/payout | Returns a list of payouts
 
 
 ## Documentation for Models
 
+ - [BleumiPay::AlgorandAddress](docs/AlgorandAddress.md)
+ - [BleumiPay::AlgorandBalance](docs/AlgorandBalance.md)
+ - [BleumiPay::AlgorandWalletAddress](docs/AlgorandWalletAddress.md)
+ - [BleumiPay::AlgorandWalletInputs](docs/AlgorandWalletInputs.md)
  - [BleumiPay::BadRequest](docs/BadRequest.md)
  - [BleumiPay::Chain](docs/Chain.md)
  - [BleumiPay::CheckoutToken](docs/CheckoutToken.md)
  - [BleumiPay::CreateCheckoutUrlRequest](docs/CreateCheckoutUrlRequest.md)
  - [BleumiPay::CreateCheckoutUrlResponse](docs/CreateCheckoutUrlResponse.md)
- - [BleumiPay::CreatePaymentRequest](docs/CreatePaymentRequest.md)
- - [BleumiPay::CreatePaymentResponse](docs/CreatePaymentResponse.md)
  - [BleumiPay::CreatePayoutRequest](docs/CreatePayoutRequest.md)
  - [BleumiPay::CreatePayoutResponse](docs/CreatePayoutResponse.md)
- - [BleumiPay::EthAddress](docs/EthAddress.md)
- - [BleumiPay::NetworkBalance](docs/NetworkBalance.md)
+ - [BleumiPay::EthereumAddress](docs/EthereumAddress.md)
+ - [BleumiPay::EthereumBalance](docs/EthereumBalance.md)
+ - [BleumiPay::EthereumWalletAddress](docs/EthereumWalletAddress.md)
+ - [BleumiPay::EthereumWalletInputs](docs/EthereumWalletInputs.md) 
  - [BleumiPay::PaginatedPaymentOperations](docs/PaginatedPaymentOperations.md)
  - [BleumiPay::PaginatedPayments](docs/PaginatedPayments.md)
  - [BleumiPay::PaginatedPayoutItems](docs/PaginatedPayoutItems.md)
@@ -117,10 +122,10 @@ BleumiPay::PayoutsApi | [**create_payout**](docs/PayoutsApi.md#create_payout) |
  - [BleumiPay::Payout](docs/Payout.md)
  - [BleumiPay::PayoutItem](docs/PayoutItem.md)
  - [BleumiPay::PayoutItemInputs](docs/PayoutItemInputs.md)
- - [BleumiPay::Token](docs/Token.md)
+ - [BleumiPay::RskAddress](docs/RskAddress.md)
+ - [BleumiPay::RskBalance](docs/RskBalance.md)
  - [BleumiPay::ValidateCheckoutRequest](docs/ValidateCheckoutRequest.md)
  - [BleumiPay::ValidateCheckoutResponse](docs/ValidateCheckoutResponse.md)
- - [BleumiPay::WalletAddress](docs/WalletAddress.md)
  - [BleumiPay::WalletBalance](docs/WalletBalance.md)
 
 

data/bleumi_pay_sdk_ruby.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
 
 =begin
-#Bleumi Pay API
+#Bleumi Pay REST API
 
-#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai payments and/or payouts into your business or application
+#A simple and powerful REST API to integrate Algorand, Ethereum, ERC-20 and xDai payments and/or payouts into your business
 
 The version of the OpenAPI document: 1.0.0
 Contact: info@bleumi.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.email       = ["info@bleumi.com"]
   s.homepage    = "https://pay.bleumi.com/"
   s.summary     = "Bleumi Pay API Ruby Gem"
-  s.description = "A simple and powerful REST API to integrate ERC20 payments into your business or application"
+  s.description = "The Bleumi Pay SDK helps you integrate Algo, Algorand Standard Asset, Ethereum, ERC-20, RSK, RSK ERC-20 & xDai payments and payouts into your business or application. The SDK bundles 'Bleumi Pay API' into one SDK to ease implementation and support."
   s.license     = "MIT"
   s.required_ruby_version = ">= 1.9"
 

data/docs/AlgorandAddress.md

@@ -0,0 +1,28 @@
+# BleumiPay::AlgorandAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**alg_mainnet** <br> (Optional)| [**Hash&lt;String, AlgorandWalletAddress&gt;**](AlgorandWalletAddress.md) | A dictionary which gives the address of the wallet generated for Algorand MainNet |
+**alg_testnet** <br> (Optional)| [**Hash&lt;String, AlgorandWalletAddress&gt;**](AlgorandWalletAddress.md) | A dictionary which gives the address of the wallet generated for Algorand TestNet |
+
+## Example
+
+```json
+{
+    "alg_testnet": {
+        "IZYYKSQO3GRZQ4SMAUVV5SVK6N7WUIDBZJCVZEVCHJ2XO22ARMQ3IEEGAQ|QTYQRYMFCS5FT63RUZXBR3MKEEQLHKMHMGMYS4UAPM5CKK27KELGP62QUY": {
+          "addr": "BE2CX2DSRWNNQH6YEAEIDCXKESHJMJTL7BA7U74RUXBEOPLYV4JQA26XXI",
+          "inputs": {
+            "merchant": "IZYYKSQO3GRZQ4SMAUVV5SVK6N7WUIDBZJCVZEVCHJ2XO22ARMQ3IEEGAQ",
+            "salt": "b73cb93c774b6c5fa4fcf2e02acff50fK9gTTRyoF64g1YANSZcydHjzXbRyfCPQNxpDIBegczRdb6Oosfr18g==",
+            "gas": "ARHKCC34GGEDB7ZZE73QMAUKWNXAK3SZWDRECYRVN6AXTPQ7JTFSRDEYCI",
+            "programBytes": "ASYHIEZxhUoO2aOYckwFK17KqvN/aiBhykVckqI6dXdrQIshIITxCOGFFLpZ+3GmbhjtiiEgs6mHYZmJcoB7OiUrX1EWIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIAROoQt8MYgw/zkn9wYCirNuBW5ZsOJBYjVvgXm+H0zLA3BheQVheGZlciDb1gr1RfLUa+ziM7438kcaEMopE3DXemdxEpiWWKhvkzEHKBIxBykSETEJKhIxCSgSMQkpEhExCSsSEREQMQ8nBBIQMRQoEjEUKRIRMRUqEjEVKBIxFSkSEREQMQ8nBRIQETEFAScGEhAxFDEAEhE=",
+            "buyer": "QTYQRYMFCS5FT63RUZXBR3MKEEQLHKMHMGMYS4UAPM5CKK27KELGP62QUY"
+          }
+        }
+      }
+    }
+}
+```

data/docs/AlgorandBalance.md

@@ -0,0 +1,28 @@
+# BleumiPay::AlgorandBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**alg_mainnet** <br>(Optional)| [**Hash&lt;String, WalletBalance&gt;**](WalletBalance.md) | A dictionary which gives the Wallet balances in each Algorand MainNet |   
+**alg_testnet** <br>(Optional)| [**Hash&lt;String, WalletBalance&gt;**](WalletBalance.md) | A dictionary which gives the Wallet balances in each Algorand TestNet | 
+
+## Example - Algorand TestNet
+
+```json 
+{
+    "balances": {
+        "algorand": {
+            "alg_testnet": {
+                "ALGO": {
+                    "blockNum": "4457461",
+                    "token_balance": "10000000",
+                    "balance": "10",
+                    "safety": "high",
+                    "token_decimals": 6
+                }
+            }
+        }
+    }
+}
+```

data/docs/AlgorandWalletAddress.md

@@ -0,0 +1,24 @@
+# BleumiPay::AlgorandWalletAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**addr** | **String** | Wallet address for the payment in the network | 
+**inputs** | [**AlgorandWalletInputs**](AlgorandWalletInputs.md) | Inputs used for the wallet creation | 
+
+
+## Example
+
+```json
+ {
+    "addr": "BEGKKXKFVAIU2PJK274A6GJDQK7J323RLEPMRRFKSDARTX2LFYR6S6VNLM",
+    "inputs": {
+        "buyer": "W5XU4IWCTVBTYXSYIGJYXEPXH2O5S6RPHLF4JK25NEPYT3RACD4Z3EBS4A",
+        "merchant": "CQRMTAHZJA3SIEOTEMZXCAIZKUWE2CCLBCFYQI4NINU43IOTEWT4LOT4IY",
+        "salt": "dbc9d66dca9185c04c8fb6dc201db8f572ICevWSmBwaIL+TZExKWDigc4PDAQwy125SrvxoMHoWHNbS79Dp+w==",
+        "gas": "CQRMTAHZJA3SIEOTEMZXCAIZKUWE2CCLBCFYQI4NINU43IOTEWT4LOT4IY",
+        "programBytes": "ASYGIBQiyYD5SDckEdMjM3EBGVUsTQhLCIuII41Dac2h0yWnILdvTiLCnUM8XlhBk4uR9z6d2XovOsvEq11pH4nuIBD5IAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA3BheQVheGZlciBdtOnkjuxx1Dec/b84B7gMkevLMHGQmt2Q5eDcnAU/KzEHKBIxBykSETEJKhIxCSgSMQkpEhExCSgSEREQMQ8rEhAxFCgSMRQpEhExFSoSMRUoEjEVKRIRERAxDycEEhARMQUBJwUSEDEUMQASEQ=="
+    }
+}
+```

data/docs/AlgorandWalletInputs.md

@@ -0,0 +1,23 @@
+# BleumiPay::AlgorandWalletInputs
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**buyer** | **String** | Buyer Address |
+**merchant** | **String** | Merchant Address |
+**salt** | **String** | Salt |
+**gas** | **String** | Gas account Address |
+**program_bytes** | **String** | Program Bytes |
+
+## Example
+
+```json
+{
+    "buyer": "W5XU4IWCTVBTYXSYIGJYXEPXH2O5S6RPHLF4JK25NEPYT3RACD4Z3EBS4A",
+    "merchant": "CQRMTAHZJA3SIEOTEMZXCAIZKUWE2CCLBCFYQI4NINU43IOTEWT4LOT4IY",
+    "salt": "dbc9d66dca9185c04c8fb6dc201db8f572ICevWSmBwaIL+TZExKWDigc4PDAQwy125SrvxoMHoWHNbS79Dp+w==",
+    "gas": "CQRMTAHZJA3SIEOTEMZXCAIZKUWE2CCLBCFYQI4NINU43IOTEWT4LOT4IY",
+    "programBytes": "ASYGIBQiyYD5SDckEdMjM3EBGVUsTQhLCIuII41Dac2h0yWnILdvTiLCnUM8XlhBk4uR9z6d2XovOsvEq11pH4nuIBD5IAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA3BheQVheGZlciBdtOnkjuxx1Dec/b84B7gMkevLMHGQmt2Q5eDcnAU/KzEHKBIxBykSETEJKhIxCSgSMQkpEhExCSgSEREQMQ8rEhAxFCgSMRQpEhExFSoSMRUoEjEVKRIRERAxDycEEhARMQUBJwUSEDEUMQASEQ=="
+}
+```

data/docs/BadRequest.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**error_code** | **String** | Code for error class. Complete list of error codes is available [here](https://pay.bleumi.com/docs/#errors) | 
+**error_code** | **String** | Code for error class. Complete list of error codes is available here. | 
 **error_message** | **String** | Error description | [optional] 
 

data/docs/Chain.md

@@ -1,11 +1,14 @@
 # BleumiPay::Chain
 
+Network enumeration. Please refer to the [Supported Networks](https://pay.bleumi.com/docs/#supported-networks).
+
 ## Enum
 
 * `MAINNET` (value: `"mainnet"`)
-* `ROPSTEN` (value: `"ropsten"`)
 * `GOERLI` (value: `"goerli"`)
-* `KOVAN` (value: `"kovan"`)
-* `RINKEBY` (value: `"rinkeby"`)
 * `XDAI` (value: `"xdai"`)
 * `XDAI_TESTNET` (value: `"xdai_testnet"`)
+* `ALG_MAINNET` (value: `"alg_mainnet"`)
+* `ALG_TESTNET` (value: `"alg_testnet"`)
+* `RSK` (value: `"rsk"`)
+* `RSK_TESTNET` (value: `"rsk_testnet"`)

data/docs/CheckoutToken.md

@@ -4,20 +4,25 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**network** | **String** | The network in which the token is defined | 
 **chain** | **String** | The chain in which the token is defined | 
-**transfer_address** | **String** | The destination address when payments are received in this token | 
+**addr** | **String** | The address of the token | 
 **name** | **String** | Name of the token | 
 **symbol** | **String** | Symbol of the token | 
-**decimals** | **String** | The decimal places supported | 
+**currency** | **string** | Currency of the token |
+**decimals** | **Integer** | Token decimal places | 
+
 
 ## Example
 
 ```json
 {
-      "chain": "ropsten",
+      "network": "ethereum",
+      "chain": "goerli",
       "transferAddress": "0xd15bdd17175825742a5904b21008dd3a019a060e",
       "name": "USD p18",
       "symbol": "USD18",
+      "currency": "USD",
       "decimals": 18
 }
 ```

data/docs/CreateCheckoutUrlRequest.md

@@ -4,15 +4,15 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | Unique identifier for this payment. <br> <b>Warning!</b> - Do not reuse this id with the [Create a Payment](PaymentApi.md#create_payment) endpoint. |
+**id** | **String** | Unique identifier for this payment. <br> <b>Warning!</b> - Do not reuse this id with the [Create a Payment](https://pay.bleumi.com/docs/#create-a-payment) endpoint. |
 **currency** | **String** | Currency Code<br><br> When you configure custom tokens for the Hosted Checkout in your account in the <a href="https://pay.bleumi.com/app/" target="_blank">Bleumi Pay Dashboard</a>, please use:<br> - ISO 4217 Alphabetic Code for fiat, gold, silver, etc.<br> - Token Symbol for crypto |
 **amount** | **String** | Token amount for this payment | 
 **cancel_url** | **String** | Buyer will be redirected to this URL upon canceling the payment. | 
-**success_url** | **String** | Buyer will be redirected to this URL upon successfully completing the payment and the following data is passed as GET parameters, <ul style="font-weight: 500"><li><b>id</b> - Unique identifier of the checkout URL</li><li><b>hmac.input</b> - Payment parameters used to generate HMAC. The format is described below.</li><li><b>hmac.keyId</b> - Key ID used to generate HMAC</li><li><b>hmac.alg</b> - Algorithm used to generate HMAC</li><li><b>hmac.value</b> - HMAC generated for hmac.input</li></ul> 
-**BuyerAddress**<br>(Optional) | [**EthAddress**](EthAddress.md) | Refund address for this payment.
-You can set this to your address to manually handle refunds (outside of Bleumi Pay) to your buyer. | [optional] 
-**token**<br>(Optional) | [**Token**](Token.md) | If this field is not specified, a list of tokens configured for the provided currency code for the Hosted Checkout in your account in the <a href="https://pay.bleumi.com/app/" target="_blank">Bleumi Pay Dashboard</a> is sent to the buyer. The buyer can complete the payment using any one of token from this list. <br><br> Set the token which must be used by the buyer for this payment. The token provided must be set in your portal for the provided currency code. The token is assumed to be 1:1 with the currency unit. <br><br> <b>ETH</b> - for Ethereum<br> <b>XDAI</b> - for xDai<br> <b>XDAIT</b> - for xDai Testnet<br> <b>&lt;contract address of ERC-20 token&gt;</b> - for ERC-20; Please refer to [ERC-20 Tokens](https://pay.bleumi.com/docs/#erc-20) for contract address; | [optional]
-**Chain**<br>(Optional) | [**Chain**](Chain.md) | (Required if specifying 'token') Network in which the hosted checkout is to be created. Please refer to the [Supported Networks.](https://pay.bleumi.com/docs/#supported-networks) | [optional] 
+**success_url** | **String** | Buyer will be redirected to this URL upon successfully completing the payment and the following data is passed as GET parameters, <ul style="font-weight: 500"><li><b>id</b> - Unique identifier of the checkout URL</li><li><b>hmac_input</b> - Payment parameters used to generate HMAC. The format is described below.</li> <li><b>hmac_keyId</b> - Key ID used to generate HMAC</li> <li><b>hmac_alg</b> - Algorithm used to generate HMAC</li> <li><b>hmac_value</b> - HMAC generated for hmac.input</li></ul> | 
+**transfer_address**<br>(Optional)| **String** | Payment transfer address (only used in case of Marketplace payments). Use this field to override the token's settlement address specified in the Bleumi Pay Dashboard for the payment. | [optional] 
+**chain** <br>(Optional)| [**Chain**](Chain.md) | (Required if specifying 'token') Network in which the hosted checkout is to be created. Please refer to the [Supported Networks.](https://pay.bleumi.com/docs/#supported-networks) |
+**token** <br>(Optional)| **String** |  If this field is not specified, a list of tokens configured for the provided currency code for the Hosted Checkout in your account in the <a href="https://pay.bleumi.com/app/" target="_blank"> Bleumi Pay Dashboard</a> is sent to the buyer. The buyer can complete the payment using any one of token from this list. <br><br> Set the token which must be used by the buyer for this payment. The token provided must be set in your portal for the provided currency code. The token is assumed to be 1:1 with the currency unit. <br><br> <b>ETH</b> - for Ethereum  <br/> <b>XDAI</b> - for xDai <br/> <b>XDAIT</b> - for xDai Testnet <br/> <b>ALGO</b> - for Algo <br/> <b>RBTC</b> - for R-BTC <br/> <b> &lt;asset id&gt;</b> - for Algorand Standard Asset <br/> <b> &lt;contract address of ERC-20 token&gt;</b> - for ERC-20 Tokens. Please refer to [ERC-20 Tokens](https://pay.bleumi.com/docs/#erc-20) for contract address; <br/> <b> &lt;contract address of RSK ERC-20 token&gt;</b> - for RSK ERC-20 Tokens. Please refer to [RSK ERC-20 Tokens](https://pay.bugnet.work/docs/#rsk-tokens-erc-20) for contract address;|
+**base64_transform** <br>(Optional)| **Boolean** | Base64 encode hmac_input GET parameter passed to the successUrl | 
 
 ## Example
 
@@ -24,7 +24,6 @@ You can set this to your address to manually handle refunds (outside of Bleumi P
     "cancelUrl": "https://demo.store/api/cancelOrder",
     "successUrl": "https://demo.store/api/completeOrder",
     "token":"0x115615dbd0f835344725146fa6343219315f15e5",
-    "chain":"ropsten",
-    "buyerAddress":"0x713883BF69B786f0A7aB6E2248a70C50577F6b34"
+    "chain":"goerli"
 }
 ```

data/docs/CreatePayoutRequest.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **txid** | **String** | Unique identifier for this payout | 
-**token** | [**Token**](Token.md) | <b>ETH</b> - for Ethereum  <br/> <b>XDAI</b> - for xDai <br/> <b>XDAIT</b> - for xDai Testnet <br/> <b> &lt;contract address of ERC-20 token&gt;</b> - for ERC-20 Tokens  | 
+**token** | **String** | <b>ETH</b> - for Ethereum  <br/> <b>XDAI</b> - for xDai <br/> <b>XDAIT</b> - for xDai Testnet <br/> <b>ALGO</b> - for Algo <br/> <b>RBTC</b> - for R-BTC <br/> <b> &lt;asset id&gt;</b> - for Algorand Standard Asset <br/> <b> &lt;contract address of ERC-20 token&gt;</b> - for ERC-20 Tokens. Please refer to [ERC-20 Tokens](https://pay.bleumi.com/docs/#erc-20) for contract address; <br/>  <b> &lt;contract address of RSK ERC-20 token&gt;</b> - for RSK ERC-20 Tokens. Please refer to [RSK ERC-20 Tokens](https://pay.bugnet.work/docs/#rsk-tokens-erc-20) for contract address;|
 **payouts** | [**Array&lt;Payout&gt;**](Payout.md) | Array of payments to be made in this payout. This is an atomic transaction (i.e. either all payments are processed or all of them are rejected). | 
 
 ## Example

data/docs/CreatePayoutResponse.md

@@ -10,6 +10,6 @@ Name | Type | Description | Notes
 
 ```json
 {
-  "salt": "0x09d6f6e0c0c781a6c49153db62c72e4d8b159f742a42e8c4cfb18fc2b9c44224"
+  "addr": "0xbea2f9d56c3cc7f2c7e17d294200dd75708eecd8"
 }
 ```

data/docs/EthereumAddress.md

@@ -0,0 +1,29 @@
+# BleumiPay::EthereumAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mainnet** | [**Hash<String, EthereumWalletAddress>**](EthereumWalletAddress.md) | A dictionary which gives the address of the wallet generated for Ethereum MainNet |
+**goerli** | [**Hash<String, EthereumWalletAddress>**](EthereumWalletAddress.md) | A dictionary which gives the address of the wallet generated for Goerli TestNet |
+**xdai** | [**Hash<String, EthereumWalletAddress>**](EthereumWalletAddress.md) | A dictionary which gives the address of the wallet generated for xDAI MainNet |
+**xdai_testnet** | [**Hash<String, EthereumWalletAddress>**](EthereumWalletAddress.md) | A dictionary which gives the address of the wallet generated for xDAI TestNet |
+
+## Example
+
+```json
+{
+      "xdai_testnet": {
+        "0x13e4acefe6a6700604929946e70e6443e4e73447|0x13e4acefe6a6700604929946e70e6443e4e73447":{
+          "addr": "0xbe1fa332f24ba568108ba55a25eccf93d882f54e",
+          "inputs": {
+            "buyer": "0x13e4acefe6a6700604929946e70e6443e4e73447",
+            "walletLibrary": "0xb33893fdf59b634653fcbed27b5d38d86710fc40",
+            "merchant": "0x13e4acefe6a6700604929946e70e6443e4e73447",
+            "salt": "0x4d5afc486391108fd9af8e33cec2caa8038899c7974fae22a3c3bb0d127ab8a7",
+            "walletProxy": "0xfaac6b338f79cfd8a53dfec95263f12ef046a049"
+          }
+        }
+      }
+}
+```

data/docs/EthereumBalance.md

@@ -0,0 +1,30 @@
+# BleumiPay::EthereumBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mainnet** <br>(Optional) | [**Hash&lt;String, WalletBalance&gt;**](WalletBalance.md) | A dictionary which gives the token balances in Ethereum MainNet |
+**goerli** <br>(Optional) | [**Hash&lt;String, WalletBalance&gt;**](WalletBalance.md) | A dictionary which gives the token balances in Ethereum Goerli TestNet |
+**xdai** <br>(Optional) | [**Hash&lt;String, WalletBalance&gt;**](WalletBalance.md) | A dictionary which gives the token balances in xDAI | 
+**xdai_testnet** <br>(Optional) | [**Hash&lt;String, WalletBalance&gt;**](WalletBalance.md) | A dictionary which gives the token balances in xDAI TestNet |
+
+## Example - Goerli - TestNet
+
+```json
+{
+    "balances": {
+        "ethereum": {
+            "goerli": {
+                "0x115615dbd0f835344725146fa6343219315f15e5": {
+                    "blockNum": "2049977",
+                    "token_balance": "10000000",
+                    "balance": "10",
+                    "safety": "high",
+                    "token_decimals": 6
+                }
+            }
+        }
+    }
+}
+```