bleumi_pay_sdk_ruby 1.0.2 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb14b4320f3d028617902cc9113626a5d0e973c71fdad64009b29a47cb6e20dc
-  data.tar.gz: f5b85bbaf36c6df463c51d32305a55f79257c2bc36a8d693bcac99ef08d195b6
+  metadata.gz: 2516d7bc08d49d915d4ee4c530a9928635d54a5ffefead3092129d401ab27afe
+  data.tar.gz: 9a95feecb24b512e60e14e1a7f6da2a84e4f65ebb7a001eebd49d3544306eceb
 SHA512:
-  metadata.gz: d4ea80d9397c9c777ab8f10111345c12786576d56be488c9db150a42b916b6e20eb62d82ced47e4f9e398e7d57f962c1419504e08ee75712b2024f1305f5e528
-  data.tar.gz: 5b3424cdfefe5b8b7e3592ee3266bf5d0193f90d4541f456a174dc30f10066eb8d2cfaa5cc821e87f17a1416758f6ea2336720fae891650c7ce0590e155b1103
+  metadata.gz: f17f1028e071ebd35c5ba82c7043e7c62a3da57c5ee4fae50da9b14d7b5e28ce24f501d50587229013f138e2ab9ecf73039885f61621ecb76ae780c5a641a1c2
+  data.tar.gz: c57949398c04c9dffe9dd0124c3d22de9bb70da39c8ba1ad6b9a4f03d885c0dbc27109b98141ee1e2b8e750082b70d7f88b4eb79198ff51e515979d71389c127

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 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 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
 
@@ -36,42 +36,40 @@ 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 an unique checkout URL 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 |
-opts = {
-  chain: BleumiPay::EthNetwork::ROPSTEN # EthNetwork | Ethereum network in which wallet is to be created.
-}
-
-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
+api_instance = BleumiPay::HostedCheckoutsApi.new
+create_checkout_url_request = BleumiPay::CreateCheckoutUrlRequest.new # CreateCheckoutUrlRequest | Specify checkout URL creation parameters.
 
 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_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 Erc20PaymentsApi->generate_wallet: #{e}"
+  puts "Exception when calling HostedCheckoutsApi->create_checkout_url: #{e}"
 end
-
 ```
 
 More examples can be found under each method in [SDK Classes](#sdk-classes) section.
@@ -80,31 +78,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::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::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::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::CreatePayoutRequest](docs/CreatePayoutRequest.md)
+ - [BleumiPay::CreatePayoutResponse](docs/CreatePayoutResponse.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)
+ - [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::RskBalance](docs/RskBalance.md)
+ - [BleumiPay::ValidateCheckoutRequest](docs/ValidateCheckoutRequest.md)
+ - [BleumiPay::ValidateCheckoutResponse](docs/ValidateCheckoutResponse.md)
+ - [BleumiPay::WalletBalance](docs/WalletBalance.md)
+
 
 ## Limitations
 
@@ -114,4 +134,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

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
 
 =begin
-#Bleumi Pay API
+#Bleumi Pay REST API
 
-#A simple and powerful REST API to integrate ERC20 payments 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.0
+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"
 
@@ -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/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,5 +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

@@ -0,0 +1,14 @@
+# BleumiPay::Chain
+
+Network enumeration. Please refer to the [Supported Networks](https://pay.bleumi.com/docs/#supported-networks).
+
+## Enum
+
+* `MAINNET` (value: `"mainnet"`)
+* `GOERLI` (value: `"goerli"`)
+* `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

@@ -0,0 +1,28 @@
+# BleumiPay::CheckoutToken
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**network** | **String** | The network in which the token is defined | 
+**chain** | **String** | The chain in which the token is defined | 
+**addr** | **String** | The address of the token | 
+**name** | **String** | Name of the token | 
+**symbol** | **String** | Symbol of the token | 
+**currency** | **string** | Currency of the token |
+**decimals** | **Integer** | Token decimal places | 
+
+
+## Example
+
+```json
+{
+      "network": "ethereum",
+      "chain": "goerli",
+      "transferAddress": "0xd15bdd17175825742a5904b21008dd3a019a060e",
+      "name": "USD p18",
+      "symbol": "USD18",
+      "currency": "USD",
+      "decimals": 18
+}
+```

data/docs/CreateCheckoutUrlRequest.md

@@ -0,0 +1,28 @@
+# 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](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> | 
+**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
+
+```json
+{
+    "id": "4",
+    "currency": "USD",
+    "amount": "10",
+    "cancelUrl": "https://demo.store/api/cancelOrder",
+    "successUrl": "https://demo.store/api/completeOrder",
+    "token":"0x115615dbd0f835344725146fa6343219315f15e5",
+    "chain":"goerli"
+}
+```

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** | **String** | 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** | **String** | 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.| 
+**token** <br> (Optional) | **String** | (Only for Algorand Standard Asset) Asset id which will be used for payment. |
+## 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** | Address of the newly created payment | 
+
+## 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** | **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
+
+```json
+{
+    "txid": "12345-6789",
+    "token": "0x84df8548086EC9025E9C93297058Bed706E90DDD",
+    "payouts": [
+        {
+            "transferAddress": "0xD15BDD17175825742A5904b21008dd3A019a060E",
+            "amount": "1"
+        },
+        {
+            "transferAddress": "0x7Dc30B85084aA1608e5C1Ce39c804Be177e40A07",
+            "amount": "1"
+        }
+    ]
+}
+```