bleumi_pay_sdk_ruby 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb14b4320f3d028617902cc9113626a5d0e973c71fdad64009b29a47cb6e20dc
-  data.tar.gz: f5b85bbaf36c6df463c51d32305a55f79257c2bc36a8d693bcac99ef08d195b6
+  metadata.gz: cc384aaf481786ccd3546ddc5358d31d94d13b150b7d6e1452d2516f0a0e84e6
+  data.tar.gz: e3733fd251abb802c79ade9ac224baf851550fcf6551efed73e9b84332bee38f
 SHA512:
-  metadata.gz: d4ea80d9397c9c777ab8f10111345c12786576d56be488c9db150a42b916b6e20eb62d82ced47e4f9e398e7d57f962c1419504e08ee75712b2024f1305f5e528
-  data.tar.gz: 5b3424cdfefe5b8b7e3592ee3266bf5d0193f90d4541f456a174dc30f10066eb8d2cfaa5cc821e87f17a1416758f6ea2336720fae891650c7ce0590e155b1103
+  metadata.gz: e8960f23b98ec45fc14766ca95b1438c60cdf19f0c187164605d3f1ca8c79e2d7a5ece991317a4593c21b1029658067b2c8cbbbf94eed3e657faaac099f4b28a
+  data.tar.gz: 654e9d7eb14a69596378ecd0fdc092271322cc08e7a697f607216cc872c054ccb51cb4a8c86e7bbf1c55e5bbaa79555c3cc465c6b5d9ea75f51e61617bc18262

data/README.md

@@ -4,7 +4,7 @@
 
 [![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 ECR-20 payments 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 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.
 
 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.
 
@@ -36,42 +36,38 @@ Add the following in the Gemfile:
 
     gem 'bleumi_pay_sdk_ruby', :git => 'https://github.com/bleumi/bleumi_pay_sdk_ruby.git'
 
-
 ### Run Sample Code
 
-The following code generates a wallet to accept payment from the buyer specific for the ECR-20 Token.
+The following code generates a payment request to accept payment from the buyer:
+
 
 ```ruby
-# Load the gem
+# load the gem
 require 'bleumi_pay_sdk_ruby'
-
-# Setup authorization
+# setup authorization
 BleumiPay.configure do |config|
   # Configure API key authorization: ApiKeyAuth
   config.api_key['x-api-key'] = '<YOUR_API_KEY>'
 end
 
-api_instance = BleumiPay::Erc20PaymentsApi.new
-wallet_create_input = BleumiPay::WalletCreateInput.new # WalletCreateInput |
+api_instance = BleumiPay::PayoutsApi.new
+create_payment_request = BleumiPay::CreatePaymentRequest.new # CreatePaymentRequest | 
 opts = {
-  chain: BleumiPay::EthNetwork::ROPSTEN # EthNetwork | Ethereum network in which wallet is to be created.
+  chain: BleumiPay::Chain.new # Chain | Ethereum network in which payment is to be created. Please refer documentation for Supported Networks
 }
 
-buyer_address = BleumiPay::EthAddress.new('<BUYER_ADDR>') # Replace <BUYER_ADDR> with the Buyer's Enthereum Network Address
-transfer_address = BleumiPay::EthAddress.new('<MERCHANT_ADDR>') # Replace <MERCHANT_ADDR> with the Merchant's Enthereum Network Address
-
-wallet_create_input.id = '<ID>'
-wallet_create_input.buyer_address = buyer_address
-wallet_create_input.transfer_address = transfer_address
-
 begin
-  #Generate an unique wallet address to accept payments for an ERC-20 token from a buyer
-  result = api_instance.generate_wallet(wallet_create_input, opts)
+  
+  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)
   p result
 rescue BleumiPay::ApiError => e
-  puts "Exception when calling Erc20PaymentsApi->generate_wallet: #{e}"
+  puts "Exception when calling PayoutsApi->create_payment: #{e}"
 end
-
 ```
 
 More examples can be found under each method in [SDK Classes](#sdk-classes) section.
@@ -80,31 +76,53 @@ More examples can be found under each method in [SDK Classes](#sdk-classes) sect
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-Erc20PaymentsApi | [**generate_wallet**](docs/Erc20PaymentsApi.md#generate_wallet) | **POST** /v1/payment/eth/wallet | Generates an unique wallet address to accept payments for an ERC-20 token.
-Erc20PaymentsApi | [**get_wallet**](docs/Erc20PaymentsApi.md#get_wallet) | **GET** /v1/payment/eth/wallet/{id} | Retrieve a wallet.
-Erc20PaymentsApi | [**list_wallets**](docs/Erc20PaymentsApi.md#list_wallets) | **GET** /v1/payment/eth/wallet | Retrieve all wallets.
-Erc20PaymentsApi | [**settle_wallet**](docs/Erc20PaymentsApi.md#settle_wallet) | **POST** /v1/payment/eth/wallet/{id}/settle | This method settles a specific amount of an ERC-20 token of a wallet to the transferAddress specified during [Generate Wallet](/docs/Erc20PaymentsApi.md#generatewallet)
-Erc20PaymentsApi | [**refund_wallet**](docs/Erc20PaymentsApi.md#refund_wallet) | **POST** /v1/payment/eth/wallet/{id}/refund | This method refunds the balance of an ERC-20 token of a wallet to the buyerAddress specified during [Generate Wallet](/docs/Erc20PaymentsApi.md#generatewallet).
-Erc20PaymentsApi | [**get_wallet_operation**](docs/Erc20PaymentsApi.md#get_wallet_operation) | **GET** /v1/payment/eth/wallet/{id}/operation/{txid} | Retrieve an operation of a wallet
-Erc20PaymentsApi | [**list_wallet_operations**](docs/Erc20PaymentsApi.md#list_wallet_operations) | **GET** /v1/payment/eth/wallet/{id}/operation | Retrieve all operations of a wallet.
+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::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
 
- - [BadRequest](docs/BadRequest.md)
- - [EthAddress](docs/EthAddress.md)
- - [EthNetwork](docs/EthNetwork.md)
- - [PaginatedWalletOperations](docs/PaginatedWalletOperations.md)
- - [PaginatedWallets](docs/PaginatedWallets.md)
- - [Wallet](docs/Wallet.md)
- - [WalletBalance](docs/WalletBalance.md)
- - [WalletCreateInput](docs/WalletCreateInput.md)
- - [WalletCreateOutput](docs/WalletCreateOutput.md)
- - [WalletInputs](docs/WalletInputs.md)
- - [WalletOperation](docs/WalletOperation.md)
- - [WalletOperationInputs](docs/WalletOperationInputs.md)
- - [WalletOperationOutput](docs/WalletOperationOutput.md)
- - [WalletRefundOperationInput](docs/WalletRefundOperationInput.md)
- - [WalletSettleOperationInput](docs/WalletSettleOperationInput.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::PaginatedPaymentOperations](docs/PaginatedPaymentOperations.md)
+ - [BleumiPay::PaginatedPayments](docs/PaginatedPayments.md)
+ - [BleumiPay::PaginatedPayoutItems](docs/PaginatedPayoutItems.md)
+ - [BleumiPay::Payment](docs/Payment.md)
+ - [BleumiPay::PaymentAddresses](docs/PaymentAddresses.md)
+ - [BleumiPay::PaymentBalances](docs/PaymentBalances.md)
+ - [BleumiPay::PaymentOperation](docs/PaymentOperation.md)
+ - [BleumiPay::PaymentOperationInputs](docs/PaymentOperationInputs.md)
+ - [BleumiPay::PaymentOperationResponse](docs/PaymentOperationResponse.md)
+ - [BleumiPay::PaymentRefundRequest](docs/PaymentRefundRequest.md)
+ - [BleumiPay::PaymentSettleRequest](docs/PaymentSettleRequest.md)
+ - [BleumiPay::Payout](docs/Payout.md)
+ - [BleumiPay::PayoutItem](docs/PayoutItem.md)
+ - [BleumiPay::PayoutItemInputs](docs/PayoutItemInputs.md)
+ - [BleumiPay::Token](docs/Token.md)
+ - [BleumiPay::ValidateCheckoutRequest](docs/ValidateCheckoutRequest.md)
+ - [BleumiPay::ValidateCheckoutResponse](docs/ValidateCheckoutResponse.md)
+ - [BleumiPay::WalletAddress](docs/WalletAddress.md)
+ - [BleumiPay::WalletBalance](docs/WalletBalance.md)
+
 
 ## Limitations
 
@@ -114,4 +132,4 @@ Erc20PaymentsApi | [**list_wallet_operations**](docs/Erc20PaymentsApi.md#list_wa
 
 Copyright 2019 Bleumi, Inc.
 
-Code licensed under the [MIT License](LICENSE).
+Code licensed under the [MIT License](LICENSE).

data/bleumi_pay_sdk_ruby.gemspec

@@ -3,12 +3,12 @@
 =begin
 #Bleumi Pay API
 
-#A simple and powerful REST API to integrate ERC20 payments into your business or application
+#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai payments and/or payouts into your business or application
 
 The version of the OpenAPI document: 1.0.0
 Contact: info@bleumi.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.0
+OpenAPI Generator version: 4.2.2
 
 =end
 
@@ -36,5 +36,4 @@ Gem::Specification.new do |s|
   s.test_files    = `find spec/*`.split("\n")
   s.executables   = []
   s.require_paths = ["lib"]
-  s.metadata    = { "source_code_uri" => "https://github.com/bleumi/bleumi-pay-sdk-ruby" }
 end

data/docs/BadRequest.md

@@ -6,3 +6,4 @@ 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_message** | **String** | Error description | [optional] 
+

data/docs/Chain.md

@@ -0,0 +1,11 @@
+# BleumiPay::Chain
+
+## Enum
+
+* `MAINNET` (value: `"mainnet"`)
+* `ROPSTEN` (value: `"ropsten"`)
+* `GOERLI` (value: `"goerli"`)
+* `KOVAN` (value: `"kovan"`)
+* `RINKEBY` (value: `"rinkeby"`)
+* `XDAI` (value: `"xdai"`)
+* `XDAI_TESTNET` (value: `"xdai_testnet"`)

data/docs/CheckoutToken.md

@@ -0,0 +1,23 @@
+# BleumiPay::CheckoutToken
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**chain** | **String** | The chain in which the token is defined | 
+**transfer_address** | **String** | The destination address when payments are received in this token | 
+**name** | **String** | Name of the token | 
+**symbol** | **String** | Symbol of the token | 
+**decimals** | **String** | The decimal places supported | 
+
+## Example
+
+```json
+{
+      "chain": "ropsten",
+      "transferAddress": "0xd15bdd17175825742a5904b21008dd3a019a060e",
+      "name": "USD p18",
+      "symbol": "USD18",
+      "decimals": 18
+}
+```

data/docs/CreateCheckoutUrlRequest.md

@@ -0,0 +1,30 @@
+# BleumiPay::CreateCheckoutUrlRequest
+
+## Properties
+
+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. |
+**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] 
+
+## Example
+
+```json
+{
+    "id": "4",
+    "currency": "USD",
+    "amount": "10",
+    "cancelUrl": "https://demo.store/api/cancelOrder",
+    "successUrl": "https://demo.store/api/completeOrder",
+    "token":"0x115615dbd0f835344725146fa6343219315f15e5",
+    "chain":"ropsten",
+    "buyerAddress":"0x713883BF69B786f0A7aB6E2248a70C50577F6b34"
+}
+```

data/docs/CreateCheckoutUrlResponse.md

@@ -0,0 +1,17 @@
+# BleumiPay::CreateCheckoutUrlResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier generated for this checkout URL | 
+**url** | **String** | URL for buyer to complete payment | 
+
+## Example
+
+```json
+{
+  "id": "TBCItOjmR52dFo1a6JxCqQ",
+  "url": "https://pay.bleumi.io/?id=TBCItOjmR52dFo1a6JxCqQ"
+}
+```

data/docs/CreatePaymentRequest.md

@@ -0,0 +1,19 @@
+# BleumiPay::CreatePaymentRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique ID identifying the payment | 
+**buyer_address** | [**EthAddress**](EthAddress.md) |  Address of buyer. Refund operations on this wallet will use this address. You can set this to your address to manually handle refunds (outside of Bleumi Pay) to your buyer. <br/> <b>Warning!</b> - This address must be able to receive payments from smart contracts.| 
+**transfer_address** | [**EthAddress**](EthAddress.md) | Your deposit address. Settle operations on this wallet will use this address. <br/> <b>Warning!</b> - This address must be able to receive payments from smart contracts.| 
+
+## Example
+
+```json
+{
+    "id": "1",
+    "buyerAddress": "0xD15BDD17175825742A5904b21008dd3A019a060E",
+    "transferAddress": "0x7Dc30B85084aA1608e5C1Ce39c804Be177e40A07"
+}
+```

data/docs/CreatePaymentResponse.md

@@ -0,0 +1,15 @@
+# BleumiPay::CreatePaymentResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**addr** | **String** | Wallet address | The unique wallet address generated
+
+## Example
+
+```json
+{
+  "addr": "0xbea2f9d56c3cc7f2c7e17d294200dd75708eecd8"
+}
+```

data/docs/CreatePayoutRequest.md

@@ -0,0 +1,28 @@
+# BleumiPay::CreatePayoutRequest
+
+## Properties
+
+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  | 
+**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
+
+```json
+{
+    "txid": "12345-6789",
+    "token": "0x84df8548086EC9025E9C93297058Bed706E90DDD",
+    "payouts": [
+        {
+            "transferAddress": "0xD15BDD17175825742A5904b21008dd3A019a060E",
+            "amount": "1"
+        },
+        {
+            "transferAddress": "0x7Dc30B85084aA1608e5C1Ce39c804Be177e40A07",
+            "amount": "1"
+        }
+    ]
+}
+```

data/docs/CreatePayoutResponse.md

@@ -0,0 +1,15 @@
+# BleumiPay::CreatePayoutResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**salt** | **String** | Unique id generated for the given txid | 
+
+## Example
+
+```json
+{
+  "salt": "0x09d6f6e0c0c781a6c49153db62c72e4d8b159f742a42e8c4cfb18fc2b9c44224"
+}
+```

data/docs/EthAddress.md

@@ -4,5 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**addr** | **String** | Valid Ethereum address string should pass validation pattern: '^0x[a-fA-F0-9]{40}$'| Eg. 0x13e4ACeFE6a6700604929946E70E6443E4E73447
+**addr** | **String** | Valid Ethereum address string should pass validation pattern: '^0x[a-fA-F0-9]{40}$' | 
 
+## Example
+
+```json
+0x13e4ACeFE6a6700604929946E70E6443E4E73447
+```

data/docs/HostedCheckoutsApi.md

@@ -0,0 +1,190 @@
+# BleumiPay::HostedCheckoutsApi
+
+
+## create_checkout_url
+
+> CreateCheckoutUrlResponse create_checkout_url(create_checkout_url_request)
+
+This method generates a unique checkout URL to accept payment.
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::HostedCheckoutsApi.new
+create_checkout_url_request = BleumiPay::CreateCheckoutUrlRequest.new # CreateCheckoutUrlRequest | Specify checkout URL creation parameters.
+
+begin
+
+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 = BleumiPay::Token.new('<TOKEN>') # Replace <TOKEN> with ETH or XDAI or ERC-20 Token Contract Address or XDAIT
+create_checkout_url_request.chain = BleumiPay::Chain::ROPSTEN #
+create_checkout_url_request.buyer_address = BleumiPay::EthAddress.new('<BUYER_ADDR>') # Replace <BUYER_ADDR> with the buyer's Ethereum Address
+
+
+  #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 HostedCheckoutsApi->create_checkout_url: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_checkout_url_request** | [**CreateCheckoutUrlRequest**](CreateCheckoutUrlRequest.md)| Specify checkout URL creation parameters. | 
+
+### Return type
+
+[**CreateCheckoutUrlResponse**](CreateCheckoutUrlResponse.md)
+
+Field | Type | Description
+----- | ----- | -----
+id | string | Unique identifier generated for this checkout URL
+url | string | URL for buyer to complete payment
+
+### Format - hmac.input GET parameter passed in successUrl
+
+The hmac.input GET parameter passed to successUrl contains payment parameters as a pipe ('|') separated string in the following order,
+<ul style="font-weight: 500">
+    <li><b>Chain</b> - Please refer documentation for <a href="https://pay.bleumi.com/docs/#supported-networks" target="_blank">Supported Networks</a> </li>
+    <li><b>Wallet Address</b></li>
+    <li><b>Token</b><br> <i>ETH</i> - for Ethereum<br> <i>XDAI</i> - for xDai<br> <i>XDAIT</i> - for xDai Testnet<br> <i>&lt;contract address of ERC-20 token&gt;</i> - for ERC-20; Please refer to [ERC-20 Tokens](/docs/#erc-20) for contract address;</li>
+    <li><b>Amount</b> - Token amount for the payment</li>
+    <li><b>Number of block confirmations</b><br> <i>12</i> - for ETH<br> <i>0</i> - for XDAI<br> <i>0</i> - for XDAIT<br> <i>12</i> - for ERC-20</li></li>
+</ul>
+
+<aside class="notice">
+Call [Validate a Checkout Payment](#validate_checkout_payment) method to validate the GET parameters passed in successUrl and then cross-check the payment parameters of hmac.input GET parameter with your database.
+</aside>
+
+
+### 400 Errors
+
+The following table is a list of possible error codes that can be returned, along with additional information about how to resolve them for a response with 400 status code.
+
+errorCode <br> <i>errorMessage</i> | Description
+---- | ----
+ValidationError <br> <i>&lt;details&gt;</i> | Details on input which does not conform to the above schema
+ValidationError <br> <i>no_tokens_defined</i> | Please configure tokens for the Hosted Checkout in your account in the <a href="https://pay.bleumi.com/app/" target="_blank">Bleumi Pay Dashboard</a>
+ValidationError <br> <i>no_tokens_defined_for_currency</i> | No tokens have been defined in your account for the specified currency
+ValidationError <br> <i>invalid_token</i> | The token provided is not valid for the specified currency
+
+
+## list_tokens
+
+> CheckoutTokens list_tokens
+
+Retrieve all tokens configured for the Hosted Checkout in your account in the [Bleumi Pay Dashboard](https://pay.bleumi.com/app/).
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::HostedCheckoutsApi.new
+
+begin
+  #Retrieve all tokens configured for the Hosted Checkout in your account in the [Bleumi Pay Dashboard](https://pay.bleumi.com/app/).
+  result = api_instance.list_tokens
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling HostedCheckoutsApi->list_tokens: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CheckoutTokens**](CheckoutTokens.md)
+
+
+### 400 Errors
+
+The following table is a list of possible error codes that can be returned, along with additional information about how to resolve them for a response with 400 status code.
+
+errorCode <br> <i>errorMessage</i> | Description
+---- | ----
+ValidationError <br> <i>no_tokens_defined</i> | No tokens have been defined in your account
+
+
+## validate_checkout_payment
+
+> ValidateCheckoutResponse validate_checkout_payment(validate_checkout_request)
+
+Validate the GET parameters passed by Hosted Checkout in successUrl upon successfully completing payment.
+
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::HostedCheckoutsApi.new
+
+begin
+  validate_checkout_request = BleumiPay::ValidateCheckoutRequest.new # ValidateCheckoutRequest | Specify validation of checkout parameters.
+  validate_checkout_request.hmac_alg = '<ALD>' # Eg. HMAC-SHA256-HEX
+  validate_checkout_request.hmac_input = '<INPUT>' # Eg. ropsten|0xbe33cde200e113f4847c66e9498f2c30e81635ad|0x115615dbd0f835344725146fa6343219315f15e5|10|12
+  validate_checkout_request.hmac_key_id = '<VER>' # Eg. v1
+  validate_checkout_request.hmac_value = '<HMAC_VALUE>' # Eg. 0d910e8dfd087dd0d0b7c3f6504f7f4316b507afc81c09e844cfeee0f3dbaef6
+  #Validate the GET parameters passed by Hosted Checkout in successUrl upon successfully completing payment.
+  result = api_instance.validate_checkout_payment(validate_checkout_request)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling HostedCheckoutsApi->validate_checkout_payment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **validate_checkout_request** | [**ValidateCheckoutRequest**](ValidateCheckoutRequest.md)| Specify validation of checkout parameters. | 
+
+### Return type
+
+[**ValidateCheckoutResponse**](ValidateCheckoutResponse.md)
+
+Field | Type | Description
+----- | ----- | -----
+valid | boolean | <b>true</b> - The data has been generated by Bleumi Pay <br> <b>false</b> - The data has not been generated by Bleumi Pay, the payment must be treated as unpaid
+
+### 400 Errors
+
+The following table is a list of possible error codes that can be returned, along with additional information about how to resolve them for a response with 400 status code.
+
+errorCode <br> <i>errorMessage</i> | Description
+---- | ----
+ValidationError <br> <i>&lt;details&gt;</i> | Details on input which does not conform to the above schema